CodeWhale

面向 DeepSeek V4 的终端原生编程智能体：100 万 token 上下文、思考模式流式推理、前缀缓存感知。自包含 Rust 二进制发布——开箱即带 MCP 客户端、沙箱和持久化任务队列。

English README 日本語 README

安装

codewhale 是自包含 Rust 二进制——运行时不依赖 Node.js 或 Python。 下面几种方式装出来的是同一套二进制，按你已有的工具链选一个即可：

# 1. npm —— 已装 Node 的最方便方式。npm 包只是一个下载器，
#    会从 GitHub Releases 拉取对应平台的预编译二进制，
#    并不会让 codewhale 本身依赖 Node 运行时。
npm install -g codewhale

# 2. Cargo —— 无需 Node。
cargo install codewhale-cli --locked   # `codewhale` 入口
cargo install codewhale-tui     --locked   # `codewhale-tui` TUI 二进制

# 3. Homebrew —— macOS 包管理器。
brew tap Hmbown/deepseek-tui
brew install deepseek-tui

# 4. 直接下载 —— 无需任何工具链。
#    https://github.com/Hmbown/CodeWhale/releases
#    覆盖 Linux x64/ARM64、macOS x64/ARM64、Windows x64

# 5. Docker —— 预构建发布镜像。
docker volume create codewhale-home
docker run --rm -it \
  -e DEEPSEEK_API_KEY="$DEEPSEEK_API_KEY" \
  -v codewhale-home:/home/codewhale/.deepseek \
  -v "$PWD:/workspace" \
  -w /workspace \
  ghcr.io/hmbown/codewhale:latest

中国大陆访问较慢时，npm 可加 --registry=https://registry.npmmirror.com， 或使用下方的 Cargo 镜像。

下载安全：官方二进制只发布在 https://github.com/Hmbown/CodeWhale/releases。手动下载时请校验 SHA-256 manifest，并避免相似仓库名或搜索结果里的镜像站。详见 下载安全与校验。

已经安装过？按你的安装方式更新：

codewhale update                         # release 二进制更新器
npm install -g codewhale@latest      # npm 包装器
brew update && brew upgrade deepseek-tui
cargo install codewhale-cli --locked --force
cargo install codewhale-tui     --locked --force

DeepWiki project index

这是什么？

codewhale 是一个完全运行在终端里的编程智能体。它让 DeepSeek 前沿模型直接访问你的工作区：读写文件、运行 shell 命令、搜索浏览网页、管理 git、调度子智能体——全部通过快速、键盘驱动的 TUI 完成。

它面向 DeepSeek V4（deepseek-v4-pro / deepseek-v4-flash）构建，原生支持 100 万 token 上下文窗口和思考模式流式输出。

主要功能

