claude-code README

The project's README from github.com/claude-code-best/claude-code. As one markdown file: README.md.

Claude Code Best V5 (CCB)

GitHub Stars GitHub Contributors GitHub Issues GitHub License Last Commit Bun Discord

Which Claude do you like? The open source one is the best.

这是 A\ (Anthropic) 官方 Claude Code 完整复原的工程化项目。而且, 我们持续跟进并实现了企业版或者需要登陆 Claude 账号才能使用的特性, 并在此基础上扩展了更多好玩的特性, 关闭了所有的外部封控点。我们完全兼容 CC 原有的配置, 你不需要改原始配置文件, Dynamic Workflow、Goal 等功能全都在。

Peri Code:Claude Code 兼容的 Rust Agent,多年大模型经验匠心制作,国内大模型(DeepSeek/GLM)精调,CPU/内存极致优化,在开发版/树莓派上也能跑 CC 一样的体验。

文档在这里 | 留影文档在这里 | Discord 群组,群主在线答疑

特性 说明 文档
🎯 Goal 持续驱动 /goal <objective> 设定目标后,自动跨轮驱动 agent 直至完成;带 token budget、completion/blocked audit、pause/resume/continue/clear 子命令,网络中断自动暂停 源码 commands/goal/ · services/goal/
📦 Artifacts(HTML 上传) 复刻 Anthropic 官方 Artifacts:模型把 HTML/数据看板/报告上传到公开 URL(7d/30d 自动过期),/artifacts 命令集中管理,Cloudflare Worker + R2 完全开源、可自托管 8 小时复刻报告 · 在线 demo
🧠 Ultracode 多 Agent 编排 /ultracode 注入 workflow 编排手册 + Workflow 工具跑确定性 JS 脚本(agent/pipeline/parallel/phase)+ /workflows 双栏监控面板;支持 journal 重放、token budget、并发 cap 文档
Claude 群控技术 Pipe IPC 多实例协作:同机 main/sub 自动编排 + LAN 跨机器零配置发现与通讯,/pipes 选择面板 + Shift+↓ 交互 + 消息广播路由 Pipe IPC / LAN
ACP 协议一等一支持 支持接入 Zed、Cursor 等 IDE,支持会话恢复、Skills、权限桥接 文档
Remote Control 私有部署 Docker 自托管远程界面, 可以手机上看 CC 文档
Langfuse 监控 企业级 Agent 监控, 可以清晰看到每次 agent loop 细节, 可以一键转化为数据集 文档
Web Search 内置网页搜索工具, 支持 bing 和 brave 搜索 文档
Poor Mode 穷鬼模式,关闭记忆提取和键入建议,大幅度减少并发请求 /poor 可以开关
Channels 频道通知 MCP 服务器推送外部消息到会话(飞书/Slack/Discord/微信等),--channels plugin:name@marketplace 启用 文档
自定义模型供应商 OpenAI/Anthropic/Gemini/Grok 兼容 (/login) 文档
Voice Mode 语音输入,支持豆包语言输入(/voice doubao) 文档
Computer Use 屏幕截图、键鼠控制 文档
Chrome Use 浏览器自动化、表单填写、数据抓取 自托管 原生版
Sentry 企业级错误追踪 文档
GrowthBook 企业级特性开关 文档
/dream 记忆整理 自动整理和优化记忆文件 文档

⚡ 快速开始(安装版)

不用克隆仓库, 从 NPM 下载后, 直接使用

npm i -g claude-code-best

# bun 安装比较多问题, 推荐 npm 装
# bun  i -g claude-code-best
# bun pm -g trust claude-code-best @claude-code-best/mcp-chrome-bridge

ccb # 以 nodejs 打开 claude code
ccb-bun # 以 bun 形态打开
ccb update # 更新到最新版本
CLAUDE_BRIDGE_BASE_URL=https://remote-control.claude-code-best.win/ CLAUDE_BRIDGE_OAUTH_TOKEN=test-my-key ccb --remote-control # 我们有自部署的远程控制

安装/更新失败? 先 npm rm -g claude-code-best 清理旧版本,再 npm i -g claude-code-best@latest。仍失败则指定版本号:npm i -g claude-code-best@<版本号>

⚡ 快速开始(源码版)

⚙️ 环境要求

一定要最新版本的 bun 啊, 不然一堆奇奇怪怪的 BUG!!! bun upgrade!!!

安装 Bun:

# Linux 和 macOS
curl -fsSL https://bun.sh/install | bash

# Windows (PowerShell)
powershell -c "irm bun.sh/install.ps1 | iex"

安装后的操作:

  1. 让当前终端识别 bun 命令

    安装脚本会把 ~/.bun/bin 写入对应的 shell 配置文件。macOS 默认 zsh 环境通常会看到:

    Added "~/.bun/bin" to $PATH in "~/.zshrc"
    

    可以按安装脚本提示重启当前 shell:

    exec /bin/zsh
    

    如果你使用 bash,重新加载 bash 配置:

    source ~/.bashrc
    

    Windows PowerShell 用户关闭并重新打开 PowerShell 即可。

  2. 验证 Bun 是否可用

    bun --help
    bun --version
    
  3. 如果已经安装过 Bun,更新到最新版本

    bun upgrade
    

📍 命令执行位置

📥 安装

cd /path/to/claude-code
bun install

▶️ 运行

# 开发模式, 看到版本号 888 说明就是对了
bun run dev

# 构建
bun run build

构建采用 code splitting 多文件打包(build.ts),产物输出到 dist/ 目录(入口 dist/cli.js + 约 450 个 chunk 文件)。

