Skip to main content
The Antigen CLI lets you launch agents, follow runs, and retrieve vulnerabilities and evidence from your terminal. It uses the same API as the Antigen SDK, so you can work with the same resources from scripts, CI pipelines, and the platform.

Sign in

After installing the CLI, sign in:
The CLI prints a link and a code, and opens the link in your browser. Sign in to Antigen if you aren’t already, check that the code matches your terminal, and approve it. Once you approve, antigen login prints the organization it signed in to. If you belong to more than one organization, name the one to use with its slug: antigen login --org acme. The approval page lists your organizations’ slugs. The CLI acts as you, with your role in your organization, and saves the session in ~/.antigen/credentials. Run antigen whoami to see who you’re signed in as, and antigen logout to sign out. Over SSH or in a container, run antigen login --no-browser and open the link on any device.

CI and automation

People sign in with antigen login. CI pipelines and other automated systems use an API key instead:
  1. An admin creates a key at Settings → API keys, or with antigen api-keys create <name>.
  2. Store it in your pipeline’s secret store and expose it as ANTIGEN_API_KEY.
When ANTIGEN_API_KEY is set, the CLI uses it for every request, even if someone has signed in on the machine. A key acts as an admin of your organization, so keep it out of logs and source control. See CI/CD for a complete pipeline.

Start a run

Launch tCell against an approved target:
The CLI prints the run ID and streams activity as the agent works:
The command waits until the run finishes. The run continues in its sandbox if your terminal disconnects. Targets must be approved before testing. See Targets for the approval process.

Commands

See Commands for arguments, options, and examples.