Codewhale is an open-source agent that reads your project, edits files, runs
commands, and checks its work using a hosted or local model you choose. Start
with one task in your terminal. For a larger job, give parts of the work to
agents with different models and roles.
Terminal preview from a v0.9.12 development build.
Install
macOS / Linux — install the official GitHub release:
curl -fsSL https://codewhale.net/install.sh | sh
"$HOME/.local/bin/codewhale"
The installer selects the latest published release. The changelog
also describes the next release's unreleased candidate; those changes are not
included in published downloads until the release is available.
Windows: download the matching installer or archive from
GitHub Releases.
For an existing direct install, run codewhale update (or codewhale update --check
to inspect it). The updater prints the executable path and keeps newer builds.
The first run helps you connect a provider or configure Codewhale offline.
Model replies require a connected hosted or local model. Codewhale also
supports npm and Cargo as secondary packaging routes, plus Docker, Nix, Scoop,
Android/Termux, and an optional CNB mirror. Existing package-managed installs
receive migration instructions. See installation and PATH help.
Tab completion is one command per shell — codewhale completion bash|zsh|fish|powershell|elvish.
See shell completions.
Use
Open a terminal in your project folder and run codewhale. Choose your provider
with /provider and your model with /model. Then describe a concrete task:
Fix the failing tests and explain what changed.
Or run a task without opening the TUI:
codewhale exec "fix the failing tests and explain what changed"
Codewhale can read your repository, edit files, run commands, inspect results,
and keep working toward a goal. Use /mode plan to explore without file changes
or shell execution, and /mode work when you want it to make changes. Press
Shift+Tab to choose Ask, Auto-Review, or Full Access; the
modes and permissions guide explains what each allows.
Terminal, apps, and Computer Use
The terminal and graphical clients connect to the Codewhale Runtime, which runs
the agent and its tools:
Terminal:codewhale opens the interactive interface; codewhale exec
runs a task from a script or CI job.
Local browser:codewhale web opens the bundled
local web client for the same runtime.
Codewhale web and desktop apps: graphical workbenches in development.
Their availability is listed on the product page.
Computer Use adds tools for observing and interacting with other applications.
The plugin is included in the current source.
Review its requested access and enable it before use; OS permissions and
platform requirements still apply. See the included
Computer Use guide and
plugin setup.
For VS Code, the community-maintained CodeWhale extension connects to the local
Runtime from a sidebar. Install it from the
VS Code Marketplace;
source code is on GitHub.
Why Codewhale
Choose your models. Connect hosted providers or local models through
Ollama, vLLM, or SGLang. Use /provider to change providers and /model to
choose a model.
Stay in control. Inspect proposed actions and resulting file changes.
Approval settings govern when review is needed; Full Access still respects
hard policy boundaries. /undo and /restore help recover workspace changes.
Keep long work organized. Save sessions, set a durable /goal, review
workflows before they run, and coordinate agents without turning their
internal instructions into your transcript.
Extend the agent you already have. Connect MCP servers and skills,
configure hooks, and keep agent roles as readable files in your project or
personal settings.
Run /help in the TUI for commands and keyboard shortcuts.
Safety
Codewhale runs on your machine with the access you grant it. Approval modes and
repository rules limit what the agent may do; optional OS sandboxing adds a
stronger execution boundary where supported. Unknown model prices stay unknown
instead of being reported as free.
Bug reports, feature ideas, and pull requests are welcome, whether you have
used Codewhale for months or are trying it for the first time. If a provider is
missing, a workflow is awkward, or the terminal UI gets in your way,
open an issue or
send a pull request so we can improve it together. We welcome
first contributions, and contributors keep credit for the work that lands.
Join the Discord, or add Hunter on WeChat
(hunterbown) and ask to join the Whale Brothers group.
Project history
Codewhale began as deepseek-tui and still preserves that configuration and
session compatibility. It is now provider-neutral and independently maintained;
it is not affiliated with any model provider.
Thanks to every contributor and to the open source communities that helped the
project grow. See the contributor record.
License
MIT. Portions adapted from other open-source projects are recorded
in third-party notices.
Codewhale (codewhale-hq/Codewhale)
Choose a tag and it will appear here. With no tags selected, all catalog projects are shown.
Searching Database…
Choose a tag and it will appear here. With no tags selected, all catalog projects are shown.
Codewhale 是一个开源的编码智能体，在终端里运行：它会读取你的项目、编辑文件、执行 shell 命令，并检查自己的工作成果。你可以选择任何托管或本地模型来使用。