关于 claude-code-docs
claude-code-docs 是 Claude Code 文档的本地镜像技能,适合查询产品行为与配置的用户。文档以 Markdown 保存,并由每 3 小时运行的 GitHub Action 更新,支持按主题定位内容。
主要功能
- 01本地 Markdown 文档镜像
- 02每 3 小时自动刷新
- 03按主题索引并读取文档
- 04涵盖配置、命令和扩展功能
- 05提供文档来源与过期回退流程
适用场景
- 01查询 Claude Code 的 CLI 行为与设置
- 02查找 MCP、hooks、skills 或插件说明
- 03核对发布说明及文档来源
MCP 相关
该技能包含 Claude Code 的 MCP 文档主题,可用于查询相关说明;它本身不是 MCP 服务。
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ mehmetbaykar/ claude-code-docs-skill --skill claude-code-docs安装后在 Claude Code 中输入/claude-code-docs确认已加载。
详细介绍
Claude Code 文档
Anthropic Claude Code 文档的本地镜像,每 3 小时通过 GitHub Action 更新一次。清理后的 Markdown 文件位于 references/;自动生成的主题列表位于 references/INDEX.md;包含上游 URL 的逐文件清单位于 references/docs_manifest.json。
范围
将此技能用于 Claude Code 专属的产品和配置问题,包括 CLI 行为、设置、斜杠命令、钩子、技能、插件、MCP、子 Agent、AGENTS.md、输出样式、沙盒、权限、环境变量、监控和用量、Claude Desktop、Slack、Chrome、Web、Agent SDK 和发行说明。如果问题涉及 OpenAI Codex、Cursor、Claude.ai 消费者功能、通用 Anthropic API 或其他非 Claude Code 产品,则此技能不适用。
工作流
- 如果用户提供了主题,将其规范化为 slug:
- 转为小写,移除开头的
/docs/en/,移除首尾斜杠 - 使用
__连接嵌套片段(例如,agent sdk hooks->agent-sdk__hooks,whats new 2026 w19->whats-new__2026-w19)
- 转为小写,移除开头的
- 如果
references/<slug>.md存在,直接读取该文件。不要先搜索整个references/目录树——先查看索引再针对性读取,速度更快且占用的上下文更少。 - 如果没有精确匹配,读取
references/INDEX.md并选择最接近的主题。如果仍不明确,列出候选项并询问用户。 - 如果用户未提供主题,读取
references/INDEX.md并展示可用主题。
答复格式
- 开头直接回答用户的问题,并以所读取的文件为依据。
- 如果文档中出现原样的命令或配置键,引用简短片段。
- 结尾使用
Source: <upstream URL>,其中 URL 取自文件 frontmatter 或references/docs_manifest.json中的original_url。
新鲜度与回退方案
镜像每 3 小时由上游 CI 刷新;如果无法获取上游内容,CI 会失败,而不会提交冻结的内容。如果本地内容看起来过时、与用户提供的信息矛盾或为空:
- 建议用户运行
npx skills update claude-code-docs。 - 检查
references/docs_manifest.json中该文件对应的条目:status为stale表示上次运行时无法访问上游。 - 通过
references/docs_manifest.json中的original_url核对规范 URL,并可将其作为后续参考来源提供给用户。 - 如果某个特定页面的 MDX 清理失败,未修改的源文件会保存在
references/_raw/<slug>.md,可将其作为回退方案读取。
示例
| 调用方式 | 读取文件 |
|---|---|
$claude-code-docs hooks / /claude-code-docs hooks | references/hooks.md |
$claude-code-docs mcp | references/mcp.md |
$claude-code-docs agent sdk hooks | references/agent-sdk__hooks.md |
$claude-code-docs cli reference | references/cli-reference.md |
$claude-code-docs changelog | references/changelog.md |
$claude-code-docs(无参数) | references/INDEX.md |
评论
支持 Markdown