mirror of
https://github.com/tiennm99/ccs.git
synced 2026-10-18 20:14:36 +00:00
docs: improve README layout and fix documentation issues
- Revert header to simple centered layout (remove table structure) - Reorganize sections: move Uninstall to end of Quick Start - Remove non-existent 'ccs claude' command references - Add Claude CLI login prerequisite to Quick Start - Replace broken badges with PoweredBy ClaudeKit attribution - Add ClaudeKit referral link (https://claudekit.cc?ref=HMNKXOHN) - Fix Mermaid diagram <path> rendering issue - Add WIP notice to Task Delegation sections - Improve professional documentation presentation
This commit is contained in:
1 parent
86b7d123a7
commit
1714451aef
2 files changed
+59
-103
No files matched your search
@@ -1,33 +1,33 @@
|
|||||||
# CCS - Claude Code Switch
|
# CCS - Claude Code Switch
|
||||||
|
|
||||||
<table>
|
<div align="center">
|
||||||
<tr>
|
|
||||||
<td width="70%">
|

|
||||||
|
|
||||||
**One command, zero downtime, right model for each task**
|
**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.
|
Switch between Claude Sonnet 4.5 and GLM 4.6 instantly. Stop hitting rate limits. Start optimizing costs.
|
||||||
|
|
||||||
[](#installation)
|
|
||||||
[](https://github.com/kaitranntt/ccs/releases)
|
|
||||||
[](LICENSE)
|
[](LICENSE)
|
||||||
[]()
|
[]()
|
||||||
|
[](https://claudekit.cc?ref=HMNKXOHN)
|
||||||
|
|
||||||
**Languages**: [English](README.md) | [Tiếng Việt](README.vi.md)
|
**Languages**: [English](README.md) | [Tiếng Việt](README.vi.md)
|
||||||
|
|
||||||
</td>
|
</div>
|
||||||
<td width="30%" align="center">
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🚀 Quick Start
|
## 🚀 Quick Start
|
||||||
|
|
||||||
|
### 🔑 Prerequisites
|
||||||
|
|
||||||
|
**Before installing CCS, make sure you're logged into Claude CLI with your subscription account:**
|
||||||
|
```bash
|
||||||
|
claude /login
|
||||||
|
```
|
||||||
|
|
||||||
### Primary Installation Methods
|
### Primary Installation Methods
|
||||||
|
|
||||||
**macOS / Linux**
|
**macOS / Linux**
|
||||||
@@ -43,12 +43,12 @@ irm ccs.kaitran.ca/install | iex
|
|||||||
### Your First Switch
|
### Your First Switch
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# Use Claude subscription (default)
|
||||||
|
ccs "Review this architecture design"
|
||||||
|
|
||||||
# Switch to GLM for cost-optimized tasks
|
# Switch to GLM for cost-optimized tasks
|
||||||
ccs glm "Create a simple REST API"
|
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
|
# Use GLM for all subsequent commands until switched back
|
||||||
ccs glm
|
ccs glm
|
||||||
ccs "Debug this issue"
|
ccs "Debug this issue"
|
||||||
@@ -120,7 +120,7 @@ graph LR
|
|||||||
end
|
end
|
||||||
|
|
||||||
subgraph "Claude CLI"
|
subgraph "Claude CLI"
|
||||||
EXEC[claude --settings <path>]
|
EXEC[claude --settings file_path]
|
||||||
end
|
end
|
||||||
|
|
||||||
subgraph "API Response"
|
subgraph "API Response"
|
||||||
@@ -139,7 +139,7 @@ graph LR
|
|||||||
## ⚡ Features
|
## ⚡ Features
|
||||||
|
|
||||||
### Instant Profile Switching
|
### 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
|
- **Smart Detection**: Automatically uses right model for each task
|
||||||
- **Persistent**: Switch stays active until changed again
|
- **Persistent**: Switch stays active until changed again
|
||||||
|
|
||||||
@@ -150,6 +150,8 @@ graph LR
|
|||||||
|
|
||||||
### Task Delegation
|
### 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:
|
CCS includes intelligent task delegation via the `/ccs` meta-command:
|
||||||
|
|
||||||
**Install CCS commands:**
|
**Install CCS commands:**
|
||||||
@@ -190,39 +192,7 @@ ccs --uninstall # Remove CCS commands and skills from ~/.claude/
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🎯 Philosophy
|
### 🗑️ Uninstall
|
||||||
|
|
||||||
- **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
|
|
||||||
|
|
||||||
**macOS / Linux**:
|
**macOS / Linux**:
|
||||||
```bash
|
```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
|
## 📖 Documentation
|
||||||
|
|
||||||
**Complete documentation in [docs/](./docs/)**:
|
**Complete documentation in [docs/](./docs/)**:
|
||||||
|
|||||||
+30
-52
@@ -1,33 +1,33 @@
|
|||||||
# CCS - Claude Code Switch
|
# CCS - Claude Code Switch
|
||||||
|
|
||||||
<table>
|
<div align="center">
|
||||||
<tr>
|
|
||||||
<td width="70%">
|

|
||||||
|
|
||||||
**Một lệnh, không downtime, đúng model cho từng tác vụ**
|
**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í.
|
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í.
|
||||||
|
|
||||||
[](#installation)
|
|
||||||
[](https://github.com/kaitranntt/ccs/releases)
|
|
||||||
[](LICENSE)
|
[](LICENSE)
|
||||||
[]()
|
[]()
|
||||||
|
[](https://claudekit.cc?ref=HMNKXOHN)
|
||||||
|
|
||||||
**Ngôn ngữ**: [English](README.md) | [Tiếng Việt](README.vi.md)
|
**Ngôn ngữ**: [English](README.md) | [Tiếng Việt](README.vi.md)
|
||||||
|
|
||||||
</td>
|
</div>
|
||||||
<td width="30%" align="center">
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🚀 Bắt Đầu Nhanh
|
## 🚀 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
|
### Phương Pháp Cài Đặt Chính
|
||||||
|
|
||||||
**macOS / Linux**
|
**macOS / Linux**
|
||||||
@@ -43,12 +43,12 @@ irm ccs.kaitran.ca/install | iex
|
|||||||
### Lần Chuyển Đổi Đầu Tiên
|
### Lần Chuyển Đổi Đầu Tiên
|
||||||
|
|
||||||
```bash
|
```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í
|
# Chuyển sang GLM cho tác vụ tối ưu chi phí
|
||||||
ccs glm "Tạo REST API đơn giản"
|
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
|
# Dùng GLM cho tất cả lệnh tiếp theo cho đến khi chuyển lại
|
||||||
ccs glm
|
ccs glm
|
||||||
ccs "Debug issue này"
|
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
|
## 🏗️ Tổng Quan Kiến Trúc
|
||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
graph TB
|
graph LR
|
||||||
subgraph "Lệnh Người Dùng"
|
subgraph "Lệnh Người Dùng"
|
||||||
CMD[ccs glm]
|
CMD[ccs glm]
|
||||||
end
|
end
|
||||||
@@ -120,7 +120,7 @@ graph TB
|
|||||||
end
|
end
|
||||||
|
|
||||||
subgraph "Claude CLI"
|
subgraph "Claude CLI"
|
||||||
EXEC[claude --settings <path>]
|
EXEC[claude --settings file_path]
|
||||||
end
|
end
|
||||||
|
|
||||||
subgraph "Phản Hồi API"
|
subgraph "Phản Hồi API"
|
||||||
@@ -139,7 +139,7 @@ graph TB
|
|||||||
## ⚡ Tính Năng
|
## ⚡ Tính Năng
|
||||||
|
|
||||||
### Chuyển Profile Ngay Lập Tức
|
### 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ụ
|
- **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
|
- **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ụ
|
### 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`:
|
CCS bao gồm delegation tác vụ thông minh qua meta-command `/ccs`:
|
||||||
|
|
||||||
**Cài đặt lệnh 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ý
|
### 🗑️ Gỡ Cài Đặt
|
||||||
|
|
||||||
- **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
|
|
||||||
|
|
||||||
**macOS / Linux**:
|
**macOS / Linux**:
|
||||||
```bash
|
```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
|
||||||
|
|
||||||
**Tài liệu đầy đủ trong [docs/](./docs/)**:
|
**Tài liệu đầy đủ trong [docs/](./docs/)**:
|
||||||
|
|||||||
Reference in new issue
Block a user