@kaitranntt/ccs 7.65.3-dev.9 → 7.66.0-dev.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/README.md +88 -808
  2. package/dist/ccs.js +3 -0
  3. package/dist/ccs.js.map +1 -1
  4. package/dist/cliproxy/auth/auth-types.d.ts +29 -6
  5. package/dist/cliproxy/auth/auth-types.d.ts.map +1 -1
  6. package/dist/cliproxy/auth/auth-types.js +58 -10
  7. package/dist/cliproxy/auth/auth-types.js.map +1 -1
  8. package/dist/cliproxy/auth/oauth-handler.d.ts +9 -1
  9. package/dist/cliproxy/auth/oauth-handler.d.ts.map +1 -1
  10. package/dist/cliproxy/auth/oauth-handler.js +196 -45
  11. package/dist/cliproxy/auth/oauth-handler.js.map +1 -1
  12. package/dist/cliproxy/auth/oauth-process.d.ts +13 -1
  13. package/dist/cliproxy/auth/oauth-process.d.ts.map +1 -1
  14. package/dist/cliproxy/auth/oauth-process.js +262 -17
  15. package/dist/cliproxy/auth/oauth-process.js.map +1 -1
  16. package/dist/cliproxy/executor/index.d.ts +5 -0
  17. package/dist/cliproxy/executor/index.d.ts.map +1 -1
  18. package/dist/cliproxy/executor/index.js +114 -7
  19. package/dist/cliproxy/executor/index.js.map +1 -1
  20. package/dist/commands/command-catalog.d.ts +1 -1
  21. package/dist/commands/command-catalog.d.ts.map +1 -1
  22. package/dist/commands/command-catalog.js +1 -0
  23. package/dist/commands/command-catalog.js.map +1 -1
  24. package/dist/commands/completion-backend.d.ts.map +1 -1
  25. package/dist/commands/completion-backend.js +9 -1
  26. package/dist/commands/completion-backend.js.map +1 -1
  27. package/dist/commands/help-command.d.ts.map +1 -1
  28. package/dist/commands/help-command.js +58 -0
  29. package/dist/commands/help-command.js.map +1 -1
  30. package/dist/ui/assets/{accounts-BjfPKR8m.js → accounts-jW1C1XCz.js} +1 -1
  31. package/dist/ui/assets/{alert-dialog-Dh2NUFdm.js → alert-dialog-9ra2FBXt.js} +1 -1
  32. package/dist/ui/assets/{api-C-3mQCFf.js → api-B1wB-xCb.js} +1 -1
  33. package/dist/ui/assets/{auth-section-Dp10_YyD.js → auth-section-L6FxRKHW.js} +1 -1
  34. package/dist/ui/assets/{backups-section-C0jF8MP1.js → backups-section-yDahh7vx.js} +1 -1
  35. package/dist/ui/assets/{channels-CkXuK5i7.js → channels-Detih8L-.js} +1 -1
  36. package/dist/ui/assets/{checkbox-tA5FH8Ol.js → checkbox-BBnsYp-P.js} +1 -1
  37. package/dist/ui/assets/{claude-extension-Bg2ZkzMz.js → claude-extension-C_krIRVF.js} +1 -1
  38. package/dist/ui/assets/cliproxy-H2_ozRn-.js +3 -0
  39. package/dist/ui/assets/{cliproxy-ai-providers-DBSXTTyw.js → cliproxy-ai-providers-CtVQymuP.js} +1 -1
  40. package/dist/ui/assets/{cliproxy-control-panel-Da-sGGyI.js → cliproxy-control-panel-zu9VU_Qf.js} +1 -1
  41. package/dist/ui/assets/{codex-ooWKOPa2.js → codex-Cxzll9c5.js} +1 -1
  42. package/dist/ui/assets/{confirm-dialog-CKjwhn9j.js → confirm-dialog-B2ThVV1S.js} +1 -1
  43. package/dist/ui/assets/{copilot-GA7EPiK1.js → copilot-DXUM1KLv.js} +1 -1
  44. package/dist/ui/assets/{cursor-B6c8CyHG.js → cursor-CrNFzSu5.js} +1 -1
  45. package/dist/ui/assets/{droid-CPRHOIX2.js → droid-RJdLxGub.js} +2 -2
  46. package/dist/ui/assets/{globalenv-section-Czgnw_GV.js → globalenv-section-Bv9iXrlD.js} +1 -1
  47. package/dist/ui/assets/{health-CXLOMk8n.js → health-CgOSX-UJ.js} +1 -1
  48. package/dist/ui/assets/{index-BceMcbCR.js → index-33V44ka2.js} +1 -1
  49. package/dist/ui/assets/{index-D2v_-6AW.js → index-C6BzhDNJ.js} +1 -1
  50. package/dist/ui/assets/{index-CvfzKRSH.js → index-CK2D-leN.js} +1 -1
  51. package/dist/ui/assets/{index-Boa5e-GY.js → index-D-9haA2-.js} +1 -1
  52. package/dist/ui/assets/{index-BMHPMj0j.js → index-DEb_1YYh.js} +26 -26
  53. package/dist/ui/assets/{index-v-DY6Zby.js → index-K0k4WFge.js} +1 -1
  54. package/dist/ui/assets/{masked-input-B1_asiUI.js → masked-input-DUpF2a8k.js} +1 -1
  55. package/dist/ui/assets/{proxy-status-widget-Ci1JpStj.js → proxy-status-widget-Dswa7OEL.js} +1 -1
  56. package/dist/ui/assets/{raw-json-settings-editor-panel-DMbTkxWw.js → raw-json-settings-editor-panel-CrjDrQgJ.js} +1 -1
  57. package/dist/ui/assets/{searchable-select-HbP2PXl3.js → searchable-select-Cl3WCoVu.js} +1 -1
  58. package/dist/ui/assets/{separator-CdaalG0K.js → separator-B_mZud18.js} +1 -1
  59. package/dist/ui/assets/{shared-BiFB-et0.js → shared-CEbDLM0x.js} +1 -1
  60. package/dist/ui/assets/{table-BPwgFXLQ.js → table-B7Mqppr5.js} +1 -1
  61. package/dist/ui/assets/{updates-l8Co9uve.js → updates-CBtsQjS3.js} +1 -1
  62. package/dist/ui/index.html +1 -1
  63. package/dist/web-server/routes/cliproxy-auth-routes.d.ts +8 -0
  64. package/dist/web-server/routes/cliproxy-auth-routes.d.ts.map +1 -1
  65. package/dist/web-server/routes/cliproxy-auth-routes.js +61 -5
  66. package/dist/web-server/routes/cliproxy-auth-routes.js.map +1 -1
  67. package/package.json +1 -1
  68. package/dist/ui/assets/cliproxy-1qRVSbVC.js +0 -3
package/README.md CHANGED
@@ -4,867 +4,147 @@
4
4
 
5
5
  ![CCS Logo](assets/ccs-logo-medium.png)
6
6
 
7
- ### The universal AI profile manager for Claude Code.
8
- Run Claude, Gemini, GLM, and any Anthropic-compatible API - concurrently, without conflicts.
7
+ ### The multi-provider profile and runtime manager for Claude Code and compatible CLIs
8
+
9
+ Run Claude, Codex, Droid-routed profiles, GLM, local models, and
10
+ Anthropic-compatible APIs without config thrash.
9
11
 
10
12
  [![License](https://img.shields.io/badge/license-MIT-C15F3C?style=for-the-badge)](LICENSE)
11
13
  [![npm](https://img.shields.io/npm/v/@kaitranntt/ccs?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@kaitranntt/ccs)
12
14
  [![PoweredBy](https://img.shields.io/badge/PoweredBy-ClaudeKit-C15F3C?style=for-the-badge)](https://claudekit.cc?ref=HMNKXOHN)
13
15
 
14
- **[Features & Pricing](https://ccs.kaitran.ca)** | **[Documentation Hub](https://docs.ccs.kaitran.ca)**
16
+ **[Website](https://ccs.kaitran.ca)** |
17
+ **[Documentation](https://docs.ccs.kaitran.ca)** |
18
+ **[Product Tour](https://docs.ccs.kaitran.ca/getting-started/product-tour)** |
19
+ **[CLI Reference](https://docs.ccs.kaitran.ca/reference/cli-commands)**
15
20
 
16
21
  </div>
17
22
 
18
- <br>
23
+ ## Why CCS
19
24
 
20
- ## The Three Pillars
25
+ CCS gives you one stable command surface while letting you switch between:
21
26
 
22
- | Capability | What It Does | Manage Via |
23
- |------------|--------------|------------|
24
- | **Multiple Claude Accounts** | Run work + personal Claude subs simultaneously | Dashboard |
25
- | **OAuth Providers** | Gemini, Codex, Antigravity - zero API keys needed | Dashboard |
26
- | **API Profiles** | GLM, Kimi, or any Anthropic-compatible API | Dashboard |
27
+ - multiple runtimes such as Claude Code, Factory Droid, and Codex CLI
28
+ - multiple Claude subscriptions and isolated account contexts
29
+ - OAuth providers like Codex, Copilot, Kiro, Claude, Qwen, Kimi, and more
30
+ - API and local-model profiles like GLM, Kimi, OpenRouter, Ollama, llama.cpp,
31
+ Novita, and Alibaba Coding Plan
27
32
 
28
- <br>
33
+ The goal is simple: stop rewriting config files, stop breaking active sessions,
34
+ and move between providers in seconds.
29
35
 
30
36
  ## Quick Start
31
37
 
32
- Looking for the full setup guide, command reference, provider guides, or troubleshooting?
33
- Start at **https://docs.ccs.kaitran.ca**.
34
-
35
- ## Contribute And Report Safely
36
-
37
- - Contributing guide: [CONTRIBUTING.md](./CONTRIBUTING.md)
38
- - Starter work: [good first issue](https://github.com/kaitranntt/ccs/labels/good%20first%20issue), [help wanted](https://github.com/kaitranntt/ccs/labels/help%20wanted)
39
- - Questions: [open a question issue](https://github.com/kaitranntt/ccs/issues/new/choose)
40
- - Security reports: [SECURITY.md](./SECURITY.md) and the [private advisory form](https://github.com/kaitranntt/ccs/security/advisories/new)
41
-
42
- ### 1. Install
43
-
44
38
  ```bash
45
39
  npm install -g @kaitranntt/ccs
46
- ```
47
-
48
- <details>
49
- <summary>Alternative package managers</summary>
50
-
51
- ```bash
52
- yarn global add @kaitranntt/ccs # yarn
53
- pnpm add -g @kaitranntt/ccs # pnpm (70% less disk space)
54
- bun add -g @kaitranntt/ccs # bun (30x faster)
55
- ```
56
-
57
- </details>
58
-
59
- ### 2. Open Dashboard
60
-
61
- ```bash
62
40
  ccs config
63
- # Opens a local browser URL
64
41
  ```
65
42
 
66
- CCS uses the runtime's system-default bind. If that bind is reachable beyond loopback,
67
- the CLI also prints bind/network details plus an auth reminder.
68
-
69
- Force all-interface binding for remote devices:
43
+ Then launch whatever runtime fits the task:
70
44
 
71
45
  ```bash
72
- ccs config --host 0.0.0.0
73
- # Terminal prints the reachable URLs to open from the other device
46
+ ccs
47
+ ccs codex
48
+ ccs --target droid glm
49
+ ccs glm
50
+ ccs ollama
74
51
  ```
75
52
 
76
- If you expose the dashboard beyond localhost, protect it first with `ccs config auth setup`.
77
-
78
- Use `ccs config --host 127.0.0.1` to force local-only binding.
53
+ Need the full setup path instead of the short version?
79
54
 
80
- Dashboard updates hub: `http://localhost:3000/updates`
55
+ | Need | Start here |
56
+ | --- | --- |
57
+ | Install and verify CCS | [`/getting-started/installation`](https://docs.ccs.kaitran.ca/getting-started/installation) |
58
+ | First successful session | [`/getting-started/first-session`](https://docs.ccs.kaitran.ca/getting-started/first-session) |
59
+ | Visual walkthrough | [`/getting-started/product-tour`](https://docs.ccs.kaitran.ca/getting-started/product-tour) |
60
+ | Provider selection | [`/providers/concepts/overview`](https://docs.ccs.kaitran.ca/providers/concepts/overview) |
61
+ | Full command reference | [`/reference/cli-commands`](https://docs.ccs.kaitran.ca/reference/cli-commands) |
62
+ | Troubleshooting | [`/reference/troubleshooting`](https://docs.ccs.kaitran.ca/reference/troubleshooting) |
81
63
 
82
- Want to run the dashboard in Docker or pull the prebuilt image? See `docker/README.md`.
64
+ ## See CCS In Action
83
65
 
84
- ### 3. Configure Your Accounts
66
+ ### Usage Analytics
85
67
 
86
- The dashboard provides visual management for all account types:
68
+ ![Analytics Dashboard](assets/screenshots/analytics.webp)
87
69
 
88
- - **Claude Accounts**: Isolation-first by default (work, personal, client), with explicit shared context opt-in
89
- - **OAuth Providers**: One-click auth for Gemini, Codex, Antigravity, Kiro, Copilot
90
- - **AI Providers**: Configure Gemini, Codex, Claude, Vertex, and OpenAI-compatible API keys under `CLIProxy -> AI Providers`
91
- - **API Profiles**: Configure GLM, Kimi, OpenRouter, and other Anthropic-compatible APIs as CCS-native profiles
92
- - **Codex CLI**: Dedicated dashboard page for native runtime diagnostics and guarded `config.toml` editing
93
- - **Factory Droid**: Track Droid install location and BYOK settings health
94
- - **Updates Center**: Track support rollouts (Droid target, CLIProxy provider changes, WebSearch integrations)
95
- - **Health Monitor**: Real-time status across all profiles
96
- - **Language Switcher**: Toggle dashboard locale between English, Simplified Chinese, and Vietnamese
70
+ Track usage, costs, and session patterns across profiles. Deep dive:
71
+ [Dashboard Analytics](https://docs.ccs.kaitran.ca/features/dashboard/analytics).
97
72
 
98
- **Analytics Dashboard**
99
-
100
- ![Analytics](assets/screenshots/analytics.webp)
101
-
102
- **Live Auth Monitor**
73
+ ### Live Auth And Health Monitoring
103
74
 
104
75
  ![Live Auth Monitor](assets/screenshots/live-auth-monitor.webp)
105
76
 
106
- **CLI Proxy API & Copilot Integration**
107
-
108
- ![CLIProxy API](assets/screenshots/cliproxyapi.webp)
109
-
110
- ![Copilot API](assets/screenshots/copilot-api.webp)
111
-
112
- **WebSearch Fallback**
113
-
114
- ![WebSearch](assets/screenshots/websearch.webp)
115
-
116
- <br>
117
-
118
- ## Built-in Providers
119
-
120
- | Provider | Auth Type | Command | Best For |
121
- |----------|-----------|---------|----------|
122
- | **Claude** | Subscription | `ccs` | Default, strategic planning |
123
- | **Gemini** | OAuth | `ccs gemini` | Zero-config, fast iteration |
124
- | **Codex** | OAuth | `ccs codex` | Code generation |
125
- | **Copilot** | OAuth | `ccs copilot` or `ccs ghcp` | GitHub Copilot models |
126
- | **Cursor IDE** | Local Token | `ccs cursor` | Run Claude through Cursor models via local daemon |
127
- | **Kiro** | OAuth (AWS default) | `ccs kiro` | AWS CodeWhisperer (Claude-powered) |
128
- | **Antigravity** | OAuth | `ccs agy` | Alternative routing |
129
- | **OpenRouter** | API Key | `ccs openrouter` | 300+ models, unified API |
130
- | **Ollama** | Local | `ccs ollama` | Local open-source models, privacy |
131
- | **llama.cpp** | Local | `ccs llamacpp` | Local GGUF inference via llama.cpp server |
132
- | **Ollama Cloud** | API Key | `ccs ollama-cloud` | Cloud-hosted open-source models |
133
- | **GLM** | API Key | `ccs glm` | Cost-optimized execution |
134
- | **KM (Kimi API)** | API Key | `ccs km` | Long-context, thinking mode |
135
- | **Kimi (OAuth)** | OAuth | `ccs kimi` | Device-code OAuth via CLIProxy |
136
- | **Azure Foundry** | API Key | `ccs foundry` | Claude via Microsoft Azure |
137
- | **Minimax** | API Key | `ccs mm` | M2 series, 1M context |
138
- | **DeepSeek** | API Key | `ccs deepseek` | V3.2 and R1 reasoning |
139
- | **Novita AI** | API Key | `ccs api create --preset novita` | Anthropic-compatible Novita endpoint for Claude Code |
140
- | **Qwen (OAuth)** | OAuth | `ccs qwen` | Qwen Code via CLIProxy |
141
- | **Qwen API** | API Key | `ccs api create --preset qwen` | DashScope Anthropic-compatible API |
142
- | **Alibaba Coding Plan** | API Key | `ccs api create --preset alibaba-coding-plan` | Model Studio Coding Plan endpoint |
143
-
144
- **OpenRouter Integration** (v7.0.0): CCS v7.0.0 adds OpenRouter with interactive model picker, dynamic discovery, and tier mapping (opus/sonnet/haiku). Create via `ccs api create --preset openrouter` or dashboard.
145
-
146
- **Alibaba Coding Plan Integration**: Configure via `ccs api create --preset alibaba-coding-plan` (or preset alias `alibaba`) with Coding Plan keys (`sk-sp-...`) and endpoint `https://coding-intl.dashscope.aliyuncs.com/apps/anthropic`.
147
-
148
- **Ollama Integration**: Run local open-source models (qwen3-coder, gpt-oss:20b) with full privacy. Use `ccs api create --preset ollama` - requires [Ollama v0.14.0+](https://ollama.com) installed. For cloud models, use `ccs api create --preset ollama-cloud`.
149
-
150
- > **Third-party WebSearch steering:** Claude-backed third-party launches keep Anthropic's native `WebSearch` disabled, provision `ccs-websearch.WebSearch` when the managed runtime is available, and append a short system hint so Claude prefers that managed tool over ad hoc Bash or `curl` lookups whenever current web information is needed.
151
- > Setting `websearch.enabled: false` disables the managed local runtime, but CCS still suppresses Anthropic's native `WebSearch` on third-party backends because those providers cannot execute it correctly.
152
-
153
- > **Image backend visibility:** `ccs config image-analysis --set-fallback <backend>` defines the backend CCS should use when a profile alias cannot be inferred directly. Use `--set-profile-backend <profile> <backend>` and `--clear-profile-backend <profile>` for explicit per-profile mappings. In the dashboard, the global `Settings -> Image` section now shows the shared backend routing state, while each profile editor keeps a compact `Image` status card that links back to those global controls.
154
- > Third-party launches now expose a first-class local `ImageAnalysis` MCP tool when the runtime is ready, route requests directly to the resolved CCS provider path, and fall back to native `Read` when the managed runtime is unavailable.
155
-
156
- > **Copilot config behavior:** Opening the dashboard or other read-only Copilot endpoints does not rewrite `~/.ccs/copilot.settings.json`. If CCS detects deprecated Copilot model IDs such as `raptor-mini`, it shows warnings immediately and only persists replacements when you explicitly save the Copilot configuration.
157
-
158
- **llama.cpp Integration**: Run a local llama.cpp OpenAI-compatible server and create a profile with `ccs api create --preset llamacpp`. CCS defaults to `http://127.0.0.1:8080`, matching the standard llama.cpp server port.
159
-
160
- **Azure Foundry**: Use `ccs api create --preset foundry` to set up Claude via Microsoft Azure AI Foundry. Requires Azure resource and API key from [ai.azure.com](https://ai.azure.com).
161
-
162
- ![OpenRouter API Profiles](assets/screenshots/api-profiles-openrouter.webp)
163
-
164
- > **OAuth providers** authenticate via browser on first run. Tokens are cached in `~/.ccs/cliproxy/auth/`.
165
-
166
- > **Kiro / Copilot account naming:** Manual nicknames are optional. If the provider does not expose an email, CCS derives a safe internal identifier automatically and you can rename it later.
167
-
168
- > **AI Providers dashboard:** Configure CLIProxy-managed API key families at `ccs config` -> `CLIProxy` -> `AI Providers`. Use `API Profiles` only for CCS-native Anthropic-compatible profiles.
169
-
170
- **Powered by:**
171
- - [CLIProxyAPIPlus](https://github.com/router-for-me/CLIProxyAPIPlus) - Extended OAuth proxy with Kiro ([@fuko2935](https://github.com/fuko2935), [@Ravens2121](https://github.com/Ravens2121)) and Copilot ([@em4go](https://github.com/em4go)) support
172
- - [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) - Core OAuth proxy for Gemini, Codex, Antigravity
173
- - [copilot-api](https://github.com/ericc-ch/copilot-api) - GitHub Copilot API integration
174
-
175
- > [!TIP]
176
- > **Need more?** CCS supports **any Anthropic-compatible API**. Create custom profiles for self-hosted LLMs, enterprise gateways, or alternative providers. See [API Profiles documentation](https://docs.ccs.kaitran.ca/providers/api-profiles).
177
-
178
- <br>
179
-
180
- ## Usage
181
-
182
- ### Basic Commands
183
-
184
- ```bash
185
- ccs # Default Claude session
186
- ccs gemini # Gemini (OAuth)
187
- ccs codex # OpenAI Codex (OAuth)
188
- ccs cursor # Run Claude through Cursor local proxy
189
- ccs kiro # Kiro/AWS CodeWhisperer (OAuth)
190
- ccs ghcp # GitHub Copilot (OAuth device flow)
191
- ccs agy # Antigravity (OAuth)
192
- ccs qwen # Qwen Code (OAuth via CLIProxy)
193
- ccs ollama # Local Ollama (no API key needed)
194
- ccs llamacpp # Local llama.cpp (no API key needed)
195
- ccs glm # GLM (API key)
196
- ccs km # Kimi API profile (API key)
197
- ccs api create --preset alibaba-coding-plan # Alibaba Coding Plan profile
198
- ccs api discover --register # Auto-register orphan *.settings.json
199
- ccs api copy glm glm-backup # Duplicate profile config + settings
200
- ccs api export glm --out ./glm.ccs-profile.json # Export for cross-device transfer
201
- ccs api import ./glm.ccs-profile.json # Import exported profile bundle
202
- ```
203
-
204
- ### Runtime Aliases (built-in bins / `argv[0]` pattern)
205
-
206
- Built-in Droid and native Codex runtime aliases are installed with the package:
207
-
208
- ```bash
209
- ccs-droid glm # explicit alias
210
- ccsd glm # legacy shortcut
211
- ccs-codex # explicit native Codex alias
212
- ccsx # short native Codex alias
213
- ```
214
-
215
- CCS also ships an opinionated Codex provider shortcut:
216
-
217
- ```bash
218
- ccsxp # same as: ccs codex --target codex
219
- ```
220
-
221
- Need additional alias names? First create the matching symlink or another launcher that
222
- preserves the invoked basename, then map that name with `CCS_TARGET_ALIASES` (preferred) or legacy
223
- target-specific env vars:
224
-
225
- ```bash
226
- ln -s "$(command -v ccs)" /usr/local/bin/mydroid
227
- ln -s "$(command -v ccs)" /usr/local/bin/mycodex
228
- CCS_TARGET_ALIASES='droid=mydroid;codex=mycodex'
229
- # Legacy fallback still supported:
230
- CCS_DROID_ALIASES='mydroid'
231
- CCS_CODEX_ALIASES='mycodex'
232
- ```
233
-
234
- For Factory BYOK compatibility, CCS also stores a per-profile Droid provider hint
235
- (`CCS_DROID_PROVIDER`) using one of:
236
- `anthropic`, `openai`, or `generic-chat-completion-api`.
237
- If the hint is missing, CCS resolves provider from base URL/model at runtime.
238
-
239
- CCS also persists Droid's active model selector in `~/.factory/settings.json`
240
- (`model: custom:<alias>`). This avoids passing `-m` argv in interactive mode,
241
- which Droid treats as queued prompt text.
242
-
243
- CCS supports structural Droid command passthrough after profile selection:
244
-
245
- ```bash
246
- ccs-droid codex exec --skip-permissions-unsafe "fix failing tests"
247
- ccs-droid codex --skip-permissions-unsafe "fix failing tests" # auto-routed to: droid exec ...
248
- ccs-droid codex -m custom:gpt-5.3-codex "fix failing tests" # short exec flags auto-routed too
249
- ```
250
-
251
- If you pass exec-only flags without a prompt (for example `--skip-permissions-unsafe`),
252
- Droid `exec` will return its native "No prompt provided" usage guidance.
253
-
254
- If multiple reasoning flags are provided in Droid exec mode, CCS keeps the first
255
- flag and warns about duplicates.
256
-
257
- Dashboard parity: `ccs config` -> `Factory Droid`
258
-
259
- ### Native Codex Runtime (runtime-only in v1)
260
-
261
- CCS can launch native Codex as a first-class runtime target without rewriting your
262
- `~/.codex/config.toml` on every run. CCS uses transient `codex -c key=value` overrides for
263
- Codex-routed sessions and leaves your existing Codex home/config in place.
264
-
265
- Supported in v1:
266
-
267
- ```bash
268
- ccs --target codex # native Codex default session
269
- ccs-codex # explicit Codex alias
270
- ccsx # short native Codex alias
271
- ccsxp # built-in CCS Codex provider on native Codex
272
- ccs codex --target codex # explicit equivalent of ccsxp
273
- ccs api create codex-api --cliproxy-provider codex
274
- ccs codex-api --target codex # Codex bridge profile on native Codex
275
- ```
276
-
277
- Not supported in v1:
278
- - Claude account profiles on Codex target
279
- - Copilot profiles on Codex target
280
- - Generic API profiles that are not Codex-routed CLIProxy bridges
281
- - Non-Codex CLIProxy providers on Codex target
282
- - Composite CLIProxy variants on Codex target
283
-
284
- Dashboard parity: `ccs config` -> `Compatible` -> `Codex CLI`
285
-
286
- The dedicated Codex dashboard reads and writes the user layer only: `~/.codex/config.toml`
287
- (or `$CODEX_HOME/config.toml`). It now ships as a split-view control center:
288
-
289
- - left pane: guided controls for top-level runtime defaults, project trust, profiles,
290
- model providers, MCP servers, and supported feature toggles
291
- - right pane: raw `config.toml` editor for unsupported or exact-fidelity edits
292
- - overview/docs tabs: binary detection, user-layer summary, support matrix guidance, and
293
- upstream OpenAI references
294
-
295
- Structured saves intentionally normalize TOML formatting and drop comments. Use the raw editor
296
- when exact layout matters. Structured edits also refresh the raw snapshot immediately. Guided
297
- controls stay disabled while the raw editor has unsaved or invalid TOML, project trust paths must
298
- be absolute or start with `~/`, and supported feature flags can be cleared back to Codex defaults
299
- with `Use default`. CCS also keeps warning that transient runtime overrides such as
300
- `codex -c key=value` and `CCS_CODEX_API_KEY` can change the effective runtime without persisting
301
- back into the user config file.
302
-
303
- #### CLIProxy-backed native Codex
304
-
305
- There are two supported ways to use CLIProxy with native Codex:
306
-
307
- 1. `ccsxp` or `ccs codex --target codex`
308
- Uses the built-in CCS Codex provider route on native Codex. This path relies on transient
309
- CCS-managed `-c` overrides and does **not** require changing your saved `model_provider`.
310
-
311
- 2. Plain `codex` or a personal alias like `cxp`
312
- Save CLIProxy as the native default provider in `~/.codex/config.toml` (or
313
- `$CODEX_HOME/config.toml`), then export `CLIPROXY_API_KEY` in your shell.
314
-
315
- ```toml
316
- model_provider = "cliproxy"
317
-
318
- [model_providers.cliproxy]
319
- base_url = "http://127.0.0.1:8317/api/provider/codex"
320
- env_key = "CLIPROXY_API_KEY"
321
- wire_api = "responses"
322
- ```
323
-
324
- The top-level `model_provider = "cliproxy"` line is required. Defining only
325
- `[model_providers.cliproxy]` is not enough for plain `codex` to pick it by default.
326
-
327
- ```bash
328
- export CLIPROXY_API_KEY="ccs-internal-managed"
329
- ccsxp "your prompt" # CCS shortcut for the built-in provider route
330
- codex "your prompt" # native Codex using your saved cliproxy default
331
- ```
332
-
333
- Dashboard parity: `ccs config` -> `Compatible` -> `Codex CLI`
334
-
335
- - `Overview`: explains `ccsx` vs `ccsxp`
336
- - `Top-level settings`: set **Default provider** to `cliproxy`
337
- - `Model providers`: save `cliproxy` with `env_key = "CLIPROXY_API_KEY"`
338
-
339
- ### Per-Profile Target Defaults
340
-
341
- You can pin a default target (`claude` or `droid`) per profile:
342
-
343
- ```bash
344
- # API profile defaults to Droid
345
- ccs api create myglm --preset glm --target droid
346
-
347
- # CLIProxy variant defaults to Droid
348
- ccs cliproxy create mycodex --provider codex --target droid
349
- ```
350
-
351
- Built-in CLIProxy providers also work with Droid alias/target override:
352
-
353
- ```bash
354
- ccs-droid codex
355
- ccs-droid agy
356
- ccs codex --target droid
357
- ccs-droid codex exec --auto high "triage this bug report"
358
- ```
359
-
360
- Dashboard parity:
361
- - `ccs config` -> `API Profiles` -> set **Default Target**
362
- - `ccs config` -> `CLIProxy` -> create/edit variant -> set **Default Target**
363
-
364
- ### Kiro Auth Methods
365
-
366
- `ccs kiro --auth` defaults to AWS Builder ID Device OAuth (best support for AWS org accounts).
367
-
368
- ```bash
369
- ccs kiro --auth --kiro-auth-method aws # AWS Builder ID device code (default)
370
- ccs kiro --auth --kiro-auth-method aws-authcode # AWS Builder ID auth code
371
- ccs kiro --auth --kiro-auth-method google # Google OAuth
372
- ccs kiro --auth --kiro-auth-method github # Dashboard management OAuth flow
373
- ```
374
-
375
- Dashboard parity: `ccs config` -> Accounts -> Add Kiro account -> choose `Auth Method`.
376
-
377
- ### Cursor IDE Quick Start
378
-
379
- ```bash
380
- ccs cursor enable
381
- ccs cursor auth
382
- ccs cursor start
383
- ccs cursor "explain this repo"
384
- ccs cursor status
385
- ```
386
-
387
- If auto-detect is unavailable:
388
-
389
- ```bash
390
- ccs cursor auth --manual --token <token> --machine-id <machine-id>
391
- ```
392
-
393
- Defaults:
394
- - Port: `20129`
395
- - Ghost mode: enabled
396
- - Dashboard page: `ccs config` -> `Cursor IDE`
397
-
398
- Detailed guide: [`docs/cursor-integration.md`](./docs/cursor-integration.md)
399
-
400
- ### Claude IDE Extension Setup
401
-
402
- CCS now has a native setup flow for the Anthropic Claude extension in VS Code and compatible hosts.
403
- Use the same resolver in both the CLI and dashboard, so API profiles, CCS auth accounts,
404
- CLIProxy-backed profiles, Copilot, and default-profile continuity all map to the correct env shape.
405
-
406
- Preferred shared-settings path:
407
-
408
- ```bash
409
- ccs persist glm
410
- ccs persist work
411
- ccs persist default
412
- ```
413
-
414
- This writes the resolved setup to `~/.claude/settings.json`, which is the best option when you want
415
- the Claude CLI and the IDE extension to share one CCS profile.
416
-
417
- IDE-local snippet path:
418
-
419
- ```bash
420
- ccs env glm --format claude-extension --ide vscode
421
- ccs env work --format claude-extension --ide cursor
422
- ccs env default --format claude-extension --ide windsurf
423
- ```
424
-
425
- This prints a copy-ready `settings.json` snippet for the installed Claude extension host:
426
-
427
- - `vscode` / `cursor`: `claudeCode.environmentVariables` plus `claudeCode.disableLoginPrompt`
428
- - `windsurf`: `claude-code.environmentVariables`
429
-
430
- Account and continuity-aware flows use `CLAUDE_CONFIG_DIR` instead of Anthropic transport env vars.
431
- CLIProxy and Copilot flows emit the required `ANTHROPIC_*` variables and still depend on their local
432
- proxy/daemon being reachable.
433
-
434
- Dashboard parity:
435
- - `ccs config` -> `Claude Extension`
436
- - Select a CCS profile and IDE host to copy either the shared `~/.claude/settings.json` payload or the IDE-local extension snippet
437
-
438
- ### Parallel Workflows
439
-
440
- Run multiple terminals with different providers:
441
-
442
- > Delegation compatibility: when CCS spawns child Claude sessions, it strips the `CLAUDECODE` guard variable to avoid nested-session blocking in Claude Code v2.1.39+.
443
-
444
- ```bash
445
- # Terminal 1: Planning (Claude Pro)
446
- ccs work "design the authentication system"
447
-
448
- # Terminal 2: Execution (GLM - cost optimized)
449
- ccs glm "implement the user service from the plan"
450
-
451
- # Terminal 3: Local testing (Ollama - offline, privacy)
452
- ccs ollama "run tests and generate coverage report"
453
-
454
- # Terminal 4: Review (Gemini)
455
- ccs gemini "review the implementation for security issues"
456
- ```
457
-
458
- ### Multi-Account Claude
459
-
460
- Create isolated Claude instances for work/personal separation:
461
-
462
- ```bash
463
- ccs auth create work
464
-
465
- # Run concurrently in separate terminals
466
- ccs work "implement feature" # Terminal 1
467
- ccs "review code" # Terminal 2 (personal account)
468
- ```
469
-
470
- #### Account Context Modes (Isolation-First)
471
-
472
- Account profiles are isolated by default.
473
-
474
- | Mode | Default | Requirements |
475
- |------|---------|--------------|
476
- | `isolated` | Yes | No `context_group` required |
477
- | `shared` | No (explicit opt-in) | Valid non-empty `context_group` |
478
-
479
- Shared mode continuity depth:
480
-
481
- - `standard` (default): shares project workspace context only
482
- - `deeper` (advanced opt-in): additionally syncs `session-env`, `file-history`, `shell-snapshots`, `todos`
483
-
484
- Opt in to shared context when needed:
485
-
486
- ```bash
487
- # Share context with default group
488
- ccs auth create backup --share-context
489
-
490
- # Share context only within named group
491
- ccs auth create backup2 --context-group sprint-a
492
-
493
- # Advanced deeper continuity mode (requires shared mode)
494
- ccs auth create backup3 --context-group sprint-a --deeper-continuity
495
- ```
496
-
497
- Update existing accounts without recreating login:
498
-
499
- 1. Run `ccs config`
500
- 2. Open `Accounts`
501
- 3. Click the pencil icon in Actions and set `isolated` or `shared` mode + continuity depth
502
-
503
- Shared mode metadata in `~/.ccs/config.yaml`:
504
-
505
- ```yaml
506
- accounts:
507
- work:
508
- created: "2026-02-24T00:00:00.000Z"
509
- last_used: null
510
- context_mode: "shared"
511
- context_group: "team-alpha"
512
- continuity_mode: "standard"
513
- ```
514
-
515
- `context_group` rules:
516
-
517
- - lowercase letters, numbers, `_`, `-`
518
- - must start with a letter
519
- - max length `64`
520
- - non-empty after normalization
521
- - normalized by trim + lowercase + whitespace collapse (`" Team Alpha "` -> `"team-alpha"`)
522
-
523
- Shared context with `standard` depth links project workspace data. `deeper` depth links additional continuity artifacts. Credentials remain isolated per account.
524
-
525
- Resume is lane-scoped:
526
-
527
- - plain `ccs -r` resumes the lane that plain `ccs` currently uses
528
- - `ccs <account> -r` resumes that account's lane only
529
- - those lanes can differ, even when an account is `shared + deeper`
530
-
531
- If you do most of your work with plain `ccs` and want future resumes to line up with an auth account:
532
-
533
- ```bash
534
- ccs auth default work
535
- ```
536
-
537
- If you need to protect local continuity files before changing account sync settings:
538
-
539
- ```bash
540
- ccs auth backup work
541
- ccs auth backup default
542
- ```
543
-
544
- - `ccs auth backup work` backs up the local continuity lane for that auth account
545
- - `ccs auth backup default` backs up the lane plain `ccs` would use right now
546
- - this backs up local continuity artifacts only; Claude-hosted resume behavior still depends on upstream state
547
-
548
- #### Cross-Profile Continuity Inheritance (Claude Target)
549
-
550
- You can map non-account profiles (API, CLIProxy, Copilot, or `default`) to reuse continuity artifacts from an account profile:
551
-
552
- ```yaml
553
- continuity:
554
- inherit_from_account:
555
- glm: pro
556
- gemini: pro
557
- copilot: pro
558
- default: pro
559
- ```
560
-
561
- With this config, `ccs glm`, `ccs gemini`, and `ccs copilot` run with `pro`'s `CLAUDE_CONFIG_DIR` continuity context while keeping each profile's own provider credentials/settings.
562
-
563
- Alternative path for lower manual switching:
564
-
565
- - Use CLIProxy Claude pool (`ccs cliproxy auth claude`) and manage pool behavior in `ccs config` -> `CLIProxy Plus`.
566
-
567
- Technical details: [`docs/session-sharing-technical-analysis.md`](docs/session-sharing-technical-analysis.md)
568
-
569
- <br>
570
-
571
- ## Maintenance
572
-
573
- ### Health Check
574
-
575
- ```bash
576
- ccs doctor
577
- ```
578
-
579
- Verifies: Claude CLI, config files, symlinks, permissions.
580
-
581
- ### Update
582
-
583
- ```bash
584
- ccs update # Update to latest
585
- ccs update --force # Force reinstall
586
- ccs update --beta # Install dev channel
587
- ```
588
-
589
- ### CI Parity Gate (for contributors)
590
-
591
- Before opening or updating a PR, run:
592
-
593
- ```bash
594
- bun run validate:ci-parity
595
- ```
596
-
597
- This mirrors CI behavior (build + validate + base-branch freshness check) and is also enforced by the local `pre-push` hook.
598
-
599
- ### Sync Shared Items
600
-
601
- ```bash
602
- ccs sync
603
- ```
604
-
605
- Re-creates symlinks for shared commands, skills, and settings.
606
-
607
- ### Quota Management
608
-
609
- ```bash
610
- ccs cliproxy doctor # Check quota status for all agy accounts
611
- ccs cliproxy quota # Show agy/claude/codex/gemini/ghcp quotas (Claude/Codex: 5h + weekly reset schedule)
612
- ```
613
-
614
- **Auto-Failover**: When a managed account runs out of quota, CCS automatically switches to another account with remaining capacity. Shared GCP project accounts are excluded (pooled quota).
615
-
616
- ### CLIProxy Lifecycle
617
-
618
- ```bash
619
- ccs cliproxy start # Start CLIProxy background service
620
- ccs cliproxy status # Check running status
621
- ccs cliproxy restart # Restart CLIProxy service
622
- ccs cliproxy stop # Stop running CLIProxy service
623
- ```
624
-
625
- <br>
626
-
627
- ## Configuration
628
-
629
- CCS auto-creates config on install. Dashboard is the recommended way to manage settings.
77
+ See auth state, account health, and provider readiness without dropping into raw
78
+ config. Deep dive:
79
+ [Live Auth Monitor](https://docs.ccs.kaitran.ca/features/dashboard/live-auth-monitor).
630
80
 
631
- **Config location**: `~/.ccs/config.yaml`
81
+ ### OAuth Provider Control Center
632
82
 
633
- <details>
634
- <summary>Custom Claude CLI path</summary>
635
-
636
- If Claude CLI is installed in a non-standard location:
637
-
638
- ```bash
639
- export CCS_CLAUDE_PATH="/path/to/claude" # Unix
640
- $env:CCS_CLAUDE_PATH = "D:\Tools\Claude\claude.exe" # Windows
641
- ```
642
-
643
- CCS sanitizes child Claude spawn environments by stripping `CLAUDECODE` (case-insensitive) to prevent nested-session guard failures during delegation. `CCS_CLAUDE_PATH` is still respected after this sanitization step.
644
-
645
- </details>
646
-
647
- <details>
648
- <summary>Windows symlink support</summary>
649
-
650
- Enable Developer Mode for true symlinks:
651
-
652
- 1. **Settings** → **Privacy & Security** → **For developers**
653
- 2. Enable **Developer Mode**
654
- 3. Reinstall: `npm install -g @kaitranntt/ccs`
655
-
656
- Without Developer Mode, CCS falls back to copying directories.
657
-
658
- </details>
659
-
660
- <br>
661
-
662
- ## WebSearch
663
-
664
- Third-party profiles (Gemini, Codex, GLM, etc.) cannot use Anthropic's native WebSearch. CCS now provisions a first-class local `ccs-websearch` MCP tool when the managed runtime is available, disables native `WebSearch` on third-party launches, and steers Claude toward real local providers instead of surfacing a denied native-tool call.
665
-
666
- ### How It Works
667
-
668
- | Profile Type | WebSearch Method |
669
- |--------------|------------------|
670
- | Claude (native) | Anthropic WebSearch API |
671
- | Third-party profiles | CCS local MCP `WebSearch` tool when available; otherwise Bash/network fallback |
672
-
673
- ### Local Search Backend Chain
674
-
675
- For third-party profiles, CCS steers Claude toward the managed `ccs-websearch.WebSearch` MCP tool when it is available. The tool is intentionally named to match the native `WebSearch` concept, which helps Claude prefer it over ad hoc Bash or `curl` fetches, but Bash/network fallback can still happen if the tool is unavailable or ignored. When the tool is used, CCS routes that request through deterministic search providers in this order:
676
-
677
- | Priority | Provider | Setup | Notes |
678
- |----------|----------|-------|-------|
679
- | 1st | Exa | `EXA_API_KEY` | API-backed search with extracted content |
680
- | 2nd | Tavily | `TAVILY_API_KEY` | Agent-oriented search API |
681
- | 3rd | Brave Search | `BRAVE_API_KEY` | Cleaner API-backed results |
682
- | 4th | DuckDuckGo | None | Built-in default fallback |
683
- | 5th | Gemini / OpenCode / Grok | Optional | Legacy compatibility fallback only |
684
-
685
- ### Configuration
686
-
687
- Configure via dashboard (**Settings** page) or `~/.ccs/config.yaml`:
688
-
689
- ```yaml
690
- websearch:
691
- enabled: true # Enable/disable (default: true)
692
- providers:
693
- exa:
694
- enabled: false # Enable when EXA_API_KEY is set
695
- tavily:
696
- enabled: false # Enable when TAVILY_API_KEY is set
697
- duckduckgo:
698
- enabled: true # Built-in zero-setup fallback
699
- brave:
700
- enabled: false # Enable when BRAVE_API_KEY is set
701
- gemini:
702
- enabled: false # Optional legacy fallback
703
- ```
704
-
705
- > [!TIP]
706
- > **DuckDuckGo** still works out of the box. Add **Exa**, **Tavily**, or **Brave Search** if you want API-backed results, then keep Gemini/OpenCode/Grok only if you explicitly want legacy fallback behavior.
707
- > CCS manages the user-scope MCP entry in `~/.claude.json` and syncs it into isolated account configs when needed.
708
-
709
- > [!NOTE]
710
- > Set `CCS_WEBSEARCH_TRACE=1` to write correlated launch, MCP, provider, and headless summary records to `~/.ccs/logs/websearch-trace.jsonl`. That trace is designed to answer whether CCS exposed the managed tool, whether Claude called it, which provider won, and when a headless run likely bypassed it via `Bash` or `WebFetch`.
711
-
712
- See [docs/websearch.md](./docs/websearch.md) for detailed configuration and troubleshooting.
713
-
714
- <br>
715
-
716
- ## Image Analysis
717
-
718
- Third-party profiles (Gemini, Codex, GLM bridge profiles, Copilot, and similar routes) now use a first-class local `ImageAnalysis` MCP tool instead of relying on a denied `Read` hook as the normal experience.
719
-
720
- ### How It Works
721
-
722
- | Profile Type | Image Method |
723
- |--------------|--------------|
724
- | Claude (native) | Native Claude vision / native `Read` |
725
- | Third-party profiles | CCS local MCP `ImageAnalysis` tool when available |
726
- | Third-party when runtime unavailable | Native `Read` fallback |
727
-
728
- ### Direct Provider Routing
729
-
730
- When the managed tool is used, CCS resolves the backend before launch and posts image-analysis requests directly to the provider-scoped CCS route:
731
-
732
- ```text
733
- /api/provider/<backend>/v1/messages
734
- ```
735
-
736
- That path goes from Claude -> `ccs-image-analysis.ImageAnalysis` -> CCS/CLIProxy provider routing. It does not bounce through Claude Code, a helper CLI, or a second model wrapper.
737
-
738
- ### Prompting and Fallback
83
+ ![CLIProxy API](assets/screenshots/cliproxyapi.webp)
739
84
 
740
- CCS appends a short steering hint telling Claude to prefer `ImageAnalysis` over `Read` for local image and PDF files. The tool uses editable prompt templates from `~/.ccs/prompts/image-analysis/` and automatically picks `default`, `screenshot`, or `document`.
85
+ Manage OAuth-backed providers, quota visibility, and routing from one place.
86
+ Deep dive:
87
+ [CLIProxy API](https://docs.ccs.kaitran.ca/features/proxy/cliproxy-api).
741
88
 
742
- If the local runtime, auth, or proxy path is unavailable, CCS keeps the launch non-fatal and falls back to native `Read`. The legacy `Read` hook remains only as a compatibility fallback when CCS can install it safely.
89
+ ### Managed Tooling And Fallbacks
743
90
 
744
- See [docs/image-analysis.md](./docs/image-analysis.md) for configuration, routing details, and troubleshooting.
91
+ ![WebSearch Fallback](assets/screenshots/websearch.webp)
745
92
 
746
- <br>
93
+ CCS can provision first-class local tools like WebSearch and image analysis for
94
+ third-party launches instead of leaving you to wire them by hand. Deep dive:
95
+ [WebSearch](https://docs.ccs.kaitran.ca/features/ai/websearch).
747
96
 
748
- ## Remote CLIProxy
97
+ ## Docs Matrix
749
98
 
750
- CCS v7.x supports connecting to remote CLIProxyAPI instances, enabling:
751
- - **Team sharing**: One CLIProxyAPI server for multiple developers
752
- - **Cost optimization**: Centralized API key management
753
- - **Network isolation**: Keep API credentials on a secure server
99
+ The README stays short on purpose. The docs site owns the detailed guides and
100
+ reference material.
754
101
 
755
- ### Quick Setup
102
+ | If you want to... | Read this |
103
+ | --- | --- |
104
+ | Understand what CCS is and how the pieces fit together | [Introduction](https://docs.ccs.kaitran.ca/introduction) |
105
+ | Install CCS cleanly on a new machine | [Installation](https://docs.ccs.kaitran.ca/getting-started/installation) |
106
+ | Go from install to a successful first run | [Your First CCS Session](https://docs.ccs.kaitran.ca/getting-started/first-session) |
107
+ | See the dashboard and workflow surfaces before setup | [Product Tour](https://docs.ccs.kaitran.ca/getting-started/product-tour) |
108
+ | Compare OAuth providers, Claude accounts, and API profiles | [Provider Overview](https://docs.ccs.kaitran.ca/providers/concepts/overview) |
109
+ | Learn the dashboard structure and feature pages | [Dashboard Overview](https://docs.ccs.kaitran.ca/features/dashboard/overview) |
110
+ | Configure profiles, paths, and environment variables | [Configuration](https://docs.ccs.kaitran.ca/getting-started/configuration) |
111
+ | Keep OpenCode aligned with your live CCS setup | [OpenCode Sync Plugin](https://docs.ccs.kaitran.ca/features/workflow/opencode-sync) |
112
+ | Browse every command and flag | [CLI Commands](https://docs.ccs.kaitran.ca/reference/cli-commands) |
113
+ | Recover from install, auth, or provider failures | [Troubleshooting](https://docs.ccs.kaitran.ca/reference/troubleshooting) |
114
+ | Understand storage, config, and architecture details | [Reference](https://docs.ccs.kaitran.ca/reference/architecture) |
756
115
 
757
- Configure via dashboard (**Settings > CLIProxy Server**) or CLI flags:
116
+ ## Example Workflow
758
117
 
759
118
  ```bash
760
- ccs gemini --proxy-host 192.168.1.100 --proxy-port 8317
761
- ccs codex --proxy-host proxy.example.com --proxy-protocol https
762
- ```
763
-
764
- ### CLI Flags
765
-
766
- | Flag | Description |
767
- |------|-------------|
768
- | `--proxy-host` | Remote proxy hostname or IP |
769
- | `--proxy-port` | Remote proxy port (default: 8317 for HTTP, 443 for HTTPS) |
770
- | `--proxy-protocol` | `http` or `https` (default: http) |
771
- | `--proxy-auth-token` | Bearer token for authentication |
772
- | `--local-proxy` | Force local mode, ignore remote config |
773
- | `--remote-only` | Fail if remote unreachable (no fallback) |
774
-
775
- See [Remote Proxy documentation](https://docs.ccs.kaitran.ca/features/remote-proxy) for detailed setup.
119
+ # Design with default Claude
120
+ ccs "design the auth flow"
776
121
 
777
- <br>
122
+ # Implement with a different provider
123
+ ccs codex "implement the user service"
778
124
 
779
- ## Standard Fetch Proxy
125
+ # Use a cheaper API profile for routine work
126
+ ccs glm "clean up tests and docs"
780
127
 
781
- CCS also respects standard proxy environment variables for fetch-based quota, dashboard,
782
- and provider management requests:
783
-
784
- ```bash
785
- export HTTPS_PROXY=http://proxy.example.com:8080
786
- export HTTP_PROXY=http://proxy.example.com:8080
787
- export ALL_PROXY=http://proxy.example.com:8080
788
- export NO_PROXY=localhost,127.0.0.1,.internal.corp
128
+ # Run a local model when you need privacy or offline access
129
+ ccs ollama "summarize these logs"
789
130
  ```
790
131
 
791
- Notes:
792
- - CCS automatically bypasses loopback addresses (`localhost`, `127.0.0.1`, `::1`) for its own local services.
793
- - If `HTTPS_PROXY` is unset, CCS falls back to `HTTP_PROXY` for HTTPS fetches.
794
- - `ALL_PROXY` is used when protocol-specific proxy variables are not configured.
795
- - Proxy URLs must use `http://` or `https://`.
796
-
797
- <br>
798
-
799
- ## Documentation Hub
800
-
801
- If you are not sure where to start, open **https://docs.ccs.kaitran.ca** first.
802
- The hosted docs are the best entry point for setup, command reference, provider guides, and troubleshooting.
132
+ ## Community Projects
803
133
 
804
- | Topic | Link |
805
- |-------|------|
806
- | Docs Home | [docs.ccs.kaitran.ca](https://docs.ccs.kaitran.ca) |
807
- | Installation | [docs.ccs.kaitran.ca/getting-started/installation](https://docs.ccs.kaitran.ca/getting-started/installation) |
808
- | Configuration | [docs.ccs.kaitran.ca/getting-started/configuration](https://docs.ccs.kaitran.ca/getting-started/configuration) |
809
- | OAuth Providers | [docs.ccs.kaitran.ca/providers/oauth-providers](https://docs.ccs.kaitran.ca/providers/oauth-providers) |
810
- | Multi-Account Claude | [docs.ccs.kaitran.ca/providers/claude-accounts](https://docs.ccs.kaitran.ca/providers/claude-accounts) |
811
- | API Profiles | [docs.ccs.kaitran.ca/providers/api-profiles](https://docs.ccs.kaitran.ca/providers/api-profiles) |
812
- | Remote Proxy | [docs.ccs.kaitran.ca/features/remote-proxy](https://docs.ccs.kaitran.ca/features/remote-proxy) |
813
- | Cursor IDE (local guide) | [./docs/cursor-integration.md](./docs/cursor-integration.md) |
814
- | Dashboard i18n (local guide) | [./docs/i18n-dashboard.md](./docs/i18n-dashboard.md) |
815
- | CLI Reference | [docs.ccs.kaitran.ca/reference/cli-commands](https://docs.ccs.kaitran.ca/reference/cli-commands) |
816
- | Architecture | [docs.ccs.kaitran.ca/reference/architecture](https://docs.ccs.kaitran.ca/reference/architecture) |
817
- | Troubleshooting | [docs.ccs.kaitran.ca/reference/troubleshooting](https://docs.ccs.kaitran.ca/reference/troubleshooting) |
818
-
819
- <br>
820
-
821
- ## Uninstall
822
-
823
- ```bash
824
- npm uninstall -g @kaitranntt/ccs
825
- ```
826
-
827
- <details>
828
- <summary>Alternative package managers</summary>
829
-
830
- ```bash
831
- yarn global remove @kaitranntt/ccs
832
- pnpm remove -g @kaitranntt/ccs
833
- bun remove -g @kaitranntt/ccs
834
- ```
134
+ | Project | Author | Description |
135
+ | --- | --- | --- |
136
+ | [opencode-ccs-sync](https://github.com/JasonLandbridge/opencode-ccs-sync) | [@JasonLandbridge](https://github.com/JasonLandbridge) | Auto-sync CCS providers into OpenCode |
835
137
 
836
- </details>
837
-
838
- <br>
839
-
840
- ## Philosophy
841
-
842
- - **YAGNI**: No features "just in case"
843
- - **KISS**: Simple, focused implementation
844
- - **DRY**: One source of truth (config)
845
-
846
- <br>
847
-
848
- ## Contributing
849
-
850
- See [CONTRIBUTING.md](./CONTRIBUTING.md). For suspected vulnerabilities, use [SECURITY.md](./SECURITY.md) instead of a public issue.
851
-
852
- <br>
853
-
854
- ## License
855
-
856
- MIT License - see [LICENSE](LICENSE).
857
-
858
- <br>
138
+ ## Contribute And Report Safely
859
139
 
860
- <div align="center">
140
+ - Contributing guide: [CONTRIBUTING.md](./CONTRIBUTING.md)
141
+ - Starter work:
142
+ [good first issue](https://github.com/kaitranntt/ccs/labels/good%20first%20issue),
143
+ [help wanted](https://github.com/kaitranntt/ccs/labels/help%20wanted)
144
+ - Questions: [open a question issue](https://github.com/kaitranntt/ccs/issues/new/choose)
145
+ - Security reports: [SECURITY.md](./SECURITY.md) and the
146
+ [private advisory form](https://github.com/kaitranntt/ccs/security/advisories/new)
861
147
 
862
148
  ## Star History
863
149
 
864
150
  [![Star History Chart](https://api.star-history.com/svg?repos=kaitranntt/ccs&type=date&legend=top-left)](https://www.star-history.com/#kaitranntt/ccs&type=date&legend=top-left)
865
-
866
- ---
867
-
868
- **[ccs.kaitran.ca](https://ccs.kaitran.ca)** | **[docs.ccs.kaitran.ca](https://docs.ccs.kaitran.ca)** | [Issue Templates](https://github.com/kaitranntt/ccs/issues/new/choose) | [Private Security Report](https://github.com/kaitranntt/ccs/security/advisories/new) | [Star on GitHub](https://github.com/kaitranntt/ccs)
869
-
870
- </div>