ccman 2.1.3 → 2.1.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 2ue
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,394 +1,294 @@
-# CCM - Claude Code Manager v2.0
+# CCM - Claude Code Manager
 
-A TypeScript-based command-line tool to manage multiple Claude Code API provider configurations with **direct settings.json integration** and **intelligent language support**.
+<div align="center">
 
-> **English Documentation** | [中文文档](./README_zh.md)
+[![npm version](https://img.shields.io/npm/v/ccman.svg)](https://www.npmjs.com/package/ccman)
+[![npm downloads](https://img.shields.io/npm/dm/ccman.svg)](https://www.npmjs.com/package/ccman)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js Version](https://img.shields.io/node/v/ccman.svg)](https://nodejs.org)
 
-## ✨ New in v2.0
+**智能管理 Claude Code API 配置的 TypeScript CLI 工具**
 
-🌍 **Intelligent Language Support** - Auto-detects system language or guides first-run setup  
-🔧 **Direct Claude Integration** - Modifies `~/.claude/settings.json` directly, no shell variables  
-📁 **Provider Management** - Store and switch between multiple API provider configurations  
-🎯 **Interactive Menu System** - Continuous operation support with navigation options  
-⚡ **Zero-Config Experience** - Works out of the box with smart defaults  
+🌍 多语言支持 · 🔧 直接配置集成 · 📁 多供应商管理 · ⚡ 零配置体验
 
-## 🚀 Quick Start
+**中文文档** | [English](./README_en.md)
 
-### Installation
+</div>
+
+---
+
+## ✨ 核心特性
+
+- **🌍 智能语言支持** - 自动检测系统语言,支持中英文无缝切换
+- **🔧 直接配置集成** - 直接修改 `~/.claude/settings.json`,无需 Shell 集成
+- **📁 多供应商管理** - 在不同 API 供应商间快速切换(Anthropic 官方、第三方等)
+- **🎯 交互式菜单** - 友好的命令行交互界面,支持连续操作
+- **⚡ 零配置体验** - 开箱即用,智能默认配置
+- **🔒 安全可靠** - 自动备份,选择性配置更新,保护用户数据
+
+## 🚀 快速开始
+
+### 安装方式
+
+#### 方式 1: npm 安装 (推荐)
 
 ```bash
-# Install from NPM
+# 全局安装
 npm install -g ccman
 
-# Or install dependencies for development
-npm install && npm run build
+# 或使用 pnpm
+pnpm add -g ccman
+
+# 或使用 yarn
+yarn global add ccman
 ```
 
-### First Run Experience
+#### 方式 2: npx 直接运行 (无需安装)
 
 ```bash
-# Start CCM (first time)
-ccman
+# 直接运行,不安装到全局
+npx ccman
 
-🌍 Welcome to CCM! / 欢迎使用 CCM!
+# 运行特定命令
+npx ccman ls
+npx ccman add anthropic "Anthropic Official" https://api.anthropic.com
+```
+
+#### 方式 3: 从源码安装
+
+```bash
+# 克隆仓库
+git clone https://github.com/2ue/ccman.git
+cd ccman
 
-This is your first time running CCM.
-这是您首次运行 CCM。
+# 安装依赖
+pnpm install
 
-? Please choose your preferred language:
-? 请选择您偏好的语言：
-❯ 🇨🇳 中文 (Chinese)  
-  🇺🇸 English
-  🌐 Auto-detect based on system
+# 全局链接 (开发模式)
+npm link
 
-✓ Language set to Chinese
-✓ You can change this later with: ccman lang set <zh|en|auto>
+# 或构建后使用
+pnpm build
+node dist/cli.js
 ```
 
-### Basic Usage
+#### 方式 4: 下载预编译版本
+
+访问 [GitHub Releases](https://github.com/2ue/ccman/releases) 下载对应平台的预编译版本 (如果提供)
+
+### 首次运行
 
 ```bash
-# Interactive main menu (recommended)
 ccman
+```
 
-# List all providers
-ccman ls
+首次运行时会自动引导你:
+1. 选择界面语言(中文/英文/自动检测)
+2. 创建第一个供应商配置
+3. 自动应用到 Claude Code
 
-# Add provider directly  
-ccman add <id> <name> <baseUrl> [apiKey]
+## 📖 命令参考
 
-# Switch provider
-ccman use <id>
+### 核心命令
 
-# Remove provider
-ccman rm <id>
+```bash
+ccman                              # 交互式主菜单(推荐入口)
+ccman ls                           # 列出所有供应商及系统状态
+ccman ls --current                 # 显示当前供应商详情
+ccman ls --brief                   # 简洁列表模式
+ccman add <id> <name> <url> [key]  # 添加新供应商
+ccman use <id>                     # 切换到指定供应商
+ccman rm <id>                      # 删除供应商
+ccman clear                        # 清除所有配置(需确认)
 ```
 
-## 🌐 Language Management
+### 语言管理
 
-### Language Commands
 ```bash
-ccman lang                    # Show current language setting
-ccman lang set zh             # Set to Chinese
-ccman lang set en             # Set to English  
-ccman lang set auto           # Auto-detect based on system
-ccman lang reset              # Reset to first-run state
+ccman lang                         # 显示当前语言设置
+ccman lang set zh                  # 设置为中文
+ccman lang set en                  # 设置为英文
+ccman lang set auto                # 自动检测系统语言
+ccman lang reset                   # 重置为首次运行状态
 ```
 
-### Supported Languages
-- **Chinese (zh)** - 完整中文界面
-- **English (en)** - Full English interface
-- **Auto-detect** - Based on system `LANG` environment variable
-
-### Language Detection Logic
-- English environments (`en-*`) → English interface
-- Other environments (including `zh-*`, unset) → Chinese interface
-- Manual override available anytime
+## 💡 使用示例
 
-## 📖 Commands Reference
+### 添加并切换供应商
 
-### Core Provider Management
 ```bash
-ccman                              # Interactive menu (default)
-ccman add <id> <name> <url> [key]  # Add new provider
-ccman use <id>                     # Switch to provider
-ccman ls                           # List all providers
-ccman ls --current                 # Show current provider details
-ccman ls --brief                   # Brief provider list
-ccman rm <id>                      # Remove provider
-ccman clear                        # Remove ALL providers (destructive)
-```
+# 添加官方 Anthropic 配置
+ccman add anthropic "Anthropic Official" https://api.anthropic.com sk-ant-xxx
 
-### Language Management
-```bash
-ccman lang                         # Show current language
-ccman lang set <zh|en|auto>        # Set language preference
-ccman lang reset                   # Reset to first-run state
+# 添加第三方供应商
+ccman add custom "My Custom API" https://api.custom.com
+
+# 切换到自定义供应商
+ccman use custom
+
+# 列出所有供应商
+ccman ls
 ```
 
-## 🎯 Interactive Experience
+### 交互式菜单操作
 
-### Main Menu Navigation
 ```bash
 $ ccman
 
-? What would you like to do?
-❯ Switch provider
-  Add new provider
-  Update provider  
-  Remove provider
-  Show detailed status
-  Exit
+? 您想要执行什么操作?
+❯ 切换供应商
+  添加新供应商
+  更新供应商
+  删除供应商
+  显示详细状态
+  退出
 
-# After each operation:
-? Would you like to perform another operation? (Y/n)
+# 选择操作后,按提示完成配置
+# 每次操作后可以选择继续或退出
 ```
 
-### Provider Addition Flow
-```bash
-$ ccman add
-
-? Provider ID: my-provider
-? Provider name: My Custom API
-? Description: My custom Claude API
-? Base URL: https://api.mycustom.com
-? API Key: ****************
-
-✓ Provider added successfully
-? Set "My Custom API" as current provider? (Y/n)
-✓ Provider switched successfully
-Claude Code configuration has been updated successfully!
-```
+## 🔧 工作原理
 
-## 🔧 Architecture Overview
+CCM 直接管理 `~/.claude/settings.json` 文件,通过以下方式确保安全:
 
-### Direct Claude Integration
-CCM v2.0 directly modifies your Claude Code settings file:
+### 选择性更新
 
-**Before (CCM manages)**:
-```json
-{
-  "env": {
-    "ANTHROPIC_AUTH_TOKEN": "old-token",
-    "ANTHROPIC_BASE_URL": "https://old-api.com"
-  }
-}
-```
+只修改 CCM 管理的配置项:
+- `env.ANTHROPIC_AUTH_TOKEN`
+- `env.ANTHROPIC_BASE_URL`
+- `env.CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC`
+- `env.CLAUDE_CODE_MAX_OUTPUT_TOKENS`
+- `permissions.allow` / `permissions.deny`
 
-**After (CCM updates)**:
-```json
-{
-  "env": {
-    "ANTHROPIC_AUTH_TOKEN": "new-token", 
-    "ANTHROPIC_BASE_URL": "https://new-api.com",
-    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": 1
-  },
-  "permissions": {
-    "allow": [],
-    "deny": []
-  },
-  "apiKeyHelper": "echo 'new-token'"
-}
-```
+**保留所有其他用户配置项**(如 `mcpServers`、`model`、`customUserConfig` 等)
+
+### 自动备份
 
-### Provider Storage Structure
-Providers are stored in `~/.ccman/providers/`:
+每次切换前自动备份当前配置到 `~/.ccman/backups/`
+
+## 📂 配置结构
 
 ```
 ~/.ccman/
-├── config.json          # Main CCM configuration
-├── providers/            # Individual provider configs
-│   ├── anthropic.json
-│   ├── my-provider.json
-│   └── staging.json
+├── config.json              # CCM 主配置
+├── providers/               # 供应商配置目录
+│   ├── anthropic.json      # Anthropic 官方
+│   ├── custom.json         # 自定义供应商
+│   └── ...
+└── backups/                # 配置备份目录(自动创建)
 ```
 
-### Configuration Merging
-CCM only updates Claude-specific keys, preserving your existing settings:
-- ✅ Preserves: `mcpServers`, `model`, `customUserConfig`, etc.
-- 🔄 Updates: `env.ANTHROPIC_*`, `permissions`, `apiKeyHelper`
-
-## 📊 Provider Configuration
-
-### Provider Structure
-```json
-{
-  "name": "Anthropic Official",
-  "description": "Official Anthropic API Configuration", 
-  "config": {
-    "env": {
-      "ANTHROPIC_AUTH_TOKEN": "your-token",
-      "ANTHROPIC_BASE_URL": "https://api.anthropic.com",
-      "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": 1
-    },
-    "permissions": { "allow": [], "deny": [] },
-    "apiKeyHelper": "echo 'your-token'"
-  },
-  "metadata": {
-    "createdAt": "2025-01-15T10:30:00.000Z",
-    "updatedAt": "2025-01-15T10:30:00.000Z", 
-    "usageCount": 5
-  }
-}
-```
+## 🌐 语言支持
 
-### Main Configuration
-```json
-{
-  "currentProvider": "anthropic",
-  "claudeConfigPath": "/Users/user/.claude/settings.json",
-  "providers": {
-    "anthropic": {
-      "name": "Anthropic Official",
-      "configFile": "anthropic.json",
-      "lastUsed": "2025-01-15T10:30:00.000Z"
-    }
-  },
-  "settings": {
-    "language": "zh",
-    "firstRun": false
-  },
-  "metadata": {
-    "version": "2.0.0",
-    "createdAt": "2025-01-15T10:00:00.000Z",
-    "updatedAt": "2025-01-15T10:30:00.000Z"
-  }
-}
-```
+### 支持的语言
 
-## 💡 Usage Examples
+- **中文 (zh)** - 完整中文界面
+- **英文 (en)** - 完整英文界面
+- **自动检测 (auto)** - 基于系统 `LANG` 环境变量自动选择
 
-### Complete First-Time Setup
-```bash
-# First run - language selection
-ccman
-# → Language selection wizard
-# → No providers found, guided creation
-# → Automatic Claude settings update
-
-# Add additional providers
-ccman add staging "Staging API" https://staging-api.com
-ccman add dev "Development" https://dev-api.com
-
-# Switch between providers
-ccman use staging
-ccman use dev
-ccman use anthropic
-```
-
-### Multi-Provider Workflow
-```bash
-# List all providers with details
-ccman ls
-# * Anthropic Official (anthropic) - https://api.anthropic.com
-#   Staging API (staging) - https://staging-api.com  
-#   Development (dev) - https://dev-api.com
+### 语言检测逻辑
 
-# Switch to staging for testing
-ccman use staging
-# ✓ Provider switched successfully
-# ✓ Claude Code configuration has been updated successfully!
+- 英文环境 (`en-*`) → 自动使用英文界面
+- 其他环境(包括 `zh-*`、未设置等) → 自动使用中文界面
+- 用户可随时手动覆盖语言设置
 
-# Check current provider
-ccman ls --current
-# Current provider: Staging API (staging)
-# Base URL: https://staging-api.com
-# Usage count: 3 times
-# Last updated: 2025-01-15 10:30:15
-```
+## 📋 系统要求
 
-### Language Switching
-```bash
-# Check current language
-ccman lang
-# Current language: 中文 (Chinese)
-
-# Switch to English
-ccman lang set en
-# ✓ Language switched successfully
-# Current language: English
-
-# Set auto-detect
-ccman lang set auto
-# ✓ Language switched successfully  
-# Current language: Auto-detect
-# Auto-detected: English
-```
+- **Node.js** >= 16.0.0
+- **Claude Code** 已安装并支持 settings.json
+- **操作系统**: Linux, macOS, Windows (WSL)
+- **包管理器**: npm, pnpm, yarn(推荐 pnpm)
 
-## 🛠️ Development Setup
+## 🔍 故障排除
 
-### Development Environment
-CCM supports isolated development environments:
+### 供应商配置未生效
 
 ```bash
-# Set development paths
-export CCM_CONFIG_DIR=".ccman-dev"
-export CLAUDE_CONFIG_PATH="$HOME/.claude/settings-dev.json"
-
-# Use development mode
-npm run dev
+# 1. 检查当前供应商信息
+ccman ls --current
 
-# Build for production
-npm run build
+# 2. 重新应用配置
+ccman use <provider-id>
 
-# Test built version
-npm start
+# 3. 检查 Claude 配置文件
+cat ~/.claude/settings.json | grep ANTHROPIC
 ```
 
-### Development Commands
+### 语言切换问题
+
 ```bash
-npm run dev                 # Development mode with tsx
-npm run build              # TypeScript compilation  
-npm run start              # Run built CLI
-npm run clean              # Remove dist/ directory
-npm run lint               # ESLint TypeScript files
-npm test                   # Run tests (passWithNoTests)
+# 查看当前语言设置
+ccman lang
+
+# 强制设置为中文
+ccman lang set zh
+
+# 重置到首次运行状态(重新选择语言)
+ccman lang reset
+ccman
 ```
 
-## 🔍 Troubleshooting
+### 配置文件损坏
 
-### Provider Issues
 ```bash
-# Provider not working?
-ccman ls --current         # Check current provider details
-ccman use <provider-id>    # Re-apply provider configuration
+# 删除所有配置(会要求确认)
+ccman clear
 
-# Settings not applied?
-# Check ~/.claude/settings.json for updates
-cat ~/.claude/settings.json | grep ANTHROPIC
+# 重新开始配置
+ccman
 ```
 
-### Language Issues  
-```bash
-# Language not switching?
-ccman lang                 # Check current setting
-ccman lang set zh          # Force Chinese
-ccman lang set en          # Force English
-
-# First-run issues?
-ccman lang reset           # Reset to first-run state
-ccman                      # Restart for language selection
-```
+## 📚 开发文档
 
-### Configuration Issues
-```bash  
-# Corrupt configuration?
-ccman clear                # Remove all (with confirmation)
-ccman                      # Fresh start
+- [开发指南 (中文)](./docs/DEVELOPMENT.md)
+- [Development Guide (English)](./docs/DEVELOPMENT_en.md)
+- [版本发布指南](./docs/release-guide.md)
+- [脚本使用指南](./docs/scripts-guide.md)
 
-# Development isolation
-export CCM_CONFIG_DIR=".ccman-dev"  # Separate dev config
-```
+## 🤝 贡献
 
-## 📋 Requirements
+我们欢迎各种形式的贡献!
 
-- **Node.js** >= 16.0.0
-- **Claude Code** installed with settings.json support
-- **Operating Systems**: Linux, macOS, Windows (WSL)
+### 如何贡献
 
-## 📄 License
+1. Fork 本仓库
+2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 提交 Pull Request
 
-MIT License - see LICENSE file for details.
+### 报告问题
 
----
+如果你发现了 bug 或有新功能建议,请在 [GitHub Issues](https://github.com/2ue/ccman/issues) 中提交。
+
+## 📄 开源协议
+
+本项目采用 [MIT License](LICENSE) 开源协议。
 
-## 🚀 Migration from v1.x
+## 👤 作者
 
-CCM v2.0 uses a completely different architecture:
+**2ue**
+- 📧 Email: jie746635835@163.com
+- 🐙 GitHub: [@2ue](https://github.com/2ue)
 
-### v1.x (Shell Integration)
-- Modified shell configuration files
-- Used environment variables
-- Complex shell integration
+## 🙏 致谢
 
-### v2.0 (Direct Integration)  
-- Modifies `~/.claude/settings.json` directly
-- Provider-based configuration
-- Language support
-- Simplified, safer approach
+感谢所有为本项目做出贡献的开发者!
 
-**Migration**: v1.x and v2.x are incompatible. Start fresh with `ccman clear` if upgrading.
+感谢以下开源项目:
+- [TypeScript](https://www.typescriptlang.org/)
+- [Commander.js](https://github.com/tj/commander.js)
+- [Inquirer.js](https://github.com/SBoudrias/Inquirer.js)
+- [Chalk](https://github.com/chalk/chalk)
 
 ---
 
-*CCM v2.0 - Intelligent, multilingual, and seamless Claude Code provider management.*
+<div align="center">
+
+**CCM v2.x - 智能、多语言、无缝的 Claude Code 供应商管理**
+
+Made with ❤️ by [2ue](https://github.com/2ue)
+
+[⬆ 回到顶部](#ccm---claude-code-manager)
+
+</div>