Skip to content

Quickstart (中文) ​

完整安装说明(前置、三条路径、常见错误)→ install.md。

1. 构建 ​

sh
git clone https://github.com/wangqiqi/planrun.git planrun && cd planrun
pnpm install
pnpm run build
pnpm run verify

harness 相关包是可选 peerDependencies,由你的 DSH profile 提供而非随包捆绑:skill-provider 与 workflow 都声明 @deepseek-ai/cordis ^4.0.0,workflow 另声明 @deepseek-ai/dsh-agent / @deepseek-ai/dsh-llm。构建不需要同级 deepseek-harness checkout(只有 verify:dogfood 需要,见 §5)。

2. 安装 bundle ​

GitHub 直装、固定版本(推荐:当前唯一可用通道) —— 无需 npm registry、无需构建授权(运行时已提交进仓库):

sh
dsh plugin --profile web add "github:wangqiqi/planrun#<tag>"   # 当前版本:#v1.9.0

npm 通道(尚未发布) —— @planrun/bundle 在 registry.npmjs.org 上返回 404,要等维护者发布该 scope 后才可用(步骤见 publish.md):

sh
dsh plugin --profile web add @planrun/bundle

本仓开发(pack-local.sh 会先构建,再把 workspace:^ 改写成 file: 依赖):

sh
export PLANRUN_HOME=/path/to/planrun
"$PLANRUN_HOME/scripts/pack-local.sh"
dsh plugin --profile web add "file:$PLANRUN_HOME/dist-local/bundle-planrun"

验证:

sh
dsh --profile web --dump-config | grep planrun-skills
ls "$DSH_HOME/profiles/web/node_modules/@planrun/skill-provider/skills/"

npm 通道的 @planrun/bundle(目录 packages/bundle-planrun/)会通过依赖把 skill 包链进 profile;不要再手动改 cordis.patch.yml 插入同一插件(避免双挂载)。

从 harness 仓开发时可用:

sh
cd /path/to/deepseek-harness
pnpm dsh plugin --profile web add "file:$PLANRUN_HOME/dist-local/bundle-planrun"

常见错误:直接 add "file:$PLANRUN_HOME/packages/bundle-planrun" 会报 ERR_PNPM_WORKSPACE_PKG_NOT_FOUND —— 源码目录用的是 workspace:^ 依赖。先跑 scripts/pack-local.sh,它会把依赖改写成 file: 并输出到 dist-local/。

3. 项目内 growth 模板 ​

sh
./scripts/install-planrun.sh --here

会在 Git 项目根创建 .dsh/growth/(plan · learn · archive)。

4. Workflow guard(Sprint 闸门) ​

sprint-plan 写好 plan 并设 PLAN_APPROVED 后,run 前先:

sh
pnpm run gate-check
pnpm run plan-check
pnpm run task-verify    # 任务收尾前
pnpm run next-task      # 找下一项
pnpm run doctor         # 版本漂移体检:guard 脚本 · 模板 · 包版本

plan 路径:.dsh/growth/plan.md(开发 PlanRun 本身可用 .cursorGrowth/plan.md)。详见 workflow-guard.md。

5. 在会话中使用 ​

使用 standard preset(或 planrun preset):

场景加载 skill
不知道用哪个流程master
多任务 / Sprint 规划sprint-plan
跨 Sprint Epiclong
执行 ACTIVE 任务run
学本仓约定learn
Git 提交/合并git
空仓库脚手架scaffold
PR / 代码回顾review
打版 / merge / tagrelease(或委派 subagent_ship)
上线走查delivery
写测试 / TDDtest
查 bug / 测挂了debug
安全审查 / 密钥鉴权security
API 设计 / OpenAPIapi
重构 / 删死代码refactor
性能慢 / bundle 大perf
单任务方案设计DSH /plan(plan mode,不是 sprint-plan)

Subagent 预设(v1.6) ​

四个 planrun* preset 现在随 bundle 一起安装(packages/bundle-planrun/presets.patch.yml 里的官方 @deepseek-ai/dsh-agent-preset 声明):

sh
dsh plugin --profile web add "github:wangqiqi/planrun#<tag>"   # 当前版本:#v1.9.0
# 装完重启 dsh web → preset 选择器出现 planrun / planrun-review / planrun-spike / planrun-ship

旧的 install-planrun.sh --preset(复制到 ~/.dsh/.agent-presets/)已删除 —— DSH 不再读取该目录。

详见 subagents.md。日常仍可用 standard preset + bundle skills;需要 subagent_review / subagent_spike / subagent_ship 时切换到 planrun preset 或专用子 preset。

6. Dogfood(deepseek-harness) ​

结构闭环(推荐先做) — 不依赖 dsh web:

sh
export PLANRUN_HOME=/path/to/planrun
export DEEPSEEK_HARNESS_HOME=/path/to/deepseek-harness
pnpm run build
pnpm run verify:dogfood

详见 dogfood.md。

交互走查(需 dsh CLI):

sh
export PLANRUN_HOME=/path/to/planrun
cd /path/to/deepseek-harness
"$PLANRUN_HOME/scripts/install-planrun.sh" --here --copy-plan
# bundle 见 §2;启动 dsh web + planrun preset 后加载 master / sprint-plan / run / review

bundle 变更后需重启 profile(dsh web),不像 profile 级 cordis.patch.yml 那样热加载。

7. 与 Super Cursor 对照 ​

见 mapping-from-super-cursor.md 与 naming.md。

English: en/quickstart.md

MIT License