{ "commands": { "build": { "aliases": [], "args": { "target": { "description": "build target (deprecated, use --target flag)", "name": "target", "required": false } }, "description": "Build workflow bundles for deployment", "examples": [ "$ workflow build", "$ workflow build --target vercel-build-output-api", "$ workflow build standalone" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "target": { "char": "t", "description": "build target", "name": "target", "default": "standalone", "hasDynamicHelp": false, "multiple": false, "options": [ "standalone", "vercel-build-output-api" ], "type": "option" }, "workflow-manifest": { "char": "m", "description": "output location for workflow manifest", "name": "workflow-manifest", "default": "", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "build", "pluginAlias": "@workflow/cli", "pluginName": "@workflow/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "build.js" ] }, "cancel": { "aliases": [ "c" ], "args": { "runId": { "description": "ID of the run to cancel (omit for bulk mode with filters)", "name": "runId", "required": false } }, "description": "Cancel a workflow run, or bulk-cancel runs by status/name", "examples": [ "$ workflow cancel ", "$ workflow cancel --status=running", "$ workflow cancel --status=running --workflowName=myWorkflow", "$ workflow cancel --status=running -y" ], "flags": { "json": { "char": "j", "description": "output JSON instead of human-readable tables/streams", "helpGroup": "Output", "helpLabel": "-j, --json", "name": "json", "required": false, "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "description": "Verbose output", "env": "DEBUG", "helpGroup": "Output", "helpLabel": "-v, --verbose", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "cursor": { "description": "pagination cursor for list commands", "helpGroup": "Filtering", "helpLabel": "--cursor", "name": "cursor", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "CURSOR", "multiple": false, "type": "option" }, "backend": { "char": "b", "description": "backend to inspect", "env": "WORKFLOW_TARGET_WORLD", "helpGroup": "Target", "helpLabel": "-b, --backend", "name": "backend", "required": false, "default": "local", "hasDynamicHelp": false, "helpValue": [ "local", "vercel", "" ], "multiple": false, "type": "option" }, "authToken": { "char": "a", "dependsOn": [ "backend" ], "description": "Authentication token to be passed to the backend. If not provided and the backend is vercel, will fall back to the token generated by `vc login`.", "env": "WORKFLOW_VERCEL_AUTH_TOKEN", "helpGroup": "Target", "helpLabel": "-a, --authToken", "name": "authToken", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "TOKEN", "multiple": false, "type": "option" }, "project": { "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel project to authenticate against", "env": "WORKFLOW_VERCEL_PROJECT", "helpGroup": "Target", "helpLabel": "--project", "name": "project", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "PROJECT", "multiple": false, "type": "option" }, "team": { "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel team to authenticate against", "env": "WORKFLOW_VERCEL_TEAM", "helpGroup": "Target", "helpLabel": "--team", "name": "team", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "TEAM", "multiple": false, "type": "option" }, "env": { "char": "e", "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel environment to use", "env": "WORKFLOW_VERCEL_ENV", "helpGroup": "Target", "helpLabel": "-e, --env", "name": "env", "required": false, "default": "production", "hasDynamicHelp": false, "helpValue": [ "production", "preview" ], "multiple": false, "options": [ "production", "preview" ], "type": "option" }, "web": { "char": "w", "description": "Open the web UI instead of displaying in terminal", "helpGroup": "Output", "helpLabel": "-w, --web", "name": "web", "required": false, "allowNo": false, "type": "boolean" }, "webPort": { "description": "Port to use when launching the web UI (default: 3456)", "env": "WORKFLOW_WEB_PORT", "helpGroup": "Output", "helpLabel": "--webPort", "name": "webPort", "required": false, "default": 3456, "hasDynamicHelp": false, "helpValue": "WEB_PORT", "multiple": false, "type": "option" }, "noBrowser": { "description": "Disable automatic browser opening when launching web UI", "env": "WORKFLOW_DISABLE_BROWSER_OPEN", "helpGroup": "Output", "helpLabel": "--noBrowser", "name": "noBrowser", "required": false, "allowNo": false, "type": "boolean" }, "localUi": { "description": "Use local web UI instead of Vercel dashboard (when backend is vercel)", "env": "WORKFLOW_LOCAL_UI", "helpGroup": "Output", "helpLabel": "--localUi", "name": "localUi", "required": false, "allowNo": false, "type": "boolean" }, "standalone": { "description": "Always start the standalone web UI, even if an embedded dashboard (e.g. /_workflow) is already running", "env": "WORKFLOW_STANDALONE_UI", "helpGroup": "Output", "helpLabel": "--standalone", "name": "standalone", "required": false, "allowNo": false, "type": "boolean" }, "sort": { "description": "sort order for list commands", "helpGroup": "Filtering", "helpLabel": "--sort", "name": "sort", "required": false, "hasDynamicHelp": false, "helpValue": [ "asc", "desc" ], "multiple": false, "options": [ "asc", "desc" ], "type": "option" }, "limit": { "description": "Max runs to cancel in bulk mode (1-100)", "helpGroup": "Bulk Cancel", "helpLabel": "--limit", "name": "limit", "required": false, "default": 50, "hasDynamicHelp": false, "helpValue": "NUMBER", "multiple": false, "type": "option" }, "interactive": { "char": "i", "description": "Enable interactive pagination with keyboard controls", "helpGroup": "Output", "helpLabel": "-i, --interactive", "name": "interactive", "required": false, "allowNo": false, "type": "boolean" }, "status": { "description": "Filter runs by status for bulk cancel (pending or running)", "helpGroup": "Bulk Cancel", "helpLabel": "--status", "name": "status", "required": false, "hasDynamicHelp": false, "multiple": false, "options": [ "pending", "running" ], "type": "option" }, "workflowName": { "char": "n", "description": "Filter runs by workflow name for bulk cancel", "helpGroup": "Bulk Cancel", "helpLabel": "-n, --workflowName", "name": "workflowName", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "confirm": { "char": "y", "description": "Skip interactive confirmation prompt", "helpGroup": "Bulk Cancel", "helpLabel": "-y, --confirm", "name": "confirm", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cancel", "pluginAlias": "@workflow/cli", "pluginName": "@workflow/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "cancel.js" ] }, "dev": { "aliases": [], "args": {}, "description": "Start development server with file watching (Coming soon)", "examples": [ "$ workflow dev", "$ workflow dev --port 3001" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "port": { "char": "p", "description": "port to run dev server on", "name": "port", "default": 3000, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target": { "char": "t", "description": "build target for development", "name": "target", "default": "standalone", "hasDynamicHelp": false, "multiple": false, "options": [ "standalone", "vercel-build-output-api" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "dev", "pluginAlias": "@workflow/cli", "pluginName": "@workflow/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "dev.js" ] }, "health": { "aliases": [], "args": {}, "description": "Check the workflow endpoint via a queue-based health check", "examples": [ "$ workflow health", "$ workflow health --timeout 60000", "$ workflow health --backend vercel --project my-project --team my-team" ], "flags": { "json": { "char": "j", "description": "output JSON instead of human-readable tables/streams", "helpGroup": "Output", "helpLabel": "-j, --json", "name": "json", "required": false, "allowNo": false, "type": "boolean" }, "timeout": { "char": "t", "description": "Timeout in milliseconds for health check", "helpGroup": "Health Check", "helpLabel": "-t, --timeout", "name": "timeout", "default": 30000, "hasDynamicHelp": false, "helpValue": "MS", "multiple": false, "type": "option" }, "port": { "char": "p", "description": "Local server port (for local backend)", "helpGroup": "Health Check", "helpLabel": "-p, --port", "name": "port", "required": false, "hasDynamicHelp": false, "helpValue": "PORT", "multiple": false, "type": "option" }, "verbose": { "char": "v", "description": "Verbose output", "env": "DEBUG", "helpGroup": "Output", "helpLabel": "-v, --verbose", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "backend": { "char": "b", "description": "backend to inspect", "env": "WORKFLOW_TARGET_WORLD", "helpGroup": "Target", "helpLabel": "-b, --backend", "name": "backend", "required": false, "default": "local", "hasDynamicHelp": false, "helpValue": [ "local", "vercel", "" ], "multiple": false, "type": "option" }, "authToken": { "char": "a", "dependsOn": [ "backend" ], "description": "Authentication token to be passed to the backend. If not provided and the backend is vercel, will fall back to the token generated by `vc login`.", "env": "WORKFLOW_VERCEL_AUTH_TOKEN", "helpGroup": "Target", "helpLabel": "-a, --authToken", "name": "authToken", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "TOKEN", "multiple": false, "type": "option" }, "project": { "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel project to authenticate against", "env": "WORKFLOW_VERCEL_PROJECT", "helpGroup": "Target", "helpLabel": "--project", "name": "project", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "PROJECT", "multiple": false, "type": "option" }, "team": { "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel team to authenticate against", "env": "WORKFLOW_VERCEL_TEAM", "helpGroup": "Target", "helpLabel": "--team", "name": "team", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "TEAM", "multiple": false, "type": "option" }, "env": { "char": "e", "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel environment to use", "env": "WORKFLOW_VERCEL_ENV", "helpGroup": "Target", "helpLabel": "-e, --env", "name": "env", "required": false, "default": "production", "hasDynamicHelp": false, "helpValue": [ "production", "preview" ], "multiple": false, "options": [ "production", "preview" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "health", "pluginAlias": "@workflow/cli", "pluginName": "@workflow/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "health.js" ] }, "init": { "aliases": [], "args": {}, "description": "Initialize a new workflow project (Coming soon)", "examples": [ "$ workflow init", "$ workflow init --template nextjs", "$ workflow init --yes" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "template": { "description": "template to use", "name": "template", "hasDynamicHelp": false, "multiple": false, "options": [ "standalone", "nextjs", "express" ], "type": "option" }, "yes": { "char": "y", "description": "skip prompts and use defaults", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "init", "pluginAlias": "@workflow/cli", "pluginName": "@workflow/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "init.js" ] }, "inspect": { "aliases": [ "i" ], "args": { "resource": { "description": "what to inspect: run(s) | step(s) | stream(s) | event(s) | hook(s) | sleep(s) | attribute(s)", "name": "resource", "options": [ "r", "run", "runs", "s", "step", "steps", "e", "event", "events", "st", "stream", "streams", "h", "hook", "hooks", "w", "web", "sleep", "sleeps", "a", "attr", "attribute", "attributes" ], "required": true }, "id": { "description": "ID of the resource if inspecting a specific item", "name": "id", "required": false } }, "description": "Inspect runs, steps, streams, or events", "examples": [ "$ workflow inspect runs", "$ workflow inspect attributes", "$ workflow inspect runs --attribute tenant=acme --status failed", "$ workflow inspect events --step=step_01K5WAJZ8W367CV2RFKDSDNWB8", "$ workflow inspect events --runId=wrun_01K5WAJZ8W367CV2RFKDSDNWB8 --json --all", "$ workflow inspect event evnt_00000000000000000000000003 --runId=wrun_01K5WAJZ8W367CV2RFKDSDNWB8", "$ workflow inspect hooks", "$ workflow inspect hook hook_01K5WAJZ8W367CV2RFKDSDNWB8", "$ workflow inspect sleeps --runId=run_01K5WAJZ8W367CV2RFKDSDNWB8" ], "flags": { "json": { "char": "j", "description": "output JSON instead of human-readable tables/streams", "helpGroup": "Output", "helpLabel": "-j, --json", "name": "json", "required": false, "allowNo": false, "type": "boolean" }, "runId": { "aliases": [ "run" ], "char": "r", "description": "Run ID to filter by (required for steps, sleeps, and events. Optional for hooks.)", "helpGroup": "Filtering", "helpLabel": "-r, --runId", "name": "runId", "required": false, "hasDynamicHelp": false, "helpValue": "RUN_ID", "multiple": false, "type": "option" }, "stepId": { "aliases": [ "step" ], "char": "s", "description": "step ID to filter by (only for events)", "helpGroup": "Filtering", "helpLabel": "-s, --stepId", "name": "stepId", "required": false, "hasDynamicHelp": false, "helpValue": "STEP_ID", "multiple": false, "type": "option" }, "hookId": { "aliases": [ "hook" ], "description": "hook ID to filter by (only for events)", "helpGroup": "Filtering", "helpLabel": "--hookId", "name": "hookId", "required": false, "hasDynamicHelp": false, "helpValue": "HOOK_ID", "multiple": false, "type": "option" }, "attribute": { "description": "filter runs by attribute, as key=value; repeatable up to 8 times", "helpGroup": "Filtering", "helpLabel": "--attribute", "name": "attribute", "required": false, "hasDynamicHelp": false, "helpValue": "KEY=VALUE", "multiple": true, "type": "option" }, "workflowName": { "aliases": [ "workflow" ], "char": "n", "description": "workflow name to filter by, in full or the short name the runs table shows (runs and attributes)", "helpGroup": "Filtering", "helpLabel": "-n, --workflowName", "name": "workflowName", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "filter runs by status (only for runs)", "helpGroup": "Filtering", "helpLabel": "--status", "name": "status", "required": false, "hasDynamicHelp": false, "multiple": false, "options": [ "pending", "running", "completed", "failed", "cancelled" ], "type": "option" }, "since": { "description": "list items active since a relative duration (30m, 12h, 7d, 2w) or timestamp; defaults to the backend window (runs and attributes)", "helpGroup": "Filtering", "helpLabel": "--since", "name": "since", "required": false, "hasDynamicHelp": false, "helpValue": "DURATION|TIMESTAMP", "multiple": false, "type": "option" }, "until": { "description": "end of the --since listing window, as a relative duration or timestamp; defaults to now (runs and attributes)", "helpGroup": "Filtering", "helpLabel": "--until", "name": "until", "required": false, "hasDynamicHelp": false, "helpValue": "DURATION|TIMESTAMP", "multiple": false, "type": "option" }, "withData": { "char": "d", "description": "include full input/output data in list views (deprecated for list views — use `inspect ` to view payloads)", "helpGroup": "Display", "helpLabel": "-d, --withData", "name": "withData", "required": false, "allowNo": false, "type": "boolean" }, "decrypt": { "description": "decrypt encrypted values (triggers audit-logged key retrieval)", "helpGroup": "Display", "helpLabel": "--decrypt", "name": "decrypt", "required": false, "allowNo": false, "type": "boolean" }, "all": { "description": "follow cursors to the last page and print every row (steps, events, and sleeps); --limit sets the page size", "helpGroup": "Filtering", "helpLabel": "--all", "name": "all", "required": false, "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "description": "Verbose output", "env": "DEBUG", "helpGroup": "Output", "helpLabel": "-v, --verbose", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "cursor": { "description": "pagination cursor for list commands", "helpGroup": "Filtering", "helpLabel": "--cursor", "name": "cursor", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "CURSOR", "multiple": false, "type": "option" }, "backend": { "char": "b", "description": "backend to inspect", "env": "WORKFLOW_TARGET_WORLD", "helpGroup": "Target", "helpLabel": "-b, --backend", "name": "backend", "required": false, "default": "local", "hasDynamicHelp": false, "helpValue": [ "local", "vercel", "" ], "multiple": false, "type": "option" }, "authToken": { "char": "a", "dependsOn": [ "backend" ], "description": "Authentication token to be passed to the backend. If not provided and the backend is vercel, will fall back to the token generated by `vc login`.", "env": "WORKFLOW_VERCEL_AUTH_TOKEN", "helpGroup": "Target", "helpLabel": "-a, --authToken", "name": "authToken", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "TOKEN", "multiple": false, "type": "option" }, "project": { "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel project to authenticate against", "env": "WORKFLOW_VERCEL_PROJECT", "helpGroup": "Target", "helpLabel": "--project", "name": "project", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "PROJECT", "multiple": false, "type": "option" }, "team": { "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel team to authenticate against", "env": "WORKFLOW_VERCEL_TEAM", "helpGroup": "Target", "helpLabel": "--team", "name": "team", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "TEAM", "multiple": false, "type": "option" }, "env": { "char": "e", "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel environment to use", "env": "WORKFLOW_VERCEL_ENV", "helpGroup": "Target", "helpLabel": "-e, --env", "name": "env", "required": false, "default": "production", "hasDynamicHelp": false, "helpValue": [ "production", "preview" ], "multiple": false, "options": [ "production", "preview" ], "type": "option" }, "web": { "char": "w", "description": "Open the web UI instead of displaying in terminal", "helpGroup": "Output", "helpLabel": "-w, --web", "name": "web", "required": false, "allowNo": false, "type": "boolean" }, "webPort": { "description": "Port to use when launching the web UI (default: 3456)", "env": "WORKFLOW_WEB_PORT", "helpGroup": "Output", "helpLabel": "--webPort", "name": "webPort", "required": false, "default": 3456, "hasDynamicHelp": false, "helpValue": "WEB_PORT", "multiple": false, "type": "option" }, "noBrowser": { "description": "Disable automatic browser opening when launching web UI", "env": "WORKFLOW_DISABLE_BROWSER_OPEN", "helpGroup": "Output", "helpLabel": "--noBrowser", "name": "noBrowser", "required": false, "allowNo": false, "type": "boolean" }, "localUi": { "description": "Use local web UI instead of Vercel dashboard (when backend is vercel)", "env": "WORKFLOW_LOCAL_UI", "helpGroup": "Output", "helpLabel": "--localUi", "name": "localUi", "required": false, "allowNo": false, "type": "boolean" }, "standalone": { "description": "Always start the standalone web UI, even if an embedded dashboard (e.g. /_workflow) is already running", "env": "WORKFLOW_STANDALONE_UI", "helpGroup": "Output", "helpLabel": "--standalone", "name": "standalone", "required": false, "allowNo": false, "type": "boolean" }, "sort": { "description": "sort order for list commands", "helpGroup": "Filtering", "helpLabel": "--sort", "name": "sort", "required": false, "hasDynamicHelp": false, "helpValue": [ "asc", "desc" ], "multiple": false, "options": [ "asc", "desc" ], "type": "option" }, "limit": { "description": "number of items to return per page", "helpGroup": "Filtering", "helpLabel": "--limit", "name": "limit", "required": false, "default": 20, "hasDynamicHelp": false, "helpValue": "NUMBER", "multiple": false, "type": "option" }, "interactive": { "char": "i", "description": "Enable interactive pagination with keyboard controls", "helpGroup": "Output", "helpLabel": "-i, --interactive", "name": "interactive", "required": false, "allowNo": false, "type": "boolean" }, "url": { "description": "Print the deep-link URL to the run/dashboard and exit (no browser, no server)", "helpGroup": "Output", "helpLabel": "--url", "name": "url", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "inspect", "pluginAlias": "@workflow/cli", "pluginName": "@workflow/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "inspect.js" ] }, "start": { "aliases": [ "s" ], "args": { "workflowName": { "description": "Name of a workflow to start. Providing a run ID will create a new run on that workflow.", "name": "workflowName", "required": true }, "args": { "description": "Arguments to pass to the workflow. All arguments will be parsed as JSON.\nE.g. `wf start example 123 \"'123'\" \"{\"a\": 1}\"` will start the \"example\" workflow with 123 (a number), \"123\" (a string), and {\"a\": 1} (an object)", "name": "args", "required": false } }, "description": "Start a workflow", "examples": [ "$ workflow start ", "$ wf start " ], "flags": { "json": { "char": "j", "description": "output JSON instead of human-readable tables/streams", "helpGroup": "Output", "helpLabel": "-j, --json", "name": "json", "required": false, "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "description": "Verbose output", "env": "DEBUG", "helpGroup": "Output", "helpLabel": "-v, --verbose", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "cursor": { "description": "pagination cursor for list commands", "helpGroup": "Filtering", "helpLabel": "--cursor", "name": "cursor", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "CURSOR", "multiple": false, "type": "option" }, "backend": { "char": "b", "description": "backend to inspect", "env": "WORKFLOW_TARGET_WORLD", "helpGroup": "Target", "helpLabel": "-b, --backend", "name": "backend", "required": false, "default": "local", "hasDynamicHelp": false, "helpValue": [ "local", "vercel", "" ], "multiple": false, "type": "option" }, "authToken": { "char": "a", "dependsOn": [ "backend" ], "description": "Authentication token to be passed to the backend. If not provided and the backend is vercel, will fall back to the token generated by `vc login`.", "env": "WORKFLOW_VERCEL_AUTH_TOKEN", "helpGroup": "Target", "helpLabel": "-a, --authToken", "name": "authToken", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "TOKEN", "multiple": false, "type": "option" }, "project": { "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel project to authenticate against", "env": "WORKFLOW_VERCEL_PROJECT", "helpGroup": "Target", "helpLabel": "--project", "name": "project", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "PROJECT", "multiple": false, "type": "option" }, "team": { "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel team to authenticate against", "env": "WORKFLOW_VERCEL_TEAM", "helpGroup": "Target", "helpLabel": "--team", "name": "team", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "TEAM", "multiple": false, "type": "option" }, "env": { "char": "e", "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel environment to use", "env": "WORKFLOW_VERCEL_ENV", "helpGroup": "Target", "helpLabel": "-e, --env", "name": "env", "required": false, "default": "production", "hasDynamicHelp": false, "helpValue": [ "production", "preview" ], "multiple": false, "options": [ "production", "preview" ], "type": "option" }, "web": { "char": "w", "description": "Open the web UI instead of displaying in terminal", "helpGroup": "Output", "helpLabel": "-w, --web", "name": "web", "required": false, "allowNo": false, "type": "boolean" }, "webPort": { "description": "Port to use when launching the web UI (default: 3456)", "env": "WORKFLOW_WEB_PORT", "helpGroup": "Output", "helpLabel": "--webPort", "name": "webPort", "required": false, "default": 3456, "hasDynamicHelp": false, "helpValue": "WEB_PORT", "multiple": false, "type": "option" }, "noBrowser": { "description": "Disable automatic browser opening when launching web UI", "env": "WORKFLOW_DISABLE_BROWSER_OPEN", "helpGroup": "Output", "helpLabel": "--noBrowser", "name": "noBrowser", "required": false, "allowNo": false, "type": "boolean" }, "localUi": { "description": "Use local web UI instead of Vercel dashboard (when backend is vercel)", "env": "WORKFLOW_LOCAL_UI", "helpGroup": "Output", "helpLabel": "--localUi", "name": "localUi", "required": false, "allowNo": false, "type": "boolean" }, "standalone": { "description": "Always start the standalone web UI, even if an embedded dashboard (e.g. /_workflow) is already running", "env": "WORKFLOW_STANDALONE_UI", "helpGroup": "Output", "helpLabel": "--standalone", "name": "standalone", "required": false, "allowNo": false, "type": "boolean" }, "sort": { "description": "sort order for list commands", "helpGroup": "Filtering", "helpLabel": "--sort", "name": "sort", "required": false, "hasDynamicHelp": false, "helpValue": [ "asc", "desc" ], "multiple": false, "options": [ "asc", "desc" ], "type": "option" }, "limit": { "description": "number of items to return per page", "helpGroup": "Filtering", "helpLabel": "--limit", "name": "limit", "required": false, "default": 20, "hasDynamicHelp": false, "helpValue": "NUMBER", "multiple": false, "type": "option" }, "interactive": { "char": "i", "description": "Enable interactive pagination with keyboard controls", "helpGroup": "Output", "helpLabel": "-i, --interactive", "name": "interactive", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "start", "pluginAlias": "@workflow/cli", "pluginName": "@workflow/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "start.js" ] }, "transform": { "aliases": [], "args": { "file": { "description": "The file to transform", "name": "file", "required": true } }, "description": "Show SWC transform output for a workflow file. Useful for inspecting what code runs in each execution context.", "examples": [ "$ workflow transform src/MyClass.ts", "$ workflow transform src/MyClass.ts --mode workflow", "$ workflow transform src/MyClass.ts --mode step", "$ workflow transform src/MyClass.ts --check-serde", "$ workflow transform src/MyClass.ts --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "mode": { "char": "m", "description": "Transform mode (workflow, step, or all)", "name": "mode", "default": "all", "hasDynamicHelp": false, "multiple": false, "options": [ "workflow", "step", "all" ], "type": "option" }, "check-serde": { "description": "Run serde compliance analysis on the transformed output", "name": "check-serde", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "transform", "pluginAlias": "@workflow/cli", "pluginName": "@workflow/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "transform.js" ] }, "validate": { "aliases": [], "args": {}, "description": "Validate workflow files for correctness, including serde compliance checks", "examples": [ "$ workflow validate", "$ workflow validate --dir src/workflows", "$ workflow validate --strict", "$ workflow validate --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "strict": { "description": "exit with code 1 if any validation issues are found", "name": "strict", "allowNo": false, "type": "boolean" }, "dir": { "char": "d", "description": "directory to validate", "name": "dir", "default": ".", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "validate", "pluginAlias": "@workflow/cli", "pluginName": "@workflow/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "validate.js" ] }, "web": { "aliases": [ "w" ], "args": { "id": { "description": "Optional run ID to open directly", "name": "id", "required": false } }, "description": "Open the web UI to inspect workflow runs", "examples": [ "$ workflow web", "$ workflow web run_01K5WAJZ8W367CV2RFKDSDNWB8", "$ workflow web --backend=vercel" ], "flags": { "json": { "char": "j", "description": "output JSON instead of human-readable tables/streams", "helpGroup": "Output", "helpLabel": "-j, --json", "name": "json", "required": false, "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "description": "Verbose output", "env": "DEBUG", "helpGroup": "Output", "helpLabel": "-v, --verbose", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "cursor": { "description": "pagination cursor for list commands", "helpGroup": "Filtering", "helpLabel": "--cursor", "name": "cursor", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "CURSOR", "multiple": false, "type": "option" }, "backend": { "char": "b", "description": "backend to inspect", "env": "WORKFLOW_TARGET_WORLD", "helpGroup": "Target", "helpLabel": "-b, --backend", "name": "backend", "required": false, "default": "local", "hasDynamicHelp": false, "helpValue": [ "local", "vercel", "" ], "multiple": false, "type": "option" }, "authToken": { "char": "a", "dependsOn": [ "backend" ], "description": "Authentication token to be passed to the backend. If not provided and the backend is vercel, will fall back to the token generated by `vc login`.", "env": "WORKFLOW_VERCEL_AUTH_TOKEN", "helpGroup": "Target", "helpLabel": "-a, --authToken", "name": "authToken", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "TOKEN", "multiple": false, "type": "option" }, "project": { "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel project to authenticate against", "env": "WORKFLOW_VERCEL_PROJECT", "helpGroup": "Target", "helpLabel": "--project", "name": "project", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "PROJECT", "multiple": false, "type": "option" }, "team": { "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel team to authenticate against", "env": "WORKFLOW_VERCEL_TEAM", "helpGroup": "Target", "helpLabel": "--team", "name": "team", "required": false, "default": "", "hasDynamicHelp": false, "helpValue": "TEAM", "multiple": false, "type": "option" }, "env": { "char": "e", "dependsOn": [ "backend" ], "description": "If backend is vercel, the vercel environment to use", "env": "WORKFLOW_VERCEL_ENV", "helpGroup": "Target", "helpLabel": "-e, --env", "name": "env", "required": false, "default": "production", "hasDynamicHelp": false, "helpValue": [ "production", "preview" ], "multiple": false, "options": [ "production", "preview" ], "type": "option" }, "web": { "char": "w", "description": "Open the web UI instead of displaying in terminal", "helpGroup": "Output", "helpLabel": "-w, --web", "name": "web", "required": false, "allowNo": false, "type": "boolean" }, "webPort": { "description": "Port to use when launching the web UI (default: 3456)", "env": "WORKFLOW_WEB_PORT", "helpGroup": "Output", "helpLabel": "--webPort", "name": "webPort", "required": false, "default": 3456, "hasDynamicHelp": false, "helpValue": "WEB_PORT", "multiple": false, "type": "option" }, "noBrowser": { "description": "Disable automatic browser opening when launching web UI", "env": "WORKFLOW_DISABLE_BROWSER_OPEN", "helpGroup": "Output", "helpLabel": "--noBrowser", "name": "noBrowser", "required": false, "allowNo": false, "type": "boolean" }, "localUi": { "description": "Use local web UI instead of Vercel dashboard (when backend is vercel)", "env": "WORKFLOW_LOCAL_UI", "helpGroup": "Output", "helpLabel": "--localUi", "name": "localUi", "required": false, "allowNo": false, "type": "boolean" }, "standalone": { "description": "Always start the standalone web UI, even if an embedded dashboard (e.g. /_workflow) is already running", "env": "WORKFLOW_STANDALONE_UI", "helpGroup": "Output", "helpLabel": "--standalone", "name": "standalone", "required": false, "allowNo": false, "type": "boolean" }, "sort": { "description": "sort order for list commands", "helpGroup": "Filtering", "helpLabel": "--sort", "name": "sort", "required": false, "hasDynamicHelp": false, "helpValue": [ "asc", "desc" ], "multiple": false, "options": [ "asc", "desc" ], "type": "option" }, "limit": { "description": "number of items to return per page", "helpGroup": "Filtering", "helpLabel": "--limit", "name": "limit", "required": false, "default": 20, "hasDynamicHelp": false, "helpValue": "NUMBER", "multiple": false, "type": "option" }, "interactive": { "char": "i", "description": "Enable interactive pagination with keyboard controls", "helpGroup": "Output", "helpLabel": "-i, --interactive", "name": "interactive", "required": false, "allowNo": false, "type": "boolean" }, "url": { "description": "Print the deep-link URL to the run/dashboard and exit (no browser, no server)", "helpGroup": "Output", "helpLabel": "--url", "name": "url", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "web", "pluginAlias": "@workflow/cli", "pluginName": "@workflow/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "web.js" ] } }, "version": "5.0.6" }