CLI Overview

AgenticAssure provides a command-line interface for every stage of the testing workflow: scaffolding projects, validating scenario files, listing scenarios, and running tests with full reporting. All commands are accessible through the agenticassure entry point.

Commands at a Glance

Command	Description
`agenticassure run <path>`	Run test scenarios against an agent and generate reports
`agenticassure validate <path>`	Validate YAML scenario files against the JSON Schema
`agenticassure list <path>`	List all scenarios with their metadata
`agenticassure init [directory]`	Scaffold a new project with example scenarios

Global Options

These options are available on the root agenticassure command, before any subcommand:

Option	Description
`--version`	Print the installed version of AgenticAssure and exit
`--help`	Show the top-level help message and exit


agenticassure --version
# agenticassure, version 0.2.0-alpha
 
agenticassure --help

Getting Help for Any Command

Every command supports the --help flag, which prints usage information, all available options, and their defaults.


agenticassure run --help
agenticassure validate --help
agenticassure list --help
agenticassure init --help

Typical Workflow

A typical workflow using the CLI follows this sequence:

Scaffold a project with agenticassure init to create the directory structure and example scenarios.
Edit scenarios in the generated scenarios/ directory, adding your own test cases.
Validate your files with agenticassure validate scenarios/ to catch schema errors before running.
List scenarios with agenticassure list scenarios/ to confirm everything loaded correctly.
Run tests with agenticassure run scenarios/ --adapter mymodule.MyAgent to execute scenarios against your agent.
Generate reports by adding --output html or --output json to the run command.

Exit Codes

All commands follow a consistent convention:

Exit Code	Meaning
`0`	Success — all validations passed, all scenarios passed
`1`	Failure — at least one validation error or at least one scenario failed

This makes it straightforward to integrate AgenticAssure into CI/CD pipelines and shell scripts where non-zero exit codes indicate failure.

What’s Next

agenticassure run — Full reference for the run command.
agenticassure validate — Validating scenario files.
agenticassure list — Listing and inspecting scenarios.
agenticassure init — Scaffolding a new project.