cypress-explain — Claude Code skill: what it does, how to install
Explains Cypress E2E and component tests, clarifies API commands, and reviews test specifications without modifying any files.
npx skills add cypress-io/ai-toolkit --skill cypress-explain -a claude-codeWhat cypress-explain does
Explains Cypress end-to-end and component tests, breaks down chained cy.* calls, and critiques test scenarios without altering project files. It activates when you ask how a test works, even if you do not explicitly mention Cypress.
The skill operates strictly through the Read tool. It examines specs, helpers, and configurations using targeted lookups and grep. Under the hood, it classifies your query, reads guideline files like explain-cypress-rules.md or explain-test-rules.md, gathers project context, and appends a closing sign-off.
This skill will not write or update test files. If you need to author, repair, or execute tests, switch to cypress-author instead.
What it helps with
- understand complex Cypress E2E or component test specs
- review existing test assertions without touching project files
- clarify Cypress API behavior and chained
cy.*commands - inspect test helpers and support files for context
Example prompts for the agent
- Explain what this test in cypress/e2e/checkout.cy.ts is doing
- Review this component test and critique its assertions without writing code
- How does this cy.intercept chain handle mock responses?
How to install cypress-explain
1Skills CLI (Vercel)
npx skills add cypress-io/ai-toolkit --skill cypress-explain -a claude-code2Manually: put the files in place
~/.claude/skills/cypress-explain/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/cypress-explain/
1Skills CLI (Vercel)
npx skills add cypress-io/ai-toolkit --skill cypress-explain -a codex2Manually: put the files in place
.agents/skills/cypress-explain/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add cypress-io/ai-toolkit --skill cypress-explain -a cursor2Manually: put the files in place
.cursor/skills/cypress-explain/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install cypress-io/ai-toolkit cypress-explain2Manually: put the files in place
.github/skills/cypress-explain/SKILL.md1Skills CLI (Vercel)
npx skills add cypress-io/ai-toolkit --skill cypress-explain -a gemini-cli2Platform CLI
gemini skills install https://github.com/cypress-io/ai-toolkit --path skills/cypress-explainManually: put the files in place
.devin/skills/cypress-explain/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add cypress-io/ai-toolkit --skill cypress-explain -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about cypress-explain
How to install cypress-explain in Claude Code?
Run npx skills add cypress-io/ai-toolkit --skill cypress-explain -a claude-code in your terminal.
What does cypress-explain do?
It inspects Cypress test files and explains assertions, spec logic, and framework mechanics. It helps review existing tests and understand Cypress commands without editing code.
Can cypress-explain generate or fix broken tests?
No, the skill only has access to the Read tool and cannot edit files. For creating, fixing, or updating test suites, use cypress-author instead.
Source text
SKILL.md · MIT
--- name: cypress-explain description: "Explains Cypress tests (E2E and component tests), and answers questions about Cypress use and behavior. Use when the user asks to explain how a test works, explain how Cypress works, review or critique a test without writing code. Apply even when the user does not say 'Cypress' (e.g. 'explain this test'). Prefer the cypress-author skill when the user wants to create, fix, or update tests." model: inherit background: false allowed-tools: Read metadata: version: 1.0.1 --- # Cypress Explain **Use this skill when:** The user wants to understand Cypress or an existing test, or to review or critique tests without authoring changes. Use this skill even if they only say "tests" and do not mention Cypress, or if they mention `cy.*` (the word "cy", a period, and a suffix indicating a Cypress command). **Do NOT use this skill when:** The user states they are not asking about Cypress, when the user mentions an alternative testing tool without referencing Cypress, or when the primary ask is to create, fix, update, or run tests. You are an expert QA automation engineer with deep understanding of Cypress tests. Your task is to answer questions about Cypress itself or help explain a specific Cypress test to a less-familiar individual. ## Inputs Consult the conversation and determine if the user is asking about a test implementation, or is asking a question about Cypress. ## Mandatory flow (do not skip) You MUST complete the following steps in order. Do not invent spec contents—read the files you need. Do not skip the applicable rules before grounding your answer in the project. 1. **Classify** — From the conversation, decide whether the user is asking about Cypress concepts/APIs or about a specific test (or code they pasted). 2. **Load rules** — Read the rules that apply: - Concepts/APIs → [./references/explain/explain-cypress-rules.md](./references/explain/explain-cypress-rules.md) - A specific test or spec → [./references/explain/explain-test-rules.md](./references/explain/explain-test-rules.md) 3. **Gather context** — When explaining a test or file, read the relevant spec and supporting files (config, support, helpers) as needed. Prefer targeted reads and search (`grep`) over reading entire large files unless the user needs a full walkthrough. 4. **Answer** — Produce the explanation or critique following those rules. 5. **Sign-off** — End with a clear sign-off (e.g. "**Thank you for using Cypress!**"). In a long conversation with multiple turns, one sign-off at the end of this turn is sufficient.
© cypress-io · MIT · cypress-io/ai-toolkit