Getting Started
Install, configure, and start your first Whale session in minutes.
Prerequisites
- • A DeepSeek API key
- • macOS, Linux, or Windows (PowerShell / Git Bash / Windows Terminal)
Installation
macOS / Linux
curl -fsSL https://raw.githubusercontent.com/usewhale/whale/main/scripts/install.sh | sh macOS (Homebrew)
brew install usewhale/tap/whale Windows (PowerShell)
irm https://raw.githubusercontent.com/usewhale/whale/main/scripts/install.ps1 | iex Windows (CMD)
powershell -NoProfile -ExecutionPolicy Bypass -Command "irm https://raw.githubusercontent.com/usewhale/whale/main/scripts/install.ps1 | iex" Upgrade
brew upgrade usewhale/tap/whale
# or rerun the install script Configure
Run these commands to set up your DeepSeek API key and verify the installation:
whale setup
whale doctor whale setup prompts you to enter your DeepSeek API key.
whale doctor runs health checks to confirm everything works.
Usage
Start the interactive TUI
whale Launches the terminal UI where you can chat with the agent, read and edit files, run commands, and more.
One-shot execution
whale exec "Explain the architecture of this project"
printf 'Summarize the current directory\n' | whale exec Resume a previous session
whale resume
whale resume --last
whale resume <session-id> Command Reference
| Command | Purpose |
|---|---|
| whale | Start interactive TUI |
| whale setup | Save API key |
| whale doctor | Health check |
| whale exec "prompt" | One-shot non-interactive |
| whale --worktree [name] | Isolated worktree session |
| whale resume | Session picker |
| whale migrate-config | Migrate v0.1.8 config |
Slash Commands (inside TUI)
| Command | Purpose |
|---|---|
| /ask [prompt] | Read-only question |
| /plan [prompt] | Plan first, then execute |
| /review [target] | Code review |
| /compact | Compact conversation |
| /focus | Toggle focused view |
| /status | Show session status |
| /skills | Skills menu |
| /memory | View/manage memory |
| /mcp | MCP server status |