openclawapi 1.0.0

package/README.md

@@ -0,0 +1,328 @@
+# OpenClaw Config Manager
+
+🔧 跨平台 OpenClaw/Clawdbot 配置管理工具
+
+一个交互式命令行工具，用于管理 OpenClaw 的中转站配置、模型切换、API Keys 等设置。
+
+## 特性
+
+- ✅ **跨平台支持**: macOS、Linux、Windows 通用
+- 🔄 **中转站管理**: 添加、编辑、删除、切换中转站
+- 🤖 **模型配置**: 主模型切换、备用模型管理
+- 🔑 **API Key 管理**: 安全地添加、查看、删除 API Keys
+- ⚙️ **高级设置**: 并发数、工作区路径等配置
+- 📋 **配置查看**: 一键查看当前完整配置
+- 🎨 **友好界面**: 彩色交互式菜单
+
+## 安装
+
+### 方式 1: 使用 npx (推荐)
+
+无需安装，直接运行：
+
+```bash
+npx /Users/mx/Documents/自动化/OpenClaw/openclaw-config-manager
+```
+
+### 方式 2: 全局安装
+
+```bash
+cd /Users/mx/Documents/自动化/OpenClaw/openclaw-config-manager
+npm install -g .
+```
+
+然后运行：
+
+```bash
+openclaw-config
+```
+
+### 方式 3: 本地运行
+
+```bash
+cd /Users/mx/Documents/自动化/OpenClaw/openclaw-config-manager
+npm install
+npm start
+```
+
+## 前置要求
+
+- Node.js >= 14.0.0
+- 已安装并初始化 clawdbot (`clawdbot onboard`)
+
+## 使用指南
+
+### 启动工具
+
+```bash
+npx /Users/mx/Documents/自动化/OpenClaw/openclaw-config-manager
+```
+
+### 主菜单
+
+```
+🔧 OpenClaw 配置管理工具
+
+? 请选择操作:
+  📡 管理中转站配置
+  🤖 管理模型配置
+  🔑 管理 API Keys
+  ⚙️  高级设置
+  📄 查看当前配置
+  ❌ 退出
+```
+
+### 1. 管理中转站配置
+
+#### 添加新中转站
+
+1. 选择 "📡 管理中转站配置" → "➕ 添加新中转站"
+2. 输入中转站名称（例如：`claude-relay-1`）
+3. 输入 Base URL（例如：`https://yunyi.cfd/claude/v1`）
+4. 选择模型类型（Claude / GPT / Gemini / 其他）
+5. 选择或输入模型 ID
+6. 设置上下文窗口大小（默认 200000）
+7. 设置最大输出 tokens（默认 8192）
+
+**示例配置：**
+
+```
+中转站名称: claude-relay-1
+Base URL: https://yunyi.cfd/claude/v1
+模型类型: Claude (Anthropic)
+模型: Claude Sonnet 4.5
+上下文窗口: 200000
+最大输出: 8192
+```
+
+#### 编辑中转站
+
+修改现有中转站的 URL、上下文窗口、最大输出等设置。
+
+#### 删除中转站
+
+删除不再使用的中转站配置（会同时删除相关的 API Key）。
+
+#### 切换主中转站
+
+快速切换当前使用的主中转站。
+
+### 2. 管理模型配置
+
+#### 切换主模型
+
+从所有已配置的中转站中选择一个作为主模型。
+
+#### 管理备用模型
+
+选择多个备用模型，按优先级排序。当主模型不可用时，系统会自动切换到备用模型。
+
+### 3. 管理 API Keys
+
+#### 添加/更新 API Key
+
+1. 选择中转站
+2. 输入 API Key（输入时会隐藏显示）
+3. 自动保存到 `~/.clawdbot/agents/main/agent/auth-profiles.json`
+
+#### 查看已配置的 Keys
+
+显示所有已配置的 API Keys（部分隐藏显示，例如：`sk-abc123...xyz789`）
+
+#### 删除 API Key
+
+删除指定中转站的 API Key。
+
+### 4. 高级设置
+
+配置系统级参数：
+
+- **最大并发任务数**: 同时运行的任务数量（默认 4）
+- **子代理最大并发数**: 子代理的并发数量（默认 8）
+- **工作区路径**: OpenClaw 工作区目录
+
+### 5. 查看当前配置
+
+显示完整的当前配置，包括：
+
+- 主模型
+- 备用模型列表
+- 所有中转站详情
+- 高级设置
+
+## 配置文件位置
+
+### macOS / Linux
+
+- 主配置: `~/.clawdbot/openclaw.json`
+- API Keys: `~/.clawdbot/agents/main/agent/auth-profiles.json`
+
+### Windows
+
+- 主配置: `C:\Users\<用户名>\.clawdbot\openclaw.json`
+- API Keys: `C:\Users\<用户名>\.clawdbot\agents\main\agent\auth-profiles.json`
+
+## 常见使用场景
+
+### 场景 1: 添加 Claude 中转站
+
+```bash
+# 运行工具
+npx /Users/mx/Documents/自动化/OpenClaw/openclaw-config-manager
+
+# 选择: 📡 管理中转站配置 → ➕ 添加新中转站
+# 输入:
+#   名称: claude-relay-1
+#   URL: https://yunyi.cfd/claude/v1
+#   模型: Claude Sonnet 4.5
+#   上下文: 200000
+#   最大输出: 8192
+
+# 然后: 🔑 管理 API Keys → ➕ 添加/更新 API Key
+# 选择: claude-relay-1
+# 输入: sk-your-api-key-here
+```
+
+### 场景 2: 配置主备中转站
+
+```bash
+# 1. 添加主中转站
+#    名称: claude-main
+#    URL: https://yunyi.cfd/claude/v1
+
+# 2. 添加备用中转站
+#    名称: claude-backup
+#    URL: https://yunyi.skem.cn/claude/v1
+
+# 3. 设置主模型
+#    选择: 🤖 管理模型配置 → 🔄 切换主模型
+#    选择: claude-main
+
+# 4. 设置备用模型
+#    选择: 🤖 管理模型配置 → 📋 管理备用模型
+#    勾选: claude-backup
+```
+
+### 场景 3: 切换到不同的模型
+
+```bash
+# 选择: 🤖 管理模型配置 → 🔄 切换主模型
+# 从列表中选择新的模型
+```
+
+## 验证配置
+
+配置完成后，运行以下命令验证：
+
+```bash
+# 检查配置
+clawdbot doctor
+
+# 启动服务
+clawdbot gateway
+```
+
+## 故障排除
+
+### 问题 1: 找不到配置文件
+
+**错误**: `配置文件不存在: ~/.clawdbot/openclaw.json`
+
+**解决**: 先运行 `clawdbot onboard` 初始化配置
+
+### 问题 2: 权限错误
+
+**错误**: `EACCES: permission denied`
+
+**解决**:
+```bash
+# macOS/Linux
+chmod 755 ~/.clawdbot
+
+# 或使用 sudo
+sudo npx /Users/mx/Documents/自动化/OpenClaw/openclaw-config-manager
+```
+
+### 问题 3: Node.js 版本过低
+
+**错误**: `Requires Node.js >= 14.0.0`
+
+**解决**: 升级 Node.js
+```bash
+# 使用 nvm
+nvm install 18
+nvm use 18
+```
+
+## 技术栈
+
+- **inquirer**: 交互式命令行界面
+- **chalk**: 彩色终端输出
+- **fs-extra**: 增强的文件系统操作
+
+## 开发
+
+### 项目结构
+
+```
+openclaw-config-manager/
+├── package.json          # 项目配置
+├── cli.js               # 主程序入口
+├── lib/
+│   ├── config-manager.js # 配置文件管理
+│   └── ui.js            # 界面工具函数
+└── README.md            # 使用文档
+```
+
+### 本地开发
+
+```bash
+cd /Users/mx/Documents/自动化/OpenClaw/openclaw-config-manager
+npm install
+node cli.js
+```
+
+### 调试
+
+```bash
+# 查看配置文件
+cat ~/.clawdbot/openclaw.json
+
+# 查看 API Keys
+cat ~/.clawdbot/agents/main/agent/auth-profiles.json
+
+# 备份配置
+cp ~/.clawdbot/openclaw.json ~/.clawdbot/openclaw.json.backup
+```
+
+## 安全提示
+
+- ⚠️ API Keys 以明文存储在 `auth-profiles.json` 中
+- ⚠️ 不要将 `auth-profiles.json` 提交到版本控制
+- ⚠️ 定期更换 API Keys
+- ⚠️ 使用 `chmod 600` 限制文件权限
+
+```bash
+chmod 600 ~/.clawdbot/agents/main/agent/auth-profiles.json
+```
+
+## 许可证
+
+MIT
+
+## 支持
+
+如有问题，请查看：
+- [OpenClaw 文档](../docs/OPENCLAW.md)
+- [Clawdbot 官方文档](https://yunwu.apifox.cn/)
+
+## 更新日志
+
+### v1.0.0 (2026-02-01)
+
+- ✅ 初始版本发布
+- ✅ 支持中转站管理
+- ✅ 支持模型配置
+- ✅ 支持 API Key 管理
+- ✅ 支持高级设置
+- ✅ 跨平台支持（macOS/Linux/Windows）