Installation¶

Install Assay on your system.

Quick Install¶

pip (Python)cargo (Rust)Homebrew (macOS)Binary (Linux/macOS)

pip install assay-it

Requires Python 3.9+. Installs the assay CLI globally.

cargo install assay-cli --locked

Note: The crate is named assay-cli, but the binary is assay. Requires Rust 1.70+. Builds from source (~2 minutes).

brew install rul1an/tap/assay

Installs pre-built binary.

curl -sSL https://assay.dev/install.sh | sh

Installs assay to ~/.assay/bin and updates your PATH.

Verify Installation¶

assay --version

Expected output:

assay 0.9.0

Platform-Specific Notes¶

macOS¶

If you see a security warning:

# Allow the binary
xattr -d com.apple.quarantine /usr/local/bin/assay

Windows¶

CargoScoopBinary

cargo install assay-cli --locked

scoop bucket add assay https://github.com/Rul1an/scoop-assay
scoop install assay

Download assay-windows-x86_64.zip from GitHub Releases and add to PATH.

Docker¶

docker pull ghcr.io/rul1an/assay:latest

# Run with volume mount
docker run -v $(pwd):/workspace ghcr.io/rul1an/assay:latest \
    run --config /workspace/mcp-eval.yaml

Development Installation¶

For contributors or those who want the latest features:

# Clone the repo
git clone https://github.com/Rul1an/assay.git
cd assay

# Build in release mode
cargo build --release

# Run from target directory
./target/release/assay --version

CI Installation¶

GitHub Actions¶

- name: Install Assay
  run: cargo install assay-cli --locked

# Or use our action (includes caching)
- uses: assay-dev/assay-action@v1

GitLab CI¶

before_script:
  - cargo install assay-cli --locked

Azure Pipelines¶

- script: cargo install assay-cli --locked
  displayName: 'Install Assay'

Uninstall¶

pipcargoHomebrew

pip uninstall assay-it

cargo uninstall assay-cli

brew uninstall assay

Troubleshooting¶

`cargo install` fails with SSL errors¶

# Update certificates
sudo apt-get update && sudo apt-get install -y ca-certificates

`pip install` fails with permission errors¶

# Use --user flag
pip install --user assay

# Or use pipx for isolated installation
pipx install assay

Binary not found after installation¶

Ensure your PATH includes:

Cargo: ~/.cargo/bin
pip: ~/.local/bin
Homebrew: /opt/homebrew/bin (Apple Silicon) or /usr/local/bin (Intel)

Next Steps¶

Quick Start — Run your first test