Codewhale 文档

查找准确的使用说明。

从新手指引和安装开始,或者直接查找产品名词、模式、权限、工具、提供商、Fleet、钩子、MCP 与运行时 API。这些页面就是正式的产品文档;每页都链接仓库中的源文档,方便查阅完整细节。

新手指引

从一条安装命令到第一个 Fleet Workflow,四步走完。每一步都只陈述当前版本真实的行为;未发布或待录制的内容会明确标注。

  1. 安装 Codewhale

    一条 npm 命令即可安装调度器和终端运行时。Cargo、预编译包、Docker、Nix 和中国镜像是有文档的备选渠道;所有渠道只提供已发布版本。

    npm install -g codewhale
    codewhale doctor
    完整安装指南
  2. 打开第一个会话——无需密钥

    运行时无需任何 API 密钥即可启动:先走过一段简短的宪法优先设置(语言、提供商就绪情况、运行姿态、你的宪法),然后进入完整界面。在 Plan 模式中探索——它始终只读。模型回复需要提供商;这正是下一步。

    codewhale
    先了解产品名词
  3. 连接提供商

    任选一条受支持的路由——托管密钥、网关,或 Ollama、vLLM、SGLang 等免密钥本地运行时(推理完全在本地)。Provider 与模型始终明确;请求与实际思考档位及路由来源是分开的来源字段,暂不可用的值保持暂不可用。

    codewhale auth set --provider deepseek
    提供商与模型
  4. 运行第一个 Fleet Workflow

    当工作需要持久 worker、有序阶段或收据时,编写可复用的 agent 团队档案并启动运行。Fleet 状态保存在工作区台账中,重启后依然存活;普通的单一任务不需要这些。

    codewhale fleet init
    codewhale fleet run tasks.json --max-workers 4
    Fleet 与 Workflow 文档

看一次真实会话

下方是真实会话媒体位。它当前处于待录制状态——这是有意为之:在 v0.9.2 候选版 dogfood 录制完成前,本站不展示任何占位或摆拍影像。

待发布候选版录制

此处不展示占位或摆拍影像。录制完成后,这段真实会话将带海报帧、双语字幕、文字稿和可选的 GIF 回退下载一同发布。

一次真实的 Codewhale 端到端会话将在 dogfood 期间从 v0.9.2 发布候选版录制:安装、首次离线会话、连接提供商,以及在密封本地路由上运行一次 Fleet Workflow。在录制完成之前,这里不展示任何影像——上面的清单与预算就是它必须满足的契约。录制计划与验收清单 ↗

接下来

钩子

借助项目级信任规则,响应生命周期事件——工具调用前后、回合结束、会话事件。

模式与权限姿态

Plan / Act / Operate 与 Ask / Auto-Review / Full Access,与运行时实际执行的一致。

文档中心

所有主题均可搜索,每个页面都注明仓库中的源文档。

来源文档:docs/GUIDE.md, docs/KEYBINDINGS.md · 步骤文案来自 web/lib/content/getting-started.ts;更新时请同步修改 docs-map.ts。