• Auto 模式 —— --model auto / /model auto 每轮自动选择模型和推理强度
• 原生 RLM（rlm_open/rlm_eval）—— 持久化 REPL 会话用于批量分析；使用带界面的辅助函数（peek、search、chunk、sub_query_batch）运行低成本 deepseek-v4-flash 子任务
• 思考模式流式输出 —— 实时观察模型在解决问题时的思维链展开
• 完整工具集 —— 文件操作、shell 执行、git、网页搜索/浏览、apply-patch、子智能体、MCP 服务器
• 100 万 token 上下文 —— 上下文跟踪、手动或配置驱动的压缩，以及前缀缓存遥测
• 前缀缓存稳定性跟踪 —— 可选 /statusline footer chip 显示最近轮次缓存前缀的稳定程度
• 三种交互模式 —— Plan（只读探索）、Agent（带审批的默认交互）、YOLO（可信工作区自动批准）
• 推理强度档位 —— 用 Shift+Tab 在 off → high → max 之间切换
• 会话保存和恢复 —— 长任务的断点续作
• 工作区回滚 —— 通过 side-git 记录每轮前后快照，支持 /restore 和 revert_turn，不影响项目自己的 .git
• 持久化任务队列 —— 后台任务在重启后仍然存在，支持计划任务和长时间运行的操作
• HTTP/SSE 运行时 API —— codewhale serve --http 用于无界面智能体流程
• MCP 协议 —— 连接 Model Context Protocol 服务器扩展工具，见 docs/MCP.md
• LSP 诊断 —— 每次编辑后通过 rust-analyzer、pyright、typescript-language-server、gopls、clangd 提供内联错误/警告
• 用户记忆 —— 可选的持久化笔记文件注入系统提示，实现跨会话偏好保持
• 多语言 UI —— 支持 en、ja、zh-Hans、pt-BR，支持自动检测
• 实时成本跟踪 —— 按轮次和会话统计 token 用量与成本估算，含缓存命中/未命中明细；简体中文 locale 下显示 CNY
• 技能系统 —— 可通过 GitHub 安装的组合式指令包；首次启动自带 skill-creator、mcp-builder、documents、presentations、spreadsheets、pdf、feishu 等 starter skills
• 终端原生通知 —— OSC 9、OSC 99、OSC 777，以及桌面通知兜底
• 内置主题选择器 —— Catppuccin、Tokyo Night、Dracula、Gruvbox 和原有亮/暗色主题，可用 /theme 实时切换

架构说明

codewhale（调度器 CLI）→ codewhale-tui（伴随二进制）→ ratatui 界面 ↔ 异步引擎 ↔ OpenAI 兼容流式客户端。工具调用通过类型化注册表（shell、文件操作、git、web、子智能体、MCP、RLM）路由，结果流式返回对话记录。引擎管理会话状态、轮次追踪、持久化任务队列和 LSP 子系统——它在下一步推理前将编辑后诊断反馈到模型上下文中。

详见 docs/ARCHITECTURE.md。

子智能体：并发后台执行

codewhale 可以同时调度多个子智能体并行运行——类似于并发任务队列：

• 非阻塞启动。 agent_open 立即返回。子智能体获得独立的上下文和工具注册表，独立运行。父进程继续工作。
• 后台执行。 子智能体并发运行（默认上限 10，可配置至 20）。引擎管理线程池——无需轮询循环。
• 完成通知。 子智能体完成后，运行时发送结构化的 <codewhale:subagent.done> 事件，包含摘要、证据列表和执行指标。父模型读取 summary 字段并整合结果。
• 按需读取结果。 大型对话记录暂存为 var_handle 引用。模型通过 handle_read 按切片、范围或 JSONPath 投影读取——保持父上下文精简。

详见 docs/SUBAGENTS.md。

快速开始

npm install -g codewhale
codewhale --version
codewhale --model auto

预构建二进制覆盖 Linux x64、Linux ARM64（v0.8.8 起）、macOS x64、macOS ARM64 和 Windows x64。其他目标平台（musl、riscv64、FreeBSD 等）请见下方的从源码安装或 docs/INSTALL.md。

首次启动时会提示输入 DeepSeek API key。密钥保存到 ~/.deepseek/config.toml，在任意目录、IDE 终端和脚本中都能使用，不会触发系统密钥环弹窗。

也可以提前配置：

codewhale auth set --provider deepseek   # 保存到 ~/.deepseek/config.toml

codewhale auth status                    # 显示当前活跃的凭证来源
export DEEPSEEK_API_KEY="YOUR_KEY"      # 环境变量方式；需要在非交互式 shell 中使用请放入 ~/.zshenv
codewhale

codewhale doctor                          # 验证安装

轮换或移除密钥：codewhale auth clear --provider deepseek。

腾讯云 / CNB 远程优先路径

