docs: 重写中文文档 — 全量覆盖功能、中文 UI 标签、桥接分页

- 重写 index.mdx 为真正的快速开始指南,链接服务商配置
- 新增 chat.mdx(对话模式、权限、上下文管理)
- 新增 skills.mdx(技能分类、市场、本地管理)
- 新增 design-agent.mdx(单张/批量图片生成、参考图、连续编辑)
- 新增 gallery.mdx(素材库浏览、筛选、详情操作)
- 重写 providers.mdx — CLI 环境认证 vs 手动添加、cc switch 不生效说明、
  国内服务商预设、Anthropic 第三方模型映射、服务商优先级链
- 重写 mcp.mdx — 三种传输类型(stdio/SSE/HTTP)、列表+JSON 双视图
- 重写 assistant-workspace.mdx — 对齐实际设置>助理标签页
- 重写 faq.mdx — 更全面的问答覆盖
- 桥接拆分为 5 页:总览(斜杠命令、全局设置) + Telegram + Discord + 飞书 + QQ
- Discord 开发者模式获取 ID 说明移入配置流程
- 飞书长连接模式启动顺序说明
- 所有 UI 按钮/菜单名称改为中文翻译(设置、服务商、技能、桥接等)
- 扁平化无子页面的 folder/index.mdx → page.mdx,消除侧边栏多余展开三角

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
7418andClaude Opus 4.6 committed 2026-03-11 00:13:16 +08:00
1 parent 9fae911760
commit c67f3ef82b
20 files changed
+1043 -277

No files matched your search

