Plan Cascade - CLI Guide
February 2, 2026 · View on GitHub
Plan Cascade - CLI Guide
版本: 4.3.3 最后更新: 2026-02-02
本文档详细介绍 Plan Cascade 独立 CLI 工具的使用方法。
安装
# 从 PyPI 安装
pip install plan-cascade
# 安装带 LLM 支持
pip install plan-cascade[llm]
# 安装全部依赖
pip install plan-cascade[all]
快速开始
# 配置向导(首次使用)
plan-cascade config --setup
# 简单模式 - 一键执行
plan-cascade run "实现用户登录功能"
# 专家模式 - 更多控制
plan-cascade run "实现用户登录功能" --expert
# 交互式聊天模式
plan-cascade chat
# 自动运行并行执行(新功能)
plan-cascade auto-run --parallel
# 大型项目 Mega-plan(新功能)
plan-cascade mega plan "构建电商平台"
双模式设计
简单模式(默认)
面向新手用户和快速任务,AI 自动判断策略并执行。
plan-cascade run "添加一个退出按钮"
# → AI 判断:小任务 → 直接执行
plan-cascade run "实现用户登录功能"
# → AI 判断:中等功能 → 生成 PRD → 自动执行
plan-cascade run "构建电商平台:用户、商品、订单"
# → AI 判断:大型项目 → Mega Plan → 多 PRD 级联
专家模式
面向资深用户,提供精细控制。
plan-cascade run "实现用户登录" --expert
专家模式支持:
- 查看和编辑 PRD
- 选择执行策略
- 指定每个 Story 的 Agent
- 调整依赖关系
- 配置质量门控
全局选项
以下选项适用于所有命令:
--legacy-mode 使用旧版路径模式(将文件存储在项目根目录而非用户目录)
--project <path> 项目路径(默认:当前目录)
--verbose 启用详细输出
旧版模式:默认情况下,Plan Cascade 将规划文件存储在平台特定的用户目录中(Unix 上为 ~/.plan-cascade/<project-id>/,Windows 上为 %APPDATA%/plan-cascade/<project-id>/)。使用 --legacy-mode 可将文件存储在项目根目录中(与旧版本兼容)。
命令参考
run - 执行任务
plan-cascade run <description> [options]
Options:
-e, --expert 专家模式
-b, --backend <name> 后端选择 (claude-code|claude-api|openai|deepseek|ollama)
--model <name> 指定模型
--project <path> 项目路径
示例:
# 简单模式
plan-cascade run "添加搜索功能"
# 专家模式
plan-cascade run "重构用户模块" --expert
# 使用 OpenAI
plan-cascade run "实现评论功能" --backend openai --model gpt-4o
config - 配置管理
plan-cascade config [options]
Options:
--show 显示当前配置
--setup 运行配置向导
示例:
# 查看配置
plan-cascade config --show
# 配置向导
plan-cascade config --setup
chat - 交互式 REPL
plan-cascade chat [options]
Options:
-p, --project <path> 项目路径
-b, --backend <name> 后端选择
REPL 特殊命令:
| 命令 | 说明 |
|---|---|
/exit, /quit | 退出 |
/clear | 清空上下文 |
/status | 查看会话状态 |
/mode [simple|expert] | 切换模式 |
/history | 查看对话历史 |
/config | 配置管理 |
/help | 帮助 |
示例:
plan-cascade chat
> 分析一下项目结构
(AI 分析并响应)
> 基于上面的分析,实现用户登录功能
(意图识别:TASK)
(策略分析)
(执行任务)
> /status
Session: abc123
Mode: simple
Project: /path/to/project
> /mode expert
Mode changed to: expert
> /exit
status - 查看状态
plan-cascade status
# 输出示例:
任务: 实现用户登录
进度: 3/5
✓ 设计数据库 Schema
✓ 实现 API 路由
✓ OAuth 登录
⟳ 手机验证码登录 (执行中)
○ 集成测试
version - 版本信息
plan-cascade version
auto-run - 自动批量执行(新功能)
自动迭代执行 PRD 批次直到完成,支持质量门控和重试管理。
plan-cascade auto-run [options]
Options:
-m, --mode <mode> 迭代模式 (until_complete|max_iterations|batch_complete)
--max-iterations <n> 最大迭代次数,用于 max_iterations 模式(默认:10)
-a, --agent <name> 默认执行 Agent
--impl-agent <name> 实现类 Story 的 Agent
--retry-agent <name> 重试时使用的 Agent
--dry-run 显示执行计划但不实际运行
--no-quality-gates 禁用质量门控(类型检查、测试、lint)
--verify 启用 AI 验证门(默认:从配置读取)
--no-verify 禁用 AI 验证门
--verify-agent <name> AI 验证 Agent(默认:从配置读取)
--no-review 禁用 AI 代码审查门
--review-agent <name> AI 代码审查 Agent(默认:从配置读取)
--no-fallback 禁用 Agent 失败回退
--parallel 批次内并行执行 Stories
--max-concurrency <n> 最大并行 Stories 数(默认:CPU 核心数)
-p, --project <path> 项目路径
示例:
# 运行直到所有 Stories 完成
plan-cascade auto-run
# 并行执行
plan-cascade auto-run --parallel --max-concurrency 4
# 限制为 5 次迭代
plan-cascade auto-run --mode max_iterations --max-iterations 5
# 干运行查看执行计划
plan-cascade auto-run --dry-run
# 使用指定 Agents
plan-cascade auto-run --agent aider --retry-agent claude-code
mega - Mega-Plan 工作流(新功能)
管理多功能项目计划的命令组。
plan-cascade mega <subcommand> [options]
子命令:
plan <description> 生成多功能计划
approve 批准并开始执行
status 查看执行进度
complete 完成并合并所有功能
edit 交互式编辑功能
resume 恢复中断的执行
示例:
# 生成 mega-plan
plan-cascade mega plan "构建电商平台:用户、商品、订单"
# 批准并开始执行
plan-cascade mega approve --auto-prd
# 检查状态
plan-cascade mega status --verbose
# 完成时合并
plan-cascade mega complete
worktree - Git Worktree 集成(新功能)
使用 Git worktree 管理隔离开发环境的命令组。
plan-cascade worktree <subcommand> [options]
子命令:
create <name> <branch> [desc] 创建隔离 worktree
complete [name] [options] 合并并清理 worktree
list 列出活跃的 worktrees
Complete 选项:
--force 强制完成,即使有未提交的更改(更改将丢失)
--no-merge 跳过合并到目标分支
示例:
# 为功能创建 worktree
plan-cascade worktree create feature-auth main "实现认证功能"
# 列出所有 worktrees
plan-cascade worktree list
# 完成并合并
plan-cascade worktree complete feature-auth
design - 设计文档系统(新功能)
管理架构设计文档的命令组。
plan-cascade design <subcommand> [options]
子命令:
generate 生成 design_doc.json(自动检测级别)
show 显示当前设计文档
review 交互式编辑设计文档
import <file> 转换外部文档(MD、JSON、HTML)
validate 验证设计文档结构
示例:
# 生成设计文档
plan-cascade design generate
# 显示设计文档
plan-cascade design show --verbose
# 从 Markdown 导入
plan-cascade design import ./architecture.md
# 交互式审查
plan-cascade design review
skills - 外部技能管理(新功能)
管理框架特定技能的命令组。
plan-cascade skills <subcommand> [options]
子命令:
list 列出所有配置的技能
detect 检测项目适用的技能
show <name> 显示技能内容
summary 显示将加载的技能
validate 验证技能配置
List 选项:
-v, --verbose 显示详细信息
-u, --check-updates 检查可用更新(需要网络)
-g, --group 按来源类型分组技能
-j, --json 以 JSON 格式输出
示例:
# 列出所有技能
plan-cascade skills list --verbose
# 检查更新
plan-cascade skills list --check-updates
# 检测适用技能
plan-cascade skills detect --phase implementation
# 显示特定技能
plan-cascade skills show react-best-practices
deps - 依赖图可视化(新功能)
显示 Stories/功能的可视化依赖图。
plan-cascade deps [options]
Options:
-f, --format <type> 输出格式 (tree|flat|table|json)
--critical-path 显示关键路径分析
--check 检查依赖问题
--strict 检测到循环依赖时以错误码退出
-p, --project <path> 项目路径
示例:
# 显示依赖树
plan-cascade deps
# 表格形式显示
plan-cascade deps --format table
# 检查问题
plan-cascade deps --check
# JSON 输出
plan-cascade deps --format json
migrate - 路径迁移(新功能)
在旧模式(项目根目录)和新模式(用户目录)之间迁移规划文件。
plan-cascade migrate <subcommand> [options]
子命令:
detect 扫描项目中的旧版文件
run [--dry-run] 迁移到新路径模式
rollback 回退到旧模式
示例:
# 检测旧版文件
plan-cascade migrate detect
# 预览迁移但不实际执行
plan-cascade migrate run --dry-run
# 执行实际迁移
plan-cascade migrate run
# 需要时回退
plan-cascade migrate rollback
resume - 上下文恢复(新功能)
自动检测并恢复中断的任务。
plan-cascade resume [options]
Options:
-a, --auto 非交互式恢复
-v, --verbose 显示详细状态信息
-j, --json JSON 格式输出
-p, --project <path> 项目路径
示例:
# 显示恢复计划
plan-cascade resume
# 自动恢复无需确认
plan-cascade resume --auto
# 详细输出
plan-cascade resume --verbose
LLM 后端配置
支持的后端
| 后端 | 需要 API Key | 说明 |
|---|---|---|
claude-code | 否 | 通过 Claude Code CLI(默认) |
claude-max | 否 | 通过 Claude Code 获取 LLM |
claude-api | 是 | 直接调用 Anthropic API |
openai | 是 | OpenAI GPT-4o 等 |
deepseek | 是 | DeepSeek Chat/Coder |
ollama | 否 | 本地模型 |
配置示例
# 使用配置向导
plan-cascade config --setup
# 选择后端:
# 1. Claude Code (推荐,无需 API Key)
# 2. Claude API
# 3. OpenAI
# 4. DeepSeek
# 5. Ollama (本地)
环境变量
# Claude API
export ANTHROPIC_API_KEY=sk-ant-...
# OpenAI
export OPENAI_API_KEY=sk-...
# DeepSeek
export DEEPSEEK_API_KEY=sk-...
# Ollama
export OLLAMA_BASE_URL=http://localhost:11434
AI 自动策略判断
简单模式下,AI 根据需求自动选择最佳执行策略:
| 输入 | AI 判断 | 执行策略 |
|---|---|---|
| "添加一个退出按钮" | 小任务 | 直接执行(无 PRD) |
| "实现用户登录功能" | 中等功能 | Hybrid Auto(自动生成 PRD) |
| "开发博客系统,包含用户、文章、评论" | 大型项目 | Mega Plan(多 PRD 级联) |
| "重构支付模块,不要影响现有功能" | 需要隔离 | Hybrid Worktree |
判断维度:
- 任务规模:单一任务 / 多功能 / 完整项目
- 复杂度:是否需要分解为多个 Stories
- 风险程度:是否需要隔离开发
- 依赖关系:是否有跨模块依赖
专家模式详解
工作流
1. 输入需求描述
↓
2. 生成 PRD
↓
3. 交互式菜单
├── view - 查看 PRD
├── edit - 编辑 PRD
├── agent - 指定 Agent
├── run - 执行
├── save - 保存草稿
└── quit - 退出
↓
4. 执行并监控
交互示例
$ plan-cascade run "实现用户登录" --expert
✓ 已生成 PRD (5 个 Stories)
? 请选择操作:
> view - 查看 PRD
edit - 编辑 PRD
agent - 指定 Agent
run - 开始执行
save - 保存草稿
quit - 退出
PRD 编辑
? 选择要编辑的内容:
> 修改 Story
添加 Story
删除 Story
调整依赖
修改优先级
返回
Agent 分配
? 为 Story 分配 Agent:
Story 1: 设计数据库 Schema
> claude-code (推荐)
aider
codex
Story 2: 实现 OAuth 登录
> aider
claude-code
codex
配置文件
配置文件位于 ~/.plan-cascade/config.yaml:
# 后端配置
backend: claude-code # claude-code | claude-api | openai | deepseek | ollama
provider: claude # claude | openai | deepseek | ollama
model: "" # 留空使用默认
# 执行 Agent
agents:
- name: claude-code
enabled: true
command: claude
is_default: true
- name: aider
enabled: true
command: aider --model gpt-4o
- name: codex
enabled: false
command: codex
# Agent 选择策略
agent_selection: prefer_default # smart | prefer_default | manual
default_agent: claude-code
# 质量门控
quality_gates:
typecheck: true
test: true
lint: true
custom: false
custom_script: ""
max_retries: 3
# AI 验证门
verification_gate:
enabled: true # 启用 AI 验证(默认:true)
confidence_threshold: 0.7 # 最小置信度阈值
timeout: 120 # 验证超时(秒)
skeleton_detection:
patterns: ["pass", "...", "NotImplementedError", "TODO", "FIXME", "stub"]
strict: true # 检测到骨架代码时失败
# 执行配置
max_parallel_stories: 3
max_iterations: 50
timeout_seconds: 300
# UI 配置
default_mode: simple # simple | expert
theme: system # light | dark | system
故障排除
API Key 未配置
Error: Claude API key is required
解决:
plan-cascade config --setup
# 或设置环境变量
export ANTHROPIC_API_KEY=sk-ant-...
后端不可用
Error: Backend 'ollama' not available
解决:确保 Ollama 已启动并运行在正确端口。
模型不支持
Error: Model 'gpt-5' not found
解决:检查模型名称是否正确,使用 --model 指定有效模型。
与 Claude Code Plugin 的区别
| 特性 | CLI | Plugin |
|---|---|---|
| 安装方式 | pip install | claude plugins install |
| 使用方式 | 命令行 | /slash 命令 |
| 后端支持 | 多 LLM | Claude Code |
| 工具执行 | 内置 ReAct | Claude Code |
| 离线使用 | 支持(Ollama) | 不支持 |
| Mega-plan 工作流 | 支持 | 支持 |
| Worktree 集成 | 支持 | 支持 |
| 设计文档 | 支持 | 支持 |
| 外部技能 | 支持 | 支持 |
| 并行执行 | 支持 | 支持 |
| 上下文恢复 | 支持 | 支持 |
| 依赖图可视化 | 支持 | 支持 |
CLI 适合:
- 需要使用其他 LLM(OpenAI、DeepSeek 等)
- 需要离线使用(Ollama)
- 偏好命令行操作
- 自动化脚本集成
- CI/CD 流水线集成
Plugin 适合:
- Claude Code 深度用户
- 需要完整 Claude Code 功能
- 偏好 /slash 命令交互
- 交互式开发工作流