Skip to content

Latest commit

 

History

History
253 lines (176 loc) · 10.2 KB

README_CN.md

File metadata and controls

253 lines (176 loc) · 10.2 KB

CodePilot CodePilot

Claude Code 的统一桌面客户端 -- 多 Provider 支持、MCP 扩展、自定义技能、跨平台 Bridge，以及理解你项目的助手工作区。

GitHub release Platform License

English | 日本語

CodePilot

下载 | 快速开始 | 文档 | 贡献 | 社区

为什么选择 CodePilot

多 Provider，统一界面。 连接 Anthropic、OpenRouter、Bedrock、Vertex 或任何自定义端点。对话中随时切换 Provider 和模型，不丢失上下文。

MCP + Skills 扩展体系。 添加 MCP 服务器（stdio / sse / http），支持运行时状态监控。定义可复用的提示词技能 -- 全局或项目级 -- 作为斜杠命令调用。从 skills.sh 浏览和安装社区技能。

随时随地控制。 Bridge 连接 CodePilot 到 Telegram、飞书、Discord 和 QQ。在手机上发消息，在桌面上收回复。

了解你项目的助手。 设置一个工作区目录，放入人设文件（soul.md、user.md）、规则（claude.md）和持久记忆（memory.md）。Claude 利用这些文件随时间适应你的项目惯例，支持 Onboarding 流程和每日签到。

为日常使用而建。 暂停、恢复和回退会话到任意检查点。分屏并排运行两个对话。追踪 Token 用量和费用。导入 CLI 会话历史。深浅主题一键切换。

快速开始

路径 A：下载发布版（大多数用户）

  1. 安装 Claude Code CLI：npm install -g @anthropic-ai/claude-code
  2. 认证：claude login
  3. 从 Releases 页面下载对应平台的安装包
  4. 启动 CodePilot

路径 B：源码构建（开发者）

前置条件 最低版本
Node.js 18+
Claude Code CLI 已安装并完成认证
npm 9+（Node 18 自带） 
git clone https://github.com/op7418/CodePilot.git
cd CodePilot
npm install
npm run dev              # 浏览器模式，访问 http://localhost:3000
# -- 或者 --
npm run electron:dev     # 完整桌面应用

首次使用

  1. 认证 Claude -- 如果还没有，先在终端运行 claude login。
  2. 配置 Provider -- 如果只使用 Anthropic（通过 CLI 认证或 ANTHROPIC_API_KEY），Provider 配置可跳过。使用 OpenRouter、Bedrock、Vertex 或自定义端点时，需要先在 设置 > Providers 中添加凭证。
  3. 创建对话 -- 选择工作目录、交互模式（Code / Plan / Ask）和模型。
  4. 设置 Assistant Workspace（可选）-- 前往 设置 > Assistant，选择工作区目录并开启 Onboarding。CodePilot 会在工作区根目录创建 soul.md、user.md、claude.md 和 memory.md（状态跟踪保存在 .assistant/ 子目录中）。
  5. 添加 MCP 服务器（可选）-- 在侧边栏的 MCP 页面添加和管理 MCP 服务器。自定义技能在单独的 Skills 页面管理。

核心能力

对话与编码

能力 说明
交互模式 Code / Plan / Ask
推理力度 Low / Medium / High / Max + Thinking 模式
权限控制 Default / Full Access，逐项审批
会话控制 暂停、恢复、回退到检查点、归档
模型切换 对话中随时切换模型
分屏 并排双会话
附件 文件和图片，支持多模态视觉
斜杠命令 /help /clear /cost /compact /doctor /review 等

扩展与集成

能力 说明
Provider Anthropic / OpenRouter / Bedrock / Vertex / 自定义端点
MCP 服务器 stdio / sse / http，运行时状态监控
Skills 自定义 / 项目 / 全局技能，skills.sh 市场
Bridge Telegram / 飞书 / Discord / QQ 远程控制
CLI 导入 导入 Claude Code CLI .jsonl 会话历史
图片生成 Gemini / Anthropic 生图、批量任务、画廊

数据与工作区