构建出的版本 bun 和 node 都可以启动, 你 publish 到私有源可以直接启动

如果遇到 bug 请直接提一个 issues, 我们优先解决

👤 新人配置 /login

首次运行后,在 REPL 中输入 /login 命令进入登录配置界面,选择 Anthropic Compatible 即可对接第三方 API 兼容服务(无需 Anthropic 官方账号)。 选择 OpenAI 和 Gemini 对应的栏目都是支持相应协议的

需要填写的字段:

📌 字段 📝 说明 💡 示例
Base URL API 服务地址 https://api.example.com/v1
API Key 认证密钥 sk-xxx
Haiku Model 快速模型 ID claude-haiku-4-5-20251001
Sonnet Model 均衡模型 ID claude-sonnet-4-6
Opus Model 高性能模型 ID claude-opus-4-6

ℹ️ 支持所有 Anthropic API 兼容服务(如 OpenRouter、AWS Bedrock 代理等),只要接口兼容 Messages API 即可。

Feature Flags

所有功能开关通过 FEATURE_<FLAG_NAME>=1 环境变量启用,例如:

FEATURE_BUDDY=1 FEATURE_FORK_SUBAGENT=1 bun run dev

各 Feature 的详细说明见 docs/features/ 目录,欢迎投稿补充。

VS Code 调试

TUI (REPL) 模式需要真实终端,无法直接通过 VS Code launch 启动调试。使用 attach 模式:

步骤

  1. 终端启动 inspect 服务:

    bun run dev:inspect
    

    会输出类似 ws://localhost:8888/xxxxxxxx 的地址。

  2. VS Code 附着调试器:

    • 在 src/ 文件中打断点
    • F5 → 选择 "Attach to Bun (TUI debug)"

Teach Me 学习项目

我们新加了一个 teach-me skills, 通过问答式引导帮你理解这个项目的任何模块。(调整 sigma skill 而来)

# 在 REPL 中直接输入
/teach-me Claude Code 架构
/teach-me React Ink 终端渲染 --level beginner
/teach-me Tool 系统 --resume

它能做什么

学习记录

学习进度保存在 .claude/skills/teach-me/ 目录下,支持跨主题学习者档案。

相关文档及网站

Contributors

Contributors

Star History

Star History Chart

致谢

许可证

本项目仅供学习研究用途。Claude Code 的所有权利归 Anthropic 所有。

claude-code (claude-code-best/claude-code)

Searching Database…

这是什么?Claude Code Best(CCB)是对 Anthropic 官方 Claude Code 命令行智能体的一次完整开源重构,可构建、可运行、可调试。它还扩展了目标驱动工作流、多智能体编排、语音输入和电脑/浏览器控制等功能,同时完全兼容原版 Claude Code 的配置。
这是图形界面应用还是终端工具?这是基于终端的命令行编程智能体,采用 REPL/TUI 交互界面,使用方式与官方 Claude Code 完全一致。你需要在终端中运行它,而不是作为桌面图形界面应用。
我该怎么安装和运行?预构建版本可以通过 npm 全局安装(`npm i -g claude-code-best@latest`)。如果要从源码运行,需要先克隆仓库并安装 Bun,然后运行 `bun run build.ts`,它会输出 `dist/cli.js`,可以用 Bun 或 Node 启动。
我需要安装 Bun 吗?还需要 Anthropic 账号吗?从源码构建需要 Bun >= 1.3.11。运行智能体则需要通过 `/login` 命令配置模型服务商,支持兼容 Anthropic 的接口、OpenAI 接口以及类 Gemini 的接口,因此无需官方 Anthropic 账号。
我能直接在 VS Code 里按 F5 调试吗?不能。TUI/REPL 需要真实的终端环境,所以 VS Code 的常规启动方式无法使用。你需要先启动 inspect 服务器,然后使用“Attach to Bun (TUI debug)”配置进行附加调试。
它能在树莓派这样的小设备上运行吗?可以。除 macOS、Windows 和 Linux 外,项目还提供了“Peri Code”,这是一个针对 CPU 和内存做过优化的 Rust 智能体,专为 DeepSeek、GLM 等国产模型调优,目的是让树莓派等低功耗设备也能获得与 Claude Code 相同的体验。
这是 Anthropic 官方发布的版本吗?不是。README 明确说明,本项目仅供学习和研究使用,Claude Code 的所有权利归 Anthropic 所有。这是一个非官方的社区重构版本,并非 Anthropic 的产品。
/goal 命令是做什么的?它用于设定一个持续性目标,智能体会在多轮对话中持续推进该目标,并跟踪令牌预算以及完成或阻塞状态。它提供 pause、resume、continue、clear 等子命令,并会在网络中断时自动暂停。
Artifacts 功能是什么?它重现了 Anthropic 官方的 Artifacts 功能。智能体可以将 HTML 页面、仪表盘或报告发布到公开链接,链接会在 7 天或 30 天后自动过期。它基于可自行部署的 Cloudflare Worker + R2 方案实现。
Computer Use 和 Chrome Use 能让智能体做什么?Computer Use 允许智能体截屏,并控制你电脑上的鼠标和键盘。Chrome Use 则增加了浏览器自动化功能,可用于填写表单和抓取数据。
智能体能在 Slack 或 Discord 里通知我吗?可以。Channels 功能通过 MCP 服务器,将智能体的消息推送到飞书、Slack、Discord 或微信等外部聊天应用。使用 `--channels plugin:name@marketplace` 参数即可启用。
Size
92.8 MB
Stars
23K
Age
6mo
Commits · 90 Days