What the skills do
testsprite agent install writes two skill files into your repository by default:
testsprite-verify— the verification-loop skill. Once in place, your coding agent discovers that this project is TestSprite-tested and knows exactly how to drive the full loop on its own: describe a behavior as a plan file and create a test; trigger a real cloud run and wait for the verdict; on failure, pull one self-consistent bundle — failing step, DOM snapshots rendered as text, root-cause hypothesis, and recommended fix target; edit the code and replay cheaply.testsprite-onboard— the onboarding skill. Guides the agent through initial project setup (runningtestsprite setup, creating the first project and test) the first time TestSprite is used in a repo.
agent install reads and writes only to your filesystem. It makes no network requests and requires no credentials.
Install the skills
testsprite-verify and testsprite-onboard by default) are written immediately.
Flags:
| Flag | Description |
|---|---|
--target <t> | Agent target: claude, cursor, cline, antigravity, kiro, windsurf, copilot, codex. Comma-separated or repeated. Prompts if omitted in a terminal. |
--skill <name> | Skill to install: testsprite-verify, testsprite-onboard. Comma-separated or repeated. Default: both. |
--dir <path> | Project root to write the skill(s) into (default: current directory). |
--force | Overwrite an existing skill file. A .bak backup is kept. For codex, replaces only the managed section — your other AGENTS.md content is preserved. |
If
--target is omitted in an interactive terminal, the CLI prompts for one (default claude). Outside a terminal — CI, a script, a piped invocation — it skips the prompt and defaults straight to claude, printing an [info] line to stderr so the choice is visible in logs.If the destination file already exists and differs from the current skill, the install is blocked until you pass
--force. The original is always backed up as <filename>.bak.Supported agents
| Target | Status | Mode | Landing path |
|---|---|---|---|
claude | GA | own-file | .claude/skills/{skill}/SKILL.md |
antigravity | experimental | own-file | .agents/skills/{skill}/SKILL.md |
cursor | experimental | own-file | .cursor/rules/{skill}.mdc |
cline | experimental | own-file | .clinerules/{skill}.md |
kiro | experimental | own-file | .kiro/skills/{skill}/SKILL.md |
windsurf | experimental | own-file | .windsurf/rules/{skill}.md |
copilot | experimental | own-file | .github/instructions/{skill}.instructions.md |
codex | experimental | managed-section | AGENTS.md |
{skill} is testsprite-verify or testsprite-onboard. Own-file targets write one file per installed skill; only the requested skill(s) land, so --skill testsprite-verify writes just that one file.
For
codex, every installed skill is merged into one managed section inside AGENTS.md. Your existing content in that file is not modified — only the TestSprite section is added or updated.Listing targets
To see all supported targets, their current status, and where each skill lands:Checking skill health
Once skills are installed, confirm they’re still in sync with the CLI version that installed them — useful right after upgrading the CLI, or in CI to catch a hand-edited skill file:| State | Meaning |
|---|---|
ok | Matches exactly what this CLI version would install |
stale | Installed by an older CLI version whose canonical content has since changed |
modified | Edited by hand after install |
unmarked | Present, but predates the provenance marker this check relies on |
absent | Not installed for this target/skill |
corrupt | codex only — the managed AGENTS.md section’s sentinels are malformed |
--dir <path> to inspect a project other than the current directory. agent status exits 1 when anything needs attention (any state other than ok or absent), so it’s CI-gateable:
One-shot onboarding
testsprite setup configures your API key and installs the skills in a single step — the recommended path when you’re setting up a project for the first time.
setup chains credential configuration → identity verification → agent skill install, and prints a unified summary.
Installation
The full onboarding walkthrough, including the non-interactive (
--from-env --yes) form for CI bootstrap.How the agent uses it
Once the skill files are in place, a coding agent like Claude Code picks them up automatically when it enters your project. It knows to:- Create a test from a plan you or the agent authors — describing the behavior in intent terms, not driver code.
- Run it against the live app and wait for a pass/fail verdict.
- On failure, pull the failure bundle — one consistent artifact with everything needed to diagnose and fix.
- Fix the code, then rerun as a cheap verbatim replay.
Where to Go Next
Quickstart
Walk through the full create → run → fix loop end-to-end
CI/CD
Gate your pipeline on TestSprite results
Running Tests
All flags and modes for triggering and waiting on runs
Command Reference
Full flag reference for every command