Runtime & Integrations
Drive Codewhale from your own tools 运行时与集成
Codewhale runs a local control plane alongside the terminal. Editors, scripts, and chat apps use it to read threads, stream events, and answer approvals.
Integration surfaces
- HTTP / SSE Runtime APIFull local HTTP + Server-Sent Events runtime API on 127.0.0.1:7878. Create threads, stream turns, manage background jobs, and control approval decisions — all from any HTTP client or the bundled mobile page.
- ACP (Agent Client Protocol)ACP stdio connects compatible editors to the existing Engine. It supports durable session creation, listing, loading, prompts, cancellation and model selection. Its local profile admits file/search/git/patch and foreground shell only with editor support and operator permission; MCP, dynamic tools and background jobs are unavailable.
- MCP (Model Context Protocol)Connect Codewhale to external tools and services through configured MCP servers over stdio or HTTP/SSE, or expose read-only file_read and search to another MCP client by default.
- VS Code ExtensionEarly companion for the local runtime. It can open Codewhale in a terminal, start and check the Runtime API, and show read-only thread summaries and restore points. It does not yet provide full chat, inline edits, or editor actions.
- CodeWhale GUI (VS Code)The community-maintained graphical frontend, in a separate repository: chat, threads, live file changes, and task tracking in a VS Code sidebar over this Runtime API. Install it from the VS Code Marketplace; the source is on GitHub.
- Telegram BridgeFirst-party Telegram bot bridge. Start a headless Codewhale session, then chat with it from any Telegram client — approvals, tool results, and completions surface inline.
- Feishu / Lark BridgeFirst-party Feishu / Lark bot bridge. Chat-native agent loop inside your Feishu workspace with approval messages, session linking, and audit trail.
- Weixin BridgeExperimental Weixin / WeChat bridge. Receive agent completions and approvals inside WeChat; early-stage and not recommended for production deployments.Experimental
Trust boundary
- Runs on your machine
- The Runtime API binds 127.0.0.1 by default. The local runtime does not require a Codewhale account or hosted relay.
- Auth required
- Runtime API routes (/v1/*) require a Bearer token. Pass --auth-token at startup or set CODEWHALE_RUNTIME_TOKEN. Only a loopback bind can turn this off, with --insecure-no-auth.
- Permissions user-controlled
- Remote clients submit requests and approval decisions through the authenticated Runtime API. Local mode, permission posture, and sandbox policy still apply.
- Open protocols
- The HTTP/SSE Runtime API, MCP surface, and ACP stdio transport serve different integration needs; choose the interface your compatible client supports.
Runtime facts
- Source version
- 0.10.2
- Tool count
- 79
- Sandbox backends
- seatbelt (macOS, when available) · bubblewrap (Linux, default when installed and working)
Details
- Crates
- 30 · agent, agent-contract, app-server, build-support, cli, cloud-facts, command-contract, commands, config, core, execpolicy, hooks, lane, localization, mcp, memory, models, palette, paths, protocol, release, runtime, sanitize, secrets, state, telemetry, tools, tui, workflow, workflow-js
- Source revision
a43f4c1e78f73ed9cc6543512792649f0b6a5ee4
Detailed implementation docs:Runtime API and ACP stdio adapterMCP integration