Skip to main content

​
System Requirements

No npm login is required to install. Without Bun, the interactive TUI prints install guidance and the CLI remains fully usable.

​
Install

Verify the installation:
Upgrade at any time:

​
Authentication

With no options, apollo login opens the browser sign-in flow via the Playground; sign in and you’re redirected back automatically. Other login modes:
Non-interactive OTP is two steps — the first call sends the code, the second verifies it:
Login stores access and refresh tokens in ~/.apollo/credentials.json (mode 600 — the only secret-bearing file). Normal commands need no additional secrets, and credentials persist across terminal sessions. apollo logout invalidates the remote session and removes the local credential.

​
Profiles

Profiles keep separate credentials for different users or contexts:
The selected profile persists for later commands. --profile <name> before any command is a one-command override for automation — it does not change the saved default.

​
Post-Login Setup

1

Verify your session

You should see your active profile, organization, project, and agent context. Add --check to also verify service connectivity and authorization, or run apollo doctor for a full end-to-end diagnosis.
2

Enable shell integration (recommended)

Add to your shell profile (the postinstall step offers to do this for you):
This lets apollo agent use / import / create drop your shell directly into the agent’s checkout directory.
3

Create or import an agent

Checkouts default to a managed directory under ~/apollo/; use --dir for an intentional other path. Both commands install authoring skill packs for Cursor and Claude Code into the checkout.

​
Uninstall

To remove stored credentials and configuration:
This removes all stored credentials, the known-checkouts registry, and diff baselines. You’ll need to run apollo login again.

​
Next Steps

Command Reference

Full reference for all CLI commands.

Configuration

Checkout structure, config files, and environment variables.