@@ -0,0 +1,62 @@
---
title: 助理工作区
description: 管理 Claude 的项目上下文、行为设定和自动化流程。
---
# 助理工作区
助理工作区(Assistant Workspace)让你为 Claude 配置项目级的上下文和行为。你可以定义 Claude 的角色、记忆、自动化流程,让它在每次对话中都保持一致的工作状态。
## 打开工作区
前往 **设置 > 助理** 标签页即可管理助理工作区的所有配置。
## 工作区路径
工作区路径指定 Claude 工作时的项目目录。设置后,Claude 在对话中会自动以该目录为上下文进行文件操作和代码分析。
## 引导设置
引导设置是在新对话开始时自动执行的提示。启用后,每次新建对话的第一条消息会自动触发引导设置流程。
典型用途:
- 让 Claude 阅读项目的 README 和关键配置文件
- 了解项目架构和代码规范
- 加载必要的上下文信息
### 配置
1. 在**助理**标签页找到**引导设置**区域
2. 切换开关启用引导设置
3. 在文本框中编写引导设置提示内容
4. 保存
## 每日问询
每日问询是定期自动执行的上下文刷新提示。启用后,Claude 会按设定的频率重新审视项目状态。
典型用途:
- 定期检查项目进度
- 刷新文件变更状态
- 更新 Claude 对项目当前状态的认知
### 配置
1. 在**助理**标签页找到**每日问询**区域
2. 切换开关启用每日问询
3. 编写每日问询提示内容
4. 保存
## 使用场景
### 个人项目维护
为长期维护的项目配置引导设置,让 Claude 每次对话都能快速了解项目现状,不需要反复解释项目背景。
### 团队协作
配置统一的工作区设定,确保团队成员使用 Claude 时遵循相同的代码规范和工作流程。
### 复杂项目管理
结合引导设置和每日问询,让 Claude 在长时间运行的任务中保持对项目上下文的持续感知。
@@ -1,46 +0,0 @@
---
title: 助手工作区
description: 检查和管理 Claude 的工作环境。
---
助手工作区让你能够查看 Claude 在对话过程中的操作。它展示文件变更、工具使用情况以及 Claude 当前的工作上下文状态。
## 功能
### 文件检查器
查看 Claude 在对话中读取或修改的文件:
- **文件树** — 浏览项目目录结构
- **Diff 视图** — 查看 Claude 对每个文件的具体更改
- **文件预览** — 带语法高亮的文件预览
### 工具活动
实时监控 Claude 的工具使用:
- 查看 Claude 正在调用哪些工具及原因
- 查看工具输入/输出以便调试
- 追踪操作序列
### 上下文使用情况
追踪 Claude 上下文窗口的使用情况:
- **Token 计数** — 当前使用的 token 数 vs. 可用数
- **使用明细** — token 在消息、工具和系统上下文中的分布
- **成本估算** — 基于当前提供商定价的大致费用
## 打开工作区
工作区面板可以通过以下方式切换:
- 前往**设置**,打开**助手**部分(即 Settings #assistant)
- 键盘快捷键(可在设置中配置)
## 使用场景
- **代码审查** — 在提交前审查 Claude 所做的所有文件更改
- **调试** — 当某些功能不正常时检查工具调用
- **学习** — 通过观察工具使用来了解 Claude 如何处理问题
- **成本管理** — 监控 token 使用以控制预算
@@ -0,0 +1,70 @@
---
title: Discord
description: 配置 Discord Bot 桥接。
---
# Discord 桥接
通过 Discord Bot 与 Claude 对话。支持服务器频道和私聊两种模式,支持流式消息预览。
## 创建 Discord Bot
1. 前往 [Discord Developer Portal](https://discord.com/developers/applications)
2. 点击 **New Application**,输入应用名称
3. 在左侧菜单选择 **Bot**
4. 点击 **Reset Token** 获取 Bot Token,复制备用
5. 在 Bot 设置中开启以下 **Privileged Gateway Intents**:
- **Message Content Intent** — 必须,Bot 需要读取消息内容
- **Server Members Intent** — 可选,用于用户身份验证
6. 在左侧选择 **OAuth2 > URL Generator**
7. 勾选 Scopes:`bot`
8. 勾选 Bot Permissions:`Send Messages`、`Read Message History`、`Embed Links`
9. 复制生成的邀请链接,在浏览器中打开
10. 选择你的服务器,授权 Bot 加入
## 在 CodePilot 中配置
1. 点击侧边栏 **桥接**,切换到 **Discord** 页面
2. 在 **Bot 凭据** 区域粘贴 Bot Token
3. 点击 **测试连接** 验证
4. 配置访问控制(获取 ID 需要先开启 Discord 的**开发者模式**:打开 Discord 设置 → **高级** → 开启 **开发者模式**,之后就可以右键复制各类 ID):
- **允许的用户** — 右键用户 → **复制用户 ID**,多个用逗号分隔
- **允许的频道** — 右键频道 → **复制频道 ID**,限制 Bot 只在特定频道响应
- **允许的服务器** — 右键服务器图标 → **复制服务器 ID**,限制 Bot 只在特定服务器工作
5. 配置群组策略:
- **开放** — Bot 在所有允许的服务器/频道中响应
- **禁用** — Bot 只在私聊中响应
6. (可选)**需要 @提及** — 开启后 Bot 只响应 @提及它的消息
7. 点击 **保存**
## 启用桥接
1. 回到桥接总览页面
2. 确保 **Discord** 渠道开关已打开
3. 确保桥接主开关已开启
4. 点击 **启动**
## 流式预览
Discord 桥接支持流式消息预览,Claude 生成回复时实时更新消息。参数:
- **最小更新字符数** — 默认 40
- **最小更新间隔** — 默认 1500ms
- **最大消息长度** — 默认 1900 字符
## 消息格式
Discord 原生支持 Markdown,Claude 的回复会直接以 Markdown 格式发送。超长消息自动分片(每片最大 2000 字符)。
## 故障排除
### Bot 在线但不响应
1. 确认 **Message Content Intent** 已开启(Developer Portal → Bot 设置)
2. 确认 Bot 有该频道的 **发送消息** 和 **查看频道** 权限
3. 如果设置了允许的频道/用户/服务器列表,确认对应 ID 正确
4. 如果开启了 **需要 @提及**,确保消息中 @了 Bot
### Bot 掉线
Discord WebSocket 连接可能因网络波动断开。CodePilot 会自动重连。如果持续掉线,检查网络连接。
@@ -0,0 +1,84 @@
---
title: 飞书
description: 配置飞书 / Lark 桥接。
---
# 飞书桥接
通过飞书(或 Lark)应用与 Claude 对话。支持国内版和国际版切换、群组策略控制。
## 创建飞书应用
### 国内版(飞书)
1. 前往 [飞书开放平台](https://open.feishu.cn),登录开发者账号
2. 点击 **创建企业自建应用**
3. 填写应用名称和描述
4. 进入应用详情页,在 **凭证与基础信息** 中获取:
- **App ID**(格式:`cli_xxxxxxxxxx`)
- **App Secret**
5. 在左侧选择 **添加应用能力 > 机器人**,启用机器人功能
6. 在 **事件订阅** 中,先选择 **使用长连接模式**(WebSocket,无需公网地址):
- 长连接模式需要先启动才能保存配置 — 点击启用后等待连接建立
- 连接建立成功后,再添加事件:`im.message.receive_v1`(接收消息)
- 保存事件订阅配置
7. 在 **权限管理** 中申请以下权限:
- `im:message`(发送消息)
- `im:message.group_at_msg`(接收群聊 @消息)
- `im:message.p2p_msg`(接收私聊消息)
8. **发布应用** — 提交审核或自审通过
### 国际版(Lark)
流程与国内版相同,但在 [Lark Developer](https://open.larksuite.com) 上操作。在 CodePilot 配置时选择域名为 **Lark**。
## 在 CodePilot 中配置
1. 点击侧边栏 **桥接**,切换到 **飞书** 页面
2. 选择域名:**飞书**(国内版)或 **Lark**(国际版)
3. 填写 **App ID** 和 **App Secret**
4. 点击 **测试连接** 验证凭据
5. 配置群组策略:
- **开放** — Bot 响应所有群聊中的 @消息
- **白名单** — 只响应指定群聊(填写群聊 chat_id)
- **禁用** — 只响应私聊
6. (可选)**需要 @提及** — 开启后群聊中只响应 @Bot 的消息
7. (可选)**允许的用户** — 填写飞书 open_id 或 chat_id,限制谁可以使用 Bot
8. 点击 **保存**
## 启用桥接
1. 回到桥接总览页面
2. 确保 **飞书** 渠道开关已打开
3. 确保桥接主开关已开启
4. 点击 **启动**
## 消息格式
飞书桥接会将 Claude 的回复转换为飞书消息格式:
- 复杂回复(含代码块、表格等)→ 消息卡片(Interactive Card)
- 简单回复 → 富文本消息(Post)
- 单条消息最大 30000 字符(通常无需分片)
## 故障排除
### 测试连接失败
1. 确认 App ID 和 App Secret 正确
2. 确认应用已发布(审核通过)
3. 确认选择了正确的域名(国内版 vs 国际版)
### Bot 不响应群聊
1. 确认已添加机器人能力
2. 确认已申请 `im:message.group_at_msg` 权限
3. 确认群组策略不是"禁用"
4. 如果策略为"白名单",确认群聊 ID 在允许列表中
5. 如果开启了"需要 @提及",确保消息中 @了 Bot
### Bot 不响应私聊
1. 确认已申请 `im:message.p2p_msg` 权限
2. 确认应用已发布
3. 在飞书中搜索 Bot 名称,发起私聊
+73 -41
View File
@@ -1,54 +1,86 @@
---
title: 消息桥接
description: 将 Claude 对话桥接到消息平台。
description: 将 Claude 对话桥接到 Telegram、Discord、飞书和 QQ。
---
CodePilot 的消息桥接功能让你可以从外部消息平台与 Claude 交互。在桌面上开始对话,然后通过 Discord、Telegram、飞书或 QQ 在手机上继续。
# 消息桥接
消息桥接让你从手机上的即时通讯应用与 Claude 对话。在桌面上启动 CodePilot,配置好 Bot 后,你可以通过 Telegram、Discord、飞书或 QQ 随时随地与 Claude 交互。
## 支持的平台
| 平台 | 功能 |
| 平台 | 特点 |
|------|------|
| **Discord** | 完整的消息桥接,支持 Bot 集成 |
| **Telegram** | 通过 Bot 进行直接消息桥接 |
| **飞书/Lark** | 企业消息桥接 |
| **QQ** | 通过 QQ Bot 平台桥接 |
## 设置
### Discord
1. 从侧边栏打开 **Bridge**
2. 在 [discord.com/developers](https://discord.com/developers/applications) 创建 Discord Bot
3. 复制 Bot Token 并粘贴到 CodePilot
4. 将 Bot 邀请到你的 Discord 服务器
5. 指定桥接操作的频道 ID
6. 点击**启用**
### Telegram
1. 从侧边栏打开 **Bridge**
2. 在 Telegram 上通过 [@BotFather](https://t.me/BotFather) 创建 Bot
3. 复制 Bot Token 并粘贴到 CodePilot
4. 点击**启用**
5. 向你的 Bot 发送消息开始桥接
### 飞书/Lark
1. 从侧边栏打开 **Bridge**
2. 在[飞书开放平台](https://open.feishu.cn)创建应用
3. 配置应用凭证(App ID 和 App Secret)
4. 设置事件订阅
5. 点击**启用**
| **Telegram** | 长轮询模式,支持流式预览、权限按钮、丰富的 Markdown 渲染 |
| **Discord** | WebSocket 模式,支持流式预览、频道/私聊双模式 |
| **飞书 / Lark** | WebSocket 模式,支持国内/国际版切换、群组策略控制 |
| **QQ** | REST API 模式,支持图片发送、私聊桥接 |
## 工作原理
1. **桌面到手机**:你在 CodePilot 中发送的消息会转发到配置的平台
2. **手机到桌面**:来自平台的消息会发送给 Claude,回复会转发回去
3. **后台模式**:CodePilot 可以在系统托盘模式下运行,即使窗口关闭也能保持桥接活跃
```
手机 IM → Bot 收到消息 → CodePilot 转发给 Claude → Claude 回复 → Bot 发回 IM
```
## 桥接模式
1. 你在消息平台上向 Bot 发送消息
2. CodePilot 的 Bridge 服务接收消息并转发给 Claude
3. Claude 处理请求后生成回复
4. 回复通过 Bot 发回你的消息平台
5. 如果 Claude 需要权限确认(如写文件),会在 IM 中发送确认按钮
- **交互模式** — 完整的双向消息传递
- **系统托盘模式** — 最小化到托盘,桥接保持活跃
- **仅通知** — 只接收通知,不转发消息
## 基本设置
### 开启桥接
1. 点击侧边栏的 **桥接**
2. 在桥接总览页面打开 **桥接主开关**
3. 分别启用你需要的渠道(Telegram / Discord / 飞书 / QQ)
4. 进入各渠道页面配置 Bot 凭据
5. 点击 **启动** 按钮
### 桥接全局设置
在桥接总览页面可以配置:
- **默认工作目录** — 新对话的默认项目路径
- **默认模型** — 桥接对话使用的模型
- **默认服务商** — 桥接对话使用的 API 服务商
- **自动启动** — CodePilot 启动时自动开启桥接服务
### 桥接状态
桥接页面实时显示:
- 主服务状态(已连接 / 已断开)
- 各渠道适配器状态
- 活跃的会话绑定数量
- 最后一条消息时间
## 斜杠命令
在 IM 中可以使用斜杠命令控制 CodePilot:
| 命令 | 参数 | 说明 |
|------|------|------|
| `/new` | `[路径]` | 新建对话,可指定工作目录 |
| `/bind` | `<会话ID>` | 绑定当前 IM 聊天到已有的 CodePilot 对话 |
| `/cwd` | `/path/to/dir` | 切换当前对话的工作目录 |
| `/mode` | `plan\|code\|ask` | 切换对话模式 |
| `/status` | — | 查看当前对话状态(ID、工作目录、模式、模型) |
| `/sessions` | — | 列出当前渠道最近的对话(最多 10 个) |
| `/stop` | — | 中止当前正在运行的任务 |
| `/help` | — | 查看可用命令 |
## 使用建议
- **保持 CodePilot 运行** — 桥接依赖桌面端作为中转,关闭后 Bot 无法响应
- **系统托盘模式** — 最小化到系统托盘,桥接保持活跃不占桌面空间
- **私聊优先** — 建议在私聊中使用,群聊中可能被其他消息干扰
- **权限确认** — Claude 需要执行敏感操作时会在 IM 中发送确认按钮,注意及时处理
## 各渠道配置
- [Telegram 配置](/zh/docs/bridge/telegram)
- [Discord 配置](/zh/docs/bridge/discord)
- [飞书配置](/zh/docs/bridge/feishu)
- [QQ 配置](/zh/docs/bridge/qq)
@@ -0,0 +1,10 @@
{
"title": "消息桥接",
"pages": [
"index",
"telegram",
"discord",
"feishu",
"qq"
]
}
+76
View File
@@ -0,0 +1,76 @@
---
title: QQ
description: 配置 QQ Bot 桥接。
---
# QQ 桥接
通过 QQ Bot 与 Claude 对话。支持图片发送和私聊桥接。
## 创建 QQ Bot
1. 前往 [QQ 开放平台](https://q.qq.com),注册开发者账号
2. 创建一个新的 Bot 应用
3. 完成实名认证(个人或企业)
4. 在应用管理页面获取:
- **AppID**(数字格式)
- **App Secret**
5. 在 **功能配置** 中开启需要的消息权限
6. 提交审核,等待通过
> QQ Bot 平台审核较严格,建议仔细阅读平台文档中的接入规范。
## 在 CodePilot 中配置
1. 点击侧边栏 **桥接**,切换到 **QQ** 页面
2. 填写 **App ID** 和 **App Secret**
3. 点击 **测试连接** 验证凭据
4. (可选)配置 **允许的用户** — 填写 QQ user_openid,多个用逗号分隔
5. (可选)配置图片设置:
- **启用图片发送** — 允许 Bot 发送图片(默认开启)
- **最大图片大小** — 单张图片大小限制(默认 20MB)
6. 点击 **保存**
## 启用桥接
1. 回到桥接总览页面
2. 确保 **QQ** 渠道开关已打开
3. 确保桥接主开关已开启
4. 点击 **启动**
5. 在 QQ 中添加 Bot 为好友,发送消息即可与 Claude 对话
## 消息格式
QQ 桥接以纯文本格式发送消息:
- 不支持 Markdown 渲染
- 超长消息自动分片(每片最大 2000 字符)
- 每条回复最多发送 3 个分片(平台限制)
- 支持发送图片(需开启图片设置)
## 权限处理
QQ Bot 平台不支持内联按钮,权限确认通过文本命令处理:
- Bot 发送权限确认消息,包含操作说明和权限 ID
- 你回复 `/perm allow <ID>` 允许操作
- 你回复 `/perm deny <ID>` 拒绝操作
- 你回复 `/perm allow_session <ID>` 允许本次会话内同类操作
## 故障排除
### 测试连接失败
1. 确认 App ID 和 App Secret 正确
2. 确认 Bot 应用已通过审核
3. 确认开发者实名认证已完成
### Bot 不响应
1. 确认已添加 Bot 为 QQ 好友
2. 确认 CodePilot 桥接已启动
3. 如果设置了允许用户列表,确认你的 user_openid 在列表中
### 消息被截断
QQ 平台限制每条回复最多 3 个分片。对于特别长的回复,可能会丢失末尾部分。建议在提示中要求 Claude 简洁回复。
@@ -0,0 +1,80 @@
---
title: Telegram
description: 配置 Telegram Bot 桥接。
---
# Telegram 桥接
通过 Telegram Bot 与 Claude 对话。支持流式消息预览、权限确认按钮和丰富的 Markdown 渲染。
## 创建 Telegram Bot
1. 在 Telegram 中搜索 [@BotFather](https://t.me/BotFather)
2. 发送 `/newbot`
3. 按提示输入 Bot 名称(显示名)和用户名(以 `_bot` 结尾)
4. BotFather 会返回一个 **Bot Token**,格式类似 `123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11`
5. 复制 Token 备用
## 在 CodePilot 中配置
1. 点击侧边栏 **桥接**,切换到 **Telegram** 页面
2. 在 **Bot 凭据** 区域粘贴 Bot Token
3. 点击 **测试连接** 验证 Token 是否有效
4. 验证成功后,点击 **自动检测 Chat ID**:
- 先在 Telegram 中向你的 Bot 发一条任意消息
- 然后点击检测按钮,CodePilot 会自动获取你的 Chat ID
5. (可选)在 **允许的用户** 中填写允许使用 Bot 的 Telegram 用户 ID,多个用逗号分隔。留空则不限制。
6. 点击 **保存**
## 启用桥接
1. 回到桥接总览页面
2. 确保 **Telegram** 渠道开关已打开
3. 确保桥接主开关已开启
4. 点击 **启动**
现在在 Telegram 中向 Bot 发送消息,你就能收到 Claude 的回复了。
## 流式预览
Telegram 桥接支持流式消息预览 — Claude 生成回复时,Bot 会实时更新消息内容,让你不用等完整回复就能看到进展。
流式预览的参数可以在高级设置中调整:
- **最小更新字符数** — 累积至少多少新字符后才更新消息(默认 20)
- **最小更新间隔** — 两次更新之间的最短间隔(默认 700ms)
- **最大消息长度** — 预览消息的最大长度(默认 3900 字符)
## 消息格式
Telegram 桥接会将 Claude 的 Markdown 回复转换为 Telegram HTML 格式:
- 代码块 → `<pre>` 带语言标注
- 粗体、斜体 → HTML 标签
- 链接 → 可点击链接
- 超长消息自动分片(每片最大 4096 字符)
如果 HTML 渲染失败,会自动降级为纯文本发送。
## 权限处理
当 Claude 需要执行敏感操作时,Bot 会发送一条带有内联按钮的消息:
- **允许** — 允许本次操作
- **允许本次会话** — 本次会话内同类操作自动允许
- **拒绝** — 拒绝操作
## 故障排除
### Bot 没有响应
1. 确认 CodePilot 桥接服务已启动(桥接页面显示"已连接")
2. 确认 Telegram 渠道开关已打开
3. 确认 Bot Token 正确(重新测试连接)
4. 如果设置了允许用户列表,确认你的用户 ID 在列表中
### 收到错误消息
- **API 额度不足** — 检查 API 密钥余额
- **模型不可用** — 检查桥接默认服务商和模型配置
- **权限超时** — Claude 等待权限确认超时,重新发送消息
+104
View File
@@ -0,0 +1,104 @@
---
title: 对话
description: CodePilot 的对话功能详解 — 模式、权限、上下文管理。
---
# 对话
对话是 CodePilot 的核心功能。你在这里与 Claude 协作完成编程任务。
## 对话模式
CodePilot 提供三种对话模式,可在输入框上方随时切换:
### 代码模式
默认模式。Claude 拥有完整的工具权限,可以:
- 读写项目文件
- 执行终端命令
- 调用 MCP 工具
- 搜索代码库
适合日常开发任务:写代码、修 Bug、重构、部署。
### 计划模式
规划模式。Claude 只进行分析和方案制定,**不会执行任何操作**。
- 分析问题并给出实施方案
- 列出需要修改的文件和步骤
- 评估不同方案的优劣
适合在动手之前理清思路,或者评估大型改动的影响范围。
### 问答模式
问答模式。Claude 只回答问题,不使用任何工具。
- 解释代码逻辑
- 回答技术问题
- 讨论架构设计
适合纯粹的知识问答场景,不需要 Claude 接触项目文件。
## 权限控制
### 会话权限
每次对话可以选择权限级别:
- **默认权限** — Claude 执行敏感操作(写文件、运行命令)前会请求确认
- **完全访问** — Claude 可以自动执行所有操作,无需逐一确认
权限选择器位于对话输入框旁。对于探索性任务建议使用默认权限,对于信任的重复性任务可以使用完全访问。
### 权限弹窗
当 Claude 需要执行受限操作时,会弹出权限确认对话框,显示:
- 工具名称和参数
- 操作说明
- 允许 / 拒绝按钮
你可以逐一审核 Claude 的每个操作。
## 上下文管理
### 上下文用量指示器
输入框旁的圆形进度条显示当前对话的上下文窗口使用情况。鼠标悬停可以看到详细信息:
- 已使用的 Token 数
- 总可用 Token 数
- 使用百分比
当上下文接近上限时,Claude 会自动压缩历史消息以继续对话。
### 对话回退
CodePilot 支持将对话回退到之前的某个节点。每条用户消息都是一个回退点 — 你可以回到任意一条之前的消息,从那里重新开始对话。
## 输入功能
### 文件附件
在输入框中可以附加图片文件,让 Claude 分析截图或设计稿。支持拖放或点击附件按钮。
### 斜杠命令
输入 `/` 触发斜杠命令菜单,快速执行常用操作。
### @-提及
输入 `@` 可以引用文件或上下文,帮助 Claude 聚焦到特定内容。
## 会话管理
### 导入 CLI 会话
如果你之前使用过 Claude Code CLI,可以通过**导入会话**功能将 CLI 中的对话导入到 CodePilot。支持搜索和筛选历史会话。
### 服务商切换
对话头部显示当前使用的服务商。你可以在对话中途切换服务商,切换后的消息将使用新服务商处理。每个对话会记住其服务商设置。
@@ -0,0 +1,64 @@
---
title: 设计 Agent
description: 使用 AI 驱动的图片生成功能。
---
# 设计 Agent
设计 Agent 是 CodePilot 内置的 AI 图片生成功能。它通过 Claude 分析你的需求,然后调用 Gemini Image API 生成图片。
## 前提条件
使用设计 Agent 需要配置 **Google Gemini (Image)** 服务商:
1. 前往 **设置 > 服务商**
2. 点击 **添加服务商**,选择 **Google Gemini (Image)**
3. 填写 API 密钥
4. 点击 **保存**
## 单张生成
### 开启设计 Agent
在对话输入框右侧找到**设计 Agent** 开关,点击启用。启用后,你发送的消息会被 Claude 分析为图片生成意图。
### 生成流程
1. 开启 Design Agent 开关
2. 用自然语言描述你想要的图片
3. Claude 分析你的需求,生成结构化的图片描述
4. 弹出确认面板,你可以调整:
- **Prompt** — 编辑生成提示词
- **宽高比** — 选择比例(1:1、16:9、9:16、3:2、4:3 等 10 种)
- **分辨率** — 选择 1K / 2K / 4K
5. 点击生成,等待结果
6. 生成的图片以卡片形式展示在对话中
### 参考图(垫图)
你可以上传参考图片来引导生成风格和构图。在输入框中附加图片,设计 Agent 会自动将其作为生成参考。
### 连续编辑
生成图片后,你可以直接描述修改需求(如"去掉右边的瓶子"),系统会自动将上一张生成结果作为参考图,实现连续迭代。
## 批量生成
设计 Agent 支持根据文档内容批量生成配图。
### 流程
1. 在对话中上传文档或提供内容
2. 描述你的配图需求和风格要求
3. Claude 分析文档,生成批量生成计划:
- 每张图的提示词
- 宽高比和分辨率
- 标签和来源引用
4. 你可以逐一审核和编辑计划中的每一项
5. 确认后开始批量生成
6. 进度面板实时显示每张图的生成状态
7. 失败的项目可以单独重试
## 查看历史
所有生成的图片会自动保存到[素材库](/zh/docs/gallery)中,你可以随时回顾、下载或收藏。
+45 -33
View File
@@ -3,68 +3,80 @@ title: 常见问题
description: 关于 CodePilot 的常见问题解答。
---
## 一般问题
# 常见问题
## 基本问题
### CodePilot 是什么?
CodePilot 是 Claude Code 的原生桌面 GUI 客户端。它为 Claude Code CLI 提供图形界面,附带多提供商支持、插件系统、消息桥接和主题自定义等额外功能。
CodePilot 是 Claude Code 的桌面工作区。它在 Claude Code CLI 的基础上提供图形界面,整合了多服务商管理、MCP 插件、技能、消息桥接和助理工作区等功能。基于 Electron + Next.js 构建。
### CodePilot 和 Claude Code CLI 是什么关系?
CodePilot 是 Claude Code CLI 的图形前端。它通过 Claude Agent SDK 调用 Claude Code CLI 的能力,同时在上层添加了 GUI 专属的功能(多服务商切换、桥接、素材库等)。使用 CodePilot 需要先安装 Claude Code CLI。
### CodePilot 免费吗?
CodePilot 是开源且免费使用的。你需要自己的 API 密钥(来自 Anthropic、OpenAI、Google、AWS Bedrock 等支持的提供商)。
CodePilot 本身开源且免费。你需要自备 API 密钥(来自 Anthropic、OpenRouter 或其他支持的服务商)。API 调用费用由服务商收取。
### 支持哪些平台?
### 支持哪些操作系统?
CodePilot 支持 macOS(Apple Silicon 和 Intel)和 Windows。Linux 支持正在计划中。
- macOS 12+(Apple Silicon 和 Intel)
- Windows 10+(64 位)
## 设置
## 安装与配置
### 出现"未找到 Node.js"错误
### 首次启动提示找不到 Node.js
CodePilot 需要 Node.js 18 或更高版本。设置向导会提供自动安装,你也可以从 [nodejs.org](https://nodejs.org) 手动安装。
CodePilot 需要 Node.js 18+。首次启动的设置向导会检测并提供自动安装。你也可以从 [nodejs.org](https://nodejs.org) 手动安装。
### 如何获取 API 密钥?
- **Anthropic**:在 [console.anthropic.com](https://console.anthropic.com) 注册并创建 API 密钥
- **OpenAI**:在 [platform.openai.com](https://platform.openai.com) 注册并创建 API 密钥
- **Google AI**:从 [aistudio.google.com](https://aistudio.google.com) 获取密钥
- **Anthropic** — [console.anthropic.com](https://console.anthropic.com)
- **OpenRouter** — [openrouter.ai](https://openrouter.ai)
- **智谱 GLM** — [open.bigmodel.cn](https://open.bigmodel.cn)
- **Kimi** — [platform.moonshot.cn](https://platform.moonshot.cn)
- **火山引擎** — [console.volcengine.com](https://console.volcengine.com)
- **阿里云百炼** — [dashscope.console.aliyun.com](https://dashscope.console.aliyun.com)
### 可以使用本地 LLM 吗?
### 可以使用本地大模型吗?
可以,如果它提供 OpenAI 兼容的 API 端点。将其配置为 OpenAI 提供商,使用本地服务器的 URL 即可。
可以。任何提供 OpenAI 兼容 API 的本地服务(Ollama、LM Studio、vLLM 等)都可以作为自定义 API 服务商接入。在服务商设置中选择自定义 API,填写本地服务的 URL。
## 使用
### macOS 提示"无法验证开发者"
### 如何切换提供商?
前往 **系统设置 > 隐私与安全性**,找到 CodePilot 相关提示,点击"仍要打开"。
使用聊天头部的提供商选择器。每个对话会记住其提供商,你可以在对话中途切换。
## 使用问题
### 如何使用 MCP 插件?
### 代码 / 计划 / 问答三种模式有什么区别?
从侧边栏打开 **MCP** 添加 MCP 服务器。连接后,其工具会自动对 Claude 可用。
- **代码** — Claude 可以读写文件、执行命令,适合日常开发
- **计划** — Claude 只分析方案不执行操作,适合规划阶段
- **问答** — Claude 只回答问题不使用工具,适合纯问答
### 可以在手机上使用 CodePilot 吗?
### 如何在手机上与 Claude 对话?
不能直接使用,但你可以使用[消息桥接](/zh/docs/bridge)将对话桥接到 Discord、Telegram、飞书或 QQ,在手机上交互。
使用 [消息桥接](/zh/docs/bridge) 功能,将 CodePilot 连接到 Telegram、Discord、飞书或 QQ。桌面端保持运行即可从手机上与 Claude 对话。
## 故障排除
### Claude 没有响应怎么办?
### 应用无法启动
1. 检查 API 密钥是否有效且有余额
2. 检查网络连接
3. 尝试切换到其他服务商
4. 查看 MCP 页面是否有服务器报错
5. 重启 CodePilot
1. 确保已安装 Node.js 18+
2. 尝试删除应用数据目录并重新启动
3. 检查应用数据目录中的日志文件
### 如何导入 CLI 的对话历史?
### Claude 没有响应
在对话页面使用导入功能,可以搜索并导入 Claude Code CLI 中的历史会话。
1. 检查 API 密钥是否有效且有足够额度
2. 验证网络连接
3. 尝试切换到其他提供商以定位问题
4. 检查侧边栏 **MCP** 页面是否有 MCP 服务器错误
## 反馈与支持
### 如何报告 Bug?
在 [GitHub](https://github.com/op7418/CodePilot/issues) 上创建 issue,包含:
- 你的操作系统和 CodePilot 版本
在 [GitHub Issues](https://github.com/op7418/CodePilot/issues) 提交,请包含:
- 操作系统和 CodePilot 版本
- 复现步骤
- 日志中的相关错误信息
- 相关错误日志
+41
View File
@@ -0,0 +1,41 @@
---
title: 素材库
description: 管理 AI 生成的图片素材。
---
# 素材库
素材库用于浏览、管理和组织通过设计 Agent 生成的所有图片。从侧边栏点击**素材库**进入。
## 浏览图片
素材库以瀑布流网格展示所有生成的图片,支持无限滚动加载。
### 筛选和排序
- **时间范围** — 按日期筛选图片
- **仅收藏** — 只显示收藏的图片
- **排序** — 按最新或最早排列
## 图片详情
点击任意图片打开详情视图,左侧为图片预览,右侧为元数据面板:
- **Prompt** — 生成时使用的提示词
- **模型** — 使用的生成模型
- **宽高比** — 图片比例(如 1:1、16:9)
- **分辨率** — 图片尺寸
- **参考图** — 生成时使用的参考图片(如有)
- **关联会话** — 跳转到生成该图片的对话
### 操作
- **下载** — 将图片保存到本地
- **收藏** — 标记为收藏,方便后续快速查找
- **删除** — 删除图片(需确认)
多张图片的生成结果会显示数量标记和左右切换箭头。
## 存储位置
生成的图片保存在 `~/.codepilot/.codepilot-media/` 目录下。如果在对话中生成,图片也会复制到项目目录的 `.codepilot-images/` 文件夹中。
+45 -17
View File
@@ -1,29 +1,57 @@
---
title: 快速开始
description: 开始使用 CodePilot — Claude Code 的原生桌面 GUI 客户端。
description: 开始使用 CodePilot — Claude Code 的桌面工作区。
---
# 快速开始
欢迎使用 CodePilot!本指南将帮助你快速上手。
CodePilot 是 Claude Code 的桌面工作区,把对话、服务商、MCP、技能、桥接和助理工作区整合到一个界面中。
## 什么是 CodePilot?
## 准备工作
CodePilot 是 Claude Code 的原生桌面 GUI 客户端,基于 Electron 和 Next.js 构建。
它提供了丰富的图形界面,用于与 Claude 交互、管理项目以及利用 AI 驱动的开发工具。
使用 CodePilot 之前,你需要:
## 快速上手
1. **Node.js 18+** — CodePilot 依赖 Node.js 运行 Claude Code CLI
2. **Claude Code CLI** — Anthropic 官方的命令行工具(首次启动时可自动安装)
3. **至少一个 API 密钥** — 来自 Anthropic、OpenRouter 或其他支持的服务商(详见[服务商配置](/zh/docs/providers)了解各服务商的获取和填写方式)
1. 从[下载页面](/zh/download)下载 CodePilot
2. 安装并启动应用
3. 在设置中配置你的 API 提供商
4. 开始新对话,与 Claude 一起编程!
## 安装与首次启动
## 功能特色
1. 从 [GitHub Releases](https://github.com/op7418/CodePilot/releases) 下载适合你平台的安装包([详细安装指南](/zh/docs/installation))
2. 安装并启动 CodePilot
3. 首次启动会进入**设置向导**,按提示完成:
- 检测并安装 Node.js(如未找到)
- 检测并安装 Claude Code CLI(如未找到)
- 配置至少一个 API 服务商
- **多提供商支持** — Anthropic、OpenAI、Google、AWS Bedrock
- **MCP 插件系统** — 通过 Model Context Protocol 插件扩展功能
- **消息桥接** — 连接 Discord、Telegram、飞书和 QQ
- **助手工作区** — 检查和管理 Claude 的工作环境
- **主题系统** — 可自定义的主题和视觉风格
- **图片生成** — 内置 AI 图片生成功能
## 界面概览
CodePilot 的主界面由左侧导航栏和右侧工作区组成:
| 导航项 | 功能 |
|--------|------|
| **对话** | 与 Claude 对话,支持代码 / 计划 / 问答三种模式 |
| **MCP** | 管理 MCP 服务器,为 Claude 接入外部工具 |
| **技能** | 浏览和管理技能(本地 + 市场) |
| **桥接** | 将对话桥接到 Telegram、Discord、飞书、QQ |
| **素材库** | 查看 Claude 生成的图片 |
| **设置** | 服务商、CLI 配置、用量统计、助理工作区 |
## 开始第一次对话
1. 点击左侧**对话**,进入对话页面
2. 在输入框中输入你的需求,按 Enter 发送
3. Claude 会以流式输出回复,过程中可以看到工具调用和文件操作
4. 使用输入框上方的模式切换器选择对话模式:
- **代码** — 默认模式,Claude 可以读写文件、执行命令
- **计划** — 规划模式,Claude 只分析和制定方案,不执行操作
- **问答** — 问答模式,Claude 只回答问题,不使用工具
## 下一步
- [安装指南](/zh/docs/installation) — 详细的安装与配置步骤
- [服务商配置](/zh/docs/providers) — 配置多个 LLM 服务商
- [MCP 插件](/zh/docs/mcp) — 通过 MCP 扩展 Claude 的能力
- [技能](/zh/docs/skills) — 使用和管理技能
- [消息桥接](/zh/docs/bridge) — 在手机上继续 Claude 对话
- [助理工作区](/zh/docs/assistant-workspace) — 管理项目上下文和 Claude 行为
+6 -6
View File
@@ -42,20 +42,20 @@ description: 如何在你的系统上安装和配置 CodePilot。
1. **检查 Node.js** — 如未找到,会提供自动安装
2. **检查 Claude Code CLI** — 如未找到,会通过 npm 安装
3. **打开设置向导** — 配置 API 提供商和偏好设置
3. **打开引导设置** — 配置 API 服务商和偏好设置
## 配置 API 提供商
## 配置 API 服务商
CodePilot 至少需要一个 API 提供商才能工作。前往**设置 > 提供商**添加:
CodePilot 至少需要一个 API 服务商才能工作。前往 **设置 > 服务商** 添加:
- **Anthropic** — 直接访问 Claude 模型
- **Custom API (OpenAI 兼容)** — 任何 OpenAI 兼容端点,包括本地 LLM
- **OpenRouter** — 通过 OpenRouter 访问多个模型提供商
- **OpenRouter** — 通过 OpenRouter 访问多个模型
- **AWS Bedrock** — 通过 AWS 使用 Claude
- **Google Vertex** — 通过 Google Cloud 使用 Claude/Gemini
输入 API 密钥并选择默认模型。你可以配置多个提供商并在它们之间切换。
输入 API 密钥并选择默认模型。你可以配置多个服务商并随时切换。
## 更新
CodePilot 内置自动更新功能。有新版本可用时,你会在应用中看到通知。也可以在**设置**的**通用**部分手动检查更新。
CodePilot 内置自动更新功能。有新版本可用时,你会在应用中看到通知。也可以在 **设置** 的 **通用** 部分手动检查更新。
+73
View File
@@ -0,0 +1,73 @@
---
title: MCP 插件
description: 通过 Model Context Protocol 为 Claude 接入外部工具。
---
# MCP 插件
[Model Context Protocol (MCP)](https://modelcontextprotocol.io) 是连接 AI 助手与外部工具的开放标准。CodePilot 内置 MCP 客户端,支持连接任意 MCP 服务器来扩展 Claude 的能力。
## 什么是 MCP?
MCP 服务器为 Claude 提供额外的工具,例如:
- **文件系统** — 读写文件、搜索目录
- **数据库** — 直接查询数据库
- **API 集成** — 连接 GitHub、Jira、Slack 等外部服务
- **开发工具** — 运行测试、代码检查、依赖管理
- **自定义工具** — 构建任何你需要的工具
## 管理 MCP 服务器
从侧边栏点击 **MCP** 进入管理页面。页面提供两种视图:
### 列表视图
以卡片形式展示所有已配置的 MCP 服务器,每个卡片显示:
- 服务器名称
- 运行状态(已连接 / 已断开 / 错误)
- 提供的工具列表
### JSON 编辑器
直接编辑 MCP 配置的 JSON 文件,适合批量配置或从其他工具导入配置。
## 添加 MCP 服务器
1. 在 MCP 页面点击 **添加服务器**
2. 填写配置:
- **名称** — 服务器的描述性名称
- **传输类型** — 选择连接方式:
- **stdio** — 本地进程,通过标准输入输出通信(最常用)
- **SSE** — 通过 Server-Sent Events 连接远程服务器
- **HTTP (Streamable)** — 通过 HTTP 流式连接
- **命令**(stdio 类型)— 启动服务器的命令,如 `npx @modelcontextprotocol/server-filesystem`
- **参数** — 命令行参数
- **URL**(SSE / HTTP 类型)— 远程服务器的地址
- **环境变量** — 服务器需要的环境变量(API 密钥等)
3. 保存后服务器会自动启动
## 使用 MCP 工具
MCP 服务器连接后,它提供的工具会自动对 Claude 可用。Claude 在处理你的请求时会根据需要调用这些工具。
你可以在 MCP 页面查看每个服务器提供的具体工具列表。
## 常用 MCP 服务器
| 服务器 | 用途 |
|--------|------|
| `@modelcontextprotocol/server-filesystem` | 文件系统访问 |
| `@modelcontextprotocol/server-github` | GitHub 集成 |
| `@modelcontextprotocol/server-slack` | Slack 集成 |
| `@anthropic-ai/mcp-server-fetch` | 网页抓取 |
更多 MCP 服务器可在 [MCP 官方仓库](https://github.com/modelcontextprotocol/servers) 和社区中找到。
## 故障排除
- **服务器无法连接** — 检查命令是否正确,所需的 npm 包是否已安装
- **工具未出现** — 尝试断开并重新连接服务器
- **权限错误** — 确保 MCP 服务器有权访问所需资源
- **SSE/HTTP 连接失败** — 检查 URL 是否正确,服务器是否正在运行
-57
View File
@@ -1,57 +0,0 @@
---
title: MCP 插件
description: 通过 Model Context Protocol 插件扩展 CodePilot 功能。
---
[Model Context Protocol (MCP)](https://modelcontextprotocol.io) 是一个用于连接 AI 助手与外部工具和数据源的开放标准。CodePilot 内置了对 MCP 服务器的支持。
## 什么是 MCP 插件?
MCP 插件让 Claude 能够使用超出默认能力的额外工具:
- **文件系统工具** — 读写文件、搜索目录
- **数据库访问** — 直接查询数据库
- **API 集成** — 连接外部服务(GitHub、Jira、Slack 等)
- **开发工具** — 运行测试、代码检查、管理依赖
- **自定义工具** — 为任何目的构建你自己的工具
## 管理插件
### 添加插件
1. 从侧边栏打开 **MCP**
2. 点击**添加 MCP 服务器**
3. 配置服务器:
- **名称** — 插件的描述性名称
- **命令** — 启动 MCP 服务器的命令(如 `npx @modelcontextprotocol/server-filesystem`)
- **参数** — 命令行参数
- **环境变量** — 所需的环境变量(API 密钥等)
4. 点击**保存**,插件将被启动
### 插件状态
每个插件会显示连接状态:
- **已连接** — 服务器正在运行,工具可用
- **已断开** — 服务器未运行
- **错误** — 服务器遇到错误(查看日志了解详情)
## 使用插件工具
插件连接后,其工具会自动在对话中对 Claude 可用。Claude 会在与你的请求相关时使用这些工具。
你可以在 **MCP** 页面中查看每个插件提供的可用工具。
## 常用 MCP 服务器
| 服务器 | 用途 |
|--------|------|
| `@modelcontextprotocol/server-filesystem` | 文件系统访问 |
| `@modelcontextprotocol/server-github` | GitHub 集成 |
| `@modelcontextprotocol/server-slack` | Slack 集成 |
| `@anthropic-ai/mcp-server-fetch` | 网页抓取 |
## 故障排除
- **插件无法连接**:检查命令是否正确,所需的 npm 包是否已安装
- **工具未出现**:尝试断开并重新连接插件
- **权限错误**:确保 MCP 服务器有权访问所需资源
+4
View File
@@ -4,10 +4,14 @@
"index",
"installation",
"---指南---",
"chat",
"providers",
"mcp",
"skills",
"bridge",
"assistant-workspace",
"design-agent",
"gallery",
"---帮助---",
"faq"
]
+155
View File
@@ -0,0 +1,155 @@
---
title: 服务商配置
description: 配置 LLM 服务商以驱动 CodePilot。
---
# 服务商配置
CodePilot 支持多种 LLM 服务商。你可以同时配置多个服务商,在不同对话中使用不同的模型。
## 认证方式概览
CodePilot 有两种获取 API 凭据的途径:
### 1. CLI 环境认证(自动检测)
如果你在 shell 环境中设置了 `ANTHROPIC_API_KEY` 环境变量,CodePilot 启动时会**自动检测**并作为内置服务商使用。
```bash
export ANTHROPIC_API_KEY="sk-ant-..."
```
> **注意:** 通过 `claude config set` 或 Claude Code 的 `/config` 命令切换的配置**不会被 CodePilot 识别**。CodePilot 只读取 shell 环境变量,不共享 Claude Code CLI 的内部配置。如果你在 CLI 中通过 `cc switch` 或类似方式切换了账号/密钥,需要在 CodePilot 的 **设置 > 服务商** 中重新手动配置对应的密钥。
> 修改环境变量后需要**重启 CodePilot** 才能生效。
### 2. 手动添加服务商
在 **设置 > 服务商** 中手动添加 API 密钥。这些凭据存储在 CodePilot 本地数据库中,与 CLI 环境相互独立。
适合需要使用多个服务商、或使用非 Anthropic 服务的场景。
### 优先级
当发送消息时,CodePilot 按以下顺序确定使用哪个服务商:
1. **对话指定** — 对话头部手动选择的服务商
2. **全局默认** — 在服务商列表中标记为"默认"的服务商
3. **环境变量** — 如果没有配置任何服务商,回退到 shell 环境中的凭据
## 支持的服务商
### Anthropic(官方)
直接连接 Anthropic API,使用 Claude 模型(Opus、Sonnet、Haiku)。
- **认证**:API 密钥
- **说明**:如果你只使用 Anthropic,通过 CLI 环境认证即可,无需手动添加
### Anthropic(第三方兼容)
连接兼容 Anthropic API 格式的第三方端点。
- **认证**:API 密钥 + 自定义基础 URL
- **模型映射**:部分第三方服务商要求使用自己的模型名称(而非 Anthropic 原始模型名)。如果遇到模型不可用的错误,点击配置表单底部的 **更多选项**,在 **模型名称** 字段中填写该服务商要求的模型标识符
### 国内服务商
CodePilot 内置了国内主流服务商的配置预设,选择后自动填充基础 URL 和默认模型:
| 服务商 | 说明 | 认证方式 |
|--------|------|----------|
| **智谱 GLM(国内版)** | 智谱 AI GLM 系列 | API 密钥 |
| **智谱 GLM(国际版)** | 智谱 AI 国际端点 | API 密钥 |
| **Kimi Coding Plan** | 月之暗面 Kimi 编程版 | Auth Token |
| **Moonshot** | 月之暗面 Moonshot API | API 密钥 |
| **MiniMax(国内版)** | MiniMax abab 系列 | API 密钥 |
| **MiniMax(国际版)** | MiniMax 国际端点 | API 密钥 |
| **火山引擎 Ark** | 字节跳动火山引擎 | Auth Token |
| **阿里云百炼 Coding Plan** | 阿里云通义系列 | API 密钥 |
> **Auth Token 类型**:Kimi Coding Plan 和火山引擎 Ark 使用 `ANTHROPIC_AUTH_TOKEN` 而非 `ANTHROPIC_API_KEY` 进行认证。在 CodePilot 中添加时,系统会自动处理认证方式,你只需填写对应平台提供的密钥。
### OpenRouter
通过 OpenRouter 统一接口访问多家模型服务商(Anthropic、OpenAI、Google、Meta 等)。
- **认证**:API 密钥
- **优势**:一个密钥访问多种模型,自动路由和故障转移
### AWS Bedrock
通过 AWS 基础设施使用 Claude。
- **认证**:环境变量方式,需要 `AWS_ACCESS_KEY_ID`、`AWS_SECRET_ACCESS_KEY`、`AWS_REGION`
- **说明**:在 CodePilot 中添加后,系统会读取你的 AWS 环境变量进行认证。不需要在界面中填写密钥。
### Google Vertex
通过 Google Cloud 使用 Claude 和 Gemini。
- **认证**:环境变量方式,需要 Google Cloud 服务账号凭证
- **说明**:与 Bedrock 类似,通过环境变量认证
### Google Gemini (Image)
Gemini 图片生成 API,供设计 Agent 使用。
- **认证**:API 密钥
- **说明**:这是专门用于图片生成的服务商,不用于文本对话
### Custom API(OpenAI 兼容)
任何兼容 OpenAI Chat Completions API 的端点。
- **认证**:API 密钥 + 基础 URL
- **用途**:接入本地模型(Ollama、LM Studio、vLLM)或其他第三方代理
### LiteLLM
统一代理,支持 100+ LLM 服务商。
- **认证**:API 密钥 + 基础 URL
## 添加服务商
1. 打开 **设置 > 服务商**
2. 点击 **添加服务商**
3. 选择服务商类型(或国内预设)
4. 填写凭据:
- **API 密钥类**:粘贴密钥
- **自定义端点**:还需填写基础 URL
- **环境变量类**(Bedrock / Vertex):确保环境变量已设置
5. 选择默认模型
6. 点击 **保存**
## 切换服务商
- 在对话头部的服务商选择器中选择
- 每个对话会记住所用的服务商
- 可以在对话中途切换,切换后的消息使用新服务商
- 在服务商列表中点击 **设为默认** 可设置全局默认
## 常见问题
### 已设置环境变量但 CodePilot 没有检测到
- 确认环境变量在 CodePilot 启动时的 shell 环境中可用
- 如果通过 `.zshrc` / `.bashrc` 设置,确保修改后**重启了 CodePilot**(不是刷新)
- macOS 通过 Launchpad 启动的应用可能不继承终端环境变量,建议从终端启动或使用手动添加服务商
### API 密钥有效但请求失败
- 检查账户是否有余额
- 检查密钥是否有模型访问权限
- 国内服务商检查网络是否可达对应 API 端点
- AWS Bedrock 检查 IAM 权限是否包含 `bedrock:InvokeModel`
### 切换服务商后对话异常
- 不同服务商的上下文窗口大小不同,切换后可能因上下文过长导致报错
- 部分服务商不支持 Claude Code 的所有功能(如工具使用),切换后某些操作可能不可用
### 如何使用本地模型
选择 **Custom API(OpenAI 兼容)** 类型,基础 URL 填写本地服务地址(如 `http://localhost:11434/v1`)。API 密钥可填任意值(本地服务通常不校验)。
@@ -1,77 +0,0 @@
---
title: 提供商配置
description: 配置 LLM 提供商以驱动你的 CodePilot 体验。
---
CodePilot 支持多个 LLM 提供商。你可以配置一个或多个提供商,随时在它们之间切换。
## 支持的提供商
| 提供商 | 说明 | 认证方式 |
|--------|------|----------|
| **Anthropic** | 直接访问 Claude 模型(Opus、Sonnet、Haiku) | API 密钥 |
| **Custom API (OpenAI 兼容)** | 任何 OpenAI 兼容端点,包括本地 LLM | API 密钥 + Base URL |
| **OpenRouter** | 通过 OpenRouter 访问多个模型提供商 | API 密钥 |
| **AWS Bedrock** | 通过 AWS 基础设施使用 Claude | AWS 凭证 |
| **Google Vertex** | 通过 Google Cloud 使用 Claude 和 Gemini | 服务账号 |
| **Google Gemini (Image)** | Gemini 图片生成 | API 密钥 |
| **LiteLLM** | 统一代理,支持 100+ LLM 提供商 | API 密钥 + Base URL |
另外还提供中国提供商预设:GLM、Kimi/Moonshot、MiniMax、火山引擎 Ark、阿里云百炼。
## 添加提供商
1. 打开**设置 > 提供商**
2. 点击**添加提供商**
3. 选择提供商类型
4. 输入凭证:
- API 密钥类型:粘贴你的 API 密钥
- AWS Bedrock:配置 AWS 区域和凭证
- Google Vertex:配置项目 ID 和区域
5. 选择默认模型
6. 点击**保存**
## 切换提供商
你可以随时切换活跃的提供商:
- 使用聊天头部的提供商选择器
- 每个对话会记住使用的提供商
- 支持在对话中途切换提供商
## 提供商特定功能
### Anthropic
- 支持**扩展思考**模式,用于复杂推理
- 带成本估算的 token 使用追踪
- 完整的 Claude Agent SDK 集成
### Custom API (OpenAI 兼容)
- 支持任何实现 OpenAI Chat Completions API 的端点
- 可用于本地 LLM(Ollama、LM Studio、vLLM 等)或第三方代理
- 通过自定义 Base URL 配置
### OpenRouter
- 通过单个 API 密钥访问 Anthropic、OpenAI、Google、Meta 等多家提供商的模型
- 自动模型路由和故障转移
### AWS Bedrock
- 使用现有的 AWS IAM 凭证
- 支持跨区域推理
- 如果已配置 AWS CLI,无需单独的 API 密钥
## 环境变量
提供商也可以通过环境变量配置。CodePilot 会自动读取你的 shell 环境:
```bash
# Anthropic(启动时自动检测)
export ANTHROPIC_API_KEY="sk-ant-..."
# AWS Bedrock(使用标准 AWS 环境变量)
export AWS_ACCESS_KEY_ID="..."
export AWS_SECRET_ACCESS_KEY="..."
export AWS_REGION="us-east-1"
```
CodePilot 启动时会自动检测 `ANTHROPIC_API_KEY` 环境变量。其他提供商请在设置的提供商界面中直接配置凭证。更新环境变量后需要重启 CodePilot 才能生效。
+51
View File
@@ -0,0 +1,51 @@
---
title: 技能
description: 使用技能扩展 Claude 的能力和工作流程。
---
# 技能
技能是可复用的提示模板和工具集合,用来扩展 Claude 在特定场景下的能力。你可以把技能理解为"技能包"— 给 Claude 加载不同的技能,它就能更好地处理特定类型的任务。
## 技能分类
CodePilot 中的技能分为三类:
### Global
全局技能,对所有对话生效。通常是基础能力增强,比如代码规范检查、文档生成模板等。
### Installed
已安装的技能,从技能市场下载或本地导入。可以按需启用或禁用。
### Plugins
来自 MCP 服务器的技能。当你连接 MCP 服务器后,服务器提供的技能会自动出现在这里。
## 管理技能
从侧边栏点击**技能**进入管理页面。
### 浏览技能市场
技能市场提供社区和官方发布的技能。你可以:
- 按分类浏览
- 搜索特定功能的技能
- 查看技能详情和使用说明
- 一键安装
### 本地技能
你也可以管理本地的技能文件:
- 查看已有的本地技能
- 启用或禁用特定技能
- 查看技能的具体内容和配置
## 在对话中使用
安装并启用的技能会自动在对话中生效。你也可以通过斜杠命令 `/` 手动触发特定的技能。
Claude 在处理任务时会根据上下文自动选择合适的技能来增强回复质量。