Skip to content

Windy3f3f3f3f/claude-code-from-scratch

Repository files navigation

Claude Code From Scratch

一步步,从零手写一个 Claude Code

GitHub stars GitHub forks License: MIT TypeScript Python Lines of Code


📘 在线阅读教程 →   |   📘 Read Tutorial (English) →   |   English


📖 想深入了解原理? 姊妹项目 How Claude Code Works — 12 篇专题,33 万字,从源码级别深度解析 Claude Code 架构


⚖️ 声明 / Disclaimer:这是一个从零手写 Claude Code 的学习项目,照着 Claude Code 的公开可观察行为和通用 Agent 写法来做,不保证和 Claude Code 真实内部实现一致。"Claude Code" 是 Anthropic 的商标,本项目和 Anthropic 没有关联。

Claude Code 有几十万行代码,读不动?

本项目用 约 5000 行代码(TypeScript 和 Python 两个版本分别写),从零手写 Claude Code 的核心:Agent Loop、13 个工具(含并行执行 + 流式早期启动)、4 层上下文压缩、语义记忆召回、技能系统、多 Agent、MCP 集成。参照的是 Claude Code 的公开可观察行为,每一步都对着它讲清差异在哪。

这不是 demo,是一份分步教程——13 章内容,跟着动手写几千行代码,从零理解一个 Coding Agent 的工作原理。而且每个代码章都能一条命令跑起来、不用 API key(见下方「每章代码都能跑」一节)。读完你就理解了 coding agent 的核心运作机制,无需啃那几十万行代码。

demo_3x.mp4

📖 分步教程

13 章内容,分两个阶段——先构建一个可用的 Coding Agent,再逐步添加进阶能力。每章都贴能跑的真实代码 + 与 Claude Code 的架构对照:

章节 内容 架构对照视角
Phase 1: 构建一个可用的 Coding Agent
1. Agent Loop 核心循环:调用 LLM → 执行工具 → 重复 agent.tsquery.ts
2. 工具系统 13 个工具 + mtime 防护 + 延迟加载 tools.tsTool.ts + 66 工具
3. System Prompt 提示词工程 + @include 语法 prompt.tsprompts.ts
4. CLI 与会话 REPL、Ctrl+C、会话持久化 cli.tscli.tsx
5. 流式输出 双后端 + 流式工具执行 + 并行执行 agent.tsapi/claude.ts
6. 权限与安全 5 模式 + 声明式规则 + 危险检测 tools.tspermissions/ (52KB)
7. 上下文管理 4 层压缩 + 大结果持久化 agent.tscompact/
Phase 2: 进阶能力
8. 记忆系统 4 类型记忆 + 语义召回 + 异步预取 memory.tsmemory.ts
9. 技能系统 技能发现 + inline/fork 双模式 skills.tsSkillTool/
10. Plan Mode 只读规划 + 4 选项审批工作流 agent.tsEnterPlanMode
11. 多 Agent Sub-Agent fork-return 多 Agent 架构 subagent.tsAgentTool/
12. MCP 集成 JSON-RPC over stdio 连接外部工具 mcp.tsmcpClient.ts
13. 架构对比 完整对比 + 扩展方向 全局
14. 功能测试 22 项手动测试覆盖全部功能 test/

▶ 每章代码都能跑(无需 API key)

读代码最怕读不懂又跑不起来,改一行也不知道对不对。所以每个代码章都配了一份能单独跑的最小实现:一条命令、不用 API key,就能看它真的转起来。

node steps/run.mjs --list     # 列出所有能跑的章节
node steps/run.mjs 7          # 跑第 7 章:对话变长了,它把旧消息压成摘要
node steps/run.mjs 7 --diff   # 只看这一章比上一章多写的那几行
node steps/run.mjs 7 --py     # 换成 Python 版

看到的输出是真跑出来的(本地 mock 模型驱动,不联网),--diff 标出的正是这一章新增的代码。想拿自己的 prompt 连真模型试,加 --live 就行。每章的这段代码、文档里贴的代码块、跑出来的那段输出,全从同一份源码生成——不会出现"文档说的和代码对不上"。

🚀 快速开始

TypeScript 版

git clone https://github.com/Windy3f3f3f3f/claude-code-from-scratch.git
cd claude-code-from-scratch
npm install && npm run build

