mirror of
https://github.com/claude-code-best/claude-code.git
synced 2026-06-18 22:35:51 +00:00
docs: 完成大量文档
This commit is contained in:
claude-code-best
@@ -1,39 +1,109 @@
|
||||
---
|
||||
title: "什么是 Claude Code"
|
||||
description: "一个住在终端里的 AI 编程搭档"
|
||||
description: "terminal-native agentic system —— 不是 IDE 插件，不是 Web Chat"
|
||||
---
|
||||
|
||||
{/* 本章目标：让完全不了解 Claude Code 的读者在 3 分钟内建立直觉 */}
|
||||
|
||||
## 一句话定义
|
||||
|
||||
Claude Code 是一个运行在命令行终端里的 AI 编程助手。你用自然语言描述需求，它直接帮你读代码、改文件、跑命令、搜索项目——全部在你的本地环境中完成。
|
||||
Claude Code 是一个**运行在本地终端中的 agentic coding system**。它不是给建议的聊天机器人——它直接在你的项目目录中读代码、改文件、跑命令、调试程序，拥有完整的 shell 能力。
|
||||
|
||||
## 它能做什么
|
||||
## 技术定位：terminal-native agentic system
|
||||
|
||||
- **对话式编程**：像和同事聊天一样描述需求，AI 直接动手实现
|
||||
- **理解整个项目**：自动读取项目结构、git 历史、配置文件，建立项目全景认知
|
||||
- **操作你的电脑**：读写文件、执行 shell 命令、搜索代码——不只是给建议，而是真正动手
|
||||
- **保护你的安全**：每个敏感操作都需要你确认，有沙箱、有权限管控
|
||||
理解 Claude Code 的关键在于三个词：
|
||||
|
||||
## 它和 ChatGPT / 普通聊天机器人的区别
|
||||
| 定位关键词 | 含义 |
|
||||
|-----------|------|
|
||||
| **Terminal-native** | 原生 CLI 应用，不是 IDE 插件、不是 Web 界面、不是 API wrapper |
|
||||
| **Agentic** | AI 自主决策工具调用链，不是"一问一答"的聊天模式 |
|
||||
| **Coding system** | 面向软件工程全流程，不是通用问答工具 |
|
||||
|
||||
| | 普通聊天 AI | Claude Code |
|
||||
|---|---|---|
|
||||
| 运行环境 | 云端网页 | 你的本地终端 |
|
||||
| 能做什么 | 回答问题、生成文本 | 直接操作你的项目文件和命令行 |
|
||||
| 项目理解 | 你需要手动粘贴代码 | 自动读取整个项目上下文 |
|
||||
| 安全性 | 无需考虑 | 多层权限保护 |
|
||||
与同类工具的**架构层面**差异（不是功能清单）：
|
||||
|
||||
## 一次典型的交互流程
|
||||
| 工具 | 架构模式 | 运行位置 | 工具执行 |
|
||||
|------|----------|----------|----------|
|
||||
| **Claude Code** | Terminal-native agentic loop | 本地进程 | 直接 shell 执行 |
|
||||
| Cursor / Copilot | IDE-integrated autocomplete + chat | IDE 进程内 | LSP / IDE API |
|
||||
| Aider | CLI chat → git patch | 本地进程 | 文件操作为主 |
|
||||
| ChatGPT / Claude.ai | Cloud chat + artifacts | 浏览器/云端 | 沙箱容器 |
|
||||
|
||||
<Frame>
|
||||
<img src="/docs/images/interaction-flow.png" alt="Claude Code 典型交互流程" />
|
||||
</Frame>
|
||||
核心差异：Claude Code 拥有**完整的 shell 访问权**——这意味着它可以做任何你在终端里能做的事，但也需要对应的安全机制来约束这个能力。
|
||||
|
||||
1. 你在终端输入自然语言需求
|
||||
2. Claude Code 分析你的项目上下文
|
||||
3. 它决定使用哪些工具（读文件？执行命令？）
|
||||
4. 每个操作请求你确认（或根据规则自动放行）
|
||||
5. 执行完成后，把结果反馈给 AI，AI 决定下一步
|
||||
6. 循环，直到任务完成
|
||||
## 端到端示例：从输入到输出
|
||||
|
||||
当你在终端中输入 `bun run dev 有个 TypeScript 报错，帮我修一下` 时，系统发生了什么？
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────┐
|
||||
│ 1. 入口层 (cli.tsx → main.tsx) │
|
||||
│ feature() = false, MACRO 注入, 启动 Commander.js CLI │
|
||||
├─────────────────────────────────────────────────────────┤
|
||||
│ 2. 交互层 (REPL.tsx — React/Ink) │
|
||||
│ PromptInput 捕获用户输入 → UserMessage 加入会话 │
|
||||
├─────────────────────────────────────────────────────────┤
|
||||
│ 3. 编排层 (QueryEngine.ts) │
|
||||
│ 管理 turn 生命周期、token 预算、compaction 触发 │
|
||||
├─────────────────────────────────────────────────────────┤
|
||||
│ 4. 核心循环 (query.ts — Agentic Loop) │
|
||||
│ 组装上下文 → 调 API → 收流式响应 → 解析工具调用 │
|
||||
│ → 权限检查 → 执行工具 → 结果回传 → 再次调 API → 循环 │
|
||||
├─────────────────────────────────────────────────────────┤
|
||||
│ 5. 工具执行 (BashTool.call / FileEditTool.call / ...) │
|
||||
│ 实际执行: 读文件、运行命令、搜索代码... │
|
||||
├─────────────────────────────────────────────────────────┤
|
||||
│ 6. 通信层 (claude.ts → Anthropic API) │
|
||||
│ 流式 HTTP, 支持 Bedrock/Vertex/Azure 多 provider │
|
||||
└─────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
具体到这个报错修复场景，一次典型的 agentic loop 可能包含多轮工具调用：
|
||||
|
||||
| Turn | AI 决策 | 工具调用 | 结果 |
|
||||
|------|---------|----------|------|
|
||||
| 1 | 先看报错信息 | `Bash("bun run dev 2>&1 | head -30")` | TypeScript 错误输出 |
|
||||
| 2 | 定位到文件 | `Read("src/utils/foo.ts")` | 源代码内容 |
|
||||
| 3 | 搜索相关类型定义 | `Grep("interface Foo", "src/")` | 类型定义位置 |
|
||||
| 4 | 修复代码 | `FileEdit(old, new)` | 代码已修改 |
|
||||
| 5 | 验证修复 | `Bash("bun run dev 2>&1 | head -10")` | 编译通过 |
|
||||
|
||||
每一步都是 AI 自主决策的——它决定用哪个工具、传什么参数、何时停止。这就是 "agentic" 的含义。
|
||||
|
||||
## 它不是什么
|
||||
|
||||
- **不是 IDE 插件**：没有图形界面，不依赖 VS Code 或任何 IDE
|
||||
- **不是 API wrapper**：它有自己的工具系统、权限模型、上下文工程、会话管理
|
||||
- **不是聊天机器人**：输出不是纯文本，而是实际的文件修改、命令执行
|
||||
- **不是无脑执行器**：每个敏感操作都有权限检查和用户确认环节
|
||||
|
||||
## 启动入口解剖
|
||||
|
||||
真正的代码入口是 `src/entrypoints/cli.tsx`，它做了三件关键的事：
|
||||
|
||||
```typescript
|
||||
// 1. 注入运行时 polyfill —— feature() 永远返回 false
|
||||
const feature = (_name: string) => false;
|
||||
|
||||
// 2. 注入构建时宏
|
||||
globalThis.MACRO = { VERSION: "2.1.888", BUILD_TIME: ..., };
|
||||
|
||||
// 3. 声明构建目标
|
||||
globalThis.BUILD_TARGET = "external"; // 外部构建（非 Anthropic 内部）
|
||||
globalThis.BUILD_ENV = "production";
|
||||
globalThis.INTERFACE_TYPE = "stdio"; // 标准 I/O 交互
|
||||
```
|
||||
|
||||
然后控制流传递到 `src/main.tsx`：
|
||||
1. Commander.js 解析命令行参数
|
||||
2. 初始化认证、遥测、策略限制
|
||||
3. 加载工具列表（`getTools()`）
|
||||
4. 启动 REPL（`launchRepl()`）或管道模式（`-p`）
|
||||
|
||||
## 为什么选择终端
|
||||
|
||||
终端不是限制，而是选择。它带来了独特的能力：
|
||||
|
||||
- **完整的 shell 访问**：可以运行任何命令行工具，无需为每个能力写插件
|
||||
- **项目原生**：直接在项目目录工作，理解文件系统结构、git 状态
|
||||
- **可组合性**：管道模式（`echo "..." | claude -p`）允许嵌入 CI/CD 和自动化流程
|
||||
- **低延迟**：没有 Electron 开销，React/Ink 渲染的 TUI 响应极快
|
||||
|
||||
代价是用户需要适应命令行界面——但也正因如此，它吸引的是需要**真正掌控开发环境**的开发者。
|
||||
|
||||
@@ -1,40 +1,120 @@
|
||||
---
|
||||
title: "为什么写这份白皮书"
|
||||
description: "将 LLM 能力落地到真实工作流的工程范本"
|
||||
description: "对 Anthropic 官方 CLI 的逆向工程分析——不是官方文档"
|
||||
---
|
||||
|
||||
{/* 本章目标：解释为什么这个项目的架构值得深入研究 */}
|
||||
## 这份白皮书是什么
|
||||
|
||||
## 不只是一个聊天工具
|
||||
这是对 Anthropic 官方发布的 **Claude Code CLI** 的**逆向工程分析**。
|
||||
|
||||
Claude Code 解决的核心问题是：**如何让大语言模型从"能说会道"变成"能说会做"**。
|
||||
源码经过反编译处理（TypeScript 单文件 bundle 逆向），保留了核心功能模块，但包含大量 `unknown`/`never`/`{}` 类型错误——这些不影响 Bun 运行时执行，但意味着我们的分析基于运行时行为 + 残留源码结构，而非原始源码。
|
||||
|
||||
这不是简单地给 AI 套一个 shell。它涉及一系列精巧的工程决策：
|
||||
**这不是：**
|
||||
- 官方文档或使用教程
|
||||
- API 参考手册
|
||||
- Claude Code 的功能推销
|
||||
|
||||
- AI 说"我要编辑这个文件"时，如何确保安全？
|
||||
- 对话越来越长，token 快爆了怎么办？
|
||||
- AI 需要并行处理多个子任务时，如何隔离和协调？
|
||||
- 用户想扩展 AI 的能力（接数据库、连 API），如何设计插拔机制？
|
||||
**这是：**
|
||||
- 一个生产级 agentic system 的架构解构
|
||||
- 每个设计决策背后的"为什么"
|
||||
- 可复用的工程模式：agentic loop、工具抽象、上下文工程、安全纵深防御
|
||||
|
||||
## 这份白皮书关注什么
|
||||
## 逆向过程中最精妙的设计决策
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="功能视角" icon="eye">
|
||||
不堆代码，从"用户能做什么、AI 如何决策"出发
|
||||
</Card>
|
||||
<Card title="设计决策" icon="lightbulb">
|
||||
每个功能背后的"为什么这样设计"
|
||||
</Card>
|
||||
<Card title="架构模式" icon="sitemap">
|
||||
可复用的模式：Agentic Loop、工具抽象、上下文工程
|
||||
</Card>
|
||||
<Card title="安全哲学" icon="shield">
|
||||
AI 操作真实环境时的信任与控制平衡
|
||||
</Card>
|
||||
</CardGroup>
|
||||
### 1. Agentic Loop 的自愈能力
|
||||
|
||||
`src/query.ts` 实现的核心循环不是简单的"发请求→收响应"。它是一个**自愈的状态机**：
|
||||
|
||||
- API 返回错误（限流、token 超限）→ 自动重试/降级
|
||||
- 工具执行超时 → 后台化 + 通知机制
|
||||
- 对话过长触发 compaction → 压缩历史后无缝继续
|
||||
- 用户中断 → 生成 `UserInterruptionMessage` 让 AI 理解发生了什么
|
||||
|
||||
这不是"if-else 堆叠"，而是让 AI 自己根据上下文决定下一步——即使发生了意外。
|
||||
|
||||
### 2. 上下文工程的分层策略
|
||||
|
||||
AI 没有真正的"记忆"，Claude Code 通过精心分层营造了这个幻觉：
|
||||
|
||||
| 层 | 机制 | 持久性 |
|
||||
|----|------|--------|
|
||||
| **System Prompt** | 项目结构、git 状态、CLAUDE.md | 每轮重建 |
|
||||
| **对话历史** | 完整的 User/Assistant/Tool 消息 | 会话内 |
|
||||
| **Compaction** | 自动压缩过长对话为摘要 | 压缩后替代原始消息 |
|
||||
| **Memory 文件** | 跨会话持久化的笔记 | 永久（用户可控） |
|
||||
| **File History** | 文件修改时间戳快照 | 会话内 |
|
||||
|
||||
`src/context.ts` 组装 System Prompt 时的策略是：**不变内容在前、变化内容在后**——这利用了 API 的缓存机制，前缀不变时可以复用缓存 token。
|
||||
|
||||
### 3. 工具系统的权限双轨制
|
||||
|
||||
`src/tools/BashTool/shouldUseSandbox.ts` 展示了一个精巧的双重安全模型：
|
||||
|
||||
- **应用层**：权限规则决定"能不能执行"（白名单/黑名单/用户确认）
|
||||
- **OS 层**：沙箱决定"执行时能做什么"（文件系统/网络/进程隔离）
|
||||
|
||||
两层的信任假设不同：应用层信任用户配置，OS 层不信任任何东西。即使 AI 绕过了应用层权限（理论上不可能，但纵深防御），OS 层沙箱仍然限制实际危害。
|
||||
|
||||
### 4. Feature Flag 的全局开关
|
||||
|
||||
`src/entrypoints/cli.tsx` 中一行代码决定了整个系统的行为：
|
||||
|
||||
```typescript
|
||||
const feature = (_name: string) => false;
|
||||
```
|
||||
|
||||
所有 `feature('FLAG_NAME')` 调用返回 `false`——这意味着 Anthropic 内部的实验功能（COORDINATOR_MODE、KAIROS、PROACTIVE 等）全部禁用。在官方构建中，这些 flag 通过 Bun 的 `bun:bundle` 在编译时注入，不同用户群体看到不同功能。
|
||||
|
||||
这是一个**渐进式发布架构**：同一个代码库，通过 feature flag 控制功能可见性，而不需要维护多个分支。
|
||||
|
||||
### 5. Compaction 的分档策略
|
||||
|
||||
`src/services/compact/` 实现了三种压缩策略：
|
||||
|
||||
- **Micro-compact**：单次工具输出过长时，截断结果
|
||||
- **Auto-compact**：对话 token 接近上限时，自动压缩历史
|
||||
- **Reactive-compact**：API 返回 token 超限错误时，紧急压缩后重试
|
||||
|
||||
这不是简单的"砍掉旧消息"——而是用 AI 自身来总结之前的对话，保留语义信息。压缩后插入一条 `TombstoneMessage` 标记边界。
|
||||
|
||||
## 阅读路线图
|
||||
|
||||
推荐的阅读顺序，每章解决一个核心问题：
|
||||
|
||||
```
|
||||
什么是 Claude Code (你在读的) ← 建立直觉
|
||||
│
|
||||
├── 架构全景 ← 五层架构 + 数据流
|
||||
│
|
||||
├── 安全体系 ← 信任与控制
|
||||
│ ├── 权限模型 ← 应用层安全
|
||||
│ ├── 沙箱机制 ← OS 层安全
|
||||
│ └── Plan Mode ← 用户主导模式
|
||||
│
|
||||
├── 对话引擎 ← AI 如何思考
|
||||
│ ├── Agentic Loop ← 核心循环
|
||||
│ ├── 流式响应 ← 实时通信
|
||||
│ └── 多轮对话 ← 上下文管理
|
||||
│
|
||||
├── 上下文工程 ← 记忆与预算
|
||||
│ ├── System Prompt ← 上下文组装
|
||||
│ ├── Token 预算 ← 预算管理
|
||||
│ └── 项目记忆 ← 跨会话持久化
|
||||
│
|
||||
├── 工具系统 ← AI 的双手
|
||||
│ ├── 工具概览 ← 统一接口
|
||||
│ ├── Shell 执行 ← Bash 工具
|
||||
│ └── 搜索与导航 ← Glob/Grep
|
||||
│
|
||||
└── Agent 与扩展 ← 能力扩展
|
||||
├── 子 Agent ← 并行任务
|
||||
├── 自定义 Agent ← 用户定义
|
||||
└── MCP 协议 ← 外部工具接入
|
||||
```
|
||||
|
||||
## 适合谁读
|
||||
|
||||
- 想理解 AI Agent 产品架构的开发者
|
||||
- 正在构建类似工具的团队
|
||||
- 对 LLM 应用工程化感兴趣的任何人
|
||||
- **AI Agent 开发者**：想理解生产级 agentic system 的架构模式
|
||||
- **安全工程师**：对 AI 操作真实环境时的信任模型感兴趣
|
||||
- **工具构建者**：正在构建类似的 coding assistant 或 CLI 工具
|
||||
- **好奇心驱动的开发者**：想知道"AI 编程助手到底怎么工作的"
|
||||
|
||||
Reference in New Issue
Block a user