如果你想要一个长期在线、可从手机控制的工作区，推荐使用腾讯云原生路径： CNB 镜像/源码，腾讯云 Lighthouse 香港实例，飞书/Lark 长连接桥接， 以及可选的 EdgeOne 公网 HTTPS 边缘。运行时 API 必须绑定在 localhost； 不要通过 EdgeOne 暴露 /v1/*。

先看 docs/TENCENT_CLOUD_REMOTE_FIRST.md， 再按 docs/TENCENT_LIGHTHOUSE_HK.md 配置服务器。

Auto 模式

使用 codewhale --model auto 或 /model auto 让 codewhale 自行决定每轮需要多少模型和推理能力。

Auto 模式同时控制两个设置：

• 模型：deepseek-v4-flash 或 deepseek-v4-pro
• 推理强度：off、high 或 max

在真实请求发出之前，应用会先用关闭推理的 deepseek-v4-flash 进行一次小型路由调用。路由器审视最新请求和最近的上下文，然后为真实请求选定具体的模型和推理强度。简短/简单的轮次保持在 Flash + 关闭推理；编码、调试、发布、架构、安全审查或模糊的多步骤任务可升级到 Pro 和/或更高推理强度。

auto 是 codewhale 本地行为。上游 API 永远不会收到 model: "auto"，它只会收到为当前轮次选定的具体模型和推理强度设置。TUI 会显示选定的路由，成本跟踪按实际运行的模型计费。如果路由调用失败或返回无效答案，应用会回退到本地启发式规则。子智能体会继承 auto 模式，除非你为它们指定了显式模型。

需要可重复基准测试、严格控制成本上限或特定提供商/模型映射时，请使用固定模型或固定推理强度。

Linux ARM64（HarmonyOS 轻薄本、openEuler、Kylin、树莓派、Graviton 等）

从 v0.8.8 起，npm i -g codewhale 直接支持 glibc 系的 ARM64 Linux。你也可以从 Releases 页面 下载预编译二进制，放到 PATH 目录中。

中国大陆 / 镜像友好安装

如果在中国大陆访问 GitHub 或 npm 下载较慢，可以通过 Cargo 注册表镜像安装：

# ~/.cargo/config.toml
[source.crates-io]
replace-with = "tuna"

[source.tuna]
registry = "sparse+https://mirrors.tuna.tsinghua.edu.cn/crates.io-index/"

然后安装两个二进制（调度器在运行时会调用 TUI）：

cargo install codewhale-cli --locked   # 提供推荐入口 `codewhale`
cargo install codewhale-tui     --locked   # 提供交互式 TUI 伴随二进制
codewhale --version

也可以直接从 GitHub Releases 下载预编译二进制。DEEPSEEK_TUI_RELEASE_BASE_URL 可用于镜像后的 release 资产。

Windows (Scoop)

Scoop 是一个 Windows 软件包管理器。codewhale 已进入 Scoop main bucket，但该 manifest 独立更新，可能滞后于 GitHub/npm/Cargo release。先运行 scoop update，安装后用 codewhale --version 核对版本：

scoop update
scoop install deepseek-tui
codewhale --version

如果需要最新版本，请优先使用 npm 或直接下载 GitHub Release 资产。

# Linux 构建依赖（Debian/Ubuntu/RHEL）：
#   sudo apt-get install -y build-essential pkg-config libdbus-1-dev
#   sudo dnf install -y gcc make pkgconf-pkg-config dbus-devel

git clone https://github.com/Hmbown/CodeWhale.git
cd CodeWhale

cargo install --path crates/cli --locked   # 需要 Rust 1.88+；提供 `codewhale`
cargo install --path crates/tui --locked   # 提供 `codewhale-tui`

其他模型提供方

# NVIDIA NIM
codewhale auth set --provider nvidia-nim --api-key "YOUR_NVIDIA_API_KEY"
codewhale --provider nvidia-nim

# AtlasCloud
codewhale auth set --provider atlascloud --api-key "YOUR_ATLASCLOUD_API_KEY"
codewhale --provider atlascloud

# Wanjie Ark
codewhale auth set --provider wanjie-ark --api-key "YOUR_WANJIE_API_KEY"
codewhale --provider wanjie-ark --model deepseek-reasoner

# OpenRouter
codewhale auth set --provider openrouter --api-key "YOUR_OPENROUTER_API_KEY"
codewhale --provider openrouter --model deepseek/deepseek-v4-pro

# Novita
codewhale auth set --provider novita --api-key "YOUR_NOVITA_API_KEY"
codewhale --provider novita --model deepseek/deepseek-v4-pro

# Fireworks
codewhale auth set --provider fireworks --api-key "YOUR_FIREWORKS_API_KEY"
codewhale --provider fireworks --model deepseek-v4-pro

# 通用 OpenAI 兼容端点
codewhale auth set --provider openai --api-key "YOUR_OPENAI_COMPATIBLE_API_KEY"
OPENAI_BASE_URL="https://openai-compatible.example/v4" codewhale --provider openai --model glm-5

# 自托管 SGLang
SGLANG_BASE_URL="http://localhost:30000/v1" codewhale --provider sglang --model deepseek-v4-flash

# 自托管 vLLM
VLLM_BASE_URL="http://localhost:8000/v1" codewhale --provider vllm --model deepseek-v4-flash

# 自托管 Ollama
ollama pull codewhale-coder:1.3b
codewhale --provider ollama --model codewhale-coder:1.3b

在 TUI 内，/provider 打开提供方选择器，/model 打开本地模型/思考模式 选择器。/provider openrouter 和 /model <id> 可直接切换；/models 会在 当前提供方支持模型列表时显式请求并列出 API 返回的实时模型。

版本说明

每个版本的具体变更见 CHANGELOG.md。README 只保留当前 安装方式、核心工作流、模型提供方配置、运行时接口和扩展入口。

使用方式

codewhale                                       # 交互式 TUI
codewhale "explain this function"              # 一次性提示
codewhale exec --auto --output-format stream-json "fix this bug" # 面向后端集成的 NDJSON 流
codewhale exec --resume <SESSION_ID> "follow up" # 继续非交互会话
codewhale --model deepseek-v4-flash "summarize" # 指定模型
codewhale --model auto "fix this bug"          # 自动选择模型 + 推理强度
codewhale --yolo                                # 自动批准工具
codewhale auth set --provider deepseek         # 保存 API key
codewhale doctor                                # 检查配置和连接
codewhale doctor --json                         # 机器可读诊断
codewhale setup --status                        # 只读安装状态
codewhale setup --tools --plugins               # 创建本地工具和插件目录
codewhale models                                # 列出可用 API 模型
codewhale sessions                              # 列出已保存会话
codewhale resume --last                         # 恢复最近会话
codewhale resume <SESSION_ID>                   # 按 UUID 恢复指定会话
codewhale fork <SESSION_ID>                     # 将已保存会话分叉为兄弟路径
codewhale serve --http                          # HTTP/SSE API 服务
codewhale serve --acp                           # Zed/自定义智能体的 ACP stdio 适配器
codewhale run pr <N>                            # 获取 PR 并预填审查提示
codewhale mcp list                              # 列出已配置 MCP 服务器
codewhale mcp validate                          # 校验 MCP 配置和连接
codewhale mcp-server                            # 启动 dispatcher MCP stdio 服务器
codewhale update                                # 检查并应用二进制更新

Docker 镜像发布在 GHCR 上：

docker volume create codewhale-home

docker run --rm -it \
  -e DEEPSEEK_API_KEY="$DEEPSEEK_API_KEY" \
  -v codewhale-home:/home/codewhale/.deepseek \
  -v "$PWD:/workspace" \
  -w /workspace \
  ghcr.io/hmbown/codewhale:latest

固定 tag、本地构建、volume 权限和非交互管道用法见 docs/DOCKER.md。

Zed / ACP

DeepSeek 可作为自定义 Agent Client Protocol 服务器运行，供 Zed 等编辑器通过 stdio 调用本地 ACP 智能体。在 Zed 中添加自定义智能体服务器：

{
  "agent_servers": {
    "DeepSeek": {
      "type": "custom",
      "command": "codewhale",
      "args": ["serve", "--acp"],
      "env": {}
    }
  }
}

首个 ACP 切片支持通过现有 DeepSeek 配置/API 密钥创建新会话和提示响应。工具支持的编辑和检查点回放尚未通过 ACP 暴露。

常用快捷键

完整快捷键目录：docs/KEYBINDINGS.md。

模式

配置

用户配置：~/.deepseek/config.toml。项目覆盖：<workspace>/.deepseek/config.toml（以下密钥被拒绝：api_key、base_url、provider、mcp_config_path）。完整选项见 config.example.toml。

常用环境变量：

locale 会控制界面语言，并作为模型自然语言的兜底设置；最新用户消息的语言优先级更高。也就是说，即使系统 locale 是英文，用户用中文提问时，V4 的 reasoning_content 和最终回复也应该使用中文。可在 config.toml 中设置 locale、使用 /config locale zh-Hans、或依赖 LC_ALL/LANG。详见 docs/LOCALIZATION.md 和 docs/CONFIGURATION.md。

切换为中文界面

如果界面是其他语言，可以在 TUI 内一键切换为简体中文：

1. 在 Composer 里输入 /config，按 Tab 或 Enter 打开配置面板。
2. 选择 Edit locale，在 New: 字段输入 zh-Hans，按 Enter 应用。

可选语言：auto | en | ja | zh-Hans | pt-BR。

也可以在 ~/.deepseek/config.toml 里直接设置 locale = "zh-Hans"，或通过 LC_ALL / LANG 环境变量自动选择：

# ~/.deepseek/config.toml
[tui]
locale = "zh-Hans"

或者通过环境变量（中文系统通常已自动生效）：

LANG=zh_CN.UTF-8 codewhale run

模型和价格

旧别名 deepseek-chat / deepseek-reasoner 映射到 deepseek-v4-flash。NVIDIA NIM 变体使用你的 NVIDIA 账号条款。

创建和安装技能

codewhale 从工作区目录（.agents/skills → skills → .opencode/skills → .claude/skills）和全局 ~/.deepseek/skills 发现技能。每个技能是一个包含 SKILL.md 的目录：

~/.deepseek/skills/my-skill/
└── SKILL.md

需要 YAML frontmatter：

---
name: my-skill
description: 当 DeepSeek 需要遵循我的自定义工作流时使用这个技能。
---

# My Skill
这里写给智能体的指令。

常用命令：/skills（列出）、/skill <name>（激活）、/skill new（创建）、/skill install github:<owner>/<repo>（社区）、/skill update / uninstall / trust。社区技能直接从 GitHub 安装，无需后端服务。已安装技能在模型可见的会话上下文里列出；当任务匹配技能描述时，智能体可通过 load_skill 工具自动读取对应的 SKILL.md。

文档

完整更新历史：CHANGELOG.md。

致谢

• DeepSeek — 感谢 DeepSeek 提供模型与支持，让每一次交互成为可能。
• DataWhale — 感谢 DataWhale 的支持，并欢迎我们加入“鲸兄弟”大家庭。
• OpenWarp — 感谢 OpenWarp 优先支持 codewhale，并一起打磨更好的终端智能体体验。
• Open Design — 感谢 Open Design 对面向设计的智能体工作流提供支持与协作。

本项目由不断壮大的贡献者社区共同打造：

• merchloubna70-dot — 28 个 PR，涵盖功能、修复和 VS Code 扩展基础架构 (#645–#681)
• WyxBUPT-22 — Markdown 表格、粗体/斜体和水平线渲染 (#579)
• loongmiaow-pixel — Windows + 中国安装文档 (#578)
• 20bytes — 用户记忆文档和帮助优化 (#569)
• staryxchen — glibc 兼容性预检 (#556)
• Vishnu1837 — glibc 兼容性改进 (#565)
• shentoumengxin — Shell cwd 边界验证 (#524)
• toi500 — Windows 粘贴修复报告
• xsstomy — 终端启动重绘报告
• melody0709 — 斜杠前缀回车激活报告
• lloydzhou 和 jeoor — 压缩成本报告；lloydzhou 还贡献了确定性的环境上下文注入 (#813, #922) 和 KV 前缀缓存稳定化 (#1080)
• Agent-Skill-007 — README 清晰化改进 (#685)
• woyxiang — Windows 安装文档 (#696)
• wangfeng — 价格/折扣信息更新 (#692)
• zichen0116 — CODE_OF_CONDUCT.md (#686)
• dfwqdyl-ui — 模型 ID 大小写兼容性报告 (#729)
• Oliver-ZPLiu — working... 卡死状态 Bug 报告和 Windows 剪贴板兜底修复 (#738, #850)
• reidliu41 — 退出后的恢复提示、工作区信任持久化、Ollama provider 支持，以及思考块流式终结修复 (#863, #870, #921, #1078)
• xieshutao — 纯 Markdown skill 兜底解析 (#869)
• GK012 — npm wrapper 的 --version 兜底 (#885)
• y0sif — 直接子智能体完成后唤醒父级 turn loop (#901)
• mac119 和 leo119 — codewhale update 命令文档 (#838, #917)
• dumbjack / 浩淼的mac — shell 命令空字节安全加固 (#706, #918)
• macworkers — fork 完成后显示新 session id (#600, #919)
• zero 和 zerx-lab — 通知条件配置和更完整的 OSC 9 通知正文 (#820, #920)
• chnjames — @mention 补全缓存、配置恢复优化，以及 Windows UTF-8 shell 输出修复 (#849, #927, #982, #1018)
• angziii — 配置安全、异步清理、Docker 加固和命令安全修复 (#822, #824, #827, #831, #833, #835, #837)
• elowen53 — UTF-8 解码和确定性测试覆盖 (#825, #840)
• wdw8276 — 用于自定义 session 标题的 /rename 命令 (#836)
• banqii — .cursor/skills 发现路径支持 (#817)
• junskyeed — API 请求动态 max_tokens 计算 (#826)
• Hafeez Pizofreude — fetch_url 的 SSRF 保护和 Star History 图表
• Unic (YuniqueUnic) — 基于 schema 的配置 UI（TUI + web）
• Jason — SSRF 安全加固
• axobase001 — 快照孤儿文件清理、npm 安装守卫、会话遥测修复、模型作用域缓存清理、符号链接技能支持，以及 npm 镜像逃生路径指引 (#975, #1032, #1047, #1049, #1052, #1019, #1051, #1056)
• MengZ-super — /theme 命令基础和 SSE gzip/brotli 解压支持 (#1057, #1061)
• DI-HUO-MING-YI — Plan 模式只读沙箱安全修复 (#1077)
• bevis-wong — 粘贴-回车自动提交问题的精确复现 (#1073)
• Duducoco 和 AlphaGogoo — 技能斜杠菜单和 /skills 覆盖范围修复 (#1068, #1083)
• ArronAI007 — macOS Terminal.app 和 ConHost 窗口大小调整残留修复 (#993)
• THINKER-ONLY — OpenRouter 和自定义端点模型 ID 保留 (#1066)
• Jefsky — deepseek-cn 官方端点默认值 (#1079, #1084)
• wlon — NVIDIA NIM provider API key 优先级诊断 (#1081)

贡献

欢迎提交 pull request——请先查看 CONTRIBUTING.md 并留意开放 issue 中的好入门任务。

本项目与 DeepSeek Inc. 无隶属关系。

许可证

MIT

Star 历史