| 1 | # Codewhale documentation |
| 2 | |
| 3 | Start with the [user guide](GUIDE.md). The website renders a subset of these |
| 4 | pages at [codewhale.net/docs](https://codewhale.net/en/docs); the Markdown here |
| 5 | is the source. Translations live beside their English page (`*.id.md`) or in |
| 6 | [`id/`](id) and [`zh_hans/`](zh_hans). |
| 7 | |
| 8 | ## Get started |
| 9 | |
| 10 | - [Installing Codewhale](INSTALL.md), including PATH help and shell completions |
| 11 | - [User guide](GUIDE.md): first run, sessions, commands, everyday workflows |
| 12 | - [Keybindings](KEYBINDINGS.md) |
| 13 | - [Modes and permission postures](MODES.md) |
| 14 | - [Configuration](CONFIGURATION.md) |
| 15 | - [Providers and local models](PROVIDERS.md) and the [Model Lab roadmap](MODEL_LAB.md) |
| 16 | - Platform notes: [Docker](DOCKER.md), [Termux / Android](TERMUX.md), |
| 17 | [HarmonyOS](HarmonyOS.md), [environment caveats](ENVIRONMENTS.md), |
| 18 | [classroom and lab installs](CLASSROOM_INSTALL.md) |
| 19 | |
| 20 | ## Using Codewhale |
| 21 | |
| 22 | - [Local browser client](WEB.md) (`codewhale web`) |
| 23 | - [Agent fleet](FLEET.md), [sub-agents](SUBAGENTS.md), and the |
| 24 | [fleet and workflow tutorial](FLEET_WORKFLOW_TUTORIAL.md) |
| 25 | - [Workflow authoring](WORKFLOW_AUTHORING.md), |
| 26 | [automatic workflows](AUTOMATIC_WORKFLOWS.md), and |
| 27 | [experimental workflow search](WORKFLOW_EXPERIMENTAL_SEARCH.md) |
| 28 | - [Skills](SKILLS.md) and [evaluating skill changes](SKILL_EVALUATION.md) |
| 29 | - [User memory](MEMORY.md) |
| 30 | - [`read_media`](READ_MEDIA.md) and [`/preview-request`](PREVIEW_REQUEST.md) |
| 31 | - [Cloud-agent dispatch](DAYTONA_CLOUD_DISPATCH.md) |
| 32 | |
| 33 | ## Extending Codewhale |
| 34 | |
| 35 | - [MCP servers](MCP.md) |
| 36 | - [Hooks](HOOKS.md) |
| 37 | - [Installing plugins](PLUGINS.md), [writing a plugin](PLUGIN_AUTHORING.md), |
| 38 | [plugin bundles](PLUGIN_BUNDLES.md), [the first-party marketplace](PLUGIN_MARKETPLACE.md), |
| 39 | and [Claude plugin compatibility](CLAUDE_PLUGIN_COMPAT.md) |
| 40 | - [Writing an extension tool](EXTENSIONS.md) (experimental `extension_host`) |
| 41 | - [LSP: PHP and custom language servers](LSP_PHP_CUSTOM.md) |
| 42 | - [Runtime API and integration contract](RUNTIME_API.md) |
| 43 | - [GitHub App setup](GITHUB_APP.md) |
| 44 | - [DeepSeek Harness integration](INTEGRATIONS_DSH.md) |
| 45 | |
| 46 | ## Safety and trust |
| 47 | |
| 48 | - [Authorization order](AUTHORIZATION_ORDER.md) |
| 49 | - [Sandbox threat model](SANDBOX.md) |
| 50 | - [Workroom security model](WORKROOM_SECURITY.md) |
| 51 | - [Runtime receipts](RECEIPTS.md) |
| 52 | - [Signed cloud facts](CLOUD_FACTS.md) |
| 53 | - [Telemetry](TELEMETRY.md) |
| 54 | - [Accessibility](ACCESSIBILITY.md) |
| 55 | - Security reports: see [`.github/SECURITY.md`](../.github/SECURITY.md) |
| 56 | |
| 57 | ## Architecture |
| 58 | |
| 59 | - [Product](PRODUCT.md) and [architecture overview](ARCHITECTURE.md) |
| 60 | - [Agent runtime](AGENT_RUNTIME.md) and [Codewhale Agent](CODEWHALE_AGENT.md) |
| 61 | - [Command and control-plane contract](COMMAND_CONTROL_PLANE.md) |
| 62 | - [Tool surface](TOOL_SURFACE.md) |
| 63 | - [Prompt-cache stability](CACHE.md) |
| 64 | - [Workroom architecture](WORKROOM_ARCHITECTURE.md) |
| 65 | - Design notes: [`architecture/`](architecture), [`design/`](design), |
| 66 | [`decisions/`](decisions), and [`rfcs/`](rfcs) |
| 67 | |
| 68 | ## Contributing and operating |
| 69 | |
| 70 | - [Contribution guide](../CONTRIBUTING.md) and [agent ethos](AGENT_ETHOS.md) |
| 71 | - [Voice and terminal charter](VOICE.md), [motion contract](MOTION_CONTRACT.md), |
| 72 | and [settings picker framework](SETTINGS_PICKER_FRAMEWORK.md) |
| 73 | - [Issue triage](ISSUE_TRIAGE.md) |
| 74 | - [Build and test performance](BUILD_PERFORMANCE.md) |
| 75 | - [Live smoke runs](LIVE_SMOKE.md) |
| 76 | - [Localization matrix](LOCALIZATION.md) |
| 77 | - [Dependency maintenance](dependency-maintenance.md) |
| 78 | - [Release checklist](RELEASE_CHECKLIST.md) and [release runbook](RELEASE_RUNBOOK.md) |
| 79 | - [Operations runbook](OPERATIONS_RUNBOOK.md) |
| 80 | - [Catalog refresh](CATALOG_REFRESH.md) and [CNB mirror](CNB_MIRROR.md) |
| 81 | - Agent skills for contributors: [`skills/`](skills) |
| 82 | |
| 83 | ## History and reference |
| 84 | |
| 85 | - [Feature registry](features.toml): every user feature with its status, first |
| 86 | release, docs page and owning code, checked against the code by a test |
| 87 | - [Contributors](CONTRIBUTORS.md) |
| 88 | - [Changelog archive](CHANGELOG_ARCHIVE.md) and the |
| 89 | [lifecycle outbox changelog](changelog-lifecycle-outbox.md) |
| 90 | - [Rebrand: DeepSeek TUI to Codewhale](REBRAND.md) and |
| 91 | [legacy `.deepseek/` paths](LEGACY_PATHS.md) |
| 92 | - [Third-party notices](THIRD_PARTY_NOTICES.md) |
| 93 | - Historical plans: [TUI modularization](TUI_MODULARIZATION.md), |
| 94 | [post-0.9.1 seams](POST_0_9_1_SEAMS.md), |
| 95 | [runtime simplification](RUNTIME_SIMPLIFICATION_DESIGN.md), |
| 96 | [tool lifecycle (v0.8.53)](TOOL_LIFECYCLE.md) |
| 97 |