关于 cypress-docs
cypress-docs 是面向 Agent 的技能，用于从 Cypress 官方文档中查找准确、可核实的信息。它优先使用适合 LLM 的结构化页面，并要求查证来源，避免依赖记忆作答。
主要功能
- 01优先检索 Cypress 官方来源
- 02通过 llms.txt 发现文档路径
- 03使用 /llm/* 结构化内容
- 04核对版本相关行为
- 05避免断言未经证实的 API
适用场景
- 01核实 Cypress 命令与 API
- 02查询配置和 CLI 细节
- 03比较 E2E 与组件测试行为
- 04依据官方文档撰写说明
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/cypress-docs确认已加载。
详细介绍
Cypress 文档
目的
优先使用官方文档和结构化来源，帮助 Agent 获取关于 Cypress 测试框架的准确、最新且可验证的信息。
适用场景
只要任务依赖于查找、阅读或引用 Cypress 文档，而不是依赖一般测试经验，就应使用此技能：
- 查找事实：Cypress 文档中记载的命令、API、断言、生命周期钩子、配置选项、环境变量、CLI 标志、插件或 TypeScript 类型。
- 确认行为：特定 Cypress 版本中的功能、E2E 与组件测试之间的差异、浏览器支持情况，或网络与 cy.intercept 的语义。
- 断言“Cypress 能／不能……”之前：先搜索文档；不要依赖记忆来确认确切的签名、默认值或已弃用的 API。
- 提取结构化内容：获取或总结文档页面时，遵循下方的 LLM 优化文档策略（
llms.txt、/llm/*）。 - 为他人提供依据：向用户解释 Cypress、编写示例，或审查必须符合官方文档的代码时。
如果用户只需要编写或修复测试，而无需查阅文档，请优先使用 cypress-author；如果用户只需要了解测试，而无需获取文档，请使用 cypress-explain。只有在官方文档是权威依据时，才使用此技能。
来源优先级
首选来源（始终先搜索）
🤖 LLM 优化文档策略
访问 docs.cypress.io 时：
-
获取
/llms.txt -
解析其中内容，以查找：
- 适合 LLM 阅读的文档路径
- 结构化内容端点
-
优先使用
/llm/*下的内容。网站上的每个路径都在/llm下提供了优化版本，例如，https://docs.cypress.io/app/faq对应的版本位于https://docs.cypress.io/llm/markdown/app/faq.md。 -
优点：
- Markdown / JSON 格式
- 结构更清晰
- 比 HTML 更少冗余内容
-
回退方案：
- 如果
/llm/*内容不完整，请使用标准文档页面
- 如果
关键规则
切勿假设缺少某项功能
- 绝不要假设 Cypress 不支持某项功能
- 下结论前务必先搜索
- 如有需要，尝试使用其他术语搜索
防止幻觉
如果无法通过文档验证某项说法：
- 请说明：“我无法在 Cypress 文档中验证这一点”
- 提供最接近且受支持的替代方案（如果有）
- 不要编造 API 或行为
搜索策略
1. 对查询分类
| 查询类型 | 搜索位置 |
|---|---|
| 如何……？ | /guides/、/core-concepts/ |
| 什么是……？ | /core-concepts/ |
| API / 命令 | /api/commands/ |
| 断言 | /api/assertions/ |
| 配置问题 | /configuration/ |
| CI/CD | /guides/ci-cd/ |
| 错误 | /references/error-messages/ |
2. 搜索流程
/llm/*（通过/llms.txt）- 标准文档页面
/changelog/cypress.io（博客、更新）
3. 根据错误调整搜索路径
如果查询包含：
- 错误消息
- 堆栈跟踪
则：
- 搜索
/references/error-messages - 扩展到指南和 API 文档
结构化内容提取规则
命令
- 语法
- 必需参数
- 可选选项
- 返回行为
- 使用示例
概念
- 定义
- 关键规则
- 常见陷阱
- 示例
配置
- 选项名称
- 类型
- 默认值
- 示例
版本注意事项
- 如果提供了 Cypress 版本，请识别该版本
- 如果未提供：假定为最新稳定版本
- 如果不同版本的行为存在差异：
- 请明确指出
回复风格指南
- 优先使用官方示例
- 提供可运行的代码片段
- 保持简洁，同时确保内容完整
- 避免推测
缓存策略（可选）
缓存经常使用的主题：
- cy.visit
- cy.get
- cy.intercept
- 身份验证模式
- 常见配置
置信度标注
在内部评估置信度：
- 高 → 与官方文档直接匹配
- 中 → 根据多个来源推断
- 低 → 不明确或属于边缘情况
如果置信度为低：
- 明确说明不确定性
LLM 路径自动发现
- 始终解析
/llms.txt - 动态适应：
- 新的
/llm/*路径 - 更新后的文档格式
- 新的
安全规则
- 绝不编造 Cypress API
- 绝不猜测语法
- 始终验证行为
- 宁可回答“未知”，也不要提供错误信息
示例行为
用户：“如何在 Cypress 中模拟 API 请求？”
Agent 应：
- 分类 → API / 网络
- 搜索
/llm/markdown/api/和/llm/markdown/guides/ - 找出
cy.intercept - 提取结构化细节
- 返回：
- 说明
- 语法
- 示例
- 备注
总结
此技能可确保：
- 基于官方来源提供准确答案
- 减少幻觉
- 输出结构化、高质量的内容
- 适应不断演进的 Cypress 文档
评论
支持 Markdown