Getting Started¶

Get Assay running in 5 minutes.

For the reproducible release contract, use the release-pinned agent golden path. This page is the shorter human introduction.

Overview¶

This guide covers:

1. Installation — Install the Assay CLI
2. Quick Start — Import a trace and run your first test
3. Your First Test — Write a custom policy from scratch
4. CI Integration — Add Assay to GitHub Actions / GitLab CI
5. Operator Proof Flow — See trace ingest, shipped control-evidence linting, and proof-kit verification as one flow

Prerequisites¶

• Rust 1.96 for repository development, Rust 1.89+ for public-crate source installs, or CPython 3.12 for Python SDK use
• CPython 3.12 on macOS x86_64/arm64 and Linux x86_64; other interpreters and platforms are not claimed.
• An MCP session log (or use our example)
• 5 minutes ☕

The 60-Second Version¶

# Install
cargo install assay-cli --version 6.4.0 --locked

# Import an MCP session as trace
assay import --format inspector session.json --out-trace traces/session.jsonl

# Run tests
assay run --config eval.yaml --trace-file traces/session.jsonl

# Add to CI
# Copy the GitHub Action from ci-integration.md

This runs the recorded evaluation path. A clean result still depends on the supplied config and trace being complete.

What You'll Learn¶

By the end of this guide, you'll understand:

Next Steps¶