docs: update project documentation with recent features

This commit is contained in:
kaitranntt committed 2025-12-12 05:49:48 -05:00
1 parent 111dba444c
commit 53259ce1c7
3 files changed
+32 -13

No files matched your search

+3 -5
View File
@@ -4,11 +4,9 @@
![CCS Logo](docs/assets/ccs-logo-medium.png)
### One command, zero downtime, multiple accounts
**Switch between multiple Claude accounts, GLM, and Kimi instantly.**<br>
Stop hitting rate limits. Keep working continuously.<br>
Features a modern React 19 dashboard with real-time updates.
### Switch between multiple Claude accounts, GLM, Kimi, and OAuth-based models (Gemini, Codex, Antigravity) instantly.
Stop hitting rate limits. Keep working continuously.
Features a modern React 19 dashboard with real-time updates and unified configuration.
[![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)]()
+21 -2
View File
@@ -74,8 +74,9 @@ ccs/
4. **CLIProxy Integration** (`src/cliproxy/`)
- OAuth-based provider integration
- Binary manager for cliproxy executables
- Binary manager for cliproxy executables, including the new **version pin feature** (see Recent Changes)
- Auth handler for OAuth flows
- **Model Catalog**: Manages available models (Gemini, Codex, AGY, Qwen, Iflow)
5. **AI Delegation** (`src/delegation/`)
- Headless Claude execution
@@ -112,7 +113,7 @@ ccs/
- Dark mode support
**Key Pages**:
- Dashboard: Overview and status
- Dashboard: Overview, status, usage analytics, CLIProxy controls, and system health monitoring
- API Profiles: Model configuration
- CLIProxy: OAuth provider setup
- Accounts: Account management
@@ -220,6 +221,23 @@ ccs/
- **Quality gates**: Pre-commit validation
- **Comprehensive tests**: Unit, integration, native
## Recent Changes
### Version Pin Feature (Issue #88)
- **Description**: Users can now explicitly pin a specific version of CLIProxy using `ccs cliproxy --install <version>`. This creates a `.version-pin` file, preventing automatic updates and ensuring stability for specific project requirements.
### Profile Persistence Fix (Issue #82)
- **Description**: Relaxed configuration validation rules to prevent unintended data loss when handling user profiles, improving robustness and user experience.
### UI Dashboard Capabilities
- **Description**: The web-based UI now provides comprehensive dashboard functionalities, including usage analytics, CLIProxy controls, and system health monitoring, enhancing user visibility and control.
### Multi-Provider Support
- **Description**: The CLIProxy now supports multiple AI model providers, including Gemini, Codex, AGY, Qwen, and Iflow, offering greater flexibility and choice for users.
### Unified Config System
- **Description**: A consolidated configuration system ensures consistent management of settings, feature flags, and secrets across the CLI and its components.
## Architecture Patterns
### Modular Design
@@ -229,6 +247,7 @@ ccs/
- **Error boundaries**: Graceful error handling
### Configuration Management
- **Unified Config System**: Consolidated management of settings, feature flags, and secrets across the CLI and its components (see Recent Changes).
- **Shared data**: Symlinks for commands, skills, agents
- **Isolated state**: Profile-specific sessions, logs
- **Auto-recovery**: Self-healing configurations
+8 -6
View File
@@ -2,7 +2,7 @@
## Executive Summary
CCS (Claude Code Switch) is a TypeScript-based CLI tool that enables instant profile switching between Claude Sonnet 4.5, GLM 4.6, GLMT (GLM with Thinking), and Kimi for Coding models. The project features a modern React 19 web dashboard with real-time WebSocket integration, comprehensive TypeScript architecture, and cross-platform support. Current architecture includes:
CCS (Claude Code Switch) is a TypeScript-based CLI tool that enables instant profile switching between Claude, GLM, Kimi, Gemini, Codex, and Antigravity (and any OAuth-based models) models. It features a version pin mechanism for precise model control and a unified configuration system for seamless management across all providers. The project features a modern React 19 web dashboard with real-time WebSocket integration, comprehensive TypeScript architecture, and cross-platform support. Current architecture includes:
- **TypeScript Core**: 43 source files with 100% type coverage
- **React 19 Dashboard**: Modern UI with Vite, shadcn/ui, and real-time features
@@ -13,13 +13,14 @@ CCS (Claude Code Switch) is a TypeScript-based CLI tool that enables instant pro
## Product Vision
### Mission Statement
Provide developers with instant, zero-downtime switching between AI models, optimizing for cost, performance, and rate limit management while maintaining a seamless workflow experience.
Provide developers with instant, zero-downtime switching between diverse AI models, ensuring precise version control, optimizing for cost, performance, and rate limit management while maintaining a seamless workflow experience.
### Core Value Proposition
- **Instant Switching**: One command to change AI models without file editing
- **Zero Downtime**: Never interrupt development workflow during model switches
- **Cost Optimization**: Use the right model for each task automatically
- **Developer Experience**: Maintain familiar Claude CLI interface with enhanced capabilities
- **Instant Switching**: One command to change AI models and providers without file editing
- **Zero Downtime**: Never interrupt development workflow during model or provider switches
- **Version Pinning**: Lock to specific model versions for consistent behavior
- **Cost Optimization**: Use the right model/provider for each task automatically
- **Developer Experience**: Maintain familiar Claude CLI interface with enhanced capabilities and multi-provider support
## Product Development Requirements (PDR)
@@ -457,6 +458,7 @@ The CCS project demonstrates successful iterative evolution balancing simplifica
- **Developer Experience**: Familiar Claude CLI interface with AI delegation
- **Maintainability**: Modular design, clear responsibilities
- **Performance**: Minimal overhead, direct CLI execution
- **Unified Configuration**: Centralized management for all AI models and providers
### Breaking Changes (v3.x → v4.x)
- **Zero Breaking Changes**: v4.x fully backward compatible with v3.x