Skip to content

Commit

Permalink
docs(ai-test): add README (#397)
Browse files Browse the repository at this point in the history
  • Loading branch information
caugner authored Jan 23, 2024
1 parent 2637def commit 41391f5
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions ai-test/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## ai-test

This module allows to gather AI Help answers for quality assurance.

### Quickstart

To understand how this tool works, run: `cargo run -p ai-test -- test --help`

```
Usage: ai-test test [OPTIONS]
Options:
-p, --path <PATH>
-o, --out <OUT>
-h, --help Print help
```

For example, to request answers for all questions in the [prompts.yaml](./data/prompts.yaml) file, run (from the repository root):

```sh
cargo run -p ai-test -- test -p ai-test/data/prompts.yaml
```

By default, the results are written to the `/tmp/test` directory, unless you specify a different output directory (see above).

0 comments on commit 41391f5

Please sign in to comment.