docs(brand): rename to codewhale across READMEs and docs
Sweep brand mentions of `DeepSeek TUI` / `deepseek-tui` / bare `deepseek` (the dispatcher binary) across all user-facing docs to the new `codewhale` brand. The DeepSeek **provider** integration is left untouched throughout: env vars (`DEEPSEEK_*`), model IDs (`deepseek-v4-pro`, `deepseek-v4-flash`, `deepseek-chat`, `deepseek-reasoner`), the `api.deepseek.com` host, the `~/.deepseek/` config dir, and the `--provider deepseek` argument value all keep the legacy spelling. Anti-scope items deliberately left as the legacy `deepseek-tui`: - Homebrew tap and formula (`Hmbown/homebrew-deepseek-tui`, `brew install deepseek-tui`, `scoop install deepseek-tui`). The tap rename ships separately. - Docker image (`ghcr.io/hmbown/deepseek-tui`). Image-tag rename ships separately. - CNB mirror namespace (`cnb.cool/deepseek-tui.com/DeepSeek-TUI`). Third-party hosted path. - Security contact email (`security@deepseek-tui.com`). - GitHub repo URL (`Hmbown/DeepSeek-TUI`). New artifact: - `docs/REBRAND.md` documents what changed, what didn't, the deprecation window, and migration commands for npm / Cargo / Homebrew / manual installs. CHANGELOG entries: - Root `CHANGELOG.md` and `crates/tui/CHANGELOG.md` both gain a new `[Unreleased]` section describing the rename and the one- release deprecation window. Historical entries are untouched. Issue templates: - `.github/ISSUE_TEMPLATE/bug_report.md` and `feature_request.md` refer to "codewhale" / `codewhale --version` instead of the old brand name in their environment fields. The rebrand sweep was driven by a perl script with bulk patterns (`deepseek-tui` -> `codewhale-tui`, `DeepSeek TUI` -> `codewhale`, bare `deepseek` -> `codewhale` with provider/model/host/env-var/ config-path negative lookbehind/lookahead) followed by targeted reverts for the anti-scope items above. Output was visually reviewed file-by-file before committing. Verified: - `cargo check --workspace --all-targets --locked` — pass. - `cargo test --workspace --all-features --locked` — pass (no test source touched here; suite stayed green to confirm no doc-from-string assertions broke). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Hunter Bown
+18
-18
@@ -1,8 +1,8 @@
|
||||
# Runtime API & Integration Contract
|
||||
|
||||
DeepSeek TUI exposes a local runtime API through `deepseek serve --http` and
|
||||
machine-readable health via `deepseek doctor --json`. It also exposes
|
||||
`deepseek serve --acp` for editor clients that speak the Agent Client Protocol
|
||||
codewhale exposes a local runtime API through `codewhale serve --http` and
|
||||
machine-readable health via `codewhale doctor --json`. It also exposes
|
||||
`codewhale serve --acp` for editor clients that speak the Agent Client Protocol
|
||||
over stdio. This document is the stable integration contract for native macOS
|
||||
workbench applications (and other local supervisors) that embed the DeepSeek
|
||||
engine without screen-scraping terminal output.
|
||||
@@ -12,19 +12,19 @@ engine without screen-scraping terminal output.
|
||||
```
|
||||
macOS workbench (or any local supervisor)
|
||||
│
|
||||
├─ deepseek doctor --json → machine-readable health & capability
|
||||
├─ deepseek serve --http → HTTP/SSE runtime API
|
||||
├─ deepseek serve --acp → ACP stdio agent for editors such as Zed
|
||||
├─ deepseek serve --mcp → MCP stdio server
|
||||
└─ deepseek [args] → interactive TUI session
|
||||
├─ codewhale doctor --json → machine-readable health & capability
|
||||
├─ codewhale serve --http → HTTP/SSE runtime API
|
||||
├─ codewhale serve --acp → ACP stdio agent for editors such as Zed
|
||||
├─ codewhale serve --mcp → MCP stdio server
|
||||
└─ codewhale [args] → interactive TUI session
|
||||
```
|
||||
|
||||
The engine runs as a local-only process. All APIs bind to `localhost` by
|
||||
default. No hosted relay, no provider-token custody, no secret leakage.
|
||||
|
||||
## ACP stdio adapter: `deepseek serve --acp`
|
||||
## ACP stdio adapter: `codewhale serve --acp`
|
||||
|
||||
`deepseek serve --acp` speaks JSON-RPC 2.0 over newline-delimited stdio for
|
||||
`codewhale serve --acp` speaks JSON-RPC 2.0 over newline-delimited stdio for
|
||||
ACP-compatible editor clients. The initial adapter implements the ACP baseline:
|
||||
|
||||
- `initialize`
|
||||
@@ -38,16 +38,16 @@ followed by a `session/prompt` response with `stopReason: "end_turn"`.
|
||||
|
||||
The adapter is intentionally conservative: it does not yet expose shell tools,
|
||||
file-write tools, checkpoint replay, or session loading through ACP. Use
|
||||
`deepseek serve --http` for the full local runtime API and `deepseek serve --mcp`
|
||||
`codewhale serve --http` for the full local runtime API and `codewhale serve --mcp`
|
||||
when another client needs DeepSeek's tools as MCP tools.
|
||||
|
||||
## Capability endpoint: `deepseek doctor --json`
|
||||
## Capability endpoint: `codewhale doctor --json`
|
||||
|
||||
Returns a JSON object describing the current installation's readiness state.
|
||||
Suitable for health-check polling from a macOS workbench.
|
||||
|
||||
```bash
|
||||
deepseek doctor --json
|
||||
codewhale doctor --json
|
||||
```
|
||||
|
||||
### Response schema (key fields)
|
||||
@@ -88,7 +88,7 @@ deepseek doctor --json
|
||||
"version": "0.8.9",
|
||||
"config_path": "/Users/you/.deepseek/config.toml",
|
||||
"config_present": true,
|
||||
"workspace": "/Users/you/projects/deepseek-tui",
|
||||
"workspace": "/Users/you/projects/codewhale-tui",
|
||||
"api_key": {
|
||||
"source": "env"
|
||||
},
|
||||
@@ -113,10 +113,10 @@ deepseek doctor --json
|
||||
}
|
||||
```
|
||||
|
||||
## HTTP/SSE runtime API: `deepseek serve --http`
|
||||
## HTTP/SSE runtime API: `codewhale serve --http`
|
||||
|
||||
```bash
|
||||
deepseek serve --http [--host 127.0.0.1] [--port 7878] [--workers 2] [--auth-token TOKEN]
|
||||
codewhale serve --http [--host 127.0.0.1] [--port 7878] [--workers 2] [--auth-token TOKEN]
|
||||
```
|
||||
|
||||
Defaults: host `127.0.0.1`, port `7878`, 2 workers (clamped 1–8).
|
||||
@@ -333,7 +333,7 @@ The runtime API ships with a built-in dev-origin allow-list:
|
||||
`http://127.0.0.1:1420`, `tauri://localhost`. To add additional origins (e.g.
|
||||
when developing a UI on Vite's default `:5173`), use any of:
|
||||
|
||||
- CLI flag (repeatable): `deepseek serve --http --cors-origin http://localhost:5173`
|
||||
- CLI flag (repeatable): `codewhale serve --http --cors-origin http://localhost:5173`
|
||||
- Env var (comma-separated): `DEEPSEEK_CORS_ORIGINS="http://localhost:5173,http://localhost:8080"`
|
||||
- Config (`~/.deepseek/config.toml`):
|
||||
```toml
|
||||
@@ -366,7 +366,7 @@ model is preserved. Added in v0.8.10 (#561).
|
||||
Contract snapshots live in `crates/protocol/tests/`. Run:
|
||||
|
||||
```bash
|
||||
cargo test -p deepseek-protocol --test parity_protocol --locked
|
||||
cargo test -p codewhale-protocol --test parity_protocol --locked
|
||||
```
|
||||
|
||||
This validates that the app-server's event schema hasn't drifted from the
|
||||
|
||||
Reference in New Issue
Block a user