mirror of
https://github.com/codewhale-hq/Codewhale.git
synced 2026-11-07 10:36:05 -10:00
Answer the integration chooser, actual catalog prerequisites, supported plugin formats, direct-versus-plugin MCP authentication and troubleshooting on the existing paper/blue pages. Link the plugin guide from docs navigation and refresh its plain-text index. Add explicit Computer Use GitHub/contributor links in all18locales and version-aware direct-MCP setup for published CLI0.10.2, whose older built-in bundle is not upgraded by catalog installation.
Reconcile repository EN/ZH docs for config precedence, validation/reload, URL-only servers, environment credentials, trust hashes, pinned-source updates and catalog freshness. Current marketplace and unreleased source remain separate from installed-release claims; DSH and MCPApps are not presented as universally qualified.
Verified locally:47existingwebtests passed (26dictionary/copy+21llms/docsIA); focused ESLint, TypeScript, locale/GT checks and diff check passed. Initial custom test harness missed Vite alias configuration in2suites; corrected harness passed those21checks. Desktop1280/mobile390 EN/ZH browser review passed; stale development module hydration mismatch cleared after owned dev-server restart. Published CLI0.10.2 discovered current CU0.16.1 tools and executed request_access through a local synthetic model:ok=true/viaapp, accessibilitygranted, screen-captureprobeok. No input or provider spend. Credential-free Cloudflare Docs MCP discovery listed2tools. Existing-helper setup is not clean-Mac/app-task qualification.
Generated agent documentation uses51hashedinputs: our5revieweddocs plus committed da143039f7 content for all other inputs, excluding active peer GUIDE/feature/native drafts. Full clean web validation/deployment follows this frozen commit; no Engine release qualification. CU setup README is carried separately by codewhale-cu-plugin afb98e8. Evidence:CW/artifacts/plugin-mcp-discoverability-20261107. Tracking:CW-7848; CU acceptance remains CW-6732.
Codewhale documentation
Start with the user guide. The website renders a subset of these
pages at codewhale.net/docs; the Markdown here
is the source. Translations live beside their English page (*.id.md) or in
id/ and zh_hans/.
Get started
- Installing Codewhale, including PATH help and shell completions
- User guide: first run, sessions, commands, everyday workflows
- Keybindings
- Pet mode: a glanceable whale view per terminal, with replies and agents on demand
- Modes and permission postures
- Configuration
- Providers and local models and the Model Lab roadmap
- Platform notes: Docker, Termux / Android, HarmonyOS, environment caveats, classroom and lab installs
Using Codewhale
- Local browser client (
codewhale web) - Agent fleet, sub-agents, and the fleet and workflow tutorial
- Workflow authoring, automatic workflows, and experimental workflow search
- Skills and evaluating skill changes
- User memory
read_mediaand/preview-request
Extending Codewhale
- MCP servers
- Hooks
- Installing plugins, writing a plugin, plugin bundles, the first-party marketplace, and Claude plugin compatibility
- Writing an extension tool (experimental
extension_host) - LSP: PHP and custom language servers
- Runtime API and integration contract
- GitHub App setup
- DeepSeek Harness integration and DSH plugin compatibility
Safety and trust
- Authorization order
- Sandbox threat model
- Workroom security model
- Runtime receipts
- Signed cloud facts
- Telemetry
- Accessibility
- Security reports: see
.github/SECURITY.md
Architecture
- Product and architecture overview
- Agent runtime and Codewhale Agent
- Command and control-plane contract
- Tool surface
- Prompt-cache stability
- Workroom architecture
- Design notes:
architecture/,design/,decisions/, andrfcs/
Contributing and operating
- Contribution guide and agent ethos
- Voice and terminal charter, motion contract, and settings picker framework
- Issue triage
- Build and test performance
- Live smoke runs
- Localization matrix
- Dependency maintenance
- Release checklist and release runbook
- Operations runbook
- Catalog refresh and CNB mirror
- Agent skills for contributors:
skills/
History and reference
- Feature registry: every user feature with its status, first release, docs page and owning code, checked against the code by a test
- Contributors
- Changelog archive and the lifecycle outbox changelog
- Rebrand: DeepSeek TUI to Codewhale and
legacy
.deepseek/paths - Third-party notices
- Historical plans: TUI modularization, post-0.9.1 seams, runtime simplification, tool lifecycle (v0.8.53)