Skip to content

README_CN.md

Latest commit

 

History

History
286 lines (202 loc) · 12.4 KB

README_CN.md

File metadata and controls

286 lines (202 loc) · 12.4 KB

CodePilot CodePilot

多模型 AI Agent 桌面客户端 -- 连接任意 AI 服务商，通过 MCP 和 Skills 扩展能力，手机远程控制，让你的助理学会你的工作方式。

GitHub release Downloads GitHub stars Platform License

English | 日本語

CodePilot

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

下载

平台 下载 架构
macOS Apple Silicon (.dmg) · Intel (.dmg) arm64 / x64
Windows 安装包 (.exe) x64 + arm64
Linux AppImage · .deb · .rpm x64 + arm64

或访问 Releases 页面获取所有版本。

为什么选择 CodePilot

多服务商，统一界面

开箱即用连接 17+ AI 服务商。对话中随时切换服务商和模型，不丢失上下文。

类别 服务商
直连 API Anthropic、OpenRouter
云平台 AWS Bedrock、Google Vertex AI
国内服务商 智谱 GLM（国内/海外）、Kimi、Moonshot、MiniMax（国内/海外）、火山引擎方舟（豆包）、小米 MiMo、阿里云百炼（通义）
本地 & 自托管 Ollama、LiteLLM
自定义 任何 Anthropic 兼容或 OpenAI 兼容端点
媒体 Google Gemini（图片生成）

不只是写代码 — 全能 AI Agent

CodePilot 从编程工具起步，已成长为通用 AI Agent 桌面客户端：

  • Assistant Workspace — 人设文件、持久记忆、Onboarding 引导和每日签到。你的助理会学习你的偏好并持续适应。
  • 生成式 UI — AI 可以创建交互式仪表盘、图表和可视化组件，在应用内实时渲染。
  • 远程 Bridge — 连接 Telegram、飞书、Discord、QQ 和微信。在手机上发消息，在桌面上收回复。
  • MCP + Skills — 添加 MCP 服务器（stdio / sse / http），支持运行时监控。定义可复用技能或从 skills.sh 市场安装。
  • Media Studio — AI 图片生成，支持批量任务、画廊和标签管理。
  • 任务调度 — 支持 cron 表达式和定时间隔的持久化任务调度。

为日常使用而建

  • 暂停、恢复和回退会话到任意检查点
  • 分屏并排运行两个对话
  • 追踪 Token 用量和费用，附每日图表
  • 导入 Claude Code CLI 会话历史
  • 深色 / 浅色主题一键切换
  • 中英文双语界面

快速开始

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

  1. 从上方下载区域下载对应平台的安装包
  2. 启动 CodePilot
  3. 在 设置 > 服务商 中配置服务商 — 添加任意支持的服务商的 API Key
  4. 开始对话

提示： 安装 Claude Code CLI（npm install -g @anthropic-ai/claude-code）可解锁更多高级能力，如直接编辑文件、执行终端命令和 Git 操作。推荐安装但并非基础聊天所必需。

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

前置条件 最低版本
Node.js 18+
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     # 完整桌面应用

核心能力

对话与交互

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

扩展与集成

能力 说明
服务商 17+ 个服务商：Anthropic、OpenRouter、Bedrock、Vertex、智谱 GLM、Kimi、Moonshot、MiniMax、火山引擎、MiMo、百炼、Ollama、LiteLLM、自定义端点
MCP 服务器 stdio / sse / http，运行时状态监控
Skills 自定义 / 项目 / 全局技能，skills.sh 市场
Bridge Telegram / 飞书 / Discord / QQ / 微信 远程控制
CLI 导入 导入 Claude Code CLI .jsonl 会话历史
图片生成 Gemini 生图、批量任务、画廊

数据与工作区

能力 说明
Assistant Workspace 人设文件（soul.md、user.md、claude.md、memory.md），Onboarding，每日签到，持久记忆
生成式 UI AI 创建的交互式仪表盘和可视化组件
文件浏览 项目文件树、语法高亮预览
Git 面板 状态、分支、提交、Worktree 管理
用量分析 Token 计数、费用估算、日用量图表
任务调度 基于 cron 和定时间隔的持久化调度
本地存储 SQLite（WAL 模式），数据全部在本地
国际化 中文 + 英文
主题 深色 / 浅色，一键切换

首次使用

  1. 配置服务商 — 前往 设置 > 服务商，为你要使用的服务商添加凭证。CodePilot 内置了所有主流服务商的预设 — 选择一个，填入 API Key 即可。
  2. 创建对话 — 选择工作目录、交互模式（Code / Plan / Ask）和模型。
  3. 设置 Assistant Workspace（可选）— 前往 设置 > Assistant，选择工作区目录并开启 Onboarding。CodePilot 会在工作区根目录创建 soul.md、user.md、claude.md 和 memory.md。
  4. 添加 MCP 服务器（可选）— 在侧边栏的 MCP 页面添加和管理 MCP 服务器。自定义技能在单独的 Skills 页面管理。
  5. 安装 Claude Code CLI（可选）— 如需文件编辑和终端命令等高级功能，安装 CLI：npm install -g @anthropic-ai/claude-code

平台与安装说明

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

macOS：Gatekeeper 首次启动提示

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

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

方案三 -- 在终端运行：

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

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

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

文档

📖 完整文档： 中文 | English

入门指南：

用户指南：

开发文档：

常见问题

必须安装 Claude Code CLI 吗？

不需要。你可以使用任何支持的服务商（OpenRouter、智谱 GLM、火山引擎、Ollama 等）直接使用 CodePilot，无需安装 Claude Code CLI。CLI 仅在你需要 Claude 直接编辑文件、执行终端命令或进行 Git 操作时才需要。对于聊天和助理功能，只需配置一个服务商即可开始使用。

配置了服务商但没有模型出现

确认 API Key 有效且端点可访问。部分服务商（Bedrock、Vertex）除 API Key 外还需要额外的环境变量或 IAM 配置。使用内置诊断功能（设置 > 服务商 > 运行诊断）检查连通性。

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 模式，并发读取性能优秀

许可证

Business Source License 1.1 (BSL-1.1)

  • 个人 / 学术 / 非营利用途：免费且无限制
  • 商业用途：需要单独许可 — 联系 @op7418 on X
  • 变更日期：2029-03-16 — 届时代码转为 Apache 2.0