From Zero to Your First Real Test Result.
No dashboard to click through first — install the CLI, authenticate, and run a real test against your site, all from the terminal. Here's the exact sequence, no steps skipped.
Requirements: Node.js 20.19+, 22.13+, or 24+
testsprite doctor tells you before your first test run does.Step 1 — Install
npm install -g @testsprite/testsprite-cli, or skip the install entirely with npx @testsprite/testsprite-cli.
Step 2 — Authenticate
testsprite setup prompts for your API key interactively. In a script or CI, skip the prompt: TESTSPRITE_API_KEY=sk-... testsprite setup --from-env --yes.
Step 3 — Create a Test Plan
testsprite test create --plan-template scaffolds a JSON plan you can edit, or point --plan-from at your PRD or API docs to generate one.
Step 4 — Run It
testsprite test create --project <id> --type frontend --plan-from plan.json --run --wait --output json runs it and waits for a real result.
$ npm install -g @testsprite/testsprite-cli
$ testsprite doctor
✓ Node.js 22.13.0
✓ network reachable
$ testsprite setup
? Paste your API key: ****************************
✓ Authenticated
$ testsprite test create --plan-template > plan.json
$ testsprite test create --project prj_8f2a --type frontend \
--plan-from plan.json --run --wait --output json
✓ TC001_Login_Rejects_Empty_Password passed 1.2s
One Command Away From a Real Answer
Everything above runs the same whether you're on your laptop, in CI, or inside a coding agent's own shell — install once, and testsprite is just a command from then on.
What to Do Next
Wire It Into CI
Add the same commands as a step in GitHub Actions, GitLab CI, or any pipeline that can run a shell command.
Connect Your Coding Agent
testsprite agent install claude (or cursor, codex, copilot, windsurf, cline, antigravity, kiro) registers testsprite as a tool it can call directly.
Free Community Version
Offers a free community version, making us accessible to everyone.
Check Your Setup Anytime
testsprite doctor re-runs environment diagnostics if something feels off later.
Trusted By Businesses Worldwide
"TestSprite offers rich test case generation, clear structure, and easy-to-read code. It also supports simple online debugging with the ability to quickly expand by generating new test cases."
"TestSprite's automation helps us reduce tons of manual work. The developers can easily catch and resolve bugs earlier in the development process."
FAQ
Do I need to install anything besides Node.js?
No — npm install -g @testsprite/testsprite-cli (Node.js 20.19+, 22.13+, or 24+) is the only dependency. Or skip the global install and run npx @testsprite/testsprite-cli directly.
How do I authenticate without the interactive prompt?
Set TESTSPRITE_API_KEY and run testsprite setup --from-env --yes --agent <name> — built for CI and scripts, no browser or prompt involved.
What if my environment isn't set up right?
testsprite doctor checks your environment before you run a real test, so a setup problem doesn't get mistaken for a test failure.
Do I have to write a test plan by hand?
No — testsprite test create --plan-template scaffolds one, or point --plan-from at your PRD or API docs and let it generate the plan for you.
Is there a cost to try it?
The CLI itself is Apache 2.0 licensed and free to install — getting through the steps above and seeing your first result doesn't require a credit card.