能力 说明
Assistant Workspace 工作区根目录文件（soul.md、user.md、claude.md、memory.md），.assistant/ 状态，Onboarding，签到
文件浏览 项目文件树、语法高亮预览
用量分析 Token 计数、费用估算、日用量图表
本地存储 SQLite（WAL 模式），数据全部在本地
国际化 英文 + 中文
主题 深色 / 浅色，一键切换

平台与安装

平台 格式 架构
macOS .dmg arm64 (Apple Silicon) + x64 (Intel)
Windows .exe (NSIS) x64 + arm64
Linux .AppImage / .deb / .rpm x64 + arm64

从 Releases 页面下载。

macOS 构建已使用 Developer ID 证书签名，但未进行公证（notarize），因此 Gatekeeper 在首次启动时仍可能弹出提示。Windows 和 Linux 构建未签名。

macOS：Gatekeeper 首次启动提示

方案一 -- 在访达中右键 CodePilot.app > 打开 > 确认。

方案二 -- 系统设置 > 隐私与安全性 > 滚动到安全性 > 点击「仍要打开」。

方案三 -- 在终端运行：

xattr -cr /Applications/CodePilot.app
Windows：SmartScreen 阻止安装

方案一 -- 在 SmartScreen 对话框中点击「更多信息」，然后点击「仍要运行」。

方案二 -- 设置 > 应用 > 高级应用设置 > 将应用安装控制设为允许任何来源。

文档

📖 完整文档： 中文 | English

入门指南：

用户指南：

开发文档：

常见问题

claude 命令找不到

全局安装 Claude Code CLI：

npm install -g @anthropic-ai/claude-code

然后运行 claude login 完成认证。确保 claude --version 能正常运行后再启动 CodePilot。

配置了 Provider 但没有模型出现

确认 API Key 有效且端点可访问。部分 Provider（Bedrock、Vertex）除 API Key 外还需要额外的环境变量或 IAM 配置。请查阅对应 Provider 的文档了解所需配置。

npm run dev 和 npm run electron:dev 的区别

npm run dev 只启动 Next.js 开发服务器，在浏览器中访问 http://localhost:3000 使用 CodePilot。npm run electron:dev 同时启动 Next.js 和 Electron 外壳，提供完整的桌面应用体验，包含原生窗口控件。

Workspace 文件到底在哪

设置工作区后，CodePilot 在工作区根目录创建四个 Markdown 文件：soul.md（人设）、user.md（用户档案）、claude.md（规则）、memory.md（长期笔记）。状态跟踪（Onboarding 进度、签到日期）保存在 .assistant/ 子目录中。每日记忆保存在 memory/daily/ 中。

Bridge 需要额外的平台配置

每个 Bridge 通道（Telegram、飞书、Discord、QQ）都需要各自的 Bot Token 或应用凭证。在侧边栏的 Bridge 页面配置通道。你需要先在目标平台创建 Bot 并获取 Token，然后提供给 CodePilot。

社区

微信用户群二维码

扫描二维码加入微信用户群，交流使用心得、反馈问题和获取最新动态。

贡献

  1. Fork 本仓库并创建功能分支
  2. npm install 然后 npm run electron:dev 本地开发
  3. 提交 PR 前运行 npm run test
  4. 向 main 提交 PR，附上清晰的变更说明

请保持 PR 聚焦 -- 每个 PR 只包含一个功能或修复。

开发命令 
npm run dev                    # Next.js 开发服务器（浏览器）
npm run electron:dev           # 完整 Electron 应用（开发模式）
npm run build                  # 生产构建
npm run electron:build         # 构建 Electron 可分发包
npm run electron:pack:mac      # macOS DMG（arm64 + x64）
npm run electron:pack:win      # Windows NSIS 安装包
npm run electron:pack:linux    # Linux AppImage、deb、rpm

CI/CD： 推送 v* tag 会自动触发全平台构建并创建 GitHub Release。

说明：

  • Electron 在 127.0.0.1 上 fork Next.js standalone 服务器，使用随机可用端口
  • 聊天数据存储在 ~/.codepilot/codepilot.db（开发模式：./data/）
  • SQLite 使用 WAL 模式，并发读取性能优秀

许可证

MIT