> For the complete documentation index, see [llms.txt](/llms.txt).
> A full single-fetch corpus is available at [llms-full.txt](/llms-full.txt).
---
title: Install the CLI
description: Install the AGNT5 CLI, verify it, and authenticate with your account.
sdk: none
last_verified: 2026-06-06
---

The `agnt5` CLI scaffolds projects, runs `agnt5 dev` against AGNT5 from your laptop, and ships projects to managed environments.

**Prerequisites:**

- macOS (Apple Silicon or Intel), Linux (x86_64 or ARM64), or Windows via WSL2. Native Windows binaries are not yet shipped.
- An AGNT5 account. Sign up at [app.agnt5.com](https://app.agnt5.com).

<details>
<summary><strong>Set up with an AI coding assistant</strong> — paste this prompt into Claude Code, Cursor, Copilot, etc.</summary>

The assistant will run the install end-to-end. Use this if you'd rather have an AI driver handle the steps below.



**Setup prompt:**

```text
Help me install the AGNT5 CLI.

What to do:

1. I need an AGNT5 account. If I don't have one, point me to https://app.agnt5.com to sign up. Wait for me to confirm.
2. Install the AGNT5 CLI: curl -LsSf https://agnt5.com/cli.sh | bash
3. Run ~/.agnt5/bin/agnt5 version and confirm the output names a version, Go toolchain, and platform. Use the absolute path; the current shell has not reloaded yet, so plain "agnt5" will not be on PATH in this session.
4. Run ~/.agnt5/bin/agnt5 auth login and wait for me to complete browser auth.
5. Run ~/.agnt5/bin/agnt5 auth status and confirm I am signed in.
6. Tell me to open a new terminal so future agnt5 commands resolve from PATH without the ~/.agnt5/bin/ prefix.
7. When done, point me to https://docs.agnt5.com/docs/quickstart for the next step.

Critical rules:

- DO NOT run agnt5 create or scaffold a project. Project scaffolding belongs in the quickstart, not the install.
- The current shell does NOT pick up the new PATH automatically. The installer wrote the PATH line into ~/.zshrc, ~/.bashrc, or ~/.config/fish/config.fish, but those changes only apply to new shells. In this session, always invoke ~/.agnt5/bin/agnt5 with the absolute path. Do not edit the rc file as a "fix" — it is already correct.
- If agnt5 version still fails after using the absolute path, the binary did not download. Re-run the curl install and check the output for errors before debugging PATH.
```



</details>

## Step 1: Install




**curl (macOS, Linux, WSL2):**

```bash
curl -LsSf https://agnt5.com/cli.sh | bash
```




**Homebrew (macOS only):**

```bash
brew install agnt5/tap/agnt5
```




The installer writes `agnt5` to `~/.agnt5/bin` and appends that directory to your shell's `PATH`. Open a new terminal, or reload the current shell:

```bash
source ~/.zshrc                    # zsh
source ~/.bashrc                   # bash
source ~/.config/fish/config.fish  # fish
```

## Step 2: Verify

```bash
agnt5 version
```

Expected output (version numbers will vary):

```
agnt5-cli version v1.x.x
  - Go version: go1.25.x
  - Platform: darwin/arm64
```

## Step 3: Authenticate

Sign in via OAuth in your browser:

```bash
agnt5 auth login
```

The CLI opens your default browser, completes the PropelAuth flow, and writes the issued API key to `~/.agnt5/config.yaml`. Confirm:

```bash
agnt5 auth status
```

The output names the authenticated user, the active environment, and the API base URL.

For CI or non-interactive environments, pass an API key directly or set `AGNT5_API_KEY` in the environment:

```bash
agnt5 auth login --api-key agnt5_sk_...
# or
export AGNT5_API_KEY=agnt5_sk_...
```

API keys are issued during the OAuth flow above, or generated in [app.agnt5.com](https://app.agnt5.com) account settings. See the [auth command reference](/cli/auth.md) for `agnt5 auth logout` and the full flag list.

## Troubleshooting

**`command not found: agnt5`** — your shell hasn't picked up the new `PATH` entry. Confirm `~/.agnt5/bin` is on `PATH`:

```bash
echo $PATH | tr ':' '\n' | grep agnt5
```

If nothing prints, add this line to your shell config and reload:

```bash
export PATH="$HOME/.agnt5/bin:$PATH"   # bash, zsh
# fish:
fish_add_path "$HOME/.agnt5/bin"
```

**`agnt5 version` still fails after fixing `PATH`** — the binary did not download. Re-run the install command and check its output for errors before further `PATH` debugging.

**Authentication errors after running `agnt5 dev` or `agnt5 deploy`** — re-authenticate with `agnt5 auth login`. If you switched accounts or contexts, run `agnt5 auth logout` first.

## Next steps

- **[Quickstart](/docs/quickstart.md)** — build and run the Hacker News digest workflow.
- **[CLI Reference](/cli)** — every command and flag.