CLI 总览
workflow-code 当前有两类 CLI:| CLI | 用途 |
|---|---|
workflow-code | 在本地 workflow 目录运行、输出 JSON 报告、检查结构。 |
workflow-workspace / pnpm -C workspace workspace | 连接 Workflow Server,完成登录、打包、上传、发布、远程运行、调试、下载和版本查询。 |
命令索引
典型工作流
本地开发时,先用workflow-code 在 workflow 目录验证运行结果和结构,再用 workspace CLI 上传到 server。
workflow-workspace 命令;phase 0 起,开发态仍默认连接 712x,发布/部署态建议显式使用 7130+ 端口带或正式域名。
配置来源
| 配置 | 说明 |
|---|---|
WORKFLOW_SERVER_URL | workspace CLI 默认 server 地址。 |
WORKFLOW_SERVER_ADMIN_KEY | workspace CLI 的显式管理员覆盖凭证;自动化或恢复场景可直接作为 Bearer 使用。 |
WORKFLOW_REPO_ROOT | workspace CLI 的仓库根目录。未设置时从当前目录向上推导。 |
WORKFLOW_CLI_AUTH_DIR | workspace CLI 保存独立登录态 workflow-auth.json 的目录。 |
WORKFLOW_APP_CONFIG_DIR | App 保存桌面端连接配置 workflow-app.json 的目录。 |
WORKFLOW_KV_STORE_DIR | workflow-code 本地运行时 KV store 目录。 |
WORKFLOW_FILE_STORE_DIR | workflow-code 本地运行时文件 store 目录。 |
workflow-code run/json 调用 context.persistentValue 时会优先读取 WORKFLOW_SERVER_URL / WORKFLOW_SERVER_ADMIN_KEY,否则回退到 workspace CLI 保存的 workflow-auth.json,再由 server 把持久值写到数据库;调用 context.files.createFile(...) 时也会用同一连接写入 server 文件 API。普通 context.kv 仍由 WORKFLOW_KV_STORE_DIR 控制本地存储,输入附件解析仍由 WORKFLOW_FILE_STORE_DIR 控制。
workspace CLI 会读取 server/cli/.env 和仓库根目录 .env。server/cli/.env.example 提供了最小配置模板。
输出约定
| 命令族 | 输出 |
|---|---|
workflow-code run | 成功时输出 output node 的内容;失败时输出 JSON 报告到 stderr。 |
workflow-code json | 始终输出完整 JSON 执行报告。 |
workflow-code structure | 输出 workflow 结构 JSON。 |
| workspace CLI | 输出 server API response JSON,形如 { errCode, errMessage, data }。 |
后续阅读
- 本地运行和结构检查见 workflow-code CLI。
- server 上传、发布和远程运行见 Server Workspace CLI。