Appearance
示例导览
这一页不只是列文件名
重点是回答两件事
- 先看哪几个示例，能最快摸清主线
- 每个示例主要在演示什么
第一轮建议
第一次浏览时，顺序建议这样排
- create-project.ts
- command-modes.ts
- docker-build.ts
- release-workflow.ts
- plugin-step.ts
这五个文件基本覆盖了最小 workflow、命令执行、条件步骤、历史复用和扩展点
按场景分组
起步场景
| 示例 | 适合什么时候看 | 重点 |
|---|---|---|
| create-project.ts | 第一次接触仓库 | defineWorkflow、defineStep、默认摘要 |
| docker-build.ts | 已经会写输入步骤 | defaultValue、when、history 复用 |
| reuse-history.ts | 只想看快照复用 | 历史保存、历史读取、运行参数 |
命令执行场景
| 示例 | 适合什么时候看 | 重点 |
|---|---|---|
| command-modes.ts | 比较三种命令入口 | command、scriptFile、run(context, io) |
| parallel-commands.ts | 需要并行执行 | parallel 分组、缓冲回放、耗时分析 |
| task-log.ts | 关注输出体验 | task-log、延迟输出、日志保存 |
| act-workflow.ts | 想看命令和交互混用 | autocomplete、多选、命令步骤 |
业务流程场景
| 示例 | 适合什么时候看 | 重点 |
|---|---|---|
| release-workflow.ts | 需要较完整的发布流程 | 检查项、channel、dry-run、条件流 |
| deploy-service.ts | 需要部署流程 | 环境选择、审批、migration、发布策略 |
| incident-runbook.ts | 需要终端 runbook | 分级动作、文件工具、后续步骤 |
扩展场景
| 示例 | 适合什么时候看 | 重点 |
|---|---|---|
| plugin-step.ts | 需要自定义步骤 | registerStepHandler、extendContextTools |
| create-project.ts | 想看 CLI 参数透传 | runExampleWorkflow 封装与 initialValues |
每个示例适合学什么
create-project.ts
最适合第一眼阅读
- 结构短
- 输入步骤完整
- 没有过早引入持久化细节
command-modes.ts
适合第二眼阅读
- 同一文件里能比较三种命令入口
- 容易看清 command 和 run 的边界
release-workflow.ts
适合进入真实业务流程前阅读
- 条件步骤比较密集
- 输入、命令、判断和摘要都在同一条链路上
plugin-step.ts
适合已经理解默认模型之后阅读
- 自定义 kind 的方式最集中
- 能顺带看 context.tools 的扩展位置
运行方式
bash
bun run example
bun run examples/create-project.ts需要直接透传参数时，可以这样运行
bash
bun run examples/create-project.ts --name my-app --framework react --features eslint,vitest --install=true这些参数会先通过 examples 层的 runExampleWorkflow() 统一接入，再由底层 createWorkflowCliBridge() 映射成 initialValues，因此已传值的步骤通常会跳过交互