mirror of
https://github.com/farion1231/cc-switch.git
synced 2026-04-26 12:22:43 +08:00
docs: restructure user manual for i18n and add EN/JA translations
Reorganize docs/user-manual/ from flat structure to language subdirectories (zh/, en/, ja/) with shared assets/. Move existing Chinese docs into zh/, fix image paths, add multilingual navigation README, and translate all 23 markdown files (~4500 lines each) to English and Japanese.
This commit is contained in:
Jason
209
docs/user-manual/zh/3-extensions/3.1-mcp.md
Normal file
209
docs/user-manual/zh/3-extensions/3.1-mcp.md
Normal file
@@ -0,0 +1,209 @@
|
||||
# 3.1 MCP 服务器管理
|
||||
|
||||
## 什么是 MCP
|
||||
|
||||
MCP (Model Context Protocol) 是一种协议，允许 AI 工具访问外部数据源和工具。通过 MCP 服务器，你可以让 AI：
|
||||
|
||||
- 访问文件系统
|
||||
- 执行网络请求
|
||||
- 查询数据库
|
||||
- 调用外部 API
|
||||
|
||||
## 打开 MCP 面板
|
||||
|
||||
点击顶部导航栏的 **MCP** 按钮。
|
||||
|
||||
## 面板概览
|
||||
|
||||
|
||||
|
||||
## 添加 MCP 服务器
|
||||
|
||||
### 使用预设模板
|
||||
|
||||
1. 点击右上角 **+** 按钮
|
||||
2. 在「预设」下拉框中选择模板
|
||||
3. 根据需要修改配置
|
||||
4. 点击「保存」
|
||||
|
||||
|
||||
|
||||
### 常用预设
|
||||
|
||||
| 预设 | 包名 | 功能说明 |
|
||||
|------|------|----------|
|
||||
| fetch | mcp-server-fetch | HTTP 请求工具，让 AI 能够获取网页内容 |
|
||||
| time | @modelcontextprotocol/server-time | 时间工具，提供当前时间信息 |
|
||||
| memory | @modelcontextprotocol/server-memory | 记忆工具，让 AI 能够存储和检索信息 |
|
||||
| sequential-thinking | @modelcontextprotocol/server-sequential-thinking | 思维链工具，增强 AI 推理能力 |
|
||||
| context7 | @upstash/context7-mcp | 文档搜索工具，查询技术文档 |
|
||||
|
||||
### 自定义配置
|
||||
|
||||
选择「自定义」后，需要填写：
|
||||
|
||||
| 字段 | 必填 | 说明 |
|
||||
|------|------|------|
|
||||
| 服务器 ID | 是 | 唯一标识符 |
|
||||
| 名称 | 否 | 显示名称 |
|
||||
| 描述 | 否 | 功能说明 |
|
||||
| 传输类型 | 是 | stdio / http / sse |
|
||||
| 命令 | 是* | stdio 类型必填 |
|
||||
| 参数 | 否 | 命令行参数 |
|
||||
| URL | 是* | http/sse 类型必填 |
|
||||
| Headers | 否 | http/sse 类型的请求头 |
|
||||
| 环境变量 | 否 | 传递给服务器的环境变量 |
|
||||
|
||||
## 传输类型
|
||||
|
||||
### stdio（标准输入输出）
|
||||
|
||||
最常用的类型，通过启动本地进程通信。
|
||||
|
||||
```json
|
||||
{
|
||||
"command": "uvx",
|
||||
"args": ["mcp-server-fetch"],
|
||||
"env": {}
|
||||
}
|
||||
```
|
||||
|
||||
**要求**：
|
||||
- 需要安装对应的命令（如 `uvx`、`npx`）
|
||||
- 服务器程序需要在 PATH 中
|
||||
|
||||
### http
|
||||
|
||||
通过 HTTP 协议与远程服务器通信。
|
||||
|
||||
```json
|
||||
{
|
||||
"url": "http://localhost:8080/mcp"
|
||||
}
|
||||
```
|
||||
|
||||
### sse（Server-Sent Events）
|
||||
|
||||
通过 SSE 协议与服务器通信，支持实时推送。
|
||||
|
||||
```json
|
||||
{
|
||||
"url": "http://localhost:8080/sse"
|
||||
}
|
||||
```
|
||||
|
||||
## 应用绑定
|
||||
|
||||
每个 MCP 服务器可以独立控制启用的应用。
|
||||
|
||||
### 开关说明
|
||||
|
||||
| 开关 | 作用 | 配置文件路径 |
|
||||
|------|------|--------------|
|
||||
| Claude | 同步到 Claude Code | `~/.claude.json` 的 `mcpServers` |
|
||||
| Codex | 同步到 Codex | `~/.codex/config.toml` 的 `[mcp_servers]` |
|
||||
| Gemini | 同步到 Gemini CLI | `~/.gemini/settings.json` 的 `mcpServers` |
|
||||
| OpenCode | 同步到 OpenCode | `~/.opencode/config.json` 的 `mcpServers` |
|
||||
|
||||
> ⚠️ **注意**：OpenClaw 暂不支持 MCP 服务器管理。MCP 功能目前仅支持 Claude、Codex、Gemini 和 OpenCode 四个应用。
|
||||
|
||||
### 开关实现机制
|
||||
|
||||
当开启某个应用的开关时，CC Switch 会：
|
||||
|
||||
1. **更新数据库**：将服务器的 `apps.claude/codex/gemini/opencode` 状态设为 `true`
|
||||
2. **同步到 Live 配置**：将服务器配置写入对应应用的配置文件
|
||||
3. **即时生效**：下次启动 CLI 工具时自动加载新的 MCP 服务器
|
||||
|
||||
当关闭某个应用的开关时，CC Switch 会：
|
||||
|
||||
1. **更新数据库**：将对应应用状态设为 `false`
|
||||
2. **从 Live 配置移除**：从应用配置文件中删除该服务器
|
||||
3. **即时生效**：下次启动 CLI 工具时不再加载该 MCP 服务器
|
||||
|
||||
### 同步条件
|
||||
|
||||
MCP 服务器同步仅在对应应用已安装时执行：
|
||||
|
||||
- **Claude**：需存在 `~/.claude/` 目录或 `~/.claude.json` 文件
|
||||
- **Codex**：需存在 `~/.codex/` 目录
|
||||
- **Gemini**：需存在 `~/.gemini/` 目录
|
||||
- **OpenCode**：需存在 `~/.opencode/` 目录
|
||||
|
||||
> 💡 **提示**：如果某个 CLI 工具未安装，开启对应开关不会报错，但配置不会写入。
|
||||
|
||||
关闭开关后，配置会从文件中移除。
|
||||
|
||||
## 编辑服务器
|
||||
|
||||
1. 点击服务器行右侧的「编辑」按钮
|
||||
2. 修改配置
|
||||
3. 点击「保存」
|
||||
|
||||
修改会立即同步到已启用的应用配置文件。
|
||||
|
||||
## 删除服务器
|
||||
|
||||
1. 点击服务器行右侧的「删除」按钮
|
||||
2. 确认删除
|
||||
|
||||
删除后，配置会从所有应用的配置文件中移除。
|
||||
|
||||
## 导入现有配置
|
||||
|
||||
如果你已经在 CLI 工具中配置了 MCP 服务器，可以导入到 CC Switch：
|
||||
|
||||
1. 点击「导入」按钮
|
||||
2. 选择要导入的应用（Claude/Codex/Gemini/OpenCode）
|
||||
3. CC Switch 会读取现有配置并导入
|
||||
|
||||
## 配置文件格式
|
||||
|
||||
### Claude (`~/.claude.json`)
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"mcp-fetch": {
|
||||
"command": "uvx",
|
||||
"args": ["mcp-server-fetch"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Codex (`~/.codex/config.toml`)
|
||||
|
||||
```toml
|
||||
[mcp_servers.mcp-fetch]
|
||||
command = "uvx"
|
||||
args = ["mcp-server-fetch"]
|
||||
```
|
||||
|
||||
### Gemini (`~/.gemini/settings.json`)
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"mcp-fetch": {
|
||||
"command": "uvx",
|
||||
"args": ["mcp-server-fetch"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 常见问题
|
||||
|
||||
### 服务器启动失败
|
||||
|
||||
检查：
|
||||
- 命令是否正确安装（如 `uvx`）
|
||||
- 命令是否在 PATH 中
|
||||
- 参数是否正确
|
||||
|
||||
### 配置不生效
|
||||
|
||||
确保：
|
||||
- 对应应用的开关已开启
|
||||
- 重启了 CLI 工具
|
||||
160
docs/user-manual/zh/3-extensions/3.2-prompts.md
Normal file
160
docs/user-manual/zh/3-extensions/3.2-prompts.md
Normal file
@@ -0,0 +1,160 @@
|
||||
# 3.2 Prompts 提示词管理
|
||||
|
||||
## 功能说明
|
||||
|
||||
Prompts 功能用于管理系统提示词预设。系统提示词会影响 AI 的行为和回复风格。
|
||||
|
||||
通过 CC Switch，你可以：
|
||||
|
||||
- 创建多个提示词预设
|
||||
- 快速切换不同场景的提示词
|
||||
- 跨设备同步提示词配置
|
||||
|
||||
## 打开 Prompts 面板
|
||||
|
||||
点击顶部导航栏的 **Prompts** 按钮。
|
||||
|
||||
## 面板概览
|
||||
|
||||
|
||||
|
||||
## 创建预设
|
||||
|
||||
### 操作步骤
|
||||
|
||||
1. 点击右上角 **+** 按钮
|
||||
2. 输入预设名称
|
||||
3. 在 Markdown 编辑器中编写提示词
|
||||
4. 点击「保存」
|
||||
|
||||
### Markdown 编辑器
|
||||
|
||||
编辑器提供：
|
||||
|
||||
- 语法高亮
|
||||
- 实时预览
|
||||
- 常用格式快捷键
|
||||
|
||||
### 提示词编写建议
|
||||
|
||||
**结构化格式**：
|
||||
|
||||
```markdown
|
||||
# 角色定义
|
||||
|
||||
你是一个专业的代码审查专家。
|
||||
|
||||
## 核心能力
|
||||
|
||||
- 代码质量分析
|
||||
- 性能优化建议
|
||||
- 安全漏洞检测
|
||||
|
||||
## 回复风格
|
||||
|
||||
- 简洁明了
|
||||
- 提供具体示例
|
||||
- 给出改进建议
|
||||
|
||||
## 注意事项
|
||||
|
||||
- 不要修改业务逻辑
|
||||
- 保持代码风格一致
|
||||
```
|
||||
|
||||
## 激活预设
|
||||
|
||||
### 操作方式
|
||||
|
||||
点击预设项的开关按钮，切换启用状态。
|
||||
|
||||
### 单一激活
|
||||
|
||||
同一时间只能激活一个预设。激活新预设时，之前的预设会自动停用。
|
||||
|
||||
### 同步目标
|
||||
|
||||
激活后，提示词会写入对应应用的文件：
|
||||
|
||||
| 应用 | 文件路径 |
|
||||
|------|----------|
|
||||
| Claude | `~/.claude/CLAUDE.md` |
|
||||
| Codex | `~/.codex/AGENTS.md` |
|
||||
| Gemini | `~/.gemini/GEMINI.md` |
|
||||
| OpenCode | `~/.opencode/AGENTS.md` |
|
||||
| OpenClaw | `~/.openclaw/AGENTS.md` |
|
||||
|
||||
## 编辑预设
|
||||
|
||||
1. 点击预设项的「编辑」按钮
|
||||
2. 修改名称或内容
|
||||
3. 点击「保存」
|
||||
|
||||
如果编辑的是当前激活的预设，保存后会立即同步到配置文件。
|
||||
|
||||
## 删除预设
|
||||
|
||||
1. 点击预设项的「删除」按钮
|
||||
2. 确认删除
|
||||
|
||||
已启用的预设不允许删除，需先停用后再删除。
|
||||
|
||||
## 智能回填
|
||||
|
||||
CC Switch 提供智能回填保护机制，确保你的手动修改不会丢失。
|
||||
|
||||
### 工作原理
|
||||
|
||||
1. 切换预设前，自动读取当前配置文件内容
|
||||
2. 比较文件内容与数据库中的预设
|
||||
3. 如果内容不同，说明用户手动修改过
|
||||
4. 将手动修改的内容保存到当前预设
|
||||
5. 然后再切换到新预设
|
||||
|
||||
### 保护场景
|
||||
|
||||
| 场景 | 处理方式 |
|
||||
|------|----------|
|
||||
| CLI 中直接编辑 `CLAUDE.md` | 修改自动保存到当前预设 |
|
||||
| 外部编辑器修改配置文件 | 修改自动保存到当前预设 |
|
||||
| 切换到其他预设 | 先保存当前修改，再切换 |
|
||||
|
||||
### 技术细节
|
||||
|
||||
回填机制在以下时机触发：
|
||||
|
||||
- **切换预设时**：保存当前 live 文件内容到当前预设
|
||||
- **编辑当前预设时**：从 live 文件读取最新内容
|
||||
- **首次启动时**：自动导入现有 live 文件内容
|
||||
|
||||
### 注意事项
|
||||
|
||||
- 回填仅在切换到不同预设时触发
|
||||
- 如果当前没有激活的预设，不会触发回填
|
||||
- 回填失败不会影响切换流程
|
||||
|
||||
## 跨应用使用
|
||||
|
||||
Prompts 是按应用分开管理的：
|
||||
|
||||
- 切换到 Claude 时，显示 Claude 的预设
|
||||
- 切换到 Codex 时，显示 Codex 的预设
|
||||
- 切换到 Gemini 时，显示 Gemini 的预设
|
||||
- 切换到 OpenCode 时，显示 OpenCode 的预设
|
||||
- 切换到 OpenClaw 时，显示 OpenClaw 的预设
|
||||
|
||||
如需在多个应用使用相同的提示词，需要分别创建。
|
||||
|
||||
## 导入导出
|
||||
|
||||
### 通过深度链接分享
|
||||
|
||||
可以生成深度链接分享预设：
|
||||
|
||||
```
|
||||
ccswitch://import/prompt?data=<base64编码的预设>
|
||||
```
|
||||
|
||||
### 通过配置导出
|
||||
|
||||
导出配置时会包含所有预设，导入后可恢复。
|
||||
207
docs/user-manual/zh/3-extensions/3.3-skills.md
Normal file
207
docs/user-manual/zh/3-extensions/3.3-skills.md
Normal file
@@ -0,0 +1,207 @@
|
||||
# 3.3 Skills 技能管理
|
||||
|
||||
## 功能说明
|
||||
|
||||
Skills 是可复用的能力扩展，让 AI 工具获得特定领域的专业能力。
|
||||
|
||||
技能以文件夹形式存在，包含：
|
||||
|
||||
- 提示词模板
|
||||
- 工具定义
|
||||
- 示例代码
|
||||
|
||||
## 支持的应用
|
||||
|
||||
Skills 功能支持所有四种应用：
|
||||
|
||||
- **Claude Code**
|
||||
- **Codex**
|
||||
- **Gemini CLI**
|
||||
- **OpenCode**
|
||||
|
||||
## 打开 Skills 页面
|
||||
|
||||
点击顶部导航栏的 **Skills** 按钮。
|
||||
|
||||
> 注意：Skills 按钮在所有应用模式下均可见。
|
||||
|
||||
## 页面概览
|
||||
|
||||
|
||||
|
||||
## 发现技能
|
||||
|
||||
### 预配置仓库
|
||||
|
||||
CC Switch 预配置了以下 GitHub 仓库：
|
||||
|
||||
| 仓库 | 说明 |
|
||||
| -------------- | ------------------------ |
|
||||
| Anthropic 官方 | Anthropic 提供的官方技能 |
|
||||
| ComposioHQ | 社区维护的技能集合 |
|
||||
| 社区精选 | 精选的高质量技能 |
|
||||
|
||||
|
||||
|
||||
### 搜索过滤
|
||||
|
||||
CC Switch 提供强大的搜索和过滤功能：
|
||||
|
||||
#### 搜索框
|
||||
|
||||
- 支持按技能名称搜索
|
||||
- 支持按技能描述搜索
|
||||
- 支持按目录名称搜索
|
||||
- 实时过滤，输入即搜索
|
||||
|
||||
#### 状态过滤
|
||||
|
||||
使用下拉菜单按安装状态过滤：
|
||||
|
||||
| 选项 | 说明 |
|
||||
| ------ | ------------------ |
|
||||
| 全部 | 显示所有技能 |
|
||||
| 已安装 | 仅显示已安装的技能 |
|
||||
| 未安装 | 仅显示未安装的技能 |
|
||||
|
||||
|
||||
|
||||
#### 组合使用
|
||||
|
||||
搜索和过滤可以组合使用：
|
||||
|
||||
- 先选择「已安装」过滤
|
||||
- 再输入关键词搜索
|
||||
- 结果显示匹配数量
|
||||
|
||||
### 刷新列表
|
||||
|
||||
点击「刷新」按钮重新扫描仓库，获取最新技能。
|
||||
|
||||
## 安装技能
|
||||
|
||||
### 操作步骤
|
||||
|
||||
1. 找到要安装的技能卡片
|
||||
2. 点击「安装」按钮
|
||||
3. 等待安装完成
|
||||
|
||||
### 安装位置
|
||||
|
||||
| 应用 | 安装目录 |
|
||||
| -------- | --------------------- |
|
||||
| Claude | `~/.claude/skills/` |
|
||||
| Codex | `~/.codex/skills/` |
|
||||
| Gemini | `~/.gemini/skills/` |
|
||||
| OpenCode | `~/.opencode/skills/` |
|
||||
|
||||
### 安装内容
|
||||
|
||||
安装会将技能文件夹复制到本地：
|
||||
|
||||
```
|
||||
~/.claude/skills/
|
||||
└── skill-name/
|
||||
├── README.md
|
||||
├── prompt.md
|
||||
└── tools/
|
||||
└── ...
|
||||
```
|
||||
|
||||
## 卸载技能
|
||||
|
||||
### 操作步骤
|
||||
|
||||
1. 找到已安装的技能卡片
|
||||
2. 点击「卸载」按钮
|
||||
3. 确认卸载
|
||||
|
||||
### 卸载效果
|
||||
|
||||
- 删除本地技能文件夹
|
||||
- 更新安装状态
|
||||
|
||||
## 仓库管理
|
||||
|
||||
### 打开仓库管理
|
||||
|
||||
点击页面顶部的「仓库管理」按钮。
|
||||
|
||||
### 添加自定义仓库
|
||||
|
||||
1. 点击「添加仓库」
|
||||
2. 填写仓库信息：
|
||||
- Owner：GitHub 用户名或组织名
|
||||
- Name：仓库名称
|
||||
- Branch：分支名（默认 main）
|
||||
- Subdirectory：技能所在子目录（可选）
|
||||
3. 点击「添加」
|
||||
|
||||
### 仓库格式
|
||||
|
||||
```
|
||||
https://github.com/{owner}/{name}/tree/{branch}/{subdirectory}
|
||||
```
|
||||
|
||||
示例：
|
||||
|
||||
```
|
||||
Owner: anthropics
|
||||
Name: claude-skills
|
||||
Branch: main
|
||||
Subdirectory: skills
|
||||
```
|
||||
|
||||
### 删除仓库
|
||||
|
||||
1. 在仓库列表中找到要删除的仓库
|
||||
2. 点击「删除」按钮
|
||||
3. 确认删除
|
||||
|
||||
删除仓库后，该仓库的技能不会从列表中消失，但无法再更新。
|
||||
|
||||
## 技能卡片信息
|
||||
|
||||
每个技能卡片显示：
|
||||
|
||||
| 信息 | 说明 |
|
||||
| ---- | --------------- |
|
||||
| 名称 | 技能名称 |
|
||||
| 描述 | 功能说明 |
|
||||
| 来源 | 所属仓库 |
|
||||
| 状态 | 已安装 / 未安装 |
|
||||
|
||||
## 技能更新
|
||||
|
||||
目前不支持自动更新。如需更新技能：
|
||||
|
||||
1. 卸载现有技能
|
||||
2. 刷新列表
|
||||
3. 重新安装
|
||||
|
||||
### 技能列表为空
|
||||
|
||||
可能原因：
|
||||
|
||||
- 网络问题，无法访问 GitHub
|
||||
- 仓库配置错误
|
||||
|
||||
解决方法：
|
||||
|
||||
- 检查网络连接
|
||||
- 点击「刷新」重试
|
||||
- 检查仓库配置
|
||||
|
||||
### 安装失败
|
||||
|
||||
可能原因：
|
||||
|
||||
- 网络问题
|
||||
- 磁盘空间不足
|
||||
- 权限问题
|
||||
|
||||
解决方法：
|
||||
|
||||
- 检查网络连接
|
||||
- 检查磁盘空间
|
||||
- 检查目录权限
|
||||
Reference in New Issue
Block a user