o2-workflow

Beta — 面向 workflow 自动化实例的终端客户端。管理工作流、执行记录、凭证与空间/项目。

轻量、仅依赖 @oclif/core，通过浏览器 SSO 登录后调用实例 REST API（/rest），面向人类、脚本与 AI Agent。

安装

# 零安装直接运行
npx o2-workflow workflow list

# 或全局安装
npm install -g o2-workflow
pnpm add -g o2-workflow

登录

首次调用 API 前，通过浏览器 SSO 登录一次：

o2-workflow login

登录凭证保存在 ~/.o2-workflow/config.json（权限 0600）。若不存在，会回退读取 ~/.oxygen-cli/config.json（与 oxygen-cli 共用登录凭证）。

也可通过环境变量跳过登录（适合 CI / Agent）：

• WORKFLOW_SSO_COOKIE：直接提供 SSO Cookie
• WORKFLOW_URL：覆盖实例地址（默认 https://oxygenflow.jd.com）

常用命令

脚本与 Agent 场景建议加 --json 输出结构化结果；写操作需加 --confirm。

# 元信息与诊断
o2-workflow info --json
o2-workflow doctor --json

# 工作流
o2-workflow workflow list --json
o2-workflow workflow export <id> --file=workflow.json
o2-workflow workflow create --file=workflow.json --confirm --json
o2-workflow workflow update <id> --file=updated.json --confirm --json
o2-workflow workflow copy <id> --confirm --json
o2-workflow workflow run <id> --json
o2-workflow workflow activate <id> --confirm --json
o2-workflow workflow deactivate <id> --confirm --json
o2-workflow workflow archive <id> --confirm --json
o2-workflow workflow unarchive <id> --confirm --json
o2-workflow workflow delete <id> --confirm --json

# 空间/项目
o2-workflow project list --json
o2-workflow project list --personalSpace --json
o2-workflow project get <id> --json

# 执行记录
o2-workflow execution list --json
o2-workflow execution get <id> --json
o2-workflow execution stop <id> --json
o2-workflow execution retry <id> --load-workflow --json
o2-workflow execution delete <id> --confirm --json

# 凭证
o2-workflow credential list --json
o2-workflow credential get <id> --json
o2-workflow credential create --file=credential.json --confirm --json
o2-workflow credential update <id> --file=credential.json --confirm --json
o2-workflow credential share <id> --projects=<projectId> --confirm --json
o2-workflow credential delete <id> --confirm --json

| Topic | 子命令 | |-------|--------| | — | login、info、doctor | | workflow | list、export、create、update、copy、run、activate、deactivate、archive、unarchive、delete | | project | list、get | | execution | list、get、stop、retry、delete | | credential | list、get、create、update、share、delete |

完整列表：o2-workflow --help；各子命令详情：o2-workflow workflow --help

Agent 集成

• SKILL：skills/o2-workflow/SKILL.md
• 能力清单：capabilities.json（与 CLI 命令一一对应）

也可通过 oxygen-cli 安装与管理：

oxygen-cli install o2-workflow
oxygen-cli skill show o2-workflow

开发

pnpm install
pnpm verify    # typecheck + lint + test + build

说明

本包通过 SSO Cookie 调用 workflow 自动化平台 REST API（/rest）。