Find the guidance you need.
Start from a task or a topic. Every page states which repository document it is drawn from and which release it describes.
By task
15Start from what you are trying to do.
Start with GitHub release binaries; npm, Cargo, Homebrew, Docker, and China mirrors are alternatives.
Start the runtime, look around in read-only Plan mode, then connect a provider.
DeepSeek, OpenAI, Anthropic, OpenRouter, or a local runtime — your key, your bill.
Read-only planning, execution, or Fleet orchestration — and the approval posture beside it.
Approval posture, the OS sandbox per platform, and why an approval is not a sandbox.
The optional account, where its session lives, and what needs no account at all.
Propose, confirm, and track a Daytona cloud agent against an explicit forge.
Roles, context forking, worktree isolation, and the concurrency caps.
Consume tools over stdio or HTTP/SSE, or expose Codewhale as a server.
Lifecycle hooks for tool execution, mode changes, and session events.
Durable task execution, roster management, and Workflow authoring.
Run the embedded web client on loopback with its one-time bootstrap.
The public HTTP API for integrations, bridges, and scripts.
Common incidents, diagnostics, the operations runbook, and Docker notes.
The hosted-provider boundary, the sandbox, telemetry field by field, and how to turn it off.
By topic
23Getting started
4npm, Cargo, Homebrew, Docker, prebuilt binaries, CNB mirror, and where config lives.
First run, sessions, commands, keyboard shortcuts, and everyday workflows.
config.toml reference, environment variables, project overrides, and legacy paths.
Provider keys versus the optional Codewhale account: how each is set, where each is stored, and what needs no account.
Core concepts
7The exact product nouns — Fleet, Workflow, Lane, Runtime; Plan / Work / Operate; Advisor; and explicit route provenance — plus measurement principles.
Agent identity, authority hierarchy, evidence rules, and the nested law system.
Plan, Work, Operate modes and orthogonal permission posture.
Canonical action tools, deferred discovery, and replay compatibility.
The single To-do list, how the model sees it through its own tool results, and how work state flows to the sidebar, relay, and sub-agents.
Parallel execution, role types, transcript handles, and nesting.
Available Seatbelt (macOS), opt-in bubblewrap (Linux), platform gaps, and approval policies.
Reference
2Supported providers, model switching, local runtimes (vLLM, Ollama, SGLang), and Model Lab.
What stays local, what a hosted provider receives, approvals versus the OS sandbox, telemetry field by field, and where to report a vulnerability.
Extending
6Model Context Protocol — consuming and exposing tools via stdio and HTTP/SSE.
Lifecycle hooks for pre/post tool execution, mode changes, and session events.
Install, discover, trust, and load reusable instruction packages.
Plugin discovery, installation, bundles, trust boundaries, and runtime lifecycle.
Public HTTP API for integrations, bridges, and automation.
Run the embedded browser client on loopback, with its one-time bootstrap and session boundaries.
Operations
4Propose, confirm, and track a Daytona cloud agent against an explicit forge — fail-closed credentials and what is not built yet.
Durable task execution, fleet roster management, and Workflow authoring.
Common issues, diagnostics, operations runbook, and Docker notes.
Contributing guide, agent ethos, contributor credits, and release process.
Web guides stay on codewhale.net. Source docs open the complete reference in the GitHub repository. Tasks come from docs-tasks.ts and topics from docs-map.ts; both registries live in the repository.