内容
# 克劳德代码文档工具
[](https://github.com/costiash/claude-code-docs/commits/main)
[](https://github.com/costiash/claude-code-docs/actions)
[](https://github.com/costiash/claude-code-docs)
[](https://github.com/hesreallyhim/awesome-claude-code)
> **基于 [ericbuess/claude-code-docs](https://github.com/ericbuess/claude-code-docs) 的增强版本**，支持原生插件、自动发现技能和 AI 驱动的语义搜索。
**官方克劳德文档，随时保持最新，触手可及。** 停止在网络上搜索 — 直接询问克劳德，获取基于官方文档的准确答案。
## 为什么使用此工具？
克劳德知道很多 — 但文档更新很快。API 参数变化，新增功能，SDK 方法更名。此工具为克劳德提供了一个本地的官方文档镜像，因此答案直接来自源头，而不是过时的训练数据。
| 没有 claude-code-docs | 有 claude-code-docs |
|---|---|
| 克劳德根据训练数据猜测 | 克劳德读取最新的官方文档 |
| 答案中的链接损坏或过时 | 正确的 `platform.claude.com` / `code.claude.com` 链接 |
| "我认为 API 的工作方式是..." | "根据文档..." |
| 您手动验证答案 | 答案引用特定的文档页面 |
## 快速入门 — 插件安装（推荐）
两个命令，无需依赖：
```bash
/plugin marketplace add costiash/claude-code-docs
/plugin install claude-docs@claude-code-docs
```
就这样。在您的下一次会话中，克劳德将自动：
1. 克隆所有文档文件到 `~/.claude-code-docs/`
2. 通过 `git pull` 在每次会话中保持更新
3. 使 `/docs` 命令可用于手动查找
4. 激活 **自动发现技能** — 当您询问与克劳德相关的问题时，克劳德会自动读取文档
### 插件提供的内容
- **`/docs` 命令** — 查找任何主题：`/docs hooks`，`/docs extended thinking`，`/docs Agent SDK sessions`
- **自动发现技能** — 当您询问关于克劳德代码、API、SDK 或提示工程的问题时，克劳德会主动搜索文档。无需 `/docs` 前缀。
- **交互式课程** — 将任何克劳德主题转化为精美的、独立的 HTML 课程，包含动画图表、协议对话、测验和代码翻译。只需说“创建关于 hooks 的课程”或运行 `/docs --course <topic>`。
- **会话启动自动更新** — 文档自动保持最新。无需 cron 作业，无需手动拉取。
- **内容搜索** — 基于 shell 的全文搜索和模糊文件名匹配，无需 Python
- **零依赖** — 无需 Python、jq、curl。只需支持插件的克劳德代码。
## 传统：脚本安装（迁移）
对于不支持插件的环境，安装脚本会本地克隆文档：
```bash
curl -fsSL https://raw.githubusercontent.com/costiash/claude-code-docs/main/install.sh | bash
```
如果检测到克劳德代码，脚本将引导您安装插件。否则，它将退回到 `git clone` 以进行基本文档访问。
## 团队 / 组织采用
通过将以下内容添加到您的项目的 `.claude/settings.json` 中，为每个团队成员自动提示安装插件：
```json
{
"extraKnownMarketplaces": {
"claude-code-docs": {
"source": {
"source": "github",
"repo": "costiash/claude-code-docs"
}
}
},
"enabledPlugins": {
"claude-docs@claude-code-docs": true
}
}
```
将此文件提交到您的存储库。当团队成员信任项目文件夹时，他们将被提示自动安装市场和插件 — 无需手动设置。
## 交互式课程 — 通过实践学习克劳德
> **这不仅仅是一个文档镜像。** 询问任何克劳德主题，并获取精美制作的、交互式的 HTML 课程 — 包含动画协议图表、实践测验、代码与英文翻译，以及令人惊艳的深色 Obsidian & Amber 视觉主题。一个独立的文件，零设置，直接在您的浏览器中打开。
```bash
/docs --course hooks # 生成关于克劳德代码 hooks 的课程
/docs --course tool use # 深入了解 Tool Use API
/docs --course prompt caching # 掌握缓存和视觉解释
```
或者，在任何文档响应后自然地询问 — 克劳德将提供创建关于您刚刚查找的主题的课程。
https://github.com/user-attachments/assets/e36ae4c1-2ee6-4932-b0a5-3463cd20e012
**您获得的内容：**
- **4-7 个滚动模块**，具有渐进式学习弧线
- **协议对话** — 动画聊天式可视化，展示客户端、API、克劳德和工具如何实际交换消息
- **代码翻译** — 来自文档的真实 API 示例，带有逐行纯英文解释
- **测试应用的测验** — “您会为此场景使用什么？”而不是“定义此术语”
- **每个克劳德特定术语的词汇提示**
- **Obsidian & Amber 主题** — 具有仪器衬线标题、温暖琥珀色装饰、纹理和玻璃效果的深色大气设计。不仅仅是教程。
课程保存在 `~/.claude-code-docs/courses/` 中，因此您可以重温或与您的团队分享它们。
### 更新日志报告
随时了解克劳德文档的变化。生成最近文档更新的视觉 HTML 报告 — 按类别分组，并附有摘要和关键亮点：
```bash
/docs --report # 最近 7 天的变化
/docs --report 24h # 最近 24 小时
/docs --report 30d # 最近 30 天
```
报告中的每个条目都包含一个 **“创建课程”** 按钮。单击它将课程生成命令复制到您的剪贴板 — 将其粘贴到克劳德代码中，以立即深入研究吸引您注意力的任何主题。
---
## 用法
### 直接查找
```bash
/docs hooks # 克劳德代码 hooks
/docs mcp # MCP 服务器配置
/docs agent sdk python # Agent SDK Python 指南
/docs --course hooks # 生成关于 hooks 的交互式课程
/docs --report # 最近文档更改的 HTML 更新日志
/docs -t # 检查新鲜度并拉取更新
/docs what's new # 最近的文档更改
```
### 自然语言查询
`/docs` 命令理解意图 — 用自然语言提问：
```bash
/docs what are the best practices for Agent SDK in Python?
/docs explain the differences between hooks and MCP
/docs how do I configure extended thinking for the API?
/docs show me all prompt library templates
```
克劳德找到正确的文档，阅读它们，并综合出一个清晰的答案，并附上来源链接。
### 启用自动发现技能（仅限插件）
当作为插件安装时，您甚至不需要 `/docs`。只需自然地询问：
> “如何在克劳德代码中设置 MCP 服务器？”
克劳德识别这是一个文档问题，并在回答之前自动读取相关文档。
## 文档覆盖
多个类别的文档文件，每 3 小时更新一次：
- **API 参考** — 消息 API、Admin API、多语言 SDK（Python、TypeScript、Go、Java、Kotlin、Ruby）
- **Agent SDK** — Python 和 TypeScript SDK 指南、会话、hooks、自定义工具
- **克劳德代码** — CLI 文档：hooks、技能、MCP、插件、设置、子代理
- **代理和工具** — MCP 连接器、工具使用模式、代理功能
- **核心文档** — 指南、教程、提示工程、扩展思考
- **关于克劳德** — 模型功能、上下文窗口、定价
- **入门** — 快速入门指南
- **测试和评估** — 评估框架、测试指南
- **提示库** — 即用提示模板
- **发行说明** — 版本历史和更新日志
- **资源** — 附加资源
## 更新机制
1. **自动（插件）** — 文档在每次克劳德代码会话开始时通过 `git pull` 更新
2. **自动（CI/CD）** — GitHub Actions 每 3 小时从 Anthropic 站点地图获取
3. **按需** — `/docs -t` 检查并拉取更新
4. **安全** — 同步保护措施防止大规模删除（至少发现 200 个路径，最多 10% 删除每个同步，最少 250 个文件）
## 故障排除
| 问题 | 解决方案 |
|---------|----------|
| `/docs` 未找到 | 重启克劳德代码；对于脚本安装，请检查 `ls ~/.claude/commands/docs.md` |
| 文档似乎已过时 | `/docs -t` 强制更新，或 `cd ~/.claude-code-docs && git pull` |
| 插件无法工作 | 运行 `/plugin list` 以验证安装 |
| “安装已取消” | 在使用 curl 安装时，使用 `CLAUDE_DOCS_AUTO_INSTALL=yes` |
## 卸载
**插件：**
```bash
/plugin uninstall claude-docs@claude-code-docs
```
**脚本安装：**
```bash
~/.claude-code-docs/uninstall.sh
```
## 安全
- 输入净化和路径遍历保护
- 同步保护措施防止灾难性文档丢失
- 所有操作仅限于文档目录，仅 HTTPS
- 具有安全覆盖的完整测试套件
## 贡献
参见 [CONTRIBUTING.md](CONTRIBUTING.md) 以获取架构概述、开发设置、测试要求和 PR 指南。
## 致谢
- **[Eric Buess](https://github.com/ericbuess)** — [原始 claude-code-docs](https://github.com/ericbuess/claude-code-docs) 的创建者
- **[zarazhangrui/codebase-to-course](https://github.com/zarazhangrui/codebase-to-course)** — 交互式课程生成器技能的灵感来源
- **[Anthropic](https://www.anthropic.com/)** — 为克劳德代码和文档提供支持
## 许可证
MIT 许可证。文档内容归 Anthropic 所有。工具代码是开源的 — 请参见 [LICENSE](LICENSE)。
MCP 市场