Summary¶
本目录树索引。全 175+ 个文档按学习路径分组。
生成方式:
python3 scripts/gen-summary.py(可重复执行) 文档源:README.md
📖 入门¶
- Claude Code 源码学习手册
- Claude Code 源码学习导读
- 术语表(Glossary)
- Glossary Addendum(术语表补充)
- 缩略语速查表(Abbreviations Cheat Sheet)
- 贡献指南 PR-IDEAS
- 如何读 50 万行代码 —— 大型项目源码学习方法论
- 视频脚本:15 分钟讲完 Claude Code 源码
🚀 7 阶段(按学习顺序)¶
- 阶段 1 | 入口与启动链
- 阶段 2 | REPL 主循环
- 阶段 3 | 状态管理
- 阶段 4 | 组件库与设计系统
- 阶段 5 | 工具调用系统
- 阶段 6 | Agent 循环 + 流式 API
- 阶段 7 | 高级系统专题
🔍 跨阶段专题 (topics/)¶
- ABI 兼容性专题
- Topic |
async function*异步生成器:Claude Code 的反应式底座 - Authentication 专题
- Topic | BashTool 安全模型:16 个文件全拆
- Topic | 五大"巨型文件"揭秘(每个 5000+ 行)
- Cache Strategies 专题
- Topic | 代码风格与 React Compiler 集成
- Topic | 上下文压缩(Context Compaction)系统全拆
- Cost Tracking 专题
- DCE 深度拆解专题
- Topic | DCE 与 Feature 旗标全景
- Deep Dive |
tools/AgentTool/6072 行多 Agent 入口拆解 - Deep Dive |
state/AppStateStore.ts569 行逐行拆解 - Deep Dive |
src/utils/attachments.ts3997 行 — 上下文附件编排中心 - Deep Dive |
src/utils/auth.ts2002 行 — 鉴权核心(API key + OAuth + AWS + GCP + 订阅) - Deep Dive |
src/utils/bash/ast.ts2679 行 — Bash AST 安全遍历器 - Deep Dive |
src/utils/bash/bashParser.ts4436 行 — 纯 TS 手写 Bash 解析器 - Deep Dive |
src/tools/BashTool/bashPermissions.ts2621 行 — Bash 权限规则引擎 - Deep Dive |
src/tools/BashTool/bashSecurity.ts2592 行 — Bash 危险命令检测规则集 - Deep Dive |
bridge/bridgeMain.ts2999 行双向消息总线拆解 - Deep Dive |
services/api/claude.ts3419 行 API 客户端拆解 - Deep Dive |
cli/print.ts5594 行 CLI 输出与 SDK 模式拆解 - Deep Dive |
services/compact/3960 行上下文压缩系统拆解 - Deep Dive |
bridge/flushGate.ts71 行背压状态机(小而精) - Deep Dive |
utils/hooks.ts5022 行 Hook 系统拆解 - Deep Dive |
src/commands/insights.ts3200 行 —/insights用量分析报告 - Deep Dive |
src/main.tsx4683 行 — Claude Code 进程入口 - Deep Dive |
src/commands/plugin/ManagePlugins.tsx2214 行 —/plugin插件管理 UI - Deep Dive |
src/utils/plugins/marketplaceManager.ts2643 行 — 插件市场管理 - Deep Dive |
src/services/mcp/auth.ts2465 行 — MCP OAuth 鉴权完整实现 - Deep Dive |
src/services/mcp/client.ts3348 行 — MCP Client 完整实现 - Deep Dive |
utils/messages.ts5512 行消息工具库拆解 - Deep Dive |
src/utils/plugins/pluginLoader.ts3302 行 — 插件加载器完整实现 - Deep Dive |
src/tools/PowerShellTool/pathValidation.ts2049 行 — PowerShell 路径校验 - Deep Dive |
src/components/PromptInput/PromptInput.tsx2338 行 — 提示输入框(多模态编辑器) - Deep Dive |
QueryEngine.ts1295 行 class 状态机拆解 - Deep Dive |
bridge/replBridge.ts2406 行 REPL ↔ Bridge 拆解 - Deep Dive |
src/screens/REPL.tsx5005 行 — Claude Code 主屏幕(God Component) - Deep Dive |
utils/sessionStorage.ts5105 行会话存储拆解 - Deep Dive |
ink/terminal-querier.ts212 行终端能力查询器 - Deep Dive |
src/native-ts/yoga-layout/index.ts2578 行 — Yoga Flexbox TS 实现 - Topic |
src/完整目录树逐个注释 - Error Codes 专题
- i18n Strategy 专题
- Ink React 调和器专题
- Topic | Ink 渲染管线全拆
- Topic | 键位系统(Keybinding System)全拆
- Logging & Observability 专题
- Topic | Markdown.tsx 渲染优化深度拆解
- MCP Elicitation 专题
- Topic | MCP(Model Context Protocol)协议深度拆解
- Topic | N-API 原生模块集成模板
- Permission System 专题
- Prompt Cache 专题
- Topic | StructuredDiff 性能考古:注释里的 PR 历史
- Swarm Mode 专题
- Terminal Compatibility 专题
- Yoga Layout 专题
🏗️ 深度拆解 (topics/deep-dive-*)¶
- ABI 兼容性专题
- Topic |
async function*异步生成器:Claude Code 的反应式底座 - Authentication 专题
- Topic | BashTool 安全模型:16 个文件全拆
- Topic | 五大"巨型文件"揭秘(每个 5000+ 行)
- Cache Strategies 专题
- Topic | 代码风格与 React Compiler 集成
- Topic | 上下文压缩(Context Compaction)系统全拆
- Cost Tracking 专题
- DCE 深度拆解专题
- Topic | DCE 与 Feature 旗标全景
- Deep Dive |
tools/AgentTool/6072 行多 Agent 入口拆解 - Deep Dive |
state/AppStateStore.ts569 行逐行拆解 - Deep Dive |
src/utils/attachments.ts3997 行 — 上下文附件编排中心 - Deep Dive |
src/utils/auth.ts2002 行 — 鉴权核心(API key + OAuth + AWS + GCP + 订阅) - Deep Dive |
src/utils/bash/ast.ts2679 行 — Bash AST 安全遍历器 - Deep Dive |
src/utils/bash/bashParser.ts4436 行 — 纯 TS 手写 Bash 解析器 - Deep Dive |
src/tools/BashTool/bashPermissions.ts2621 行 — Bash 权限规则引擎 - Deep Dive |
src/tools/BashTool/bashSecurity.ts2592 行 — Bash 危险命令检测规则集 - Deep Dive |
bridge/bridgeMain.ts2999 行双向消息总线拆解 - Deep Dive |
services/api/claude.ts3419 行 API 客户端拆解 - Deep Dive |
cli/print.ts5594 行 CLI 输出与 SDK 模式拆解 - Deep Dive |
services/compact/3960 行上下文压缩系统拆解 - Deep Dive |
bridge/flushGate.ts71 行背压状态机(小而精) - Deep Dive |
utils/hooks.ts5022 行 Hook 系统拆解 - Deep Dive |
src/commands/insights.ts3200 行 —/insights用量分析报告 - Deep Dive |
src/main.tsx4683 行 — Claude Code 进程入口 - Deep Dive |
src/commands/plugin/ManagePlugins.tsx2214 行 —/plugin插件管理 UI - Deep Dive |
src/utils/plugins/marketplaceManager.ts2643 行 — 插件市场管理 - Deep Dive |
src/services/mcp/auth.ts2465 行 — MCP OAuth 鉴权完整实现 - Deep Dive |
src/services/mcp/client.ts3348 行 — MCP Client 完整实现 - Deep Dive |
utils/messages.ts5512 行消息工具库拆解 - Deep Dive |
src/utils/plugins/pluginLoader.ts3302 行 — 插件加载器完整实现 - Deep Dive |
src/tools/PowerShellTool/pathValidation.ts2049 行 — PowerShell 路径校验 - Deep Dive |
src/components/PromptInput/PromptInput.tsx2338 行 — 提示输入框(多模态编辑器) - Deep Dive |
QueryEngine.ts1295 行 class 状态机拆解 - Deep Dive |
bridge/replBridge.ts2406 行 REPL ↔ Bridge 拆解 - Deep Dive |
src/screens/REPL.tsx5005 行 — Claude Code 主屏幕(God Component) - Deep Dive |
utils/sessionStorage.ts5105 行会话存储拆解 - Deep Dive |
ink/terminal-querier.ts212 行终端能力查询器 - Deep Dive |
src/native-ts/yoga-layout/index.ts2578 行 — Yoga Flexbox TS 实现 - Topic |
src/完整目录树逐个注释 - Error Codes 专题
- i18n Strategy 专题
- Ink React 调和器专题
- Topic | Ink 渲染管线全拆
- Topic | 键位系统(Keybinding System)全拆
- Logging & Observability 专题
- Topic | Markdown.tsx 渲染优化深度拆解
- MCP Elicitation 专题
- Topic | MCP(Model Context Protocol)协议深度拆解
- Topic | N-API 原生模块集成模板
- Permission System 专题
- Prompt Cache 专题
- Topic | StructuredDiff 性能考古:注释里的 PR 历史
- Swarm Mode 专题
- Terminal Compatibility 专题
- Yoga Layout 专题
📚 教程 (tutorials/)¶
- Tutorial | 构建自定义 Command
- Tutorial | 构建自定义 Agent
- Tutorial | 构建自定义 Hook
- Tutorial | 构建 MCP Server
- Tutorial | 构建 Claude Code Plugin
- Tutorial | 构建 Skill
- Tutorial | 贡献到 Claude Code
- Tutorial | 调试 Session
- Tutorial | 集成 Claude Code 到 IDE
- Tutorial | 在 CI 中运行 Claude Code
📦 仓库根文档 (docs/)¶
- Bridge Protocol —— Claude Code ↔ IDE 双向通信协议
- Design Decisions
- Environment Variables
- Feature Flags
- Hooks
- MCP Authoring Guide
- MCP Protocol
- Migration Guide
- Performance
- Permissions
- Plugin Guide
- Security Model
- Skill Guide
📖 速查手册 (reference/)¶
- Reference | 导出符号速查
- Reference: DCE Product Matrix
- Reference: Env Var Categories
- Reference | 环境变量完整清单(~400 个)
- Reference: Error Classes
- Reference | Feature 旗标完整清单(~95 个)
- Reference | 关键文件 1 句话索引
- Reference | 关键 import 关系图
- Reference: 最大文件
- Reference: Tool Presets
- Reference: Type Brands
📊 可视化 (data/)¶
- Data | 架构图(Mermaid)
- Data | 调用图
- Cost Flow
- Error Recovery
- Full Call Graph
- Hook Flow
- MCP Lifecycle
- Permission Decision Tree
- Data | 序列图(精选时序)
- Data | 状态机图
✏️ 练习答案 (walkthrough/)¶
- Walkthrough | 设计一个新工具:GitCommitTool(阶段 5 练习答案)
- Walkthrough | 构建一个 MCP Server
- Walkthrough | 构建 Async Stream
- Walkthrough | 手写 Async Generator
- Walkthrough | 手写 Bash 安全检测
- Walkthrough | 手写 Claude API Client
- Walkthrough | 手写 QueryEngine
- Walkthrough | 手写 60 行 Store(阶段 3 练习答案)
- Walkthrough | 手写 Yoga Layout
- Walkthrough | LRU Cache 实现(阶段 4 练习答案)
- Walkthrough | 手写 5 行 agent 循环(阶段 6 练习答案)
- Walkthrough | 模拟 Permission Prompt
🔬 深度分析 (analysis/)¶
- 整体架构演进史
- DCE 编译时门控(Dead Code Elimination)
- Dependency Injection Analysis
- Analysis | Claude Code 设计哲学
- 错误处理全景
- Analysis | 错误处理模式全拆
- Event-Driven Architecture Analysis
- 可扩展性分析
- G1 Grep 报告 —— 源码深扫
- G2-3 DCE 实际砍掉代码量估算
- G2-2 export 统计报告 —— 函数 / class / 类型
- G2-1 文件分类报告 —— 1902 个源文件全景
- G2-4 throws 统计报告 —— 错误处理全景
- G2-5 type vs interface 统计报告
- i18n Strategy Analysis
- 国际化策略(i18n)
- 日志 + 遥测架构
- 模块依赖图全拆
- 性能优化编年史
- Performance Optimization History
- 安全审计
- Security Model Analysis
- CLI 启动时间优化
- Testing Strategy Analysis
🛠️ 构建/部署 (build/)¶
- mkdocs GitHub Pages 自动部署
- mkdocs Blog 插件
- mkdocs 中文搜索同义词
- mkdocs Favicon + Logo
- mkdocs RSS / Atom Feed
- mkdocs Social Links
- mkdocs Validation 链接检查插件
- mkdocstrings 对 TypeScript 评估
- mkdocs requirements-docs.txt
📰 博客 (blog/)¶
📅 月度更新 (changelog/)¶
总计: 225 个文档
目录统计:
- topics/: 58
- analysis/: 24
- (learn_doc/ 根): 15
- docs/: 13
- walkthrough/: 12
- reference/: 11
- tutorials/: 10
- data/: 10
- build/: 9
- blog/: 3
- changelog/: 2