@kaitranntt/ccs 3.0.0 → 3.0.2

package/README.md

@@ -4,9 +4,10 @@
 
 ![CCS Logo](docs/assets/ccs-logo-medium.png)
 
-**One command, zero downtime, right model for each task**
+**One command, zero downtime, multiple accounts**
 
-Switch between Claude Sonnet 4.5, GLM 4.6, and Kimi for Coding instantly. Stop hitting rate limits. Start optimizing costs.
+Switch between multiple Claude accounts, GLM, and Kimi instantly.<br>
+Stop hitting rate limits. Keep working continuously.
 
 
 [![License](https://img.shields.io/badge/license-MIT-C15F3C?style=for-the-badge)](LICENSE)
@@ -14,7 +15,7 @@ Switch between Claude Sonnet 4.5, GLM 4.6, and Kimi for Coding instantly. Stop h
 [![npm](https://img.shields.io/npm/v/@kaitranntt/ccs?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@kaitranntt/ccs)
 [![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)
+**Languages**: [English](README.md) | [Tiếng Việt](README.vi.md) | [日本語](README.ja.md)
 
 </div>
 
@@ -38,7 +39,18 @@ claude /login
 npm install -g @kaitranntt/ccs
 ```
 
-Compatible with npm, yarn, pnpm, and bun package managers.
+All major package managers are supported:
+
+```bash
+# yarn
+yarn global add @kaitranntt/ccs
+
+# pnpm (70% less disk space)
+pnpm add -g @kaitranntt/ccs
+
+# bun (30x faster)
+bun add -g @kaitranntt/ccs
+```
 
 #### Option 2: Direct Install (Traditional)
 
@@ -52,41 +64,7 @@ curl -fsSL ccs.kaitran.ca/install | bash
 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 to Kimi for alternative option
-ccs kimi "Write integration tests"
-
-# Use GLM for all subsequent commands until switched back
-ccs glm
-ccs "Debug this issue"
-ccs "Write unit tests"
-```
-
-#### Package Manager Options
-
-All major package managers are supported:
-
-```bash
-# npm (default)
-npm install -g @kaitranntt/ccs
-
-# yarn
-yarn global add @kaitranntt/ccs
-
-# pnpm (70% less disk space)
-pnpm add -g @kaitranntt/ccs
-
-# bun (30x faster)
-bun add -g @kaitranntt/ccs
-```
+> **💡 Performance Tip**: Traditional installs bypass Node.js routing for faster startup, but I prioritize npm updates due to easier deployment automation.
 
 ### Configuration (Auto-created)
 
@@ -116,107 +94,137 @@ $env:CCS_CLAUDE_PATH = "D:\Tools\Claude\claude.exe"   # Windows
 
 ---
 
+### Your First Switch
+
+> **⚠️ Important**: Before using GLM or Kimi profiles, you need to update your API keys in their respective settings files:
+> - **GLM**: Edit `~/.ccs/glm.settings.json` and add your GLM API key
+> - **Kimi**: Edit `~/.ccs/kimi.settings.json` and add your Kimi API key
+
+```bash
+# Use Claude subscription (default) for high-level planning
+ccs "Plan the implementation of a microservices architecture"
+
+# Switch to GLM for cost-optimized tasks
+ccs glm "Create a simple REST API"
+
+# Switch to Kimi for its thinking capabilities
+ccs kimi "Write integration tests with proper error handling"
+```
+
+---
+
 ## The Daily Developer Pain Point
 
-You have Claude subscription, GLM Coding Plan, and Kimi for Coding. Three scenarios happen every day:
+Developers face multiple subscription scenarios daily:
 
-1. **Rate Limits Hit**: Claude stops mid-project → you manually edit `~/.claude/settings.json`
-2. **Cost Waste**: Simple tasks use expensive Claude → GLM or Kimi would work fine
-3. **Model Choice**: Different tasks benefit from different model strengths → manual switching
+1. **Account Separation**: Company Claude account vs personal Claude → you must manually switch contexts to keep work and personal separate
+2. **Rate Limits Hit**: Claude stops mid-project → you manually edit `~/.claude/settings.json`
+3. **Cost Management**: 2-3 Pro subscriptions ($20/month each) vs Claude Max at 5x cost ($100/month) → Pro tier is the practical ceiling for most developers
+4. **Model Choice**: Different tasks benefit from different model strengths → manual switching
 
-Manual switching breaks your flow. **CCS fixes it instantly**.
+Manual context switching breaks your workflow. **CCS manages it seamlessly**.
 
 ## Why CCS Instead of Manual Switching?
 
 <div align="center">
 
-| Feature | Benefit | Emotional Value |
-|---------|---------|-----------------|
-| **Instant Switching** | One command, no file editing | Confidence, control |
-| **Zero Downtime** | Never interrupt your workflow | Reliability, consistency |
-| **Smart Delegation** | Right model for each task automatically | Simplicity, ease |
-| **Cost Control** | Use expensive models only when needed | Efficiency, savings |
-| **Cross-Platform** | Works on macOS, Linux, Windows | Flexibility, portability |
-| **Reliable** | Pure bash/PowerShell, zero dependencies | Trust, peace of mind |
+| Feature | Benefit |
+|---------|---------|
+| **Account Isolation** | Keep work separate from personal |
+| **Cost Optimization** | 2-3 Pro accounts vs Max at 5x cost |
+| **Instant Switching** | One command, no file editing |
+| **Zero Downtime** | Never interrupt workflow |
+| **Rate Limit Management** | Switch accounts when limits hit |
+| **Cross-Platform** | macOS, Linux, Windows |
 
 </div>
 
 **The Solution**:
 ```bash
-ccs           # Use Claude subscription (default)
-ccs glm       # Switch to GLM fallback
-ccs kimi      # Switch to Kimi for Coding
+ccs work          # Use company Claude account
+ccs personal      # Switch to personal Claude account
+ccs glm           # Switch to GLM for cost-effective tasks
+ccs kimi          # Switch to Kimi for alternative option
 # Hit rate limit? Switch instantly:
-ccs glm       # Continue working with GLM
-# Or switch to Kimi:
-ccs kimi      # Continue working with Kimi
+ccs glm           # Continue working with GLM
+# Need different company account?
+ccs work-2        # Switch to second company account
 ```
 
-One command. Zero downtime. No file editing. Right model, right task.
-
 ---
 
-## 🏗️ Architecture Overview (v3.0 Simplified)
+## 🏗️ Architecture Overview
 
 **v3.0 Login-Per-Profile Model**: Each profile is an isolated Claude instance where users login directly. No credential copying or vault encryption.
 
 ```mermaid
-graph LR
-    subgraph "User Command"
-        CMD[ccs <profile>]
+flowchart TD
+    subgraph "User Input"
+        USER["User runs: ccs &lt;profile&gt; [args...]"]
     end
 
-    subgraph "Profile Detection"
+    subgraph "Profile Detection Engine"
         DETECT[ProfileDetector]
-        SETTINGS[Settings-based: glm, kimi]
-        ACCOUNT[Account-based: work, personal]
+        PROFILE_CHECK{Profile exists?}
+
+        subgraph "Profile Types"
+            SETTINGS["Settings-based<br/>glm, kimi, default"]
+            ACCOUNT["Account-based<br/>work, personal, team"]
+        end
     end
 
-    subgraph "CCS Processing"
-        CONFIG[Read config.json/profiles.json]
-        INSTANCE[InstanceManager: lazy directory init]
+    subgraph "CCS Core Processing"
+        CONFIG["Read config.json<br/>and profiles.json"]
+
+        subgraph "Profile Handlers"
+            SETTINGS_MGR["SettingsManager<br/>→ --settings flag"]
+            INSTANCE_MGR["InstanceManager<br/>→ CLAUDE_CONFIG_DIR"]
+        end
     end
 
     subgraph "Claude CLI Execution"
-        SETTINGS_EXEC[claude --settings <path>]
-        INSTANCE_EXEC[CLAUDE_CONFIG_DIR=<instance> claude]
+        CLAUDE_DETECT["Claude CLI Detection<br/>CCS_CLAUDE_PATH support"]
+
+        subgraph "Execution Methods"
+            SETTINGS_EXEC["claude --settings &lt;path&gt;"]
+            INSTANCE_EXEC["CLAUDE_CONFIG_DIR=&lt;instance&gt; claude"]
+        end
     end
 
-    subgraph "API Response"
-        API[Claude/GLM/Kimi API]
+    subgraph "API Layer"
+        API["API Response<br/>Claude Sonnet 4.5<br/>GLM 4.6<br/>Kimi K2 Thinking"]
     end
 
-    CMD --> DETECT
-    DETECT --> SETTINGS
-    DETECT --> ACCOUNT
+    %% Flow connections
+    USER --> DETECT
+    DETECT --> PROFILE_CHECK
+    PROFILE_CHECK -->|Yes| SETTINGS
+    PROFILE_CHECK -->|Yes| ACCOUNT
+
     SETTINGS --> CONFIG
-    ACCOUNT --> INSTANCE
-    SETTINGS --> SETTINGS_EXEC
-    ACCOUNT --> INSTANCE_EXEC
-    SETTINGS_EXEC --> API
-    INSTANCE_EXEC --> API
+    ACCOUNT --> CONFIG
+
+    CONFIG --> SETTINGS_MGR
+    CONFIG --> INSTANCE_MGR
+
+    SETTINGS_MGR --> SETTINGS_EXEC
+    INSTANCE_MGR --> INSTANCE_EXEC
+
+    SETTINGS_EXEC --> CLAUDE_DETECT
+    INSTANCE_EXEC --> CLAUDE_DETECT
+
+    CLAUDE_DETECT --> API
 ```
 
 ---
 
 ## ⚡ Features
 
-### Instant Profile Switching
-- **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
-
-### Concurrent Sessions (All Platforms)
-- **Multiple Profiles Simultaneously**: Run `ccs work` and `ccs personal` in different terminals concurrently
-- **Isolated Instances**: Each profile gets own config directory (`~/.ccs/instances/<profile>/`)
-- **Independent Sessions**: Separate login, chat sessions, todos, logs per profile
-- **Platform Parity**: Works identically on macOS, Linux, and Windows via `CLAUDE_CONFIG_DIR`
-- **Backward Compatible**: Existing settings profiles (glm, kimi) work unchanged
-
-### Zero Workflow Interruption
-- **No Downtime**: Switching happens instantly between commands
-- **Context Preservation**: Your workflow remains uninterrupted
-- **Seamless Integration**: Works exactly like native Claude CLI
+- **Instant Switching** - `ccs glm` switches to GLM, no config editing
+- **Concurrent Sessions** - Run multiple profiles simultaneously in different terminals
+- **Isolated Instances** - Each profile gets own config (`~/.ccs/instances/<profile>/`)
+- **Cross-Platform** - macOS, Linux, Windows - identical behavior
+- **Zero Downtime** - Switch instantly, no workflow interruption
 
 
 ---
@@ -233,46 +241,49 @@ ccs --version    # Show CCS version and install location
 
 ### Concurrent Sessions (Multi-Account)
 ```bash
-# First time: Create profile and login
-ccs auth create work        # Opens Claude, prompts for login
-ccs auth create personal    # Opens Claude, prompts for login
+# Create multiple Claude accounts
+ccs auth create work       # Company account
+ccs auth create personal   # Personal account
+ccs auth create team       # Team account
 
 # Terminal 1 - Work account
 ccs work "implement feature"
 
-# Terminal 2 - Personal account (concurrent)
+# Terminal 2 - Personal account (runs concurrently)
 ccs personal "review code"
-
-# Both run simultaneously with isolated logins/sessions
-# Works on all platforms: macOS, Linux, Windows
 ```
 
 ---
 
-### 🗑️ Official Uninstall
+### 🗑️ Uninstall
+
+**Package Managers**
+```bash
+# npm
+npm uninstall -g @kaitranntt/ccs
+
+# yarn
+yarn global remove @kaitranntt/ccs
+
+# pnpm
+pnpm remove -g @kaitranntt/ccs
 
-**The recommended way to completely remove CCS:**
+# bun
+bun remove -g @kaitranntt/ccs
+```
 
-**macOS / Linux**:
+**Official Uninstaller**
+
+**macOS / Linux**
 ```bash
 curl -fsSL ccs.kaitran.ca/uninstall | bash
 ```
 
-**Windows PowerShell**:
+**Windows PowerShell**
 ```powershell
 irm ccs.kaitran.ca/uninstall | iex
 ```
 
-> 💡 **Why use the official uninstaller?**
-> - Removes all CCS files and configurations
-> - Cleans up PATH modifications
-> - Removes Claude CLI commands/skills
-> - Handles edge cases we've tested
-
-**Alternative methods** (if official uninstaller fails):
-- **npm**: `npm uninstall -g @kaitranntt/ccs`
-- **Manual**: See [troubleshooting guide](./docs/en/troubleshooting.md#manual-uninstall)
-
 ---
 
 ## 🎯 Philosophy
@@ -290,13 +301,13 @@ irm ccs.kaitran.ca/uninstall | iex
 - [Configuration](./docs/en/configuration.md)
 - [Usage Examples](./docs/en/usage.md)
 - [Troubleshooting](./docs/en/troubleshooting.md)
-- [Contributing](./docs/en/contributing.md)
+- [Contributing](./CONTRIBUTING.md)
 
 ---
 
 ## 🤝 Contributing
 
-We welcome contributions! Please see our [Contributing Guide](./docs/en/contributing.md) for details.
+We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details.
 
 ---
 
@@ -312,4 +323,4 @@ CCS is licensed under the [MIT License](LICENSE).
 
 [⭐ Star this repo](https://github.com/kaitranntt/ccs) | [🐛 Report issues](https://github.com/kaitranntt/ccs/issues) | [📖 Read docs](./docs/en/)
 
-</div>
+</div>