Skip to main content
The TestSprite CLI is production-ready for the workflows listed below, with a stable --output json contract that agents and CI can rely on today. Changes are strictly additive: new fields may appear, but existing fields, exit codes, and command shapes will not change.
Stability promise: the JSON output contract and exit codes are stable. New commands or flags may be added, but nothing currently documented will be removed or renamed without a major version bump.

​
What’s included

​
Auth

CapabilityCommand
Configure an API key (with --from-env for CI)auth configure
Verify the active profileauth whoami
Remove credentialsauth logout

​
Projects

CapabilityCommand
List, get, create, and update projects (frontend and backend types)—

​
Tests

CapabilityCommand
List and get tests—
Create a single testtest create
Bulk-create frontend teststest create-batch, test create-batch --plan-from-dir
Update test metadata—
Delete a single test or bulk-deletetest delete, test delete-batch

​
Authoring

  • Frontend: create from an agent-supplied plan file (--plan-from) with full planSteps[]; replace plan steps (test plan put)
  • Backend: create from a test code file (--code-file, typically Python/pytest); declare captured variables (--produces/--needs) and teardown tests (--category teardown) for wave-ordered dependency runs; replace code with ETag-guarded optimistic concurrency (test code put)
  • Read the generated test code (test code get)

​
Running

CapabilityCommand
Trigger a single test runtest run
All backend tests in wave ordertest run --all
Block until terminal--wait, --timeout
Resume a detached runtest wait <run-id>
Create and run in a single commandtest create --run --wait

​
Rerun & auto-heal

CapabilityCommand
Replay a frontend test verbatim (no credit charge) or re-run a backend dependency closuretest rerun
Rerun all tests matching a filtertest rerun --all
Auto-heal on by default for frontend reruns — uses a small amount of credit only when AI healing actually engages; opt out--no-auto-heal

​
Reading results

CapabilityCommand
Cumulative step log, scoped to a run with --run-idtest steps
Latest result, with inline analysis via --include-analysistest result
Run history list, filterable by source and time rangetest result --history
One-screen failure triagetest failure summary
Full failure bundle for latest failing runtest failure get
Run-scoped, immutable failure bundle — unaffected by concurrent runstest artifact get <run-id>

​
Onboarding

CapabilityCommand
One command to configure credentials and install the agent skill, with a unified summarytestsprite init

​
Coding-agent skill

CapabilityCommand
Write the TestSprite verification-loop skill file for Claude Code (GA), Cursor, Cline, Antigravity, or Codex (all experimental except Claude)agent install
See all supported targets, modes, and landing pathsagent list

​
Global capabilities

CapabilityCommand
Try any command offline without an API key--dry-run
Stable, parseable contract for agents and CI--output json
Named profiles and environment variables for flexible credential management—
On run completion — deep-link into the Web PortaldashboardUrl

​
On the roadmap

These capabilities are designed and coming in a future release. No version promises.
  • Test Lists (suites) — create and run named collections of tests spanning multiple projects
  • Schedule and monitoring reads — read scheduled run history and monitoring status from the CLI
  • Project-level test reports — aggregate pass/fail summary across all tests in a project

​
Feedback

The CLI gets better when you share what’s rough. Join the community to tell us what broke, what was confusing, or what you wished the CLI could do — your feedback directly shapes the roadmap.

​
Where to Go Next

Overview

What the CLI is and how it fits alongside the Web Portal and MCP

Quickstart

Install, configure, and run your first test in minutes

Command Reference

Every command, flag, and output shape in one place

Agent Integration

How coding agents use the CLI as a verification loop