Whale

Whale

MCP.Pizza Chef: usewhale

This command-line assistant reads your project's files, edits code, runs commands, and searches the web to help you finish programming tasks — all without leaving your terminal. It can connect to thousands of add-on tools for extra abilities, such as working with databases or browsers, and it can be set up to run multi-step jobs on its own, like reviewing a batch of files or researching a topic from several angles at once. You'll need a DeepSeek account and a personal access key to use it, and it runs on Mac, Windows, and Linux.

Coding
Web/Research

Use This MCP client To

Have an AI write and fix code for me Ask quick coding questions from the command line Let it search the web while working on my project Have it review a whole batch of files automatically Set up hands-off coding tasks that run on their own Get an instant code review before I commit

README

Whale

Whale — AI coding agent for DeepSeek, in any environment

简体中文 · English

release npm CI license GitHub stars 98% prompt cache hit

Blazingly fast · ~98% prompt cache hit · Zero bloat

Whale — AI coding agent for DeepSeek, in any environment.
Long context, tools, and programmable workflows —
start in the terminal, scale to desktop and beyond.


🚀 Quick Start

Any platform:

npm install -g @usewhale/whale

macOS:

brew install usewhale/tap/whale

Linux:

curl -fsSL https://raw.githubusercontent.com/usewhale/Whale/main/scripts/install.sh | sh

Windows PowerShell:

Requires Windows 10 or Windows Server 2016 or later.

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"
# Set your DeepSeek API key
whale setup

# Launch the interactive TUI
whale

That's it. Type your question and Whale starts working — reading files, running commands, editing code, searching the web.

Need a different model provider, proxy, or custom config? See Configuration.


✨ At a Glance

What Why it matters
💰 ~98% prompt cache hit Whale reuses cached context aggressively — most prompts hit cache, slashing costs to pennies per session. DeepSeek pricing × Whale caching = AI-assisted coding at scale.
🐋 DeepSeek-native Built for DeepSeek's long context (1M tokens), tool calling, and cost efficiency — no generic multi-model wrapper
🔁 Dynamic Workflows Write JavaScript scripts that orchestrate multiple agents — fan-out research, multi-perspective review, pipelines. Claude Code compatible.
🔌 MCP Plug in 1,000+ MCP servers for extended tooling — file ops, shell, git, web, and more
🧩 Skills + Plugins Install community skills (code review, git workflows, etc.) or write your own

🔁 Dynamic Workflows

Whale's Dynamic Workflows let you script multi-agent orchestration in JavaScript:

// .whale/workflows/research.js
const results = await parallel([
  () => agent("Search for best practices in Go error handling"),
  () => agent("Find common Go error handling mistakes"),
]);
return agent("Synthesize both findings into a concise guide");

Fan-out research · Multi-perspective review · Pipeline processing · Adversarial validation

Claude Code compatible — workflow scripts written for Claude Code work as-is in Whale.

⚠️ Disabled by default — run /config in the TUI and enable Dynamic workflows, or add [workflows] enabled = true to .whale/config.local.toml.

Learn more: Workflow Overview · Custom Workflow Guide


🧰 MCP, Skills & Plugins

Extension What it does Get started
MCP Servers Connect to 1,000+ tools (databases, APIs, browser automation) docs/mcp.en.md
Skills Load domain expertise — code review, git-worktree, and more docs/skills.en.md
Subagents Define focused child-agent roles such as reviewers or researchers docs/agents.en.md
Plugins Extend Whale's runtime with custom logic docs/plugins.en.md
Hooks Run scripts on lifecycle events docs/hooks.en.md

📸 How It Works

Whale currently offers three interfaces — with more environments on the way:

Interface When to use
whale (TUI) Interactive coding sessions — chat, review, iterate with full context
whale ask "..." (CLI) One-shot questions, quick code reviews, single commands
whale --headless CI/CD, automated PR reviews, scheduled tasks

🎯 Non-goals

  • Multi-model shell. Whale is DeepSeek-first — optimized for DeepSeek's caching, tools, and pricing.
  • IDE replacement. Whale is not an IDE — it's an agent that meets you wherever you code: terminal, desktop, or CI.

📦 Project Status

Whale is in active development. Best suited for personal projects, experimental repositories, and workflows where changes can be reviewed and rolled back.

Disclaimer: This project is not affiliated with DeepSeek Inc. It is an independent open-source community project.


🤝 Contributing

See CONTRIBUTING.md for local development, testing, issues, and PRs.

Current direction and available tasks: ROADMAP.md.

Security issues: SECURITY.md.


Star History

Star History Chart

🙏 Credits

Whale stands on the shoulders of giants:

And the many open-source libraries we depend on — thank you.

Whale FAQ

Do I need an account or key to use this?
Yes — you need a DeepSeek account and a personal access key before you can start. The setup process walks you through entering the key the first time.
How hard is it to set up?
You'll need to install it from the command line and enter your DeepSeek key — there's no drag-and-drop installer, so some comfort with a terminal helps.
Can I use this to review my code before I commit it?
Yes — you can ask it to read through your files and point out bugs, style issues, or missing tests before you push changes.
Can I use this to research a topic from multiple angles automatically?
Yes — you can set up a scripted job that has the AI search several angles of a question at once and combine the answers into one summary.
Does it only work with DeepSeek?
It's built and tuned specifically for DeepSeek's models, though its settings allow swapping in another provider such as OpenAI, Claude, or Gemini if you need to.
Will it run on my computer?
Yes — it installs on Mac, Windows, and Linux through the command line.
Can it connect to other apps and tools?
Yes — it can plug into thousands of add-on tools, letting it do things like browse the web, work with files, or check a database.
Is this safe to use on my real projects?
The maker recommends starting with personal or test projects rather than critical work, since the tool is still under active development and can change quickly.