From c6be09b55b9df21be551f4844b4fba3dfd9a6b3f Mon Sep 17 00:00:00 2001 From: kaitranntt Date: Wed, 4 Feb 2026 08:20:26 -0500 Subject: [PATCH] docs: update documentation for v7.34 release MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - add image analysis hook architecture - update test metrics (638 → 1407 tests) - add new hook modules to codebase summary - update all dates to 2026-02-04 --- docs/code-standards.md | 2 +- docs/codebase-summary.md | 29 ++++++++++++++++++++--------- docs/dashboard-auth-cli.md | 2 ++ docs/project-overview-pdr.md | 19 ++++++++++++++++--- docs/project-roadmap.md | 8 +++++--- docs/system-architecture.md | 12 ++++++++++-- docs/websearch.md | 2 +- 7 files changed, 55 insertions(+), 19 deletions(-) diff --git a/docs/code-standards.md b/docs/code-standards.md index 64cca0e8..5eea1cac 100644 --- a/docs/code-standards.md +++ b/docs/code-standards.md @@ -1,6 +1,6 @@ # CCS Code Standards -Last Updated: 2026-01-06 +Last Updated: 2026-02-04 Code standards, modularization patterns, and conventions for the CCS codebase. diff --git a/docs/codebase-summary.md b/docs/codebase-summary.md index e5bf2eaa..4ef7fc7b 100644 --- a/docs/codebase-summary.md +++ b/docs/codebase-summary.md @@ -1,8 +1,8 @@ # CCS Codebase Summary -Last Updated: 2026-01-06 +Last Updated: 2026-02-04 -Comprehensive overview of the modularized CCS codebase structure following the Phase 9 modularization effort (Settings, Analytics, Auth Monitor splits + Test Infrastructure), v7.1 Remote CLIProxy feature, v7.2 Kiro + GitHub Copilot (ghcp) OAuth providers, and v7.14 Hybrid Quota Management. +Comprehensive overview of the modularized CCS codebase structure following the Phase 9 modularization effort (Settings, Analytics, Auth Monitor splits + Test Infrastructure), v7.1 Remote CLIProxy feature, v7.2 Kiro + GitHub Copilot (ghcp) OAuth providers, v7.14 Hybrid Quota Management, and v7.34 Image Analysis Hook. ## Repository Structure @@ -45,6 +45,8 @@ src/ │ ├── commands/ # CLI command handlers │ ├── cliproxy-command.ts # CLIProxy subcommand handling +│ ├── config-command.ts # Config management commands +│ ├── config-image-analysis-command.ts # Image analysis hook config (NEW v7.34) │ ├── doctor-command.ts # Health diagnostics │ ├── help-command.ts # Help text generation │ ├── install-command.ts # Install/uninstall logic @@ -116,7 +118,8 @@ src/ ├── management/ # Doctor diagnostics │ ├── index.ts # Barrel export │ ├── checks/ # Diagnostic checks -│ │ └── index.ts +│ │ ├── index.ts +│ │ └── image-analysis-check.ts # Image hook validation (NEW v7.34) │ └── repair/ # Auto-repair logic │ └── index.ts │ @@ -136,6 +139,15 @@ src/ │ │ └── spinners.ts # Progress spinners │ ├── websearch/ # Search tool integrations │ │ └── index.ts +│ ├── hooks/ # Claude Code hooks (NEW v7.34) +│ │ ├── index.ts +│ │ ├── image-analyzer-hook-installer.ts +│ │ ├── image-analyzer-hook-configuration.ts +│ │ ├── image-analyzer-profile-hook-injector.ts +│ │ └── get-image-analysis-hook-env.ts +│ ├── image-analysis/ # Image analysis hook utilities (NEW v7.34) +│ │ ├── index.ts +│ │ └── hook-installer.ts │ └── [utility files...] │ └── web-server/ # Express web server (heavily modularized) @@ -173,6 +185,7 @@ src/ | Providers | `cliproxy/`, `copilot/`, `glmt/` | Provider integrations (7 CLIProxy providers: gemini, codex, agy, qwen, iflow, kiro, ghcp) | | Quota | `cliproxy/quota-*.ts`, `account-manager.ts` | Hybrid quota management (v7.14) | | Remote Proxy | `cliproxy/remote-*.ts`, `proxy-config-resolver.ts` | Remote CLIProxy support (v7.1) | +| Image Analysis | `utils/image-analysis/`, `utils/hooks/` | Vision model proxying (v7.34) | | Services | `web-server/`, `api/` | HTTP server, API services | | Utilities | `utils/`, `management/` | Helpers, diagnostics | @@ -474,14 +487,12 @@ tests/ | Metric | Value | |--------|-------| -| CLI Tests | 539 | -| UI Tests | 99 | -| Total Tests | 638 | -| Passing | 612 | +| Total Tests | 1407 | +| Passing | 1407 | | Skipped | 6 | -| Failed | 0 (CLI), 26 (UI - jsdom setup) | +| Failed | 0 | | Coverage Threshold | 90% | -| Test Files | 38 | +| Test Files | 40+ | --- diff --git a/docs/dashboard-auth-cli.md b/docs/dashboard-auth-cli.md index 0ea982d9..60c442e4 100644 --- a/docs/dashboard-auth-cli.md +++ b/docs/dashboard-auth-cli.md @@ -1,5 +1,7 @@ # Dashboard Authentication CLI +Last Updated: 2026-02-04 + CLI commands for managing CCS dashboard authentication. ## Overview diff --git a/docs/project-overview-pdr.md b/docs/project-overview-pdr.md index 1de940fa..2fd44000 100644 --- a/docs/project-overview-pdr.md +++ b/docs/project-overview-pdr.md @@ -1,6 +1,6 @@ # CCS Product Development Requirements (PDR) -Last Updated: 2026-01-06 +Last Updated: 2026-02-04 ## Product Overview @@ -10,7 +10,7 @@ Last Updated: 2026-01-06 **Description**: CLI wrapper enabling seamless switching between multiple Claude accounts and alternative AI providers (GLM, Gemini, Codex, OpenRouter, Qwen, Kimi, DeepSeek) with a React-based dashboard for configuration management. Supports both local and remote CLIProxyAPI instances with hybrid quota management. -**Current Version**: v7.14.x (Hybrid Quota Management + Pause/Resume) +**Current Version**: v7.34.x (Image Analysis Hook + Performance Improvements) --- @@ -192,7 +192,7 @@ CCS provides: | Startup time | < 100ms | Achieved | | Dashboard load | < 2s | Achieved | | Error rate | < 1% | Achieved | -| Test coverage | > 90% | 90% (539 CLI + 99 UI tests) | +| Test coverage | > 90% | 90% (1407 tests, 6 skipped) | | File size compliance | 100% < 200 lines | 95% | --- @@ -248,6 +248,19 @@ CCS provides: - [x] Pre-installed AI CLI tools (claude, gemini, grok, opencode) - [x] Entrypoint with privilege dropping +### v7.34 Release (Complete) +- [x] Image Analysis Hook for vision model proxying +- [x] Auto-injection for agy, gemini, codex, cliproxy profiles +- [x] Skip hook for Claude Sub accounts (native vision) +- [x] CLIProxy fallback with deprecated block-image-read +- [x] `ccs config image-analysis` CLI command +- [x] Doctor integration for hook validation +- [x] 791-line E2E test suite for image analysis +- [x] Performance: Replace busy-wait with Atomics.wait in config lock +- [x] Network error handling with noRetryPatterns +- [x] Quota 429 rate limit handling improvements +- [x] WebSocket maxPayload limit (DoS prevention) + ### v8.0 Release (Planned - Q1 2026) - [ ] Multiple CLIProxyAPI instances (load balancing, failover) - [ ] Native git worktree support diff --git a/docs/project-roadmap.md b/docs/project-roadmap.md index e8234cee..2aa857fc 100644 --- a/docs/project-roadmap.md +++ b/docs/project-roadmap.md @@ -1,6 +1,6 @@ # CCS Project Roadmap -Last Updated: 2026-01-06 +Last Updated: 2026-02-04 Forward-looking roadmap documenting current priorities, GitHub issues, and future feature plans. @@ -20,18 +20,19 @@ All major modularization work is complete. The codebase evolved from monolithic | 6 | Settings Page | `pages/settings/` (1,781->20 files) | | 7 | Analytics Page | `pages/analytics/` (420->8 files) | | 8 | Auth Monitor | `monitoring/auth-monitor/` (465->8 files) | -| 9 | Test Infrastructure | 99 UI tests + 539 CLI tests, 90% coverage | +| 9 | Test Infrastructure | 1407 tests, 90% coverage | | 10 | Remote CLIProxy | `proxy-config-resolver.ts`, `remote-proxy-client.ts` | | 11 | Kiro + ghcp Providers | OAuth support via CLIProxyAPIPlus (v7.2) | | 12 | Hybrid Quota Management | `quota-manager.ts`, `quota-fetcher.ts` (v7.14) | | 13 | Docker Support | `docker/` directory with Dockerfile, Compose, entrypoint | +| 14 | Image Analysis Hook | Vision proxying via CLIProxy transformers (v7.34) | **Metrics Achieved**: - Files >500 lines: 12 -> 5 (-58%) - UI files >200 lines: 28 -> 8 (-71%) - Barrel exports: 5 -> 39 (+680%) - Test coverage: 0% -> 90% -- Total tests: 638 (539 CLI + 99 UI) +- Total tests: 1407 (6 skipped) --- @@ -168,6 +169,7 @@ worktrees: | Kiro + GitHub Copilot OAuth (#157) | COMPLETE | v7.2 | | Hybrid Quota Management | COMPLETE | v7.14 | | Docker Support (PR #345) | COMPLETE | v7.23 | +| Image Analysis Hook | COMPLETE | v7.34 | | Critical Bug Fixes (#158, #155, #124) | PLANNED | Q1 2026 | | Multiple CLIProxyAPI Instances | PLANNED | Q1 2026 | | Git Worktree Support | PLANNED | Q2 2026 | diff --git a/docs/system-architecture.md b/docs/system-architecture.md index ac8f2daa..cca04f5b 100644 --- a/docs/system-architecture.md +++ b/docs/system-architecture.md @@ -1,6 +1,6 @@ # CCS System Architecture -Last Updated: 2026-01-06 +Last Updated: 2026-02-04 High-level architecture documentation for the CCS (Claude Code Switch) system. @@ -13,7 +13,7 @@ CCS is a CLI wrapper that enables seamless switching between multiple Claude acc 1. **CLI Application** (`src/`) - Node.js TypeScript CLI 2. **Dashboard UI** (`ui/`) - React web application served by Express -CCS v7.14 adds Hybrid Quota Management with pause/resume/status commands and auto-failover. +CCS v7.34 adds Image Analysis Hook for vision model proxying through CLIProxy with automatic injection for all profile types. ``` +===========================================================================+ @@ -325,6 +325,14 @@ CCS v7.14 adds Hybrid Quota Management with pause/resume/status commands and aut | v | Anthropic Format --> Provider Format | + +---> Image Analysis Hook (v7.34) + | | + | v + | Vision Model Proxying (gemini, codex, agy, cliproxy) + | - Auto-injected via claude-hooks + | - Skip for Claude Sub accounts (native vision) + | - Fallback with deprecated block-image-read + | +---> Provider APIs | +---> Google (Gemini) diff --git a/docs/websearch.md b/docs/websearch.md index c7f92b58..06e93141 100644 --- a/docs/websearch.md +++ b/docs/websearch.md @@ -1,6 +1,6 @@ # WebSearch Configuration Guide -Last Updated: 2026-01-06 +Last Updated: 2026-02-04 CCS provides automatic web search capability for all profiles, including third-party providers that cannot access Anthropic's native WebSearch API.