Codewhale README

The project's README from github.com/codewhale-hq/Codewhale. As one markdown file: README.md.

Codewhale

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.

Codewhale

简体中文 · 日本語 · Tiếng Việt · Bahasa Indonesia · 한국어 · Español · Português · Русский · Українська · Français · Deutsch · 繁體中文 · हिन्दी · Türkçe · Italiano · Polski · العربية · Català

CI crates.io npm Discord

A Codewhale terminal session

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:

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

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.

Read authorization order for the exact policy stack and configuration for local settings.

Documentation

Join the community

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)

Searching Database…

41.1K ·GitHub
What is this?Codewhale is an open-source coding agent that runs in your terminal: it reads your project, edits files, runs shell commands, and checks its own work, using whichever hosted or local model you pick.
Is this just a terminal tool, or does it have a GUI too?It is primarily a terminal TUI launched with codewhale, plus codewhale web for a bundled local web client; desktop and web apps are still in development, and a community-maintained VS Code extension connects to the same Runtime.
How do I install and start using it?Install the official GitHub release on macOS/Linux or the matching installer on Windows, or grab it via npm, Cargo, Docker, Nix, Scoop, or Android/Termux. Then open a terminal in your project folder and run codewhale.
Do I need to bring my own model or API key?Yes, on first run you connect a hosted provider or set up a local model; model replies won't work until one is connected. Local models can run through Ollama, vLLM, or SGLang.
Is every changelog entry something I can actually download right now?No, the changelog can describe the next release's unreleased candidate, and those changes aren't in any published build until that release actually ships.
How much control do I have over what the agent is allowed to do?Approval modes (Ask, Auto-Review, Full Access) and repository rules gate what the agent can do, and even Full Access respects hard policy boundaries; optional OS sandboxing adds a stronger execution boundary where supported.
Can I split a big task across multiple agents?Yes, Codewhale supports agent teams: you can hand parts of a larger job to agents running different models and roles, and coordinate them without their internal instructions leaking into your transcript.
Why did this project exist alongside tools like Claude Code or Codex?Codewhale began as deepseek-tui, still keeps that project's configuration and session compatibility, but is now provider-neutral, independently maintained, and not affiliated with any model provider.
Can I plug in my own MCP servers and skills?Yes, you can connect MCP servers and skills, configure hooks, and keep agent roles as readable files in your project or personal settings.
What if the agent makes a change I don't want?The /undo and /restore commands let you roll back workspace changes the agent made.
Size
289.5 MB
Stars
41.1K
Age
8mo
Commits · 90 Days