npm - ccman - Versions diffs - 3.0.13 → 3.0.15 - Mend

ccman 3.0.13 → 3.0.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/README.md CHANGED Viewed

@@ -1,371 +1,296 @@
 # ccman
-> Codex 和 Claude Code 的 API 服务商配置管理工具
+> Codex 和 Claude Code 的 API 服务商配置管理工具，一键切换 Codex 和 Claude Code 的 API 服务商配置。
-## ✨ 特性
+---
-- 🔄 **快速切换**：一键切换不同的 API 服务商
-- 📦 **预设模板**：内置 7 个常用服务商模板，只需填写 API Key
-- 🛠️ **灵活配置**：支持自定义服务商配置
-- 🔒 **安全存储**：API Key 只存储在本地，权限保护
+## ✨ 核心特性
+- 🔄 **一键切换**：一条命令切换服务商，自动修改配置文件
+- 📦 **内置预设**：7 个常用服务商模板，只需填写 API Key
+- 🛠️ **自定义配置**：支持添加任意第三方服务商
+- 🔐 **零破坏性**：只修改管理的字段，写入前备份，失败回滚
 - 🎯 **双工具支持**：同时管理 Codex 和 Claude Code
+- 📱 **双界面**：提供 CLI（命令行）和 Desktop（图形界面）
+- 🔁 **克隆功能**：快速复制配置，管理多个 API Key
+- ☁️ **WebDAV 同步**（可选）：同步配置到你自己的 WebDAV 服务器（iCloud/Dropbox）
+- 🔒 **无第三方上传**：不会上传到我们的服务器，配置权限 `0600`
+- 🎨 **交互式菜单**：无需记忆命令，跟随提示操作
-## 📦 安装
+---
-```bash
-npm install -g ccman
-```
+## 也许你不需要 ccman
-**系统要求**：Node.js >= 18.0.0
+ccman 的核心功能是自动化配置文件的切换：
-## 🚀 快速开始
+- **Codex**：自动修改 `~/.codex/config.toml` 和 `~/.codex/auth.json`
+- **Claude Code**：自动修改 `~/.claude/settings.json`
+- **备份机制**：写入前自动备份，失败时自动回滚
-### 管理 Codex 服务商
+如果你更喜欢手动编辑配置文件，或者只使用一个服务商从不切换，可能不需要这个工具。
-```bash
-# 1. 添加服务商（交互式）
-ccman cx add
+📖 更多信息：[GitHub 仓库](https://github.com/2ue/ccm) - 包含手动配置方式和详细对比分析
-# 2. 查看所有服务商
-ccman cx list
+---
-# 3. 切换服务商
-ccman cx use
-# 4. 查看当前服务商
-ccman cx current
-```
-### 管理 Claude Code 服务商
+## 安装
 ```bash
-# 1. 添加服务商（交互式）
-ccman cc add
+npm install -g ccman
+```
-# 2. 查看所有服务商
-ccman cc list
+**要求**：Node.js >= 18.0.0
-# 3. 切换服务商
-ccman cc use
+**Desktop 版本**：如果你更喜欢图形界面，可以从 [GitHub Releases](https://github.com/2ue/ccm/releases) 下载 Desktop 应用（macOS/Windows/Linux）。
-# 4. 查看当前服务商
-ccman cc current
-```
+---
-### 交互式菜单
+## 快速开始
-直接运行 `ccman` 进入交互式主菜单：
+### 查看帮助
 ```bash
-ccman         # 主菜单（选择 Codex 或 Claude Code）
-ccman cx      # Codex 菜单
-ccman cc      # Claude Code 菜单
-```
+$ ccman --help
-## 📚 命令详解
+Usage: ccman [options] [command]
-### Codex 命令（`ccman cx`）
+Codex/Claude Code API 服务商配置管理工具
-#### `ccman cx add`
+Options:
+  -V, --version   output the version number
+  -h, --help      display help for command
-添加新的 Codex 服务商。
+Commands:
+  cx              管理 Codex 服务商
+  cc              管理 Claude 服务商
+  sync            WebDAV 同步配置
+  help [command]  display help for command
+```
-**交互流程**：
+### 管理 Codex 服务商
 ```bash
-$ ccman cx add
-? 选择配置方式 ›
-❯ 使用预设模板
-  自定义配置
-# 选择 "使用预设模板"
-? 选择预设 ›
-❯ Anthropic Official
-  AnyRouter
-  PackyCode
-  CoordCode
-  88Code
-  BigModel
-  ModelScope
-# 填写信息
-? 服务商名称 › Anthropic Official
-? API Key › sk-ant-••••••••••••••••••••••
-✅ 添加成功！
-💡 切换到此服务商: ccman cx use "Anthropic Official"
+ccman cx           # 进入交互式菜单
+ccman cx add       # 添加服务商
+ccman cx use       # 切换服务商
+ccman cx list      # 查看所有服务商
 ```
-#### `ccman cx list`
-列出所有 Codex 服务商，`●` 表示当前使用的服务商。
+**示例输出**：
 ```bash
 $ ccman cx list
-📋 Codex 服务商列表 (共 2 个)
+📋 Codex 服务商 (2 个)
-● Anthropic Official
-  https://api.anthropic.com
+  ●  Anthropic Official [当前]
+     https://api.anthropic.com
-○ PackyCode
-  https://api.packycode.com
+  ○  88Code
+     https://www.88code.org/api
 ```
-#### `ccman cx use [name]`
-切换 Codex 服务商。如果不提供名称，会显示交互式选择器。
 ```bash
-# 交互式选择
-$ ccman cx use
-? 选择要使用的服务商 ›
-  Anthropic Official (当前)
-❯ PackyCode
+$ ccman cx current
-✅ 已切换到: PackyCode
+📍 当前 Codex 服务商
-# 直接指定名称
-$ ccman cx use PackyCode
-✅ 已切换到: PackyCode
+  Anthropic Official
+  ID: codex-1760178741529-hbgbad
+  URL: https://api.anthropic.com
+  最后使用: 2025/10/11 18:32:25
 ```
-**说明**：切换后会自动更新 `~/.codex/` 中的配置文件，无需重启 Codex。
-#### `ccman cx current`
-显示当前使用的 Codex 服务商。
+### 管理 Claude Code 服务商
 ```bash
-$ ccman cx current
-✅ 当前 Codex 服务商
-名称: PackyCode
-Base URL: https://api.packycode.com
-API Key: sk-••••••••••••••••••••••••••••••••
+ccman cc           # 进入交互式菜单
+ccman cc add       # 添加服务商
+ccman cc use       # 切换服务商
+ccman cc list      # 查看所有服务商
 ```
-#### `ccman cx edit [name]`
-编辑 Codex 服务商配置。
+**示例输出**：
 ```bash
-$ ccman cx edit
+$ ccman cc list
-? 选择要编辑的服务商 ›
-❯ Anthropic Official
-  PackyCode
+📋 Claude Code 服务商 (2 个)
-# 选择后可以修改
-? 服务商名称 › Anthropic Official
-? Base URL › https://api.anthropic.com
-? API Key › (留空保持不变)
+  ○  AnyRouter
+     https://anyrouter.top
-✅ 编辑成功！
+  ●  PackyCode [当前]
+     https://api.packycode.com
 ```
-#### `ccman cx remove [name]`
-删除 Codex 服务商。
 ```bash
-$ ccman cx remove
-? 选择要删除的服务商 ›
-  Anthropic Official (当前使用中)
-❯ PackyCode
+$ ccman cc current
-? 确认删除 "PackyCode"? › (y/N)
+📍 当前 Claude Code 服务商
-✅ 已删除: PackyCode
+  PackyCode
+  ID: claude-1760182672751-unh2bp
+  URL: https://api.packycode.com
+  最后使用: 2025/10/11 20:14:08
 ```
-#### `ccman cx clone [source]`
+---
-克隆 Codex 服务商配置（复制 Base URL，修改名称和 API Key）。
+## 完整命令
-```bash
-$ ccman cx clone
+| 命令 | 说明 |
+|------|------|
+| `ccman` | 主菜单（选择 Codex 或 Claude Code） |
+| `ccman cx` | Codex 交互式菜单 |
+| `ccman cx add` | 添加 Codex 服务商（支持预设模板和自定义） |
+| `ccman cx list` | 列出所有 Codex 服务商 |
+| `ccman cx use [name]` | 切换 Codex 服务商 |
+| `ccman cx current` | 查看当前 Codex 服务商 |
+| `ccman cx edit [name]` | 编辑 Codex 服务商 |
+| `ccman cx remove [name]` | 删除 Codex 服务商 |
+| `ccman cx clone [source]` | 克隆 Codex 服务商（复制配置，改名称和 Key） |
+| `ccman cc` | Claude Code 交互式菜单 |
+| `ccman cc add` | 添加 Claude Code 服务商 |
+| `ccman cc list` | 列出所有 Claude Code 服务商 |
+| `ccman cc use [name]` | 切换 Claude Code 服务商 |
+| `ccman cc current` | 查看当前 Claude Code 服务商 |
+| `ccman cc edit [name]` | 编辑 Claude Code 服务商 |
+| `ccman cc remove [name]` | 删除 Claude Code 服务商 |
+| `ccman cc clone [source]` | 克隆 Claude Code 服务商 |
+| `ccman sync` | WebDAV 同步配置（备份/恢复/合并） |
-? 选择要克隆的服务商 ›
-❯ Anthropic Official
-  PackyCode
+---
-? 新服务商名称 › Anthropic Test
-? API Key › sk-ant-test-••••••••••••••••••
+## 内置预设
-✅ 克隆成功！
-💡 切换到此服务商: ccman cx use "Anthropic Test"
-```
-**使用场景**：
-- 同一服务商有多个 API Key（测试/生产环境）
-- 快速创建类似配置的服务商
-### Claude Code 命令（`ccman cc`）
+添加服务商时可以选择"使用预设模板"，只需填写 API Key：
-Claude Code 的命令与 Codex 完全相同：
+| 预设名称 | Base URL |
+|---------|----------|
+| Anthropic Official | `https://api.anthropic.com` |
+| AnyRouter | `https://anyrouter.top` |
+| PackyCode | `https://api.packycode.com` |
+| CoordCode | `https://api.coordcode.com/api` |
+| 88Code | `https://www.88code.org/api` |
+| BigModel | `https://open.bigmodel.cn/api/anthropic` |
+| ModelScope | `https://api-inference.modelscope.cn/v1/chat/completions` |
-- `ccman cc add` - 添加服务商
-- `ccman cc list` - 列出服务商
-- `ccman cc use [name]` - 切换服务商
-- `ccman cc current` - 查看当前服务商
-- `ccman cc edit [name]` - 编辑服务商
-- `ccman cc remove [name]` - 删除服务商
-- `ccman cc clone [source]` - 克隆服务商
+也可以选择"自定义配置"，手动填写 Base URL。
-**说明**：切换后会自动更新 `~/.claude/settings.json`，无需重启 Claude Code。
+---
-## 🎨 内置预设模板
+## 完整使用示例
-两个工具都支持以下预设（只需填写 API Key）：
+### 场景 1：添加并切换服务商
-| 预设名称 | Base URL | 说明 |
-|---------|----------|------|
-| Anthropic Official | `https://api.anthropic.com` | Anthropic 官方 API |
-| AnyRouter | `https://anyrouter.top` | AnyRouter API 服务 |
-| PackyCode | `https://api.packycode.com` | PackyCode API 服务 |
-| CoordCode | `https://api.coordcode.com/api` | CoordCode API 服务 |
-| 88Code | `https://www.88code.org/api` | 88Code API 服务 |
-| BigModel | `https://open.bigmodel.cn/api/anthropic` | 智谱 BigModel API |
-| ModelScope | `https://api-inference.modelscope.cn/v1/chat/completions` | 阿里云 ModelScope API |
+```bash
+# 1. 查看当前列表
+$ ccman cx list
-## 💡 使用示例
+📋 Codex 服务商 (1 个)
-### 示例 1：添加并切换到新服务商
+  ●  Anthropic Official [当前]
+     https://api.anthropic.com
-```bash
-# 1. 添加 PackyCode
+# 2. 添加 PackyCode（交互式）
 $ ccman cx add
-# 选择 "使用预设模板" → "PackyCode" → 输入 API Key
+? 选择配置方式 › 使用预设模板
+? 选择预设 › PackyCode
+? 服务商名称 › PackyCode
+? API Key › ••••••••••••••••••••
+✅ 添加成功！
+💡 切换到此服务商: ccman cx use PackyCode
-# 2. 切换到 PackyCode
+# 3. 切换到 PackyCode
 $ ccman cx use PackyCode
 ✅ 已切换到: PackyCode
-# 3. 确认
+# 4. 确认当前服务商
 $ ccman cx current
-✅ 当前 Codex 服务商
-名称: PackyCode
+📍 当前 Codex 服务商
+  PackyCode
+  ID: codex-1760178741529-abc123
+  URL: https://api.packycode.com
+  最后使用: 2025/10/11 18:32:25
 ```
-### 示例 2：管理多个 API Key
+### 场景 2：克隆服务商（管理多个 Key）
 ```bash
-# 场景：同一服务商有测试和生产两个 API Key
 # 1. 添加生产配置
 $ ccman cc add
-# 名称: Claude Production
-# API Key: sk-ant-prod-xxx
+? 选择配置方式 › 自定义配置
+? 服务商名称 › Claude Production
+? Base URL › https://api.anthropic.com
+? API Key › ••••••••••••••••••••
+✅ 添加成功！
 # 2. 克隆创建测试配置
 $ ccman cc clone
-# 选择 "Claude Production"
-# 新名称: Claude Test
-# API Key: sk-ant-test-xxx
+? 选择要克隆的服务商 › Claude Production
+? 新服务商名称 › Claude Test
+? API Key › ••••••••••••••••••••
+✅ 克隆成功！
+💡 切换到此服务商: ccman cc use "Claude Test"
 # 3. 查看列表
 $ ccman cc list
-📋 Claude Code 服务商列表 (共 2 个)
-● Claude Production (当前)
-○ Claude Test
-# 4. 快速切换
-$ ccman cc use "Claude Test"
-✅ 已切换到: Claude Test
-```
+📋 Claude Code 服务商 (2 个)
-### 示例 3：自定义服务商配置
+  ●  Claude Production [当前]
+     https://api.anthropic.com
-```bash
-$ ccman cx add
-? 选择配置方式 › 自定义配置
-? 服务商名称 › My Custom Provider
-? Base URL › https://api.example.com/v1
-? API Key › my-secret-key
-✅ 添加成功！
-```
+  ○  Claude Test
+     https://api.anthropic.com
-## 📂 配置文件
-### ccman 配置
-**位置**：`~/.ccman/config.json`
-**结构**：
-```json
-{
-  "providers": [
-    {
-      "id": "codex-1234567890-abc123",
-      "name": "PackyCode",
-      "type": "codex",
-      "baseUrl": "https://api.packycode.com",
-      "apiKey": "sk-xxx",
-      "createdAt": 1234567890000,
-      "lastUsedAt": 1234567900000
-    }
-  ],
-  "currentCodexProvider": "codex-1234567890-abc123",
-  "currentClaudeProvider": null
-}
+# 4. 快速切换
+$ ccman cc use "Claude Test"
+✅ 已切换到: Claude Test
 ```
-### Codex 配置
-ccman 会自动修改以下文件：
-- `~/.codex/config.toml` - Codex 主配置
-- `~/.codex/auth.json` - 认证信息
-### Claude Code 配置
-ccman 会自动修改以下文件：
-- `~/.claude/settings.json` - Claude Code 设置（只修改 `env.ANTHROPIC_AUTH_TOKEN` 和 `env.ANTHROPIC_BASE_URL`，不影响其他配置）
-## 🔒 安全性
-- ✅ API Key 只存储在本地，不会联网上传
-- ✅ 配置文件设置为 `0600` 权限（仅当前用户可读写）
-- ✅ 终端输入 API Key 时自动隐藏（显示为 `••••`）
-- ✅ 列表显示时 API Key 自动脱敏
+---
-## ❓ 常见问题
+## 配置文件
-### Q: 如何切换回之前的服务商？
+**ccman 配置**：`~/.ccman/config.json`
-A: 使用 `ccman cx use` 或 `ccman cc use` 选择之前的服务商即可。
+**Codex 配置**（ccman 会自动修改）：
+- `~/.codex/config.toml`
+- `~/.codex/auth.json`
-### Q: 删除服务商后还能恢复吗？
+**Claude Code 配置**（ccman 会自动修改）：
+- `~/.claude/settings.json`
-A: 不能。删除操作不可逆，建议删除前确认。
+**零破坏性承诺**：
+- 只修改管理的字段，保留其他所有配置
+- 写入前备份，失败时自动回滚
+- API Key 存储在本地，权限 `0600`
-### Q: 可以同时使用 CLI 和 Desktop 吗？
+---
-A: 可以。未来会推出 Desktop 应用，CLI 和 Desktop 共享同一套配置文件（`~/.ccman/`），修改会实时同步。
+## 常见问题
-### Q: 切换服务商后需要重启 Codex/Claude Code 吗？
+**Q: 支持配置导入/导出吗？**
+A: 当前版本不支持。如需备份，手动复制 `~/.ccman/` 目录。
-A: 不需要。ccman 会直接修改配置文件，工具会自动重新加载配置。
+**Q: WebDAV 同步是什么？**
+A: 将 ccman 配置同步到 WebDAV 服务器（如 iCloud/Dropbox），多设备共享配置。详见 `ccman sync --help`。
-### Q: 支持导入/导出配置吗？
+---
-A: 当前版本不支持。如需备份配置，可以手动复制 `~/.ccman/` 目录。
+## 许可证
-## 📄 许可证
+MIT
-MIT © [2ue](https://github.com/2ue)
+---
-## 🔗 相关链接
+## 相关链接
 - [GitHub 仓库](https://github.com/2ue/ccm)
 - [问题反馈](https://github.com/2ue/ccm/issues)
 - [更新日志](https://github.com/2ue/ccm/blob/main/CHANGELOG.md)
+- [Desktop 版本](https://github.com/2ue/ccm/releases)（图形界面）