diff --git a/README.md b/README.md index 94204123..53a1b367 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,33 @@ # CCS - Claude Code Switch - - - - - -
+
+ +![CCS Logo](docs/assets/ccs-logo-medium.png) **One command, zero downtime, right model for each task** Switch between Claude Sonnet 4.5 and GLM 4.6 instantly. Stop hitting rate limits. Start optimizing costs. -[![Install CCS](https://img.shields.io/badge/Install-CCS-C15F3C?style=for-the-badge&logo=linux&logoColor=white)](#installation) -[![Version](https://img.shields.io/badge/version-2.2.3-141618?style=for-the-badge)](https://github.com/kaitranntt/ccs/releases) + [![License](https://img.shields.io/badge/license-MIT-C15F3C?style=for-the-badge)](LICENSE) [![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey?style=for-the-badge)]() +[![PoweredBy](https://img.shields.io/badge/PoweredBy-ClaudeKit-C15F3C?style=for-the-badge)](https://claudekit.cc?ref=HMNKXOHN) **Languages**: [English](README.md) | [Tiếng Việt](README.vi.md) -
- -![CCS Logo](docs/assets/ccs-logo-medium.png) - -
+ --- ## 🚀 Quick Start +### 🔑 Prerequisites + +**Before installing CCS, make sure you're logged into Claude CLI with your subscription account:** +```bash +claude /login +``` + ### Primary Installation Methods **macOS / Linux** @@ -43,12 +43,12 @@ irm ccs.kaitran.ca/install | iex ### Your First Switch ```bash +# Use Claude subscription (default) +ccs "Review this architecture design" + # Switch to GLM for cost-optimized tasks ccs glm "Create a simple REST API" -# Switch back to Claude for complex tasks -ccs claude "Review this architecture design" - # Use GLM for all subsequent commands until switched back ccs glm ccs "Debug this issue" @@ -120,7 +120,7 @@ graph LR end subgraph "Claude CLI" - EXEC[claude --settings ] + EXEC[claude --settings file_path] end subgraph "API Response" @@ -139,7 +139,7 @@ graph LR ## ⚡ Features ### Instant Profile Switching -- **One Command**: `ccs glm` or `ccs claude` - no config file editing +- **One Command**: `ccs glm` to switch to GLM, `ccs` to use Claude subscription - no config file editing - **Smart Detection**: Automatically uses right model for each task - **Persistent**: Switch stays active until changed again @@ -150,6 +150,8 @@ graph LR ### Task Delegation +> **🚧 Work in Progress**: This feature is experimental and not fully tested. Use with caution. + CCS includes intelligent task delegation via the `/ccs` meta-command: **Install CCS commands:** @@ -190,39 +192,7 @@ ccs --uninstall # Remove CCS commands and skills from ~/.claude/ --- -## 🎯 Philosophy - -- **YAGNI**: No features "just in case" -- **KISS**: Simple bash, no complexity -- **DRY**: One source of truth (config) - ---- - -## 🔧 Installation - -### System Requirements - -- **Node.js**: Not required (pure bash/PowerShell) -- **Python**: Not required -- **Dependencies**: Only `jq` for JSON parsing (Unix systems) -- **Claude CLI**: Must be installed separately -- **API Keys**: Valid Claude and GLM API keys - -### Verification - -```bash -# Verify installation -ccs --version - -# Expected output: -# CCS v2.2.3 -# Installed at: ~/.local/bin/ccs (Unix) or %USERPROFILE%\.ccs\ccs.ps1 (Windows) -# Claude CLI: Found at /usr/local/bin/claude -``` - ---- - -## 🗑️ Uninstall +### 🗑️ Uninstall **macOS / Linux**: ```bash @@ -236,6 +206,14 @@ irm ccs.kaitran.ca/uninstall | iex --- +## 🎯 Philosophy + +- **YAGNI**: No features "just in case" +- **KISS**: Simple bash, no complexity +- **DRY**: One source of truth (config) + +--- + ## 📖 Documentation **Complete documentation in [docs/](./docs/)**: diff --git a/README.vi.md b/README.vi.md index 8ec546e0..a3854716 100644 --- a/README.vi.md +++ b/README.vi.md @@ -1,33 +1,33 @@ # CCS - Claude Code Switch - - - - - -
+
+ +![CCS Logo](docs/assets/ccs-logo-medium.png) **Một lệnh, không downtime, đúng model cho từng tác vụ** Chuyển đổi giữa Claude Sonnet 4.5 và GLM 4.6 ngay lập tức. Ngừng hitting rate limits. Bắt đầu tối ưu chi phí. -[![Install CCS](https://img.shields.io/badge/Install-CCS-C15F3C?style=for-the-badge&logo=linux&logoColor=white)](#installation) -[![Version](https://img.shields.io/badge/version-2.2.3-141618?style=for-the-badge)](https://github.com/kaitranntt/ccs/releases) + [![License](https://img.shields.io/badge/license-MIT-C15F3C?style=for-the-badge)](LICENSE) [![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey?style=for-the-badge)]() +[![PoweredBy](https://img.shields.io/badge/PoweredBy-ClaudeKit-C15F3C?style=for-the-badge)](https://claudekit.cc?ref=HMNKXOHN) **Ngôn ngữ**: [English](README.md) | [Tiếng Việt](README.vi.md) -
- -![CCS Logo](docs/assets/ccs-logo-medium.png) - -
+ --- ## 🚀 Bắt Đầu Nhanh +### 🔑 Điều Kiện Tiên Quyết + +**Trước khi cài đặt CCS, hãy đảm bảo bạn đã đăng nhập vào Claude CLI với tài khoản subscription:** +```bash +claude /login +``` + ### Phương Pháp Cài Đặt Chính **macOS / Linux** @@ -43,12 +43,12 @@ irm ccs.kaitran.ca/install | iex ### Lần Chuyển Đổi Đầu Tiên ```bash +# Dùng Claude subscription (mặc định) +ccs "Review thiết kế kiến trúc này" + # Chuyển sang GLM cho tác vụ tối ưu chi phí ccs glm "Tạo REST API đơn giản" -# Chuyển lại Claude cho tác vụ phức tạp -ccs claude "Review thiết kế kiến trúc này" - # Dùng GLM cho tất cả lệnh tiếp theo cho đến khi chuyển lại ccs glm ccs "Debug issue này" @@ -108,7 +108,7 @@ Một lệnh. Không downtime. Không phải sửa file. Đúng model, đúng vi ## 🏗️ Tổng Quan Kiến Trúc ```mermaid -graph TB +graph LR subgraph "Lệnh Người Dùng" CMD[ccs glm] end @@ -120,7 +120,7 @@ graph TB end subgraph "Claude CLI" - EXEC[claude --settings ] + EXEC[claude --settings file_path] end subgraph "Phản Hồi API" @@ -139,7 +139,7 @@ graph TB ## ⚡ Tính Năng ### Chuyển Profile Ngay Lập Tức -- **Một Lệnh**: `ccs glm` hoặc `ccs claude` - không cần sửa file config +- **Một Lệnh**: `ccs glm` để chuyển sang GLM, `ccs` để dùng Claude subscription - không cần sửa file config - **Phát Hiện Thông Minh**: Tự động dùng đúng model cho từng tác vụ - **Liên Tục**: Chuyển đổi hoạt động cho đến khi thay đổi lại @@ -150,6 +150,8 @@ graph TB ### Delegation Tác Vụ +> **🚧 Đang phát triển**: Tính năng này đang trong giai đoạn thử nghiệm và chưa được kiểm tra đầy đủ. Sử dụng với cẩn thận. + CCS bao gồm delegation tác vụ thông minh qua meta-command `/ccs`: **Cài đặt lệnh CCS:** @@ -190,39 +192,7 @@ ccs --uninstall # Gỡ bỏ lệnh và kỹ năng CCS khỏi ~/.claude/ --- -## 🎯 Triết Lý - -- **YAGNI**: Không có tính năng "phòng hờ" -- **KISS**: Bash đơn giản, không phức tạp -- **DRY**: Một nguồn chân lý duy nhất (config) - ---- - -## 🔧 Cài Đặt - -### Yêu Cầu Hệ Thống - -- **Node.js**: Không yêu cầu (bash/PowerShell thuần) -- **Python**: Không yêu cầu -- **Dependencies**: Chỉ `jq` để parse JSON (Unix systems) -- **Claude CLI**: Phải cài đặt riêng -- **API Keys**: Có sẵn Claude và GLM API keys hợp lệ - -### Kiểm Tra - -```bash -# Kiểm tra cài đặt -ccs --version - -# Kết quả mong đợi: -# CCS v2.2.3 -# Installed at: ~/.local/bin/ccs (Unix) hoặc %USERPROFILE%\.ccs\ccs.ps1 (Windows) -# Claude CLI: Found at /usr/local/bin/claude -``` - ---- - -## 🗑️ Gỡ Cài Đặt +### 🗑️ Gỡ Cài Đặt **macOS / Linux**: ```bash @@ -236,6 +206,14 @@ irm ccs.kaitran.ca/uninstall | iex --- +## 🎯 Triết Lý + +- **YAGNI**: Không có tính năng "phòng hờ" +- **KISS**: Bash đơn giản, không phức tạp +- **DRY**: Một nguồn chân lý duy nhất (config) + +--- + ## 📖 Tài Liệu **Tài liệu đầy đủ trong [docs/](./docs/)**: