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