workflow-code CLI
workflow-code 是根包暴露的本地运行 CLI。它加载本地 workflow 项目，安装全局 runtime API，并在本机执行 workflow。
调用方式
仓库根包在package.json 中声明了 workflow-code bin，入口文件是 bin/workflow-code.mjs。开发环境中该入口会优先加载 core/cli.ts，构建后加载 dist/core/cli.js。
| 场景 | 命令 |
|---|---|
| 已链接或已安装 bin | workflow-code <command> |
| 仓库脚本中直接调用 | pnpm exec workflow-code <command> |
| 本地源码开发 | node bin/workflow-code.mjs <command> |
命令格式
| 部分 | 说明 |
|---|---|
<command> | run、json、structure 或 help。不传命令时显示帮助。 |
[workflow-dir] | workflow 项目目录。不传时使用当前目录。 |
[--] [...args] | executor createInput 可读取的 CLI 风格参数。-- 用于停止解析 CLI 自身选项，后续参数会原样传给 workflow。 |
全局选项
| 选项 | 说明 |
|---|---|
--help / -h | 显示帮助。必须作为第一个参数使用。 |
--json | 在 run 命令中切换为 JSON 报告输出；json 命令默认开启。 |
--conversation-id <id> | 指定会话 ID。run 和 json 都可使用。 |
--file-store-dir <dir> | 指定本地文件 store 目录。run 和 json 都可使用。 |
命令列表
| 命令 | 说明 |
|---|---|
workflow-code run | 本地执行 workflow，普通模式输出 output node 内容。 |
workflow-code json | 本地执行 workflow，并输出完整 JSON 执行报告。 |
workflow-code structure | 分析 workflow 结构并输出 JSON。 |
workflow-code help | 输出帮助信息。 |
本地运行环境
| 环境变量 | 说明 |
|---|---|
WORKFLOW_KV_STORE_DIR | 本地 KV store 目录。 |
WORKFLOW_FILE_STORE_DIR | 本地文件 store 目录。 |
WORKFLOW_APP_RUNTIME_EVENTS=1 | json 模式下额外输出 App 可消费的 runtime event 前缀行。 |
退出码
| 情况 | 退出码 |
|---|---|
运行成功，且 payload errCode 为 0 | 0 |
| 运行失败 | 1 |
payload errCode 非 0 | 1 |
| structure 分析失败 | 1 |
输出
| 命令 | stdout/stderr |
|---|---|
run | 成功时将 output node 内容写到 stdout；失败时 JSON 报告写到 stderr。 |
json | 完整执行报告写到 stdout。 |
structure | workflow 结构 JSON 写到 stdout。 |
参数分隔
如果 workflow 参数本身以-- 开头，建议显式写分隔符：
args 数组，即使参数名与 CLI 自身选项相同也不会再被 workflow-code 消费。例如 workflow-code run . -- --json 会把 --json 作为 workflow 参数，而不是切换 JSON 报告输出。