Get started Install the CLI

Install the CLI

Install the AGNT5 CLI to develop, test, and deploy durable AI workflows.

The AGNT5 CLI is your primary interface for developing workflows locally and deploying them to production. It manages the local dev server, scaffolds projects, and handles deployments.

Requirements

  • macOS (Apple Silicon or Intel) or Linux (x86_64)

Install

curl -LsSf https://agnt5.com/cli.sh | bash
brew install agnt5/tap/agnt5

The installer adds agnt5 to your PATH. You may need to restart your terminal or run source ~/.bashrc (or ~/.zshrc) for the command to be available.

Verify installation

agnt5 version

You should see output like:

agnt5 version v0.2.2

Authenticate

Authentication is required to deploy to AGNT5 Cloud.

Interactive login (recommended) 

agnt5 auth login

This opens your browser to complete OAuth authentication. Once authenticated, your credentials are stored locally.

API key login

For non-interactive environments or CI/CD pipelines, authenticate with an API key:

agnt5 auth login --api-key <your-api-key>

Check your login status:

agnt5 whoami

What the CLI does

The CLI handles core workflows:

Command Purpose
agnt5 create Scaffold a new project from templates
agnt5 deploy Build and deploy to staging or production

Other useful commands:

  • agnt5 secrets — Manage secrets
  • agnt5 projects — List your projects
  • agnt5 logs — Stream logs from deployments

Run agnt5 --help to see all available commands, or agnt5 <command> --help for details on a specific command.

Update

Check your current version and update to the latest:

# Check current version
agnt5 version

# Update to latest
agnt5 version update

If you installed via Homebrew:

brew upgrade agnt5

Troubleshooting

Command not found

If agnt5 isn’t recognized after installation:

  1. Restart your terminal — The PATH update requires a new shell session
  2. Check your PATH — The CLI installs to ~/.agnt5/bin. Ensure this is in your PATH: 
    echo $PATH | grep -q '.agnt5/bin' && echo "Found" || echo "Not in PATH"
  3. Manually add to PATH — Add this to your ~/.bashrc, ~/.zshrc, or shell config: 
    export PATH="$HOME/.agnt5/bin:$PATH"

Permission denied during install

If the curl installer fails with permission errors:

# Install to a custom location
curl -LsSf https://agnt5.com/cli.sh | bash -s -- --prefix ~/.local

Then add ~/.local/bin to your PATH.

Next steps