Getting Started

View as Markdown

testerarmy (alias ta) is an agent-first control plane for the TesterArmy dashboard. Use it to manage projects, environments, credentials, and saved tests, and to queue remote runs that execute in TesterArmy cloud. It works standalone for interactive use or as a skill for coding agents like Claude Code, Codex, and OpenCode.

Your coding agent orchestrates dashboard-managed QA to validate changes - keeping the feedback loop tight without polluting main agent context. Local browser execution is available for quick ad hoc checks.

Install

$npm install -g testerarmy

Or use without installing:

$npx testerarmy --help

Both testerarmy and ta map to the same CLI.

Agent workflow

Agents can discover the full flow from ta --help. The usual path is:

$ta auth
$echo '{"name":"Example","url":"https://example.com","projectType":"web"}' | ta projects create --json
$ta projects list --json
$ta projects environments-create <projectId> --name Staging --url https://staging.example.com --json
$echo '{"category":"site_structure","title":"Auth route","content":"Login is at /login","importance":"high"}' | ta memories create --project <projectId> --json
$ta memories delete <memoryId> --project <projectId> --json
$echo '{"title":"Login flow","steps":[{"title":"Navigate to /login","type":"act"},{"title":"Dashboard loads","type":"assert"}]}' | ta tests create --project <projectId> --json
$ta tests run <testId> --wait --json
$ta tests run <testId> --env staging --wait --json

ta tests run queues a remote run in TesterArmy cloud by default; pass --local to execute in a local browser instead.

If you use a coding agent, install the official skill for tighter integration:

$npx skills add tester-army/cli

This gives your agent structured instructions for running tests, interpreting results, and iterating on failures.

Repository: github.com/tester-army/cli

Authenticate

Run ta auth and paste your API key when prompted:

$ta auth

Get your key from the TesterArmy dashboard under Profile → API Keys.

For API key troubleshooting and Bearer token examples, see API Keys.

You can also pass the key directly:

$ta auth --api-key YOUR_KEY

Or set it as an environment variable (useful for CI):

$export TESTERARMY_API_KEY="YOUR_KEY"

Verify

$ta status

Use --json for machine-readable output:

$ta status --json

Sign out

$ta signout
$# or
$ta logout

Next steps