Python 版(需要 Python 3.11+,详细说明

cd python
pip install -e .
mini-claude-py          # 命令行入口(避免与 TS 版 mini-claude 冲突)
python -m mini_claude   # 或用 python -m 方式运行

配置 API

支持两种后端,通过环境变量自动识别:(支持自定义base url)

方式一:Anthropic 格式(推荐)

export ANTHROPIC_API_KEY="sk-ant-xxx"
# 可选:使用代理
export ANTHROPIC_BASE_URL="https://aihubmix.com"

方式二:OpenAI 兼容格式

export OPENAI_API_KEY="sk-xxx"
export OPENAI_BASE_URL="https://api.openai.com/v1"

默认模型为 claude-opus-4-6,可通过环境变量或命令行参数自定义:

export MINI_CLAUDE_MODEL="claude-sonnet-4-6"    # 环境变量方式
npm start -- --model gpt-4o                      # 命令行方式(优先级更高)

运行

TypeScript 版

npm start                    # 交互式 REPL 模式(推荐)
npm start -- --resume        # 恢复上次会话继续对话
npm start -- --yolo          # 跳过安全确认(危险命令自动执行)
npm start -- --plan          # Plan 模式:只分析不修改
npm start -- --accept-edits  # 自动批准文件编辑
npm start -- --dont-ask      # CI 模式:需确认的操作自动拒绝
npm start -- --max-cost 0.50 # 费用限制(美元)
npm start -- --max-turns 20  # 轮次限制

Python 版

mini-claude-py               # 交互式 REPL 模式(推荐)
mini-claude-py --resume      # 恢复上次会话继续对话
mini-claude-py --yolo        # 跳过安全确认
mini-claude-py --plan        # Plan 模式:只分析不修改
mini-claude-py --accept-edits # 自动批准文件编辑
mini-claude-py --dont-ask    # CI 模式:需确认的操作自动拒绝
mini-claude-py --max-cost 0.50 # 费用限制(美元)
mini-claude-py --max-turns 20  # 轮次限制

全局安装后可在任意目录使用:

TypeScript 版

npm link                     # 全局安装
cd ~/your-project
mini-claude                  # 直接启动

Python 版

cd python
pip install -e .             # 全局安装(editable 模式)
cd ~/your-project
mini-claude-py               # 直接启动

REPL 命令

命令 功能
/clear 清空对话历史
/cost 显示累计 token 用量和费用估算
/compact 手动触发对话压缩
/memory 列出所有已保存的记忆
/skills 列出可用的技能
/<skill> 调用已注册的技能(如 /commit

详见 CLI 与会话功能测试

⚖️ 与 Claude Code 的对比

维度 Claude Code Mini Claude Code
定位 生产级编程智能体 学习 / 最小可用实现
工具数量 66+ 内置工具 13 个工具(6 核心 + web_fetch + tool_search + skill + agent + plan mode)
工具执行 并发 + streaming 早期启动 并行执行 + streaming 早期启动
上下文管理 4 级压缩流水线 4 层压缩 + 大结果持久化(>30KB)
权限系统 7 层 + AST 分析 5 种模式 + 声明式规则 + 正则检测
编辑验证 14 步流水线 引号容错 + 唯一性 + mtime 防护 + diff 输出
记忆系统 4 类型 + 语义召回 4 类型 + 语义召回 + 异步预取
技能系统 6 源 + inline/fork 2 源 + inline/fork
多 Agent Sub-Agent + Coordinator + Swarm Sub-Agent(3 内置 + 自定义 Agent)
MCP 集成 mcpClient.ts + 动态工具发现 McpManager + JSON-RPC over stdio
预算控制 USD/轮次/abort 三维 USD + 轮次限制
代码量 50 万+ 行 ~5500 行(TS)/ ~5000 行(Python)

⚡ 核心能力

  • Agent 循环:自动调用工具、处理结果、持续迭代,直到任务完成
  • 13 个工具:读写编辑文件(mtime 防护)、搜索、Shell、WebFetch、ToolSearch(延迟加载)、技能、子 Agent、Plan Mode
  • 流式输出:逐字实时显示,Anthropic + OpenAI 双后端,streaming 工具早期执行
  • 并行工具执行:只读工具(read_file、grep_search 等)自动并发,2-3x 加速
  • 4 层上下文压缩:budget 截断 → stale snip → microcompact → auto-compact + 大结果持久化(>30KB 写磁盘)
  • 权限系统:5 种模式 + .claude/settings.json 声明式 allow/deny 规则 + 16 个危险命令正则
  • 记忆系统:4 类型记忆 + 语义召回(sideQuery 调模型选择相关记忆)+ 异步预取
  • 技能系统.claude/skills/ 目录加载,支持 inline 注入和 fork 子 Agent 两种执行模式
  • 多 Agent:Sub-Agent fork-return 模式(3 内置类型 + .claude/agents/ 自定义类型)
  • MCP 集成:JSON-RPC over stdio 连接外部工具服务器,动态工具发现与调用转发
  • System Prompt:@include 语法递归引入、.claude/rules/ 自动加载、模板变量替换
  • Extended Thinking:支持 Anthropic 扩展思考(--thinking),adaptive/enabled/disabled 三模式
  • 预算控制--max-cost 费用限制 + --max-turns 轮次限制,超限自动停止
  • 会话持久化:自动保存对话,--resume 恢复上次会话
  • 跨平台:Windows / macOS / Linux,自动检测 shell(PowerShell / bash / zsh)
  • 错误恢复:API 限流/过载时指数退避 + 随机抖动重试(最多 3 次),Ctrl+C 优雅中断

📁 项目结构

src/                # TypeScript 版
├── agent.ts        # Agent 循环:流式、并行执行、4 层压缩、预算   (2169 行)
├── tools.ts        # 工具:13 工具 + mtime 防护 + 延迟加载       (884 行)
├── autonomy.ts     # 自治:/goal 评估器 + /loop + Auto Mode 分类器 (464 行)
├── cli.ts          # CLI 入口:参数解析、REPL、预算 flags         (416 行)
├── memory.ts       # 记忆系统:4 类型 + 语义召回 + 异步预取       (392 行)
├── mcp.ts          # MCP 客户端:JSON-RPC over stdio             (277 行)
├── prompt.ts       # System Prompt:@include + 模板 + 注入       (253 行)
├── ui.ts           # 终端输出:彩色显示、格式化、子 Agent 显示    (215 行)
├── subagent.ts     # 子 Agent:3 内置 + 自定义 Agent 发现         (199 行)
├── skills.ts       # 技能系统:目录发现 + inline/fork 双模式      (175 行)
├── session.ts      # 会话持久化:保存/恢复/列表                   (63 行)
├── frontmatter.ts  # 共享 YAML frontmatter 解析器                (41 行)
                                                    总计: ~5500 行

python/             # Python 版(功能一致)
├── mini_claude/
│   ├── agent.py, tools.py, autonomy.py, __main__.py, ui.py,
│   ├── prompt.py, session.py, memory.py, skills.py, subagent.py,
│   ├── mcp_client.py, frontmatter.py
│   └── system_prompt.md
└── pyproject.toml                                  总计: ~5000 行

steps/              # 每章可运行的最小实现(单一真源 → 生成快照)
├── canonical/{ts,py}   # 教学代码真源,#step 标记按章切片
├── run.mjs             # node steps/run.mjs <N> [--diff|--py|--live|--list]
└── build.mjs, test.mjs # 生成快照 + 零 key 验证每一步

🏗️ 架构图

用户输入
  │
  ▼
┌─────────────────────────────────────┐
│          Agent Loop                 │
│                                     │
│  消息历史 → API (流式) → 实时输出   │
│       ▲                   │         │
│       │              ┌────┴───┐     │
│       │              │文本输出│     │
│       │              │工具调用│     │
│       │              └────┬───┘     │
│       │                   │         │
│       │   ┌───────┐ ┌────▼───┐     │
│       │   │截断保护│←│工具执行│     │
│       │   └───────┘ └────┬───┘     │
│       │                   │         │
│       │   ┌───────────────▼───┐     │
│       └───│Token 追踪 + 压缩 │     │
│           └───────────────────┘     │
└─────────────────────────────────────┘
  │
  ▼
任务完成 → 自动保存会话

🔗 相关项目

🤝 贡献者

@Windy3f3f3f3f @davidweidawang Kaibo Huang

🙏 致谢

感谢 LINUX DO 社区的支持与讨论。

💬 更多交流

加入 AI Agent 工坊 交流群

QQ 群二维码

QQ 群号:1090526244

📈 Star History

Star History Chart

📄 License

MIT

About

Build your own Claude Code from scratch. 🔍 Claude Code 开源了 50 万行代码,读不动?用 ~5000 行 TypeScript / Python 从零复现核心架构,11 章分步教程带你理解 coding agent 精髓

Topics

Resources

License

Stars

2.2k stars

Watchers

8 watching

Forks

Packages

 
 
 

Contributors