271 lines
15 KiB
Markdown
271 lines
15 KiB
Markdown
---
|
|
tags: [docs, index, claude-code, documentation]
|
|
create time: 2026-06-09 14:30
|
|
---
|
|
|
|
# Claude Code Best - Documentation Index
|
|
|
|
## 概述
|
|
|
|
本文档是 `claude-code-best` 项目的完整文档索引，按 8 大分类整理全部 70+ 篇技术文档，并提供推荐学习路径，帮助读者由浅入深地掌握 Claude Code 的方方面面。
|
|
|
|
## 正文
|
|
|
|
### 文档总览
|
|
|
|
下面的树图展示了整个知识库的分类层级与文档分布：
|
|
|
|
```mermaid
|
|
mindmap
|
|
root(("Claude Code Best"))
|
|
入门
|
|
架构
|
|
核心架构
|
|
对话系统
|
|
上下文管理
|
|
工具系统
|
|
Agent 系统
|
|
功能特性
|
|
全部功能
|
|
Computer Use
|
|
通信后台
|
|
工作流
|
|
监控可观测
|
|
其他特性
|
|
扩展性
|
|
内部实现
|
|
安全
|
|
任务
|
|
测试
|
|
性能
|
|
其他
|
|
```
|
|
|
|
> [!info] 提示
|
|
> 共 **70+** 篇文档，覆盖 8 大分类、11 个子模块。如果你第一次接触 Claude Code，建议从下方「推荐学习路径」开始阅读。
|
|
|
|
> [!tip] 如何使用本索引
|
|
> - **快速查找**：直接使用下方「快速导航」表格，按分类定位目标文档
|
|
> - **系统学习**：按照「推荐学习路径」由浅入深逐步推进
|
|
> - **主题深挖**：点击感兴趣分类的子文档链接，进入对应主题深入了解
|
|
|
|
---
|
|
|
|
### 推荐学习路径
|
|
|
|
对于初次阅读者，推荐按照由浅入深的顺序逐步深入：
|
|
|
|
```mermaid
|
|
mindmap
|
|
root(("开始探索"))
|
|
入门概览
|
|
什么是 Claude Code
|
|
五层架构全景
|
|
Agent Loop 核心流程
|
|
开发者视角
|
|
对话系统
|
|
上下文管理
|
|
工具系统
|
|
Agent 系统
|
|
配置与扩展
|
|
Hooks 与 Skills
|
|
MCP 配置与协议
|
|
自定义 Agent
|
|
运维与排障
|
|
安全与权限模型
|
|
性能分析
|
|
任务跟踪记录
|
|
```
|
|
|
|
> [!question] 三条路径怎么选？
|
|
> - **想写代码/理解内部机制** → 开发者视角，从对话系统和工具系统入手
|
|
> - **想扩展 Claude Code 能力** → 配置与扩展，了解 Hooks、MCP、自定义 Agent
|
|
> - **想在生产环境运维** → 运维与排障，关注安全模型和性能优化
|
|
|
|
---
|
|
|
|
### 快速导航
|
|
|
|
#### Introduction (入门)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/README\|README.md]] | 项目总览：功能特性、安装方式、Feature Flags、调试指南、致谢与许可证 |
|
|
| [[claude-code-best/docs/introduction/what-is-claude-code\|what-is-claude-code]] | 什么是 Claude Code — Terminal-native agentic coding system 的技术定位、核心能力对比 |
|
|
| [[claude-code-best/docs/introduction/architecture-overview\|architecture-overview]] | 五层架构全景图：交互层 → 编排层 → 核心循环层 → 工具层 → 通信层，附源码路径追踪 |
|
|
| [[claude-code-best/docs/introduction/why-this-whitepaper\|why-this-whitepaper]] | 为什么需要这份白皮书 |
|
|
|
|
#### Architecture (架构设计)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/docs/diagrams/agent-loop\|agent-loop]] | Agent Loop 完整流程图 |
|
|
| [[claude-code-best/docs/diagrams/agent-loop-simple\|agent-loop-simple]] | Agent Loop 简化版示意图 |
|
|
|
|
#### Core Architecture (核心架构)
|
|
|
|
##### Conversation (对话系统)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/docs/conversation/the-loop\|the-loop]] | Agentic Loop 详细实现 — 单次迭代的完整生命周期 |
|
|
| [[claude-code-best/docs/conversation/multi-turn\|multi-turn]] | 多轮对话管理 — 会话状态、消息累积、权限上下文 |
|
|
| [[claude-code-best/docs/conversation/streaming\|streaming]] | 流式通信机制 — Streaming API、StreamingToolExecutor |
|
|
|
|
##### Context Management (上下文管理)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/docs/context/system-prompt\|system-prompt]] | System Prompt 动态组装 — CLAUDE.md、git 状态、MCP 服务器列表 |
|
|
| [[claude-code-best/docs/context/compaction\|compaction]] | 上下文压缩策略 — microcompact、snipCompact、autocompact |
|
|
| [[claude-code-best/docs/context/token-budget\|token-budget]] | Token 预算管理 — 预算跟踪、预算耗尽处理 |
|
|
| [[claude-code-best/docs/context/project-memory\|project-memory]] | 项目记忆系统 — 自动记忆提取、持久化、检索 |
|
|
|
|
##### Tools (工具系统)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/docs/tools/what-are-tools\|what-are-tools]] | 工具系统概述 — Tool 接口、工具注册、MCP 集成 |
|
|
| [[claude-code-best/docs/tools/file-operations\|file-operations]] | 文件操作工具 — Read、Edit、Write、FileEdit |
|
|
| [[claude-code-best/docs/tools/shell-execution\|shell-execution]] | Shell 执行工具 — BashTool、权限模型、安全边界 |
|
|
| [[claude-code-best/docs/tools/search-and-navigation\|search-and-navigation]] | 搜索与导航工具 — Grep、Glob、FindFiles |
|
|
| [[claude-code-best/docs/tools/task-management\|task-management]] | 任务管理工具 — TaskCreate、TaskUpdate、TaskList |
|
|
|
|
##### Agent (Agent 系统)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/docs/agent/sub-agents\|sub-agents]] | 子 Agent 机制 — Fork、继承、独立执行 |
|
|
| [[claude-code-best/docs/agent/coordinator-and-swarm\|coordinator-and-swarm]] | Coordinator 模式与 Swarm 多 Worker 协调 |
|
|
| [[claude-code-best/docs/agent/worktree-isolation\|worktree-isolation]] | Worktree 隔离 — 并发安全的分支开发环境 |
|
|
| [[claude-code-best/docs/agent/sur-skill-overflow-bugs\|sur-skill-overflow-bugs]] | Skill Overflow Bug 分析与修复记录 |
|
|
| [[claude-code-best/docs/agent/sur-loop-scheduled-oom\|sur-loop-scheduled-oom]] | Loop 定时任务 OOM 问题排查 |
|
|
|
|
#### Features (功能特性)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/docs/features/all-features-guide\|all-features-guide]] | 全功能使用指南 — 18 大功能类别的完整说明和示例 |
|
|
| [[claude-code-best/docs/features/acp-zed\|acp-zed]] | ACP 协议支持 — 接入 Zed/Cursor IDE |
|
|
| [[claude-code-best/docs/features/acp-link\|acp-link]] | ACP 深度链接集成 |
|
|
| [[claude-code-best/docs/features/remote-control-self-hosting\|remote-control-self-hosting]] | Remote Control 私有部署 — Docker 自托管远程界面 |
|
|
| [[claude-code-best/docs/features/computer-use\|computer-use]] | Computer Use — 屏幕截图、键鼠控制 |
|
|
| [[claude-code-best/docs/features/computer-use-architecture-v2\|computer-use-architecture-v2]] | Computer Use v2 架构 — 跨平台 Executor |
|
|
| [[claude-code-best/docs/features/computer-use-windows-enhancement\|computer-use-windows-enhancement]] | Windows 平台增强适配 |
|
|
| [[claude-code-best/docs/features/computer-use-mcp-test报告\|computer-use-mcp-test报告]] | Computer Use MCP 测试报告 |
|
|
| [[claude-code-best/docs/features/computer-use-tools-reference\|computer-use-tools-reference]] | Computer Use 工具参考手册 |
|
|
| [[claude-code-best/docs/features/chrome-use-mcp\|chrome-use-mcp]] | Chrome 浏览器自动化（自托管 MCP） |
|
|
| [[claude-code-best/docs/features/claude-in-chrome-mcp\|claude-in-chrome-mcp]] | Claude in Chrome MCP（原生版） |
|
|
| [[claude-code-best/docs/features/voice-mode\|voice-mode]] | Voice Mode — Push-to-Talk 语音输入 |
|
|
| [[claude-code-best/docs/features/web-browser-tool\|web-browser-tool]] | Web Browser Tool — 终端内网页交互 |
|
|
| [[claude-code-best/docs/features/web-search-tool\|web-search-tool]] | Web Search Tool — Bing/Brave 搜索引擎 |
|
|
| [[claude-code-best/docs/features/channels\|channels]] | Channels 频道通知 — MCP 推送外部消息到会话 |
|
|
| [[claude-code-best/docs/features/buddy\|buddy]] | Buddy 伴侣系统 — 后台异步 AI 建议 |
|
|
| [[claude-code-best/docs/features/bridge-mode\|bridge-mode]] | Bridge Mode — 远程控制协议 |
|
|
| [[claude-code-best/docs/features/daemon\|daemon]] | Daemon 后台守护进程 |
|
|
| [[claude-code-best/docs/features/daemon-restructure-design\|daemon-restructure-design]] | Daemon 重构设计方案 |
|
|
| [[claude-code-best/docs/features/status-line\|status-line]] | Status Line — 运行时状态指示器 |
|
|
| [[claude-code-best/docs/features/debug-mode\|debug-mode]] | Debug Mode — 调试模式配置 |
|
|
| [[claude-code-best/docs/features/proactive\|proactive]] | Proactive 自主模式 — AI 主动发起操作 |
|
|
| [[claude-code-best/docs/features/kairos\|kairos]] | Kairos 调度系统 |
|
|
| [[claude-code-best/docs/features/ultraplan\|ultraplan]] | /ultraplan 高级规划 — 多阶段任务分解 |
|
|
| [[claude-code-best/docs/features/fork-subagent\|fork-subagent]] | Fork 子 Agent 详细设计 |
|
|
| [[claude-code-best/docs/features/auto-dream\|auto-dream]] | /dream 记忆整理 — 自动优化记忆文件 |
|
|
| [[claude-code-best/docs/features/growthbook-enablement-plan\|growthbook-enablement-plan]] | GrowthBook 功能启用计划 |
|
|
| [[claude-code-best/docs/features/ssh-remote\|ssh-remote]] | SSH 远程连接 |
|
|
| [[claude-code-best/docs/features/tree-sitter-bash\|tree-sitter-bash]] | Tree-sitter Bash 解析 |
|
|
| [[claude-code-best/docs/features/langfuse-monitoring\|langfuse-monitoring]] | Langfuse 企业级监控 |
|
|
| [[claude-code-best/docs/features/uds-inbox\|uds-inbox]] | UDS Inbox — Pipe IPC 多实例协作 |
|
|
| [[claude-code-best/docs/features/lan-pipes\|lan-pipes]] | LAN Pipes — 局域网跨机器零配置发现 |
|
|
| [[claude-code-best/docs/features/lan-pipes-implementation\|lan-pipes-implementation]] | LAN Pipes 实现细节 |
|
|
| [[claude-code-best/docs/features/pipes-and-lan\|pipes-and-lan]] | Pipes 与 LAN 综合指南 |
|
|
| [[claude-code-best/docs/features/background-agent-selector\|background-agent-selector]] | 后台 Agent 选择器 |
|
|
| [[claude-code-best/docs/features/bash-classifier\|bash-classifier]] | Bash Classifier — 命令分类器 |
|
|
| [[claude-code-best/docs/features/context-collapse\|context-collapse]] | Context Collapse — 上下文折叠 |
|
|
| [[claude-code-best/docs/features/coordinator-mode\|coordinator-mode]] | Coordinator Mode 详细说明 |
|
|
| [[claude-code-best/docs/features/experimental-skill-search\|experimental-skill-search]] | 实验性 Skill 搜索 |
|
|
| [[claude-code-best/docs/features/mcp-skills\|mcp-skills]] | MCP Skills 集成 |
|
|
| [[claude-code-best/docs/features/stub-recovery-design-1-4\|stub-recovery-design-1-4]] | Stub Recovery 设计方案 |
|
|
| [[claude-code-best/docs/features/tier3-stubs\|tier3-stubs]] | Tier 3 Stubs — 三层门控机制 |
|
|
| [[claude-code-best/docs/features/token-budget\|token-budget]] | Token Budget 功能实现 |
|
|
| [[claude-code-best/docs/features/teammem\|teammem]] | TeamMem — 团队协作记忆 |
|
|
| [[claude-code-best/docs/features/workflow-scripts\|workflow-scripts]] | Workflow Scripts — 工作流脚本 |
|
|
| [[claude-code-best/docs/features/autofix-pr\|autofix-pr]] | AutoFix PR — 自动修复 Pull Request |
|
|
|
|
#### Extensibility (扩展性)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/docs/extensibility/custom-agents\|custom-agents]] | 自定义 Agent — 编写你自己的 Agent 插件 |
|
|
| [[claude-code-best/docs/extensibility/hooks\|hooks]] | Hooks 系统 — 生命周期钩子注入 |
|
|
| [[claude-code-best/docs/extensibility/skills\|skills]] | Skills — 技能定义、注册与调用 |
|
|
| [[claude-code-best/docs/extensibility/mcp-configuration\|mcp-configuration]] | MCP 配置 — 服务器声明、参数传递 |
|
|
| [[claude-code-best/docs/extensibility/mcp-protocol\|mcp-protocol]] | MCP 协议 — JSON-RPC 规范详解 |
|
|
|
|
#### Internals (内部实现)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/docs/internals/feature-flags\|feature-flags]] | Feature Flags 机制 — 开关管理、默认值、环境变量覆盖 |
|
|
| [[claude-code-best/docs/internals/growthbook-ab-testing\|growthbook-ab-testing]] | GrowthBook A/B 测试集成 |
|
|
| [[claude-code-best/docs/internals/growthbook-adapter\|growthbook-adapter]] | GrowthBook Adapter — 本地 gate defaults |
|
|
| [[claude-code-best/docs/internals/three-tier-gating\|three-tier-gating]] | 三层门控机制 — 功能分级发布 |
|
|
| [[claude-code-best/docs/internals/sentry-setup\|sentry-setup]] | Sentry 错误追踪配置 |
|
|
| [[claude-code-best/docs/internals/hidden-features\|hidden-features]] | Hidden Features — 未公开功能的发现与说明 |
|
|
| [[claude-code-best/docs/internals/agent-comm-fix-jira-tasks\|agent-comm-fix-jira-tasks]] | Agent 通信修复 — JIRA 任务跟踪 |
|
|
| [[claude-code-best/docs/internals/agent-comm-fix-questions\|agent-comm-fix-questions]] | Agent 通信修复 — 问题排查记录 |
|
|
| [[claude-code-best/docs/internals/ant-only-world\|ant-only-world]] | Ant-Only World — 纯 Anthropic 生态方案 |
|
|
| [[claude-code-best/docs/internals/autonomy-jira\|autonomy-jira]] | Autonomy 自主性 — JIRA 任务跟踪 |
|
|
|
|
#### Safety & Permissions (安全与权限)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/docs/safety/why-safety-matters\|why-safety-matters]] | 为什么安全很重要 — 设计理念与风险意识 |
|
|
| [[claude-code-best/docs/safety/permission-model\|permission-model]] | 权限模型 — 规则来源、匹配方式、作用域 |
|
|
| [[claude-code-best/docs/safety/auto-mode\|auto-mode]] | Auto Mode — 自动批准与安全边界 |
|
|
| [[claude-code-best/docs/safety/plan-mode\|plan-mode]] | Plan Mode — 只读规划模式 |
|
|
| [[claude-code-best/docs/safety/sandbox\|sandbox]] | Sandbox 沙箱机制 |
|
|
|
|
#### Tasks (任务追踪)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/docs/task/task-001-daemon-status-stop\|task-001]] | Daemon 状态与停止逻辑 |
|
|
| [[claude-code-best/docs/task/task-002-bg-sessions-ps-logs-kill\|task-002]] | 后台会话：进程查看、日志、终止 |
|
|
| [[claude-code-best/docs/task/task-003-templates-job-mvp\|task-003]] | Templates Job MVP |
|
|
| [[claude-code-best/docs/task/task-004-assistant-session-attach\|task-004]] | Assistant Session Attach |
|
|
| [[claude-code-best/docs/task/task-013-bg-engine-abstraction\|task-013]] | 后台引擎抽象 |
|
|
| [[claude-code-best/docs/task/task-014-daemon-command-hierarchy\|task-014]] | Daemon 命令层级 |
|
|
| [[claude-code-best/docs/task/task-015-job-command-hierarchy\|task-015]] | Job 命令层级 |
|
|
| [[claude-code-best/docs/task/task-016-backward-compat-tests\|task-016]] | 向后兼容测试 |
|
|
|
|
#### Testing (测试)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/docs/testing/SLASH-COMMANDS-TEST-CHECKLIST\|slash-commands-test]] | 斜杠命令测试清单 |
|
|
| [[claude-code-best/docs/test-plans/openclaw-autonomy-baseline\|openclaw-autonomy-baseline]] | OpenClaw 自主性基线测试计划 |
|
|
|
|
#### Performance (性能)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/docs/performance-reporter\|performance-reporter]] | 性能报告 — 基准测试结果 |
|
|
| [[claude-code-best/docs/memory-leak-audit\|memory-leak-audit]] | 内存泄漏审计 |
|
|
| [[claude-code-best/docs/memory-peak-analysis\|memory-peak-analysis]] | 内存峰值分析 |
|
|
|
|
#### Other (其他)
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [[claude-code-best/docs/external-dependencies\|external-dependencies]] | 外部依赖关系 |
|
|
| [[claude-code-best/docs/auto-updater\|auto-updater]] | 自动更新机制 |
|
|
| [[claude-code-best/docs/lsp-integration\|lsp-integration]] | LSP 集成 |
|
|
| [[claude-code-best/docs/design/tool-search-design-guide\|tool-search-design-guide]] | 工具搜索设计指南 |
|
|
| [[claude-code-best/docs/telemetry-remote-config-audit\|telemetry-remote-config-audit]] | 遥测远程配置审计 |
|
|
|
|
## 关联笔记
|
|
|
|
- [[claude-code-best/README|README — 项目总览]]
|