From install to your first task.
Install Codewhale on macOS or Linux with the command below. Choose your model, open a project, and tell it what you want to do.
curl -fsSL https://codewhale.net/install.sh | sh
The installer checks the release’s SHA-256 checksum and installs codewhale and codew to ~/.local/bin. Both commands open the same app.
Computer Use para Mac
Adicione controle de apps em segundo plano com o assistente Computer Use. Configure as permissões do Mac, execute uma verificação em segundo plano e pause ou interrompa a entrada do assistente pela barra de menus.
Download e configuração do Computer UseConnect a model. Start a task.
1. Connect your model
Model replies need a connection to a hosted or local model. Use your own provider key, as in the DeepSeek example below, or follow the provider guide for other services and local models. Offline setup does not require a key.
Choose a providercodewhale auth set --provider deepseek
2. Give it a task
Open Codewhale in your project folder. Try /mode plan and ask it to explain the project, then use /mode work when you want edits and commands. Shift+Tab changes the approval setting; /provider and /model change the model connection.
Modes and permissionscodewhale
Use Plan to explore before making changes, Work to build, and Operate for ongoing work. /mode opens the mode picker; /config opens settings. Permissions are separate: choose Ask, Auto-Review, or Full Access. Plan blocks file changes and shell execution.
Getting-started guideCheck your setup
Confirm the installed version, then check your provider connection and local tools. codewhale doctor explains anything that needs attention.
codewhale --version codewhale doctor
Keep Codewhale up to date
For a release binary, run codewhale update. If you used a package manager, update with that package manager.
codewhale update
npm update -g codewhale # or brew upgrade codewhale
Other ways to install
Choose the option that fits your machine. Package-manager versions may differ from the latest GitHub release.
Download a release binary
Download for macOS, Linux, or Windows, and verify its checksum. Windows users can also run the Linux version in WSL2.
curl -fsSL -O https://github.com/Hmbown/CodeWhale/releases/latest/download/codewhale-artifacts-sha256.txt curl -fsSL -O \ https://github.com/Hmbown/CodeWhale/releases/latest/download/codewhale-macos-arm64 curl -fsSL -O \ https://github.com/Hmbown/CodeWhale/releases/latest/download/codew-macos-arm64 grep -E ' (codewhale|codew)-macos-arm64$' codewhale-artifacts-sha256.txt | shasum -a 256 -c - chmod +x codewhale-macos-arm64 codew-macos-arm64 xattr -d com.apple.quarantine codewhale-macos-arm64 codew-macos-arm64 2>/dev/null || true sudo mv codewhale-macos-arm64 /usr/local/bin/codewhale sudo mv codew-macos-arm64 /usr/local/bin/codew
curl -fsSL -O https://github.com/Hmbown/CodeWhale/releases/latest/download/codewhale-artifacts-sha256.txt
verify_binary() {
asset="$1"
installed="$2"
expected=$(awk -v asset="$asset" '$2 == asset { print $1 }' codewhale-artifacts-sha256.txt)
actual=$(shasum -a 256 "$installed" | awk '{ print $1 }')
if [ -z "$expected" ] || [ "$actual" != "$expected" ]; then
echo "$installed checksum mismatch" >&2
return 1
fi
}
verify_binary codewhale-macos-arm64 /usr/local/bin/codewhale
verify_binary codew-macos-arm64 /usr/local/bin/codewnpm · Node 18+
Requires Node 18+. The npm package downloads a verified release binary and installs both codewhale and codew.
npm install -g codewhale
Build with Cargo
Requires Rust 1.88+. Installs codewhale to ~/.cargo/bin. Linux builds also need pkg-config and libdbus-1-dev.
cargo install codewhale-cli --locked
Homebrew · macOS / Linux
The Homebrew formula is codewhale; the tap retains its original repository name.
brew tap Hmbown/deepseek-tui brew install codewhale
Docker
Keep your Codewhale files in the named volume and mount your project at /workspace. Replace latest with a release tag to pin the version.
docker volume create codewhale-home docker run --rm -it \ -e DEEPSEEK_API_KEY=$DEEPSEEK_API_KEY \ -v codewhale-home:/home/codewhale/.codewhale \ -v "$PWD:/workspace" -w /workspace \ ghcr.io/hmbown/codewhale:latest
Build from source
Use a source build to try development changes or contribute a fix.
git clone https://github.com/Hmbown/CodeWhale cd CodeWhale cargo build --release --locked # Install the compiled runtime as codewhale cargo install --path crates/cli --locked
Mirrors for your network
CNB mirror
Build the latest known release from the community CNB mirror. Mirrors may take time to catch up with a new GitHub release.
cargo install --git https://cnb.cool/codewhale.net/codewhale --tag v0.9.13 codewhale-cli --locked --force
TUNA
For Cargo downloads through Tsinghua’s TUNA mirror, add this to ~/.cargo/config.toml, then run the Cargo install command above.
# ~/.cargo/config.toml [source.crates-io] replace-with = "tuna" [source.tuna] registry = "sparse+https://mirrors.tuna.tsinghua.edu.cn/crates.io-index/"
cargo install codewhale-cli --locked