Files
hmbown--codewhale/docs/public-surface-facts.json
CodeWhale Bot 037aab9cf3 docs: align the v0.9.6 public surface
Document Work and To-do as the two product concepts, synchronize every shipped locale, publish the six-tool and typed-image contracts, and keep static web generation offline while live GitHub chrome refreshes after deployment.
2026-08-11 06:16:30 -07:00

242 lines
6.6 KiB
JSON

{
"schemaVersion": 2,
"product": {
"name": "Codewhale",
"description": "Terminal coding agent for supported hosted and local models. One runtime on your machine. Rust, MIT.",
"positioning": "Terminal-native, model/provider-neutral, local-first coding agent",
"license": "MIT",
"terminology": {
"Fleet": "who does the work",
"Workflow": "what order the work follows",
"Lane": "one running Workflow instance",
"Runtime": "where and how a Lane executes"
},
"sources": [
"Cargo.toml",
"LICENSE",
"README.md",
"npm/codewhale/package.json",
"docs/FLEET.md"
]
},
"sourceCandidate": {
"version": "0.9.6",
"providerCount": 41,
"toolCount": 74,
"sandboxBackends": [
"seatbelt (macOS, when available)",
"bubblewrap (Linux, opt-in when installed)"
],
"sources": [
"Cargo.toml",
"crates/tui/src/config.rs",
"crates/tui/src/sandbox/mod.rs",
"web/scripts/derive-facts.mjs"
]
},
"latestPublishedRelease": {
"tag": "v0.9.5",
"version": "0.9.5",
"publishedAt": "2026-08-08T16:39:59Z",
"url": "https://github.com/Hmbown/CodeWhale/releases/tag/v0.9.5",
"sources": [
"web/data/latest-published-release.json"
]
},
"install": {
"recommended": "npm install -g codewhale",
"binaries": [
"codewhale",
"codew"
],
"channels": {
"npm": "published releases only",
"cargo": "published crates only",
"prebuiltArchives": "published GitHub Releases only",
"cnbMirror": "documented targets only"
},
"androidTermux": {
"status": "preview",
"npm": "preview",
"requiresMatchingPublishedAssets": true,
"sourceBuild": true
},
"sources": [
"README.md",
"npm/codewhale/package.json",
"npm/codewhale/README.md",
"npm/codewhale/scripts/artifacts.js",
"docs/INSTALL.md",
"docs/CNB_MIRROR.md"
]
},
"control": {
"modes": [
"Plan",
"Work",
"Operate"
],
"permissionPostures": [
"Ask",
"Auto-Review",
"Full Access"
],
"shortcuts": {
"mode": {
"chord": "Tab",
"when": "composer empty"
},
"permissionPosture": {
"chord": "Shift+Tab",
"when": "always (suppressed only under a non-Config modal)"
}
},
"sources": [
"docs/MODES.md",
"docs/KEYBINDINGS.md",
"crates/tui/src/settings.rs"
]
},
"toolSurface": {
"defaultActive": [
"read",
"write",
"edit",
"bash",
"agent",
"tool_search"
],
"schemas": {
"read": [
"path",
"offset?",
"limit?"
],
"write": [
"path",
"content"
],
"edit": [
"path",
"edits"
],
"bash": [
"command",
"timeout?"
]
},
"deferred": {
"Web": [
"search",
"fetch",
"wait"
]
},
"compatibility": {
"legacyAliases": "hidden-exact",
"modelVisible": false,
"toolSearchDiscoverable": false
},
"activationCache": {
"maximumNames": 8,
"maximumSchemaBytes": 16384,
"scope": "per conversation; each subagent owns an independent policy-filtered cache"
},
"agentConcurrency": {
"defaultConfigured": 64,
"maximumConfigured": 128,
"maximumAdmitted": 1024
},
"sources": [
"docs/TOOL_SURFACE.md",
"docs/RUNTIME_SIMPLIFICATION_DESIGN.md",
"crates/tui/src/core/engine/tool_catalog.rs",
"crates/tui/src/tools/registry.rs",
"crates/tui/src/config/subagent_limits.rs"
]
},
"surfaces": {
"availableInSourceCandidate": [
"TUI",
"codewhale exec",
"Web client",
"Runtime API",
"MCP",
"Fleet"
],
"sources": [
"docs/GUIDE.md",
"docs/WEB.md",
"docs/RUNTIME_API.md",
"docs/MCP.md",
"docs/FLEET.md"
]
},
"trust": {
"localRuntime": "runtime, workspace state, and audit log stay on the user's machine",
"hostedProviderBoundary": "the selected hosted provider receives turn context required for inference",
"localInference": "a loopback local-model route can keep inference local",
"telemetry": "anonymous usage counting is on by default with a clear first-run disclosure and a durable opt-out; Codewhale does not collect conversations, code, prompts, files, file/repo/branch names, model content, credentials, or per-turn/per-tool timelines; it posts aggregate counts and closed enums to the first-party endpoint https://telemetry.codewhale.net/v1/telemetry, whose storage has no IP, country, or geo column and a fixed three-month retention; telemetry_endpoint = \"\" writes only to a local dry-run file; no mandatory hosted relay",
"account": "no account required for the local runtime",
"plan": "Plan is read-only",
"sandbox": "Seatbelt is used on macOS when available; Linux bubblewrap is opt-in and must be installed; Windows currently reports no OS sandbox",
"audit": "sensitive events append best-effort to $CODEWHALE_HOME/audit.log (default ~/.codewhale/audit.log); write failures are logged",
"usage": "provider token and cache usage is shown locally when available",
"sources": [
"docs/PROVIDERS.md",
"docs/MODES.md",
"docs/SANDBOX.md",
"docs/RUNTIME_API.md",
"docs/WEB.md",
"crates/tui/src/audit.rs",
"web/app/[locale]/faq/page.tsx",
"web/app/[locale]/install/page.tsx"
]
},
"platforms": {
"prebuilt": [
"Linux x64",
"Linux arm64",
"macOS x64",
"macOS arm64",
"Windows x64",
"Windows arm64"
],
"preview": [
"Android/Termux arm64"
],
"sources": [
"docs/INSTALL.md"
]
},
"repository": {
"canonical": "https://github.com/Hmbown/CodeWhale",
"mirrors": [
"https://cnb.cool/codewhale.net/codewhale",
"https://npmmirror.com/package/codewhale"
],
"creditSources": [
"CHANGELOG.md",
"docs/CONTRIBUTORS.md",
"web/lib/release-credits.ts"
],
"requiredCandidateCredits": [
"@xavierpestel-ai",
"@ousamabenyounes",
"@rafaelcavalheri"
]
},
"screenshot": {
"readme": "assets/screenshot.png",
"website": "web/public/codewhale-tui.png",
"sourceVersion": null,
"sourceCommit": null,
"terminal": "unrecorded",
"theme": "Blue Stage dark",
"capture": "current Codewhale session; exact binary identity was not recorded, so this image makes no published-release or exact-candidate claim",
"sources": [
"crates/tui"
]
}
}