{ "commands": { "fix": { "aliases": [], "args": {}, "description": "Fix Output scripts in the package.json (reset overwrites, add missing and remove deprecated)", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "fix", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "fix.js" ] }, "init": { "aliases": [], "args": { "folderName": { "description": "Optional folder name for the project (skips folder name prompt)", "name": "folderName", "required": false } }, "description": "Initialize a new Output project by scaffolding the complete project structure", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> my-workflow-project" ], "flags": { "skip-env": { "description": "Skip interactive environment variable configuration", "name": "skip-env", "allowNo": false, "type": "boolean" }, "skip-git": { "description": "Skip git repository initialization", "name": "skip-git", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "init", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "init.js" ] }, "migrate": { "aliases": [], "args": {}, "description": "Upgrade a project between versions of the Output framework. Fetches the matching migration guide from docs.output.ai and applies it.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --to 0.2.0", "<%= config.bin %> <%= command.id %> --from 0.1.12 --to 0.2.0", "<%= config.bin %> <%= command.id %> --to 0.2.0 --notes \"skip the http changes, we don't use that package\"" ], "flags": { "from": { "description": "Version to migrate from. Defaults to the framework version in your package.json.", "name": "from", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "to": { "description": "Version to migrate to. Defaults to the latest published version.", "name": "to", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "notes": { "char": "n", "description": "Extra guidance passed through to the migration agent.", "name": "notes", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "migrate", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "migrate.js" ] }, "update": { "aliases": [], "args": {}, "description": "Update Output CLI and agent configuration", "examples": [ "<%= config.bin %> update", "<%= config.bin %> update --cli", "<%= config.bin %> update --agents" ], "flags": { "cli": { "description": "Update CLI packages only", "name": "cli", "allowNo": false, "type": "boolean" }, "agents": { "description": "Update Claude Code agent configuration", "name": "agents", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "update", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "update.js" ] }, "credentials:edit": { "aliases": [], "args": {}, "description": "Edit encrypted credentials in your $EDITOR", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --environment production", "<%= config.bin %> <%= command.id %> --workflow my_workflow" ], "flags": { "environment": { "char": "e", "description": "Target environment (e.g. production, development)", "name": "environment", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "workflow": { "char": "w", "description": "Target a specific workflow directory", "name": "workflow", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Edit on an empty file and re-encrypt with the current key when it cannot decrypt the existing file (discards existing values)", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "credentials:edit", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "credentials", "edit.js" ] }, "credentials:get": { "aliases": [], "args": { "path": { "description": "Dot-notation path to the credential (e.g. anthropic.api_key)", "name": "path", "required": true } }, "description": "Get a specific credential value by dot-notation path", "examples": [ "<%= config.bin %> <%= command.id %> anthropic.api_key", "<%= config.bin %> <%= command.id %> aws.region --environment production", "<%= config.bin %> <%= command.id %> stripe.key --workflow my_workflow" ], "flags": { "environment": { "char": "e", "description": "Target environment (e.g. production, development)", "name": "environment", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "workflow": { "char": "w", "description": "Target a specific workflow directory", "name": "workflow", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "credentials:get", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "credentials", "get.js" ] }, "credentials:init": { "aliases": [], "args": {}, "description": "Initialize encrypted credentials file and master key", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --environment production", "<%= config.bin %> <%= command.id %> --workflow my_workflow" ], "flags": { "environment": { "char": "e", "description": "Target environment (e.g. production, development)", "name": "environment", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "workflow": { "char": "w", "description": "Target a specific workflow directory", "name": "workflow", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrite existing credentials", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "credentials:init", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "credentials", "init.js" ] }, "credentials:set": { "aliases": [], "args": { "path": { "description": "Dot-notation path to the credential (e.g. anthropic.api_key)", "name": "path", "required": true }, "value": { "description": "Value to set", "name": "value", "required": true } }, "description": "Set a credential value by dot-notation path", "examples": [ "<%= config.bin %> <%= command.id %> anthropic.api_key sk-ant-...", "<%= config.bin %> <%= command.id %> openai.api_key sk-... --environment production", "<%= config.bin %> <%= command.id %> stripe.key sk_live_... --workflow my_workflow" ], "flags": { "environment": { "char": "e", "description": "Target environment (e.g. production, development)", "name": "environment", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "workflow": { "char": "w", "description": "Target a specific workflow directory", "name": "workflow", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip confirmation prompts when overwriting a value of a different shape", "name": "yes", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Re-encrypt with the current key even if it cannot decrypt the existing file (discards existing values)", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "credentials:set", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "credentials", "set.js" ] }, "credentials:show": { "aliases": [], "args": {}, "description": "Show decrypted credentials (for debugging)", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --environment production", "<%= config.bin %> <%= command.id %> --workflow my_workflow" ], "flags": { "environment": { "char": "e", "description": "Target environment (e.g. production, development)", "name": "environment", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "workflow": { "char": "w", "description": "Target a specific workflow directory", "name": "workflow", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "credentials:show", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "credentials", "show.js" ] }, "dev:down": { "aliases": [], "args": {}, "description": "Stop Output development services started by `output dev`\n\nUseful after `output dev -d`, or when an attached `output dev` session\nleft the services running on quit.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --compose-file ./custom-docker-compose.yml" ], "flags": { "compose-file": { "char": "f", "description": "Path to a custom docker-compose file", "name": "compose-file", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "dev:down", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "dev", "down.js" ] }, "dev:eject": { "aliases": [], "args": {}, "description": "Eject the Docker Compose configuration to your project root for customization", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --output ./custom-compose.yml" ], "flags": { "output": { "char": "o", "description": "Output path for the docker-compose file", "name": "output", "required": false, "default": "docker-compose.yml", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrite existing file without prompting", "name": "force", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "dev:eject", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "dev", "eject.js" ] }, "dev": { "aliases": [], "args": {}, "description": "Start Output development services (auto-restarts worker on file changes)\n\nIf services are already running (e.g. after `output dev -d`), this attaches\nto monitor them rather than treating our own containers as a port collision.\nQuitting an attached session leaves the services running — stop them with\n`output dev down`.\n\nTo run a second dev stack concurrently, give it its own compose project and\nhost ports in .env — without DOCKER_SERVICE_NAME both checkouts share one\nstack, and the second will attach to the first instead of starting:\n\n DOCKER_SERVICE_NAME=output-sdk-two\n OUTPUT_API_HOST_PORT=3002\n OUTPUT_TEMPORAL_UI_HOST_PORT=8081\n OUTPUT_TEMPORAL_HOST_PORT=7234", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --detached", "<%= config.bin %> <%= command.id %> --compose-file ./custom-docker-compose.yml", "<%= config.bin %> <%= command.id %> --image-pull-policy missing" ], "flags": { "compose-file": { "char": "f", "description": "Path to a custom docker-compose file", "name": "compose-file", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "image-pull-policy": { "description": "Image pull policy for docker compose (always, missing, never)", "name": "image-pull-policy", "default": "always", "hasDynamicHelp": false, "multiple": false, "options": [ "always", "missing", "never" ], "type": "option" }, "detached": { "char": "d", "description": "Start services in detached (background) mode and exit immediately", "name": "detached", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "dev", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "dev", "index.js" ] }, "workflow:cost": { "aliases": [], "args": { "workflowId": { "description": "Workflow ID to calculate cost for", "name": "workflowId", "required": true }, "tracePath": { "description": "Path to a trace JSON file (optional, fetches latest trace if omitted)", "name": "tracePath", "required": false } }, "description": "Calculate the cost of a workflow execution", "examples": [ "<%= config.bin %> <%= command.id %> my_workflow_id", "<%= config.bin %> <%= command.id %> my_workflow_id --verbose", "<%= config.bin %> <%= command.id %> my_workflow_id path/to/trace.json", "<%= config.bin %> <%= command.id %> my_workflow_id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Show detailed per-call breakdown", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:cost", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "cost.js" ] }, "workflow:debug": { "aliases": [], "args": { "workflowId": { "description": "The workflow ID to debug", "name": "workflowId", "required": true } }, "description": "Get and display workflow execution trace for debugging", "examples": [ "<%= config.bin %> <%= command.id %> wf-12345", "<%= config.bin %> <%= command.id %> wf-12345 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:debug", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "debug.js" ] }, "workflow:generate": { "aliases": [], "args": { "name": { "description": "Name of the workflow to generate", "name": "name", "required": true } }, "description": "Generate a new Output workflow from a skeleton or plan file", "examples": [ "<%= config.bin %> <%= command.id %> my-workflow --skeleton", "<%= config.bin %> <%= command.id %> my-workflow --skeleton --description \"Process and transform data\"", "<%= config.bin %> <%= command.id %> my-workflow --plan-file .outputai/plans/2025_10_09_my_workflow/PLAN.md", "<%= config.bin %> <%= command.id %> my-workflow --skeleton --output-dir ./custom/path" ], "flags": { "skeleton": { "char": "s", "description": "Generate minimal skeleton workflow without example steps", "name": "skeleton", "allowNo": false, "type": "boolean" }, "description": { "char": "d", "description": "Description of the workflow", "name": "description", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output-dir": { "char": "o", "description": "Output directory for the workflow", "name": "output-dir", "default": "src/workflows", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrite existing directory", "name": "force", "allowNo": false, "type": "boolean" }, "plan-file": { "char": "p", "description": "Path to plan file for AI-assisted workflow implementation", "name": "plan-file", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:generate", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "generate.js" ] }, "workflow:history": { "aliases": [], "args": { "workflowId": { "description": "The workflow ID to show history for", "name": "workflowId", "required": true } }, "description": "Show a workflow run's step timeline as a waterfall (durations and start times)", "examples": [ "<%= config.bin %> <%= command.id %> wf-12345", "<%= config.bin %> <%= command.id %> wf-12345 --run-id 2fe0b36b-...", "<%= config.bin %> <%= command.id %> wf-12345 --format json", "<%= config.bin %> <%= command.id %> wf-12345 --raw --include-payloads" ], "flags": { "run-id": { "char": "r", "description": "Show a specific run (defaults to the latest run)", "name": "run-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "format": { "char": "f", "description": "Output format", "name": "format", "default": "text", "hasDynamicHelp": false, "multiple": false, "options": [ "text", "json" ], "type": "option" }, "raw": { "description": "Print the history endpoint's raw response (workflow + events)", "name": "raw", "allowNo": false, "type": "boolean" }, "include-payloads": { "description": "Include decoded step input/output payloads", "name": "include-payloads", "allowNo": false, "type": "boolean" }, "width": { "description": "Override the detected terminal width", "name": "width", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "color": { "description": "Colorize the waterfall (use --no-color to disable)", "name": "color", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:history", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "history.js" ] }, "workflow:input": { "aliases": [], "args": { "workflowId": { "description": "The workflow ID to get the input for", "name": "workflowId", "required": true } }, "description": "Get the original input a workflow run was started with", "examples": [ "<%= config.bin %> <%= command.id %> wf-12345", "<%= config.bin %> <%= command.id %> wf-12345 --run-id 11111111-2222-4333-8444-555555555555", "<%= config.bin %> <%= command.id %> wf-12345 -o w_input.json", "<%= config.bin %> <%= command.id %> wf-12345 --output-file w_input.json --force" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "run-id": { "description": "Specific run id to target (defaults to the latest run)", "name": "run-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output-file": { "char": "o", "description": "Write the input JSON to this file instead of stdout", "name": "output-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrite the output file if it already exists", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:input", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "input.js" ] }, "workflow:list": { "aliases": [], "args": {}, "description": "List available workflows from the catalog", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --format table", "<%= config.bin %> <%= command.id %> --json", "<%= config.bin %> <%= command.id %> --detailed", "<%= config.bin %> <%= command.id %> --filter simple", "<%= config.bin %> <%= command.id %> --catalog my-catalog" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "catalog": { "aliases": [ "task-queue" ], "char": "c", "charAliases": [ "q" ], "deprecateAliases": true, "description": "Catalog to list workflows from (defaults to OUTPUT_CATALOG_ID)", "env": "OUTPUT_CATALOG_ID", "name": "catalog", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "format": { "char": "f", "description": "Output format (use --json for JSON output)", "name": "format", "default": "list", "hasDynamicHelp": false, "multiple": false, "options": [ "list", "table" ], "type": "option" }, "detailed": { "char": "d", "description": "Show detailed parameter information", "name": "detailed", "allowNo": false, "type": "boolean" }, "filter": { "description": "Filter workflows by name", "name": "filter", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:list", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "list.js" ] }, "workflow:monitor": { "aliases": [], "args": { "workflowId": { "description": "The workflow ID to monitor", "name": "workflowId", "required": true } }, "description": "Attach to a workflow run and stream status updates until it ends", "examples": [ "<%= config.bin %> <%= command.id %> wf-12345", "<%= config.bin %> <%= command.id %> wf-12345 --run-id 2fe0b36b-...", "<%= config.bin %> <%= command.id %> wf-12345 --format json" ], "flags": { "run-id": { "char": "r", "description": "Monitor a specific run (defaults to the latest run; continue-as-new chains are followed regardless)", "name": "run-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "format": { "char": "f", "description": "Output format", "name": "format", "default": "text", "hasDynamicHelp": false, "multiple": false, "options": [ "text", "json" ], "type": "option" }, "include-payloads": { "description": "Include decoded step input/output payloads", "name": "include-payloads", "allowNo": false, "type": "boolean" }, "interval": { "description": "Poll interval in milliseconds. Once a resumed poll is long-polling server-side for new events, this also bounds how long that block may last (capped at the server's configured max), so an idle workflow's update cadence is roughly twice this value (the long-poll bound, then this sleep) rather than a much longer, separate server default.", "name": "interval", "default": 2500, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "color": { "description": "Colorize status output (use --no-color to disable)", "name": "color", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:monitor", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "monitor.js" ] }, "workflow:plan": { "aliases": [], "args": {}, "description": "Generate a workflow plan from a description", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --description \"A workflow to take a question and answer it\"", "<%= config.bin %> <%= command.id %> --force-agent-file-write" ], "flags": { "force-agent-file-write": { "description": "Force overwrite of agent template files", "name": "force-agent-file-write", "allowNo": false, "type": "boolean" }, "description": { "char": "d", "description": "Workflow description", "name": "description", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:plan", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "plan.js" ] }, "workflow:reset": { "aliases": [], "args": { "workflowId": { "description": "The workflow ID to reset", "name": "workflowId", "required": true } }, "description": "Reset a workflow to re-run from after a specific step", "examples": [ "<%= config.bin %> <%= command.id %> wf-12345 --step generateBlogPost", "<%= config.bin %> <%= command.id %> wf-12345 --step consolidateCompetitors --reason \"Retry with updated prompt\"" ], "flags": { "step": { "char": "s", "description": "The step name to reset after", "name": "step", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reason": { "char": "r", "description": "Reason for the reset", "name": "reason", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:reset", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "reset.js" ] }, "workflow:result": { "aliases": [], "args": { "workflowId": { "description": "The workflow ID to get result for", "name": "workflowId", "required": true } }, "description": "Get workflow execution result", "examples": [ "<%= config.bin %> <%= command.id %> wf-12345", "<%= config.bin %> <%= command.id %> wf-12345 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:result", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "result.js" ] }, "workflow:run": { "aliases": [], "args": { "workflowName": { "description": "Name of the workflow to execute", "name": "workflowName", "required": true }, "scenario": { "description": "Scenario name (resolved from the workflow's scenarios/ directory)", "name": "scenario", "required": false } }, "description": "Execute a workflow synchronously and wait for completion", "examples": [ "<%= config.bin %> <%= command.id %> simple basic_input", "<%= config.bin %> <%= command.id %> simple my_scenario --json", "<%= config.bin %> <%= command.id %> simple --input '{\"values\":[1,2,3]}'", "<%= config.bin %> <%= command.id %> simple --input input.json", "<%= config.bin %> <%= command.id %> simple --input '{\"key\":\"value\"}' --catalog my-catalog" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "input": { "char": "i", "description": "Workflow input as JSON string or file path (overrides scenario)", "name": "input", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "catalog": { "aliases": [ "task-queue" ], "char": "c", "charAliases": [ "q" ], "deprecateAliases": true, "description": "Catalog name for workflow execution (defaults to OUTPUT_CATALOG_ID)", "env": "OUTPUT_CATALOG_ID", "name": "catalog", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:run", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "run.js" ] }, "workflow:start": { "aliases": [], "args": { "workflowName": { "description": "Name of the workflow to start", "name": "workflowName", "required": true }, "scenario": { "description": "Scenario name (resolved from the workflow's scenarios/ directory)", "name": "scenario", "required": false } }, "description": "Start a workflow asynchronously without waiting for completion", "examples": [ "<%= config.bin %> <%= command.id %> simple basic_input", "<%= config.bin %> <%= command.id %> simple --input '{\"values\":[1,2,3]}'", "<%= config.bin %> <%= command.id %> simple --input input.json", "<%= config.bin %> <%= command.id %> simple --input input.json --monitor", "<%= config.bin %> <%= command.id %> simple --input '{\"key\":\"value\"}' --catalog my-catalog", "<%= config.bin %> <%= command.id %> simple --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "input": { "char": "i", "description": "Workflow input as JSON string or file path (overrides scenario)", "name": "input", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "catalog": { "aliases": [ "task-queue" ], "char": "c", "charAliases": [ "q" ], "deprecateAliases": true, "description": "Catalog name for workflow execution (defaults to OUTPUT_CATALOG_ID)", "env": "OUTPUT_CATALOG_ID", "name": "catalog", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "monitor": { "char": "m", "description": "After starting, attach and stream status updates until the workflow ends (Ctrl+C detaches; the workflow keeps running). Cannot be combined with --json", "name": "monitor", "allowNo": false, "type": "boolean" }, "include-payloads": { "dependsOn": [ "monitor" ], "description": "Include decoded step input/output payloads (requires --monitor)", "helpGroup": "MONITOR", "name": "include-payloads", "allowNo": false, "type": "boolean" }, "interval": { "dependsOn": [ "monitor" ], "description": "Poll interval in milliseconds. Once a resumed poll is long-polling server-side for new events, this also bounds how long that block may last (capped at the server's configured max), so an idle workflow's update cadence is roughly twice this value (the long-poll bound, then this sleep) rather than a much longer, separate server default. (requires --monitor) [default: 2500]", "helpGroup": "MONITOR", "name": "interval", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "color": { "dependsOn": [ "monitor" ], "description": "Colorize status output (use --no-color to disable) (requires --monitor)", "helpGroup": "MONITOR", "name": "color", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:start", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "start.js" ] }, "workflow:status": { "aliases": [], "args": { "workflowId": { "description": "The workflow ID to check status for", "name": "workflowId", "required": true } }, "description": "Get workflow execution status", "examples": [ "<%= config.bin %> <%= command.id %> wf-12345", "<%= config.bin %> <%= command.id %> wf-12345 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:status", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "status.js" ] }, "workflow:stop": { "aliases": [], "args": { "workflowId": { "description": "The workflow ID to stop", "name": "workflowId", "required": true } }, "description": "Stop a workflow execution", "examples": [ "<%= config.bin %> <%= command.id %> wf-12345" ], "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:stop", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "stop.js" ] }, "workflow:terminate": { "aliases": [], "args": { "workflowId": { "description": "The workflow ID to terminate", "name": "workflowId", "required": true } }, "description": "Terminate a workflow execution (force stop)", "examples": [ "<%= config.bin %> <%= command.id %> wf-12345", "<%= config.bin %> <%= command.id %> wf-12345 --reason \"Cleaning up old workflows\"" ], "flags": { "reason": { "char": "r", "description": "Reason for termination", "name": "reason", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:terminate", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "terminate.js" ] }, "workflow:test": { "aliases": [], "args": { "workflowName": { "description": "Name of the workflow to test", "name": "workflowName", "required": true } }, "description": "Run evaluations against a workflow using its datasets", "examples": [ "<%= config.bin %> <%= command.id %> simple", "<%= config.bin %> <%= command.id %> simple --cached", "<%= config.bin %> <%= command.id %> simple --save", "<%= config.bin %> <%= command.id %> simple --dataset basic_input,edge_case", "<%= config.bin %> <%= command.id %> simple --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "catalog": { "aliases": [ "task-queue" ], "char": "c", "charAliases": [ "q" ], "deprecateAliases": true, "description": "Catalog name for workflow execution (defaults to OUTPUT_CATALOG_ID)", "env": "OUTPUT_CATALOG_ID", "name": "catalog", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cached": { "description": "Use cached output from dataset files (skip workflow execution)", "exclusive": [ "save" ], "name": "cached", "allowNo": false, "type": "boolean" }, "save": { "description": "Run workflow and save output back to dataset files", "exclusive": [ "cached" ], "name": "save", "allowNo": false, "type": "boolean" }, "dataset": { "char": "d", "description": "Comma-separated list of dataset names to run", "name": "dataset", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:test", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "test.js" ] }, "workflow:dataset:generate": { "aliases": [], "args": { "workflowName": { "description": "Name of the workflow", "name": "workflowName", "required": true }, "scenario": { "description": "Scenario name (resolved from the workflow's scenarios/ directory)", "name": "scenario", "required": false } }, "description": "Generate a dataset for a workflow from a scenario, trace file, or recent runs", "examples": [ "<%= config.bin %> <%= command.id %> simple basic_input", "<%= config.bin %> <%= command.id %> simple --trace logs/runs/simple/trace.json --name edge_case", "<%= config.bin %> <%= command.id %> simple --download --limit 5" ], "flags": { "catalog": { "aliases": [ "task-queue" ], "char": "c", "charAliases": [ "q" ], "deprecateAliases": true, "description": "Catalog name for workflow execution (defaults to OUTPUT_CATALOG_ID)", "env": "OUTPUT_CATALOG_ID", "name": "catalog", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "char": "t", "description": "Path to a local trace file to extract dataset from", "exclusive": [ "download" ], "name": "trace", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "description": "Dataset name (defaults to scenario name or trace filename)", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "download": { "char": "d", "description": "Generate datasets from recent workflow runs fetched via the Output API", "exclusive": [ "trace" ], "name": "download", "allowNo": false, "type": "boolean" }, "limit": { "char": "l", "description": "Maximum number of recent runs to fetch", "name": "limit", "default": 5, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "input": { "char": "i", "description": "Workflow input as JSON string or file path (overrides scenario)", "name": "input", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:dataset:generate", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "dataset", "generate.js" ] }, "workflow:dataset:list": { "aliases": [], "args": { "workflowName": { "description": "Workflow name to list datasets for", "name": "workflowName", "required": true } }, "description": "List datasets for a workflow", "examples": [ "<%= config.bin %> <%= command.id %> simple", "<%= config.bin %> <%= command.id %> simple --json", "<%= config.bin %> <%= command.id %> simple --format table" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "format": { "char": "f", "description": "Output format (use --json for JSON output)", "name": "format", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "text" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:dataset:list", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "dataset", "list.js" ] }, "workflow:runs:list": { "aliases": [], "args": { "workflowName": { "description": "Filter by workflow type/name", "name": "workflowName", "required": false } }, "description": "List workflow runs with optional filtering by workflow type", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> simple", "<%= config.bin %> <%= command.id %> simple --limit 10", "<%= config.bin %> <%= command.id %> --catalog my-catalog", "<%= config.bin %> <%= command.id %> --json", "<%= config.bin %> <%= command.id %> --format table" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "catalog": { "char": "c", "description": "Filter runs by catalog (defaults to OUTPUT_CATALOG_ID)", "env": "OUTPUT_CATALOG_ID", "name": "catalog", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "char": "l", "description": "Maximum number of runs to return", "name": "limit", "default": 100, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "format": { "char": "f", "description": "Output format (use --json for JSON output)", "name": "format", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "text" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "workflow:runs:list", "pluginAlias": "@outputai/cli", "pluginName": "@outputai/cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "workflow", "runs", "list.js" ] } }, "version": "0.13.0" }