diff --git a/website/docs/docs/ai/index.md b/website/docs/docs/ai/index.md index ef69ad74..18853a14 100644 --- a/website/docs/docs/ai/index.md +++ b/website/docs/docs/ai/index.md @@ -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: @@ -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: