diff --git a/README.md b/README.md index bca3b4b1..4d13ee7e 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ ### Manage every agent and provider from one place. -Connect Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, Kilo Code, OpenCode, Pi, ZCode, and compatible API clients to the providers you choose—then route, fail over, extend, and observe every request from one app. +Connect Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, Kilo Code, OpenCode, Pi, ZCode, WorkBuddy, and compatible API clients to the providers you choose—then route, fail over, extend, and observe every request from one app.

Download Desktop @@ -59,7 +59,7 @@ Connect Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, Kilo Code, OpenCo ## Why use Claude Code Router? -Claude Code Router (CCR) is a local model gateway and control plane for coding agents. It gives Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, Kilo Code, OpenCode, Pi, ZCode, and compatible API clients **one stable local endpoint**, while you manage the providers, models, accounts, routing rules, and tools behind it from one place. +Claude Code Router (CCR) is a local model gateway and control plane for coding agents. It gives Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, Kilo Code, OpenCode, Pi, ZCode, WorkBuddy, and compatible API clients **one stable local endpoint**, while you manage the providers, models, accounts, routing rules, and tools behind it from one place. Use CCR to: @@ -78,71 +78,78 @@ CCR supports OpenAI Chat / Responses, Anthropic Messages, Gemini Generate Conten - - - - - - - - + + - - - +
+ Claude Code logo
Claude Code (CLI & APP)
+ Codex logo
Codex (CLI & APP)
+ Grok CLI logo
Grok CLI (CLI)
+ Kimi CLI logo
Kimi CLI (CLI)
+ Kilo Code logo
Kilo Code (CLI)
+
OpenCode logo
OpenCode (CLI & APP)
+ Pi logo
Pi (CLI)
+ ZCode logo
ZCode (APP)
+ Claude Design logo
Claude Design (APP)
+ + WorkBuddy logo +
+ WorkBuddy (APP) +
+
@@ -162,28 +169,28 @@ CCR supports OpenAI Chat / Responses, Anthropic Messages, Gemini Generate Conten
- + Windows logo
Windows
- + Linux logo
Linux
- + macOS logo
macOS (Apple Silicon)
- + macOS logo
macOS (Intel) @@ -198,7 +205,7 @@ CCR supports OpenAI Chat / Responses, Anthropic Messages, Gemini Generate Conten 2. Open **Providers → Add Provider**. Choose a built-in preset or a custom endpoint, enter the API key, select the protocol and models, then save. 3. Open **Server** and click **Start**. The local model gateway listens on `http://127.0.0.1:3456` by default. -4. Open **Agent Config**, choose Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, Kilo Code, OpenCode, Pi, or ZCode, select a model, and apply the profile. +4. Open **Agent Config**, choose Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, Kilo Code, OpenCode, Pi, ZCode, or WorkBuddy, select a model, and apply the profile. 5. Start using your agent. Open **Logs** to confirm the resolved provider, model, status, tokens, latency, and errors. Your agent is now connected to CCR. To add conditions, retries, request rewrites, or fallback models, open **Routing**. @@ -236,7 +243,7 @@ Windows app packaging must run on Windows x64 because `better-sqlite3` ships a n ## How it works ```text -Claude Code · Claude Design · Codex · Grok CLI · Kimi CLI · Kilo Code · OpenCode · Pi · ZCode · Compatible API clients +Claude Code · Claude Design · Codex · Grok CLI · Kimi CLI · Kilo Code · OpenCode · Pi · ZCode · WorkBuddy · Compatible API clients │ ▼ Claude Code Router :3456 @@ -250,7 +257,7 @@ Claude Code · Claude Design · Codex · Grok CLI · Kimi CLI · Kilo Code · Op | Area | Highlights | | --- | --- | -| **Agents** | Profiles for Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, Kilo Code, OpenCode, Pi, and ZCode; model overrides; scopes; environment settings; CLI and app launch entries; multi-instance workflows | +| **Agents** | Profiles for Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, Kilo Code, OpenCode, Pi, ZCode, and WorkBuddy; model overrides; scopes; environment settings; CLI and app launch entries; multi-instance workflows | | **Providers** | Presets and custom endpoints; protocol probing; model discovery; connectivity checks; local login import where supported; single keys and credential pools | | **Models & routing** | Searchable catalog; model descriptions for task selection; conditions on headers and bodies; prefixes; rewrites; retries; ordered fallbacks | | **Tools & extensions** | Fusion models; ToolHub; built-in browser automation; Chrome login-state import; wrapper and core gateway plugins; local routes and virtual models | diff --git a/README_zh.md b/README_zh.md index d9dd857a..6eb17a40 100644 --- a/README_zh.md +++ b/README_zh.md @@ -36,7 +36,7 @@ ### 在一个地方,管理你所有的 Agent 与 Provider -让 Claude Code、Claude Design、Codex、Grok CLI、Kimi CLI、Kilo Code、OpenCode、Pi、ZCode 和兼容 API 客户端连接你选择的供应商,并在一个应用里完成每次请求的路由、降级、增强与观测。 +让 Claude Code、Claude Design、Codex、Grok CLI、Kimi CLI、Kilo Code、OpenCode、Pi、ZCode、WorkBuddy 和兼容 API 客户端连接你选择的供应商,并在一个应用里完成每次请求的路由、降级、增强与观测。

下载桌面端 @@ -59,7 +59,7 @@ ## 为什么使用 Claude Code Router? -Claude Code Router(CCR)是面向编程 Agent 的本地模型网关与控制平面。它为 Claude Code、Claude Design、Codex、Grok CLI、Kimi CLI、Kilo Code、OpenCode、Pi、ZCode 和兼容 API 客户端提供**一个稳定的本地入口**,让你在一个地方管理入口背后的供应商、模型、账号、路由规则与工具。 +Claude Code Router(CCR)是面向编程 Agent 的本地模型网关与控制平面。它为 Claude Code、Claude Design、Codex、Grok CLI、Kimi CLI、Kilo Code、OpenCode、Pi、ZCode、WorkBuddy 和兼容 API 客户端提供**一个稳定的本地入口**,让你在一个地方管理入口背后的供应商、模型、账号、路由规则与工具。 你可以使用 CCR: @@ -78,71 +78,78 @@ CCR 支持 OpenAI Chat / Responses、Anthropic Messages、Gemini Generate Conten - - - - - - - - + + - - - +
+ Claude Code 图标
Claude Code (CLI & APP)
+ Codex 图标
Codex (CLI & APP)
+ Grok CLI 图标
Grok CLI (CLI)
+ Kimi CLI 图标
Kimi CLI (CLI)
+ Kilo Code 图标
Kilo Code (CLI)
+
OpenCode 图标
OpenCode (CLI & APP)
+ Pi 图标
Pi (CLI)
+ ZCode 图标
ZCode (APP)
+ Claude Design 图标
Claude Design (APP)
+ + WorkBuddy 图标 +
+ WorkBuddy (APP) +
+
@@ -162,28 +169,28 @@ CCR 支持 OpenAI Chat / Responses、Anthropic Messages、Gemini Generate Conten
- + Windows 图标
Windows
- + Linux 图标
Linux
- + macOS 图标
macOS (Apple Silicon)
- + macOS 图标
macOS (Intel) @@ -198,7 +205,7 @@ CCR 支持 OpenAI Chat / Responses、Anthropic Messages、Gemini Generate Conten 2. 打开 **供应商 → 添加供应商**。选择内置预设或自定义端点,填写 API Key,选择协议与模型,然后保存。 3. 打开 **服务** 并点击 **启动**。本地模型网关默认监听 `http://127.0.0.1:3456`。 -4. 打开 **Agent配置**,选择 Claude Code、Claude Design、Codex、Grok CLI、Kimi CLI、Kilo Code、OpenCode、Pi 或 ZCode,指定模型并应用配置档案。 +4. 打开 **Agent配置**,选择 Claude Code、Claude Design、Codex、Grok CLI、Kimi CLI、Kilo Code、OpenCode、Pi、ZCode 或 WorkBuddy,指定模型并应用配置档案。 5. 开始使用 Agent。在 **日志** 中确认最终供应商、模型、状态、Token、耗时与错误。 现在 Agent 已经连接到 CCR。如需增加条件规则、自动重试、请求改写或 Fallback 模型,请打开 **路由**。 @@ -236,7 +243,7 @@ Windows App 打包必须在 Windows x64 上运行,因为 `better-sqlite3` 包 ## 工作方式 ```text -Claude Code · Claude Design · Codex · Grok CLI · Kimi CLI · Kilo Code · OpenCode · Pi · ZCode · 兼容 API 客户端 +Claude Code · Claude Design · Codex · Grok CLI · Kimi CLI · Kilo Code · OpenCode · Pi · ZCode · WorkBuddy · 兼容 API 客户端 │ ▼ Claude Code Router :3456 @@ -250,7 +257,7 @@ Claude Code · Claude Design · Codex · Grok CLI · Kimi CLI · Kilo Code · Op | 能力领域 | 功能亮点 | | --- | --- | -| **Agent** | Claude Code、Claude Design、Codex、Grok CLI、Kimi CLI、Kilo Code、OpenCode、Pi 和 ZCode 配置档案;模型覆盖;作用范围;环境变量;CLI / App 启动入口;多开工作流 | +| **Agent** | Claude Code、Claude Design、Codex、Grok CLI、Kimi CLI、Kilo Code、OpenCode、Pi、ZCode 和 WorkBuddy 配置档案;模型覆盖;作用范围;环境变量;CLI / App 启动入口;多开工作流 | | **供应商** | 内置预设和自定义端点;协议探测;模型发现;连通性检测;按支持情况导入本机登录态;单 Key 与凭据池 | | **模型与路由** | 可搜索模型目录;用于任务选择的模型描述;Header / Body 条件;模型前缀;请求改写;重试;有序 Fallback | | **工具与扩展** | Fusion 模型;ToolHub;内置浏览器自动化;Chrome 登录态导入;wrapper / core gateway plugin;本地路由与虚拟模型 | diff --git a/docs/src/content/docs/en/agentclaw.md b/docs/src/content/docs/en/agentclaw.md index eeccbc89..03281864 100644 --- a/docs/src/content/docs/en/agentclaw.md +++ b/docs/src/content/docs/en/agentclaw.md @@ -7,7 +7,7 @@ lead: "AgentClaw connects an agent running locally under CCR to your IM apps: th AgentClaw is CCR's agent relay capability. A local agent managed by CCR keeps its workspace, login state, config files, model routing, and tool permissions; AgentClaw exposes a remote entry point for it through an IM bot. From Slack, Discord, Telegram, LINE, Weixin, WeCom, Feishu, or DingTalk, you can watch agent output, continue the conversation, answer permission requests, or take over after your computer locks. -Handoff means that after your screen locks and the idle threshold passes, further agent interaction moves to IM, where you can continue from your phone or another device. Handoff relies on a companion worker that follows the App lifecycle: opening an Agent App from CCR starts its worker, and closing the App stops the worker and the Bot connection. CLI-only agents can still route model requests through CCR, but they do not forward messages to IM. +Handoff means that after your screen locks and the idle threshold passes, further agent interaction moves to IM, where you can continue from your phone or another device. Keep the Agent App open while using IM relay. CLI-only agents can still route model requests through CCR, but they do not forward messages to IM. ## When to use it @@ -29,7 +29,7 @@ Handoff means that after your screen locks and the idle threshold passes, furthe | Session | An agent-native conversation inside a Project | | Companion worker | The relay process that follows the managed Agent App lifecycle and handles IM messages, Projects/Sessions, queueing, attachments, and diagnostics | -AgentClaw shares the lifecycle of the Agent App opened by CCR. Opening Claude, Codex, ZCode, or OpenCode App starts its companion worker; closing the App stops both the worker and the Bot connection. CLI-only agents can route model requests through CCR but do not forward Bot messages. +AgentClaw follows the Agent App opened by CCR. Closing the App stops the Bot connection. CLI-only agents can route model requests through CCR but do not forward Bot messages. ## Support matrix @@ -39,9 +39,10 @@ AgentClaw shares the lifecycle of the Agent App opened by CCR. Opening Claude, C | Codex / ChatGPT App | Full Bot forwarding, handoff, Projects/Sessions, queueing, model settings, usage, and attachments | | OpenCode App | Full Bot forwarding, handoff, and Projects/Sessions; messages run through OpenCode CLI under the same config | | ZCode App | Full Bot forwarding, handoff, and native Session discovery | +| WorkBuddy App | Full Bot forwarding, handoff, and WorkBuddy companion relay | | Claude Code, Codex CLI | Can use CCR model routing; Bot forwarding is not active yet | | Grok CLI, Kimi CLI | Can use CCR model routing; these are CLI-only and do not enter AgentClaw relay | -| Other local agents | They need a CCR-managed App entry plus a companion worker before they can act as AgentClaw executors | +| Other local agents | They need a CCR-managed App entry before they can act as AgentClaw executors | ## Three modes @@ -78,7 +79,7 @@ AgentClaw exposes only `/project` and `/session` as public command domains. Othe | `/session name