Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

wip: draft updates for BYO templates feature #318

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

wip: draft updates for BYO templates feature #318

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions website/docs/docs/ai/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ Authentication requires valid PactFlow API Tokens, which can be obtained from th

You can authenticate with the CLI in several ways:

### Example

TBC - show basic example of invoking the CLI to generate a test

#### Environment Variables

Set the following environment variables, and the CLI will use them to communicate with PactFlow:
Expand All @@ -106,6 +110,14 @@ Alternatively, store the user configuration file in `~/.config/pact/config.toml`

Pass the `--user` flag when running `pactflow-ai config set` to write to this file automatically.

### Generating Tests

TBC - explain the key features of this and mention the `help` command for detail.

### Using Test Templates

TBC - explain the new feature.

## Usage Limits

Access to the feature is metered based on the number of tests generated in a 30-day rolling window. Credits are allocated as follows:
Expand Down