Install and use Codewhale
Find installation steps, model setup, tool configuration and troubleshooting. The guides include commands and examples you can run.
By task
23Start from what you are trying to do.
Read a redacted request manifest without sending or changing session state.
Return LSP errors after edits and configure custom servers by file extension.
Read rule sources, matchers and scope; understand allow, ask and deny precedence.
Find SKILL.md folders, import into owned roots and control invocation.
Keep compatible instructions and skills, and review a settings import plan.
One command on macOS or Linux; npm, Cargo, release binaries, and the Homebrew tap on Linux also work.
Open Codewhale in a project, look around in Plan, then let it edit in Work.
Save a key for DeepSeek, OpenAI, Anthropic, OpenRouter, or another provider — or run a local model with no key.
Supported providers, switching mid-session, and local runners.
Plan, Work, or Operate; Ask, Auto-Review, or Full Access; and how to answer a prompt.
See every edit, roll files back to an earlier turn, and get a code review before you push.
Read a session receipt of commands, file changes, tools and approval decisions.
Turn on pet mode in each terminal to see which session is working, waiting for you, done, or failed.
Write a repeatable Workflow, run it as a Lane, and watch or stop it from any terminal.
Roles, separate worktrees for parallel edits, and how to watch sub-agents.
Add a local or remote MCP server, sign in with OAuth, or serve Codewhale over MCP.
Let the model compose several tool calls — MCP and plugin tools included — in one short program, under the same approvals as direct calls. Experimental, on by default.
Block a risky command, add context, or get notified when Codewhale waits for you.
See which OS sandbox your platform has and turn on bubblewrap on Linux.
Run one-shot jobs in CI, or drive threads and approvals over the local HTTP API.
Work in a local browser tab, or continue a session from the web app with /rc.
Diagnose in one command, then fix install, key, network, and stuck-turn problems.
What a provider receives, what usage counting sends, and how to turn it off.
By topic
25Get started
6The installer, npm, Homebrew tap, Cargo, and release binaries, with the output each step prints.
Details
docs/INSTALL.md
Install, connect a model, and give Codewhale a task in your project.
Details
docs/GUIDE.md, docs/KEYBINDINGS.md
Save a provider key, check which key is used, or run a local model.
Details
docs/CONFIGURATION.md, docs/CODEWHALE_AGENT.md
Supported providers, switching models, and local runners such as Ollama, vLLM, and SGLang.
Details
docs/PROVIDERS.md, docs/MODEL_LAB.md
Find the config file, change settings from the session or shell, and see what a repository may override.
Details
docs/CONFIGURATION.md, docs/LEGACY_PATHS.md
Keep compatible instructions and skills, and review settings and MCP imports without running Claude Code plugin runtimes.
Details
docs/CLAUDE_PLUGIN_COMPAT.md, docs/CONFIGURATION.md
Work with Codewhale
8Plan, Work, or Operate for the kind of work; Ask, Auto-Review, or Full Access for when it asks you.
Details
docs/MODES.md
See every edit, roll files back to an earlier turn, get a code review, and keep a review receipt.
Details
docs/RECEIPTS.md, docs/CONFIGURATION.md
Follow the goal, To-do list, and sub-agents in the workbar, and hand work to a fresh session.
Details
docs/TOOL_SURFACE.md, docs/TOOL_LIFECYCLE.md
A whale view per terminal that shows working, waiting for you, done, or failed, with replies and agents one key away.
Details
docs/PET_MODE.md
Hand independent parts of a task to sub-agents, pick roles, and keep parallel edits in worktrees.
Details
docs/SUBAGENTS.md
Save roles in a Fleet, write a repeatable Workflow, run it as a Lane, and run batches of tasks.
Details
docs/FLEET.md, docs/WORKFLOW_AUTHORING.md
The OS sandbox on macOS, Linux, and Windows, how to turn it on, and how much a command may write.
Details
docs/SANDBOX.md, docs/AUTHORIZATION_ORDER.md
What stays local, what a provider receives, what usage counting sends, and how to turn it off.
Details
docs/SANDBOX.md, docs/AUTHORIZATION_ORDER.md, docs/TELEMETRY.md, docs/public-surface-facts.json, docs/PREVIEW_REQUEST.md
Extend and automate
6Add local (stdio) or remote (HTTP) MCP servers, sign in with OAuth, serve Codewhale over MCP, and try code mode.
Details
docs/MCP.md
Run your own scripts at session start, before a tool call, at turn end, or when Codewhale waits for you.
Details
docs/rfcs/1364-hooks-lifecycle.md, docs/CONFIGURATION.md
Install, find, trust, and load reusable instruction packages.
Details
docs/SKILLS.md, docs/CLAUDE_PLUGIN_COMPAT.md
Find, install, review, and trust plugin bundles.
Details
docs/PLUGINS.md, docs/PLUGIN_BUNDLES.md, docs/EXTENSIONS.md
Get help
2Diagnose in one command, then fix install, key, network, stuck-turn, session, and MCP problems.
Details
docs/OPERATIONS_RUNBOOK.md, docs/DOCKER.md
The contributing guide, agent ethos, contributor credits, and release process.
Details
CONTRIBUTING.md, docs/AGENT_ETHOS.md, docs/CONTRIBUTORS.md, docs/RELEASE_CHECKLIST.md
Reference
3Fleet, Workflow, Lane, and Runtime; Plan, Work, and Operate — each in one sentence.
Details
docs/FLEET.md, docs/MODES.md, docs/public-surface-facts.json
What the agent treats as law: built-in rules, your personal constitution, and a repository's own.
Details
docs/ARCHITECTURE.md
The small set of tools every session starts with, and how Codewhale finds the rest.
Details
docs/TOOL_SURFACE.md, docs/RUNTIME_SIMPLIFICATION_DESIGN.md, docs/LSP_PHP_CUSTOM.md
Web guides open on codewhale.net. Source docs open the full reference in the GitHub repository.