CLI Commands

PromptCanary CLI syntax:

promptcanary [global options] <command> [command options]

Global options

• --dotenv <path>: path to .env file (defaults to .env in current directory)
• --version: print version
• --help: show help

promptcanary init

Creates starter promptcanary.yaml in the current directory.

promptcanary init

Options:

• --test-runner <type>: also scaffold promptcanary.test.ts using vitest or jest

Examples:

promptcanary init --test-runner vitest
promptcanary init --test-runner jest

promptcanary validate <file>

Loads and validates config file.

promptcanary validate promptcanary.yaml

Exit codes:

• 0 valid config
• 1 invalid config

promptcanary run <file>

Runs tests against configured providers and stores results in SQLite.

promptcanary run promptcanary.yaml

Flags:

• --json: output machine-readable JSON
• --verbose: print progress lines for each completed provider run

Examples:

promptcanary run promptcanary.yaml --verbose
promptcanary run promptcanary.yaml --json
promptcanary --dotenv ~/.config/promptcanary/.env run promptcanary.yaml

Exit codes:

• 0 all tests passed
• 1 one or more tests failed or execution error

promptcanary results [--last N]

Shows recent stored runs from promptcanary.db.

promptcanary results
promptcanary results --last 25

Options:

• --last <number>: number of recent runs to display (default 10)