Codewhale

The open-source coding agent that works with any model.

Codewhale reads your project, edits files, runs commands, and checks its own work — in your terminal, with a hosted or local model you choose.

Website · Documentation · Changelog · Contributing

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

Real Codewhale terminal capture from a configured local demo session.

Install

macOS and Linux:

curl -fsSL https://codewhale.net/install.sh | sh

The installer downloads checksum-verified binaries into ~/.local/bin. If codewhale then says "command not found", run the one PATH line the installer prints, or see Put it on your PATH. Upgrade any time with codewhale update.

Windows, npm, Cargo, and other routes

winget install HunterBown.CodeWhale  # Windows x64 (or Scoop, or the installer from GitHub Releases)
npm install -g codewhale            # wraps the same release binaries
cargo install codewhale-cli --locked  # build from crates.io

Docker, Nix, Homebrew on Linux, Android/Termux, manual downloads with checksum verification, and the optional CNB mirror are covered in the installation guide. Pick one route: several installs on one machine end up fighting over PATH.

Quickstart

Your provider keys, managed in one place. Create a Codewhale account or run codewhale login to sign in. Save and update your API keys in your account, then use them through the Codewhale model route on your signed-in devices. Set up account keys. Signing in does not upload existing local keys; local use remains available without an account.

1. Open your project. Run codewhale in the folder you want to work on.
2. Connect a model. Run /provider (or press F3) to add a hosted key or pick a local runtime. If Ollama is already running with a chat model, Codewhale switches to it on its own. Use /model to change models.
3. Give it a concrete task.

Fix the failing tests and explain what changed.

The same task runs headless from a script or CI job:

codewhale exec --auto "fix the failing tests and explain what changed"

Run /help for commands and keyboard shortcuts.

Ways to run it

Every client drives the same local Codewhale Engine, so sessions, tools, and permissions behave the same everywhere.