diff --git a/README.md b/README.md index 73561f09d..dfe8e2948 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,242 @@ -# CC_Pure — Claude Code 纯净留影版本 +# Claude Code Best V5 (CCB) +[![GitHub Stars](https://img.shields.io/github/stars/claude-code-best/claude-code?style=flat-square&logo=github&color=yellow)](https://github.com/claude-code-best/claude-code/stargazers) +[![GitHub Contributors](https://img.shields.io/github/contributors/claude-code-best/claude-code?style=flat-square&color=green)](https://github.com/claude-code-best/claude-code/graphs/contributors) +[![GitHub Issues](https://img.shields.io/github/issues/claude-code-best/claude-code?style=flat-square&color=orange)](https://github.com/claude-code-best/claude-code/issues) +[![GitHub License](https://img.shields.io/github/license/claude-code-best/claude-code?style=flat-square)](https://github.com/claude-code-best/claude-code/blob/main/LICENSE) +[![Last Commit](https://img.shields.io/github/last-commit/claude-code-best/claude-code?style=flat-square&color=blue)](https://github.com/claude-code-best/claude-code/commits/main) [![Bun](https://img.shields.io/badge/runtime-Bun-black?style=flat-square&logo=bun)](https://bun.sh/) -[![GitHub License](https://img.shields.io/github/license/GhostDragon124/CC_Pure?style=flat-square)](./LICENSE) +[![Discord](https://img.shields.io/badge/Discord-Join-5865F2?style=flat-square&logo=discord)](https://discord.gg/uApuzJWGKX) -> 基于 [claude-code-best (CCB)](https://github.com/claude-code-best/claude-code) v2.1.888 的纯净留影版本。 -> 保留 CCB 全部功能，彻底移除所有 Anthropic 遥测上报。 +> Which Claude do you like? The open source one is the best. ---- +牢 A (Anthropic) 官方 [Claude Code](https://docs.anthropic.com/en/docs/claude-code) 完整复原的工程化项目。虽然很难绷, 但是它叫做 CCB(踩踩背)... 而且, 我们实现了企业版或者需要登陆 Claude 账号才能使用的特性, 并在此基础上扩展了更多好玩的特性。 -## 🙏 致谢 +[Peri Code](https://github.com/KonghaYao/peri)：Claude Code 兼容的 Rust Agent，多年大模型经验匠心制作，国内大模型（DeepSeek/GLM）精调，CPU/内存极致优化，在开发版/树莓派上也能跑 CC 一样的体验。 -本项目是 [claude-code-best](https://github.com/claude-code-best/claude-code) 的 fork，**衷心感谢 CCB 项目全体作者的卓越贡献**。他们完成了 Claude Code 的反编译/逆向还原这一不可思议的工作，让社区得以学习、研究和自由使用。 +[文档在这里](https://ccb.agent-aura.top/) | [留影文档在这里](./Friends.md) | [Discord 群组，群主在线答疑](https://discord.gg/uApuzJWGKX) -本项目在此基础上，进一步完成了 **Anthropic 遥测系统的彻底清除**，使其成为一个真正纯净的本地版本。 +| 特性 | 说明 | 文档 | +| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| **Claude 群控技术** | Pipe IPC 多实例协作：同机 main/sub 自动编排 + LAN 跨机器零配置发现与通讯，`/pipes` 选择面板 + `Shift+↓` 交互 + 消息广播路由 | [Pipe IPC](https://ccb.agent-aura.top/docs/features/uds-inbox) / [LAN](https://ccb.agent-aura.top/docs/features/lan-pipes) | +| **ACP 协议一等一支持** | 支持接入 Zed、Cursor 等 IDE，支持会话恢复、Skills、权限桥接 | [文档](https://ccb.agent-aura.top/docs/features/acp-zed) | +| **Remote Control 私有部署** | Docker 自托管远程界面, 可以手机上看 CC | [文档](https://ccb.agent-aura.top/docs/features/remote-control-self-hosting) | +| **Langfuse 监控** | 企业级 Agent 监控, 可以清晰看到每次 agent loop 细节, 可以一键转化为数据集 | [文档](https://ccb.agent-aura.top/docs/features/langfuse-monitoring) | +| **Web Search** | 内置网页搜索工具, 支持 bing 和 brave 搜索 | [文档](https://ccb.agent-aura.top/docs/features/web-browser-tool) | +| **Poor Mode** | 穷鬼模式，关闭记忆提取和键入建议,大幅度减少并发请求 | /poor 可以开关 | +| **Channels 频道通知** | MCP 服务器推送外部消息到会话（飞书/Slack/Discord/微信等），`--channels plugin:name@marketplace` 启用 | [文档](https://ccb.agent-aura.top/docs/features/channels) | +| **自定义模型供应商** | OpenAI/Anthropic/Gemini/Grok 兼容 (`/login`) | [文档](https://ccb.agent-aura.top/docs/features/all-features-guide) | +| Voice Mode | 语音输入，支持豆包语言输入（`/voice doubao`） | [文档](https://ccb.agent-aura.top/docs/features/voice-mode) | +| Computer Use | 屏幕截图、键鼠控制 | [文档](https://ccb.agent-aura.top/docs/features/computer-use) | +| Chrome Use | 浏览器自动化、表单填写、数据抓取 | [自托管](https://ccb.agent-aura.top/docs/features/chrome-use-mcp) [原生版](https://ccb.agent-aura.top/docs/features/claude-in-chrome-mcp) | +| Sentry | 企业级错误追踪 | [文档](https://ccb.agent-aura.top/docs/internals/sentry-setup) | +| GrowthBook | 企业级特性开关 | [文档](https://ccb.agent-aura.top/docs/internals/growthbook-adapter) | +| /dream 记忆整理 | 自动整理和优化记忆文件 | [文档](https://ccb.agent-aura.top/docs/features/auto-dream) | ---- +- 🚀 [想要启动项目](#-快速开始源码版) +- 🐛 [想要调试项目](#vs-code-调试) +- 📖 [想要学习项目](#teach-me-学习项目) -## 🔧 CC_Pure 的额外贡献 +## ⚡ 快速开始(安装版) -### 已清除的遥测系统 +不用克隆仓库, 从 NPM 下载后, 直接使用 -| 系统 | 原行为 | 处理方式 | -|------|--------|---------| -| **Datadog 日志** | 向 Anthropic Datadog 上报事件 | 默认端点已清空 (CCB) | -| **1P Event Logging** | 批量发送事件到 `api.anthropic.com` | 源码级永久禁用 | -| **GrowthBook 远程配置** | 启动时连接 Anthropic 拉取 feature flags | 初始化代码已移除 | -| **BigQuery Metrics** | 每 5 分钟上报 metrics | `isAnalyticsDisabled()` 永久返回 true | -| **OpenTelemetry** | 三方遥测指标/日志/追踪 | 初始化入口已守卫 | -| **Sentry** | 错误上报 | DSN 为空, no-op (CCB) | +```sh +npm i -g claude-code-best -### 修改的文件（4 个） +# bun 安装比较多问题, 推荐 npm 装 +# bun i -g claude-code-best +# bun pm -g trust claude-code-best @claude-code-best/mcp-chrome-bridge -``` -src/services/analytics/config.ts — isAnalyticsDisabled() 永久返回 true -src/entrypoints/init.ts — GrowthBook/1P/Telemetry 初始化已禁用 -src/main.tsx — Analytics gate 初始化已禁用 -src/utils/sinks.ts — Analytics sink 已禁用 +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 # 我们有自部署的远程控制 ``` -所有修改均标注 `// CC_Pure:` 注释，原代码保留以供参考。 +> **安装/更新失败？** 先 `npm rm -g claude-code-best` 清理旧版本，再 `npm i -g claude-code-best@latest`。仍失败则指定版本号：`npm i -g claude-code-best@<版本号>` -详细审计报告见 [`docs/telemetry-cleanup-audit.md`](docs/telemetry-cleanup-audit.md)。 +## ⚡ 快速开始(源码版) ---- +### ⚙️ 环境要求 -## ⚡ 快速开始 - -### 环境要求 +一定要最新版本的 bun 啊, 不然一堆奇奇怪怪的 BUG!!! bun upgrade!!! - 📦 [Bun](https://bun.sh/) >= 1.3.11 -### 安装与运行 +**安装 Bun：** ```bash -bun install -bun run dev # 开发模式 -bun run build # 构建（产物输出到 dist/） +# Linux 和 macOS +curl -fsSL https://bun.sh/install | bash + +# Windows (PowerShell) +powershell -c "irm bun.sh/install.ps1 | iex" ``` -### 配置 API +**安装后的操作：** -在 REPL 中输入 `/login`，选择 **Anthropic Compatible** 配置第三方 API： +1. **让当前终端识别 `bun` 命令** -| 字段 | 说明 | -|------|------| -| Base URL | API 地址 | -| API Key | 认证密钥 | -| Haiku / Sonnet / Opus Model | 模型 ID | + 安装脚本会把 `~/.bun/bin` 写入对应的 shell 配置文件。macOS 默认 zsh 环境通常会看到： -配置保存到 `~/.claude/settings.json`。 + ```text + Added "~/.bun/bin" to $PATH in "~/.zshrc" + ``` ---- + 可以按安装脚本提示重启当前 shell： -## 📖 原 CCB 文档 + ```bash + exec /bin/zsh + ``` -- 在线文档：[ccb.agent-aura.top](https://ccb.agent-aura.top/) -- DeepWiki：[deepwiki.com/claude-code-best/claude-code](https://deepwiki.com/claude-code-best/claude-code) + 如果你使用 bash，重新加载 bash 配置： ---- + ```bash + source ~/.bashrc + ``` -## ⚖️ 许可证 + Windows PowerShell 用户关闭并重新打开 PowerShell 即可。 + +2. **验证 Bun 是否可用** + + ```bash + bun --help + bun --version + ``` + +3. **如果已经安装过 Bun，更新到最新版本** + + ```bash + bun upgrade + ``` + +- ⚙️ 常规的配置 CC 的方式, 各大提供商都有自己的配置方式 + +### 📍 命令执行位置 + +- 安装或检查 Bun 的命令可以在任意目录执行： + `curl -fsSL https://bun.sh/install | bash`、`bun --help`、`bun --version`、`bun upgrade` +- 安装本项目依赖、启动开发模式、构建项目时，必须先进入本仓库根目录，也就是包含 `package.json` 的目录。 + +### 📥 安装 + +```bash +cd /path/to/claude-code +bun install +``` + +### ▶️ 运行 + +```bash +# 开发模式, 看到版本号 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` | + +- ⌨️ **Tab / Shift+Tab** 切换字段，**Enter** 确认并跳到下一个，最后一个字段按 Enter 保存 + +> ℹ️ 支持所有 Anthropic API 兼容服务（如 OpenRouter、AWS Bedrock 代理等），只要接口兼容 Messages API 即可。 + +## Feature Flags + +所有功能开关通过 `FEATURE_=1` 环境变量启用，例如： + +```bash +FEATURE_BUDDY=1 FEATURE_FORK_SUBAGENT=1 bun run dev +``` + +各 Feature 的详细说明见 [`docs/features/`](docs/features/) 目录，欢迎投稿补充。 + +## VS Code 调试 + +TUI (REPL) 模式需要真实终端，无法直接通过 VS Code launch 启动调试。使用 **attach 模式**： + +### 步骤 + +1. **终端启动 inspect 服务**： + + ```bash + 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 而来](https://github.com/sanyuan0704/sanyuan-skills)) + +```bash +# 在 REPL 中直接输入 +/teach-me Claude Code 架构 +/teach-me React Ink 终端渲染 --level beginner +/teach-me Tool 系统 --resume +``` + +### 它能做什么 + +- **诊断水平** — 自动评估你对相关概念的掌握程度，跳过已知的、聚焦薄弱的 +- **构建学习路径** — 将主题拆解为 5-15 个原子概念，按依赖排序逐步推进 +- **苏格拉底式提问** — 用选项引导思考，而非直接给答案 +- **错误概念追踪** — 发现并纠正深层误解 +- **断点续学** — `--resume` 从上次进度继续 + +### 学习记录 + +学习进度保存在 `.claude/skills/teach-me/` 目录下，支持跨主题学习者档案。 + +## 相关文档及网站 + +- **在线文档（Mintlify）**: [ccb.agent-aura.top](https://ccb.agent-aura.top/) — 文档源码位于 [`docs/`](docs/) 目录，欢迎投稿 PR +- **DeepWiki**: [https://deepwiki.com/claude-code-best/claude-code](https://deepwiki.com/claude-code-best/claude-code) + +## Contributors + + + Contributors + + +## Star History + + + + + + Star History Chart + + + +## 致谢 + +- [doubaoime-asr](https://github.com/starccy/doubaoime-asr) — 豆包 ASR 语音识别 SDK，为 Voice Mode 提供无需 Anthropic OAuth 的语音输入方案 + +## 许可证 本项目仅供学习研究用途。Claude Code 的所有权利归 [Anthropic](https://www.anthropic.com/) 所有。