{ "commands": { "runtime": { "aliases": [], "args": {}, "description": "Start a stdio NDJSON runtime for in-process Agentia command invokes", "flags": { "idle-ms": { "description": "Exit after this many idle milliseconds with no in-flight requests", "name": "idle-ms", "default": 600000, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "runtime", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "runtime.js" ] }, "setup": { "aliases": [], "args": {}, "description": "Prepare this machine and the current project for Agentia. Guides CICD, AI, and CRT authentication, Cursor and Claude Code MCP, local quality gates, Agent Skills, agent rules, and removal of a legacy AGENTS.md section. Use --skip-auth to skip authentication and continue with Cursor and Claude Code MCP and project setup. Git is optional: .gitignore is updated only inside a repository, and generated files are not committed.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --skip-auth" ], "flags": { "skip-auth": { "description": "Skip CICD, AI, and CRT authentication; continue with Cursor and Claude Code MCP and project setup", "name": "skip-auth", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "setup", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "setup.js" ] }, "update": { "aliases": [], "args": {}, "description": "Update the globally installed Agentia CLI to the newest release for the selected channel", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --check", "<%= config.bin %> <%= command.id %> --channel latest --check", "<%= config.bin %> <%= command.id %> --channel rc", "<%= config.bin %> <%= command.id %> --check --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "channel": { "description": "npm dist-tag to check or install (rc or latest). Also saves that channel as the preferred update channel when an install runs. Omit to auto-select from the stored preference or install type: prerelease installs and an rc preference compare rc and latest; stable installs with a latest preference (or no preference) use latest only.", "name": "channel", "hasDynamicHelp": false, "multiple": false, "options": [ "rc", "latest" ], "type": "option" }, "check": { "description": "Check for an update without installing it or changing the preferred channel", "name": "check", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "update.js" ] }, "auth:get": { "aliases": [], "args": {}, "description": "Show stored authentication credentials and their configured endpoints and scopes", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --ai", "<%= config.bin %> <%= command.id %> --adv", "<%= config.bin %> <%= command.id %> --cicd", "<%= config.bin %> <%= command.id %> --crt", "<%= config.bin %> <%= command.id %> --cicd --crt", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "adv": { "description": "Show PAT for Pipelines Advanced authentication", "name": "adv", "allowNo": false, "type": "boolean" }, "ai": { "description": "Show PAK for Copado AI authentication", "name": "ai", "allowNo": false, "type": "boolean" }, "cicd": { "description": "Show Copado API key for CICD authentication", "name": "cicd", "allowNo": false, "type": "boolean" }, "crt": { "description": "Show PAK for CRT authentication", "name": "crt", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "auth:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "auth", "get.js" ] }, "auth:set": { "aliases": [], "args": {}, "description": "Store authentication credentials securely in the system keychain", "examples": [ "<%= config.bin %> <%= command.id %> --ai --ai-domain robotic.copado.com --ai-org 42888", "<%= config.bin %> <%= command.id %> --ai --ai-org 42888", "<%= config.bin %> <%= command.id %> --ai --ai-domain robotic.copado.com --ai-org 42888 --ai-workspace 42d0b908-37b7-4565-9ec9-86eda40c9782", "<%= config.bin %> <%= command.id %> --ai --ai-gateway-url http://localhost:8080/organizations/42888", "<%= config.bin %> <%= command.id %> --ai-workspace 42d0b908-37b7-4565-9ec9-86eda40c9782", "<%= config.bin %> <%= command.id %> --adv ", "<%= config.bin %> <%= command.id %> --adv --adv-base-url https://uat.pipeline.copado.com", "<%= config.bin %> <%= command.id %> --cicd --region na", "<%= config.bin %> <%= command.id %> --cicd --custom-url https://dev.api.copado.com", "<%= config.bin %> <%= command.id %> --cicd ", "<%= config.bin %> <%= command.id %> --crt --crt-org ", "<%= config.bin %> <%= command.id %> --crt --crt-domain robotic.copado.com --crt-org ", "<%= config.bin %> <%= command.id %> --cicd --region na --crt ", "<%= config.bin %> <%= command.id %> --cicd --region na --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "adv": { "description": "Personal Access Token for Copado Pipelines Advanced authentication", "name": "adv", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "adv-base-url": { "description": "Optional Pipelines Advanced base URL; omit to auto-discover from the PAT", "name": "adv-base-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ai": { "description": "PAK for Copado AI authentication", "name": "ai", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ai-domain": { "description": "Optional Copado AI domain hostname; omit to auto-discover from the PAK and organization ID", "name": "ai-domain", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ai-gateway-url": { "description": "Full Copado AI gateway base URL used instead of deriving from domain and organization; HTTP is allowed for local testing", "name": "ai-gateway-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ai-org": { "description": "Copado AI organization ID used with --ai-domain", "name": "ai-org", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ai-workspace": { "description": "Copado AI workspace UUID to validate and store as the default", "name": "ai-workspace", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cicd": { "description": "Copado API key for CICD authentication", "name": "cicd", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "crt": { "description": "PAK for CRT authentication (requires --crt-org)", "name": "crt", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "crt-domain": { "description": "CRT domain hostname for robotic testing commands", "name": "crt-domain", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "crt-org": { "description": "CRT organization ID for robotic testing commands", "name": "crt-org", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "custom-url": { "description": "CICD gateway base URL used instead of regional mapping", "name": "custom-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "local": { "description": "Store authentication for the current project and user.", "name": "local", "allowNo": false, "type": "boolean" }, "region": { "description": "CICD region used to resolve the gateway endpoint", "name": "region", "hasDynamicHelp": false, "multiple": false, "options": [ "na", "emea", "emea2", "apac", "apac2" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "auth:set", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "auth", "set.js" ] }, "auth:unset": { "aliases": [], "args": {}, "description": "Remove stored authentication credentials from the system keychain", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --ai", "<%= config.bin %> <%= command.id %> --adv", "<%= config.bin %> <%= command.id %> --cicd", "<%= config.bin %> <%= command.id %> --crt", "<%= config.bin %> <%= command.id %> --cicd --crt --yes", "<%= config.bin %> <%= command.id %> --json --yes" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "adv": { "description": "Remove Pipelines Advanced PAT and endpoint configuration", "name": "adv", "allowNo": false, "type": "boolean" }, "ai": { "description": "Remove Copado AI PAK, domain, organization, workspace, and gateway URL configuration", "name": "ai", "allowNo": false, "type": "boolean" }, "cicd": { "description": "Remove Copado API key and CICD endpoint configuration", "name": "cicd", "allowNo": false, "type": "boolean" }, "crt": { "description": "Remove CRT PAK, domain, and organization configuration", "name": "crt", "allowNo": false, "type": "boolean" }, "global": { "description": "Remove global authentication (the default scope).", "name": "global", "allowNo": false, "type": "boolean" }, "local": { "description": "Remove authentication for the current project and user.", "name": "local", "allowNo": false, "type": "boolean" }, "yes": { "char": "y", "description": "Confirm removal without prompting (required for --json)", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "auth:unset", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "auth", "unset.js" ] }, "cicd:health-check": { "aliases": [], "args": {}, "description": "Run organization-scoped governance health checks", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --json", "<%= config.bin %> <%= command.id %> --git-sizer", "<%= config.bin %> <%= command.id %> --git-sizer --path /path/to/clone" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "git-sizer": { "description": "Also analyze a local Git clone with git-sizer", "name": "git-sizer", "allowNo": false, "type": "boolean" }, "path": { "dependsOn": [ "git-sizer" ], "description": "Local Git clone for --git-sizer. Defaults to the current directory.", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:health-check", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "health-check.js" ] }, "mcp:start": { "aliases": [], "args": {}, "description": "Start the local Agentia MCP server over stdio", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> # long-running stdio MCP server for Cursor and other clients" ], "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "mcp:start", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "mcp", "start.js" ] }, "plugins:install": { "aliases": [ "plugins:add" ], "args": { "plugin": { "description": "npm package name (optionally with @tag) or git URL.", "name": "plugin", "required": true } }, "description": "Install plugins with npm after checking them against the Agentia plugin catalog.\n\nOfficial and Verified plugins install without a prompt. Community, unlisted, and git URL plugins ask first. Use --allow-unverified when there is no terminal or with --json.\n\nA revoked version, or an npm tarball that differs from the hash in the catalog, is always refused. If the catalog cannot be reached, plugins cannot be checked, so the command warns and asks first, even for Official and Verified plugins. Use --allow-unverified to install without the check.", "examples": [ "<%= config.bin %> <%= command.id %> @acme/agentia-plugin-x", "<%= config.bin %> <%= command.id %> @acme/agentia-plugin-x@1.2.0 --allow-unverified --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "allow-unverified": { "description": "Install plugins that are not Official or Verified without asking. Never overrides a revoked or mismatched version.", "name": "allow-unverified", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force npm to fetch remote resources even if a local copy exists.", "name": "force", "allowNo": false, "type": "boolean" }, "silent": { "char": "s", "description": "Silence npm output.", "name": "silent", "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "description": "Show verbose npm output.", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "plugins:install", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": false, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "plugins", "install.js" ] }, "adv:auth:status": { "aliases": [], "args": {}, "description": "Check the configured Pipelines Advanced PAT", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:auth:status", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "auth", "status.js" ] }, "adv:component:add": { "aliases": [], "args": { "deployment-id": { "description": "Pipelines Advanced deployment ID.", "name": "deployment-id", "required": true } }, "description": "Add components to a Pipelines Advanced deployment selection", "examples": [ "<%= config.bin %> <%= command.id %> 1025 --component ApexClass/Foo --component ApexClass/Bar", "<%= config.bin %> <%= command.id %> 1025 --file components.txt", "<%= config.bin %> <%= command.id %> 1025 --json-file components.json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "component": { "description": "Component to add as Type/Name; repeat for multiple components.", "exclusive": [ "file", "json-file" ], "name": "component", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "description": "Text file with one Type/Name component per line.", "exclusive": [ "component", "json-file" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "json-file": { "description": "JSON file containing a bare component array (not a --json envelope); accepts list rows, {type, fullName}, or {nodeType: {name}, fullName}.", "exclusive": [ "component", "file" ], "name": "json-file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:component:add", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "component", "add.js" ] }, "adv:component:list": { "aliases": [], "args": {}, "description": "List source components for a Pipelines Advanced deployment", "examples": [ "<%= config.bin %> <%= command.id %> --flow 1025 --type ApexClass", "<%= config.bin %> <%= command.id %> --flow 1025 --type ApexClass,ApexTrigger --include-managed-package" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flow": { "description": "Pipelines Advanced deployment ID.", "name": "flow", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "include-managed-package": { "description": "Include managed package components.", "name": "include-managed-package", "allowNo": false, "type": "boolean" }, "type": { "description": "Comma-separated component type names.", "name": "type", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:component:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "component", "list.js" ] }, "adv:component:refresh": { "aliases": [], "args": {}, "description": "Refresh Pipelines Advanced component comparison cache", "examples": [ "<%= config.bin %> <%= command.id %> --flow 1025 --type ApexClass", "<%= config.bin %> <%= command.id %> --flow 1025 --type ApexClass,Flow --full" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flow": { "description": "Pipelines Advanced deployment ID.", "name": "flow", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "full": { "description": "Delete cached comparison data before refreshing.", "name": "full", "allowNo": false, "type": "boolean" }, "type": { "description": "Comma-separated component type names.", "name": "type", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:component:refresh", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "component", "refresh.js" ] }, "adv:component:remove": { "aliases": [], "args": { "deployment-id": { "description": "Pipelines Advanced deployment ID.", "name": "deployment-id", "required": true } }, "description": "Remove components from a Pipelines Advanced deployment selection", "examples": [ "<%= config.bin %> <%= command.id %> 1025 --component ApexClass/Foo", "<%= config.bin %> <%= command.id %> 1025 --json-file components.json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "component": { "description": "Component to remove as Type/Name; repeat for multiple components.", "exclusive": [ "json-file" ], "name": "component", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "json-file": { "description": "JSON file containing a bare component array (not a --json envelope); text-file input is not supported.", "exclusive": [ "component" ], "name": "json-file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:component:remove", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "component", "remove.js" ] }, "adv:component:selected": { "aliases": [], "args": { "deployment-id": { "description": "Pipelines Advanced deployment ID.", "name": "deployment-id", "required": true } }, "description": "List components currently selected for a Pipelines Advanced deployment", "examples": [ "<%= config.bin %> <%= command.id %> 1025", "<%= config.bin %> <%= command.id %> 1025 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:component:selected", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "component", "selected.js" ] }, "adv:component:types": { "aliases": [], "args": {}, "description": "List Pipelines Advanced component type views; a component type can appear in multiple views", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:component:types", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "component", "types.js" ] }, "adv:deployment:cancel": { "aliases": [], "args": { "id": { "description": "Pipelines Advanced deployment ID.", "name": "id", "required": true } }, "description": "Request cancellation of the current Pipelines Advanced run", "examples": [ "<%= config.bin %> <%= command.id %> 1025", "<%= config.bin %> <%= command.id %> 1025 --yes --wait" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "interval": { "description": "Seconds between job status polls when waiting (default: 3).", "name": "interval", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "Maximum seconds to wait; the remote run continues after timeout (default: 3600).", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "description": "Wait for the accepted run to finish.", "name": "wait", "allowNo": false, "type": "boolean" }, "yes": { "char": "y", "description": "Confirm the action without prompting (required for --json or non-interactive runs).", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:deployment:cancel", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "deployment", "cancel.js" ] }, "adv:deployment:create": { "aliases": [], "args": {}, "description": "Create a Pipelines Advanced deployment between two organizations", "examples": [ "<%= config.bin %> <%= command.id %> --name release-1 --source-org 910001 --target-org 910002", "<%= config.bin %> <%= command.id %> --name release-1 --source-org 910001 --target-org 910002 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "name": { "description": "Deployment name.", "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-org": { "description": "Source organization ID.", "name": "source-org", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "description": "Target organization ID.", "name": "target-org", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:deployment:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "deployment", "create.js" ] }, "adv:deployment:deploy": { "aliases": [], "args": { "id": { "description": "Pipelines Advanced deployment ID.", "name": "id", "required": true } }, "description": "Start a Pipelines Advanced deploy run", "examples": [ "<%= config.bin %> <%= command.id %> 1025", "<%= config.bin %> <%= command.id %> 1025 --yes --wait --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "interval": { "description": "Seconds between job status polls when waiting (default: 3).", "name": "interval", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "Maximum seconds to wait; the remote run continues after timeout (default: 3600).", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "description": "Wait for the accepted run to finish.", "name": "wait", "allowNo": false, "type": "boolean" }, "yes": { "char": "y", "description": "Confirm the action without prompting (required for --json or non-interactive runs).", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:deployment:deploy", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "deployment", "deploy.js" ] }, "adv:deployment:get": { "aliases": [], "args": { "id": { "description": "Pipelines Advanced deployment ID.", "name": "id", "required": true } }, "description": "Show one Pipelines Advanced deployment", "examples": [ "<%= config.bin %> <%= command.id %> 1025", "<%= config.bin %> <%= command.id %> 1025 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:deployment:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "deployment", "get.js" ] }, "adv:deployment:list": { "aliases": [], "args": {}, "description": "List up to 500 Pipelines Advanced deployments visible to the PAT user; the API does not support filters", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --include-archived", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "include-archived": { "description": "Include archived deployments.", "name": "include-archived", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:deployment:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "deployment", "list.js" ] }, "adv:deployment:options": { "aliases": [], "args": { "id": { "description": "Pipelines Advanced deployment ID.", "name": "id", "required": true } }, "description": "Update Pipelines Advanced deployment options", "examples": [ "<%= config.bin %> <%= command.id %> 1025 --set deployOptionsIgnoreWarnings=false", "<%= config.bin %> <%= command.id %> 1025 --file options.json", "<%= config.bin %> <%= command.id %> 1025 --set deployOptionsTestLevel=RUN_LOCAL_TESTS --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "file": { "description": "JSON file with deployment options to merge over the current options.", "exclusive": [ "set" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "set": { "description": "Deployment option as name=value; true, false, null, and any finite JavaScript Number value (including hex and exponent notation) are converted.", "exclusive": [ "file" ], "name": "set", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:deployment:options", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "deployment", "options.js" ] }, "adv:deployment:quick-deploy": { "aliases": [], "args": { "id": { "description": "Pipelines Advanced deployment ID.", "name": "id", "required": true } }, "description": "Start a Pipelines Advanced quick deploy run", "examples": [ "<%= config.bin %> <%= command.id %> 1025", "<%= config.bin %> <%= command.id %> 1025 --backup --yes --wait" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "interval": { "description": "Seconds between job status polls when waiting (default: 3).", "name": "interval", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "Maximum seconds to wait; the remote run continues after timeout (default: 3600).", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "description": "Wait for the accepted run to finish.", "name": "wait", "allowNo": false, "type": "boolean" }, "yes": { "char": "y", "description": "Confirm the action without prompting (required for --json or non-interactive runs).", "name": "yes", "allowNo": false, "type": "boolean" }, "backup": { "description": "Run backupThenDeploy instead of a quick deploy; the returned action reflects backupThenDeploy.", "name": "backup", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:deployment:quick-deploy", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "deployment", "quick-deploy.js" ] }, "adv:deployment:validate": { "aliases": [], "args": { "id": { "description": "Pipelines Advanced deployment ID.", "name": "id", "required": true } }, "description": "Start a check-only Pipelines Advanced validation run", "examples": [ "<%= config.bin %> <%= command.id %> 1025", "<%= config.bin %> <%= command.id %> 1025 --wait" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "interval": { "description": "Seconds between job status polls when waiting (default: 3).", "name": "interval", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "Maximum seconds to wait; the remote run continues after timeout (default: 3600).", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "description": "Wait for the accepted run to finish.", "name": "wait", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:deployment:validate", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "deployment", "validate.js" ] }, "adv:job:get": { "aliases": [], "args": { "deployment-id": { "description": "Pipelines Advanced deployment ID.", "name": "deployment-id", "required": true } }, "description": "Show the latest Pipelines Advanced run for a deployment", "examples": [ "<%= config.bin %> <%= command.id %> 1025", "<%= config.bin %> <%= command.id %> 1025 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:job:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "job", "get.js" ] }, "adv:job:list": { "aliases": [], "args": { "deployment-id": { "description": "Pipelines Advanced deployment ID.", "name": "deployment-id", "required": true } }, "description": "List deploy and quick-deploy history for a Pipelines Advanced deployment; validation runs are not included", "examples": [ "<%= config.bin %> <%= command.id %> 1025", "<%= config.bin %> <%= command.id %> 1025 --page 1 --page-size 25" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "page": { "description": "Page number starting at 0 (default: 0).", "name": "page", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Rows per page (default: 50; server maximum: 100).", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:job:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "job", "list.js" ] }, "adv:job:wait": { "aliases": [], "args": { "deployment-id": { "description": "Pipelines Advanced deployment ID.", "name": "deployment-id", "required": true } }, "description": "Wait for the latest Pipelines Advanced run to finish", "examples": [ "<%= config.bin %> <%= command.id %> 1025", "<%= config.bin %> <%= command.id %> 1025 --interval 5 --timeout 1800" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "interval": { "description": "Seconds between job status polls (default: 3).", "name": "interval", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "Maximum seconds to wait; the remote run continues after timeout (default: 3600).", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:job:wait", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "job", "wait.js" ] }, "adv:organization:get": { "aliases": [], "args": { "id": { "description": "Pipelines Advanced organization ID.", "name": "id", "required": true } }, "description": "Show one Pipelines Advanced organization", "examples": [ "<%= config.bin %> <%= command.id %> 910001", "<%= config.bin %> <%= command.id %> 910001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:organization:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "organization", "get.js" ] }, "adv:organization:list": { "aliases": [], "args": {}, "description": "List Pipelines Advanced organizations visible to the PAT user", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:organization:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "organization", "list.js" ] }, "adv:organization:validate": { "aliases": [], "args": { "id": { "description": "Pipelines Advanced organization ID.", "name": "id", "required": true } }, "description": "Validate that Pipelines Advanced can connect to an organization", "examples": [ "<%= config.bin %> <%= command.id %> 910001", "<%= config.bin %> <%= command.id %> 910001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "adv:organization:validate", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "adv", "organization", "validate.js" ] }, "ai:agent:ask": { "aliases": [], "args": {}, "description": "Send a single-turn prompt to a Copado AI agent", "examples": [ "<%= config.bin %> <%= command.id %> -p \"Why did the last promotion fail?\"", "<%= config.bin %> <%= command.id %> --agent plan -p \"Break this requirement into implementation steps\"", "<%= config.bin %> <%= command.id %> --agent build -p \"Generate an Apex handler outline\" --sf-org test14 --user-story US-1042", "<%= config.bin %> <%= command.id %> --agent test -p \"Create regression checks\" --component LeadScoringHandler --json", "<%= config.bin %> <%= command.id %> --agent operate -p \"Diagnose this deployment error\" --timeout 240", "<%= config.bin %> <%= command.id %> --agent knowledge -p \"Summarize our deployment guidance\"" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "agent": { "description": "AI agent to target (defaults to orchestrate, which routes to the right specialist)", "name": "agent", "default": "orchestrate", "hasDynamicHelp": false, "multiple": false, "options": [ "orchestrate", "plan", "build", "test", "release", "operate", "knowledge" ], "type": "option" }, "component": { "description": "Metadata component name to include in prompt context", "name": "component", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "credential-id": { "description": "Copado credential ID that overrides the project default for workspace synchronization", "name": "credential-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dialogue": { "description": "Copado AI dialogue UUID to reuse", "name": "dialogue", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "AI gateway timeout in seconds for workspace, dialogue, and message calls", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force-credential-sync": { "description": "Replace the cached Copado CICD workspace integration", "name": "force-credential-sync", "allowNo": false, "type": "boolean" }, "no-credential-sync": { "description": "Skip Copado CICD workspace credential synchronization", "name": "no-credential-sync", "allowNo": false, "type": "boolean" }, "no-stream": { "description": "Buffer the full response before printing in human mode", "name": "no-stream", "allowNo": false, "type": "boolean" }, "prompt": { "char": "p", "description": "Natural language instruction for the agent", "name": "prompt", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sf-org": { "description": "Salesforce org or environment name to include in prompt context", "name": "sf-org", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "user-story": { "description": "User story identifier to include in prompt context", "name": "user-story", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "work-item": { "description": "Work item identifier to include in prompt context", "name": "work-item", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "workspace": { "description": "Copado AI workspace UUID to reuse for a new dialogue", "name": "workspace", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai:agent:ask", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "ai", "agent", "ask.js" ] }, "ai:agent:chat": { "aliases": [], "args": {}, "description": "Start an interactive Copado AI agent chat session", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --agent plan --sf-org test14", "<%= config.bin %> <%= command.id %> --agent build --user-story US-1042 --timeout 240", "<%= config.bin %> <%= command.id %> --agent knowledge", "<%= config.bin %> <%= command.id %> --workspace 42d0b908-37b7-4565-9ec9-86eda40c9782" ], "flags": { "agent": { "description": "AI agent to target (defaults to orchestrate, which routes to the right specialist)", "name": "agent", "default": "orchestrate", "hasDynamicHelp": false, "multiple": false, "options": [ "orchestrate", "plan", "build", "test", "release", "operate", "knowledge" ], "type": "option" }, "component": { "description": "Metadata component name to include in prompt context", "name": "component", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "credential-id": { "description": "Copado credential ID that overrides the project default for workspace synchronization", "name": "credential-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dialogue": { "description": "Copado AI dialogue UUID to reuse", "name": "dialogue", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "AI gateway timeout in seconds for workspace, dialogue, and message calls", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force-credential-sync": { "description": "Replace the cached Copado CICD workspace integration", "name": "force-credential-sync", "allowNo": false, "type": "boolean" }, "no-credential-sync": { "description": "Skip Copado CICD workspace credential synchronization", "name": "no-credential-sync", "allowNo": false, "type": "boolean" }, "sf-org": { "description": "Salesforce org or environment name to include in prompt context", "name": "sf-org", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "user-story": { "description": "User story identifier to include in prompt context", "name": "user-story", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "work-item": { "description": "Work item identifier to include in prompt context", "name": "work-item", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "workspace": { "description": "Copado AI workspace UUID to reuse for a new dialogue", "name": "workspace", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai:agent:chat", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "ai", "agent", "chat.js" ] }, "ai:quota:get": { "aliases": [], "args": {}, "description": "Get Copado AI organization quota", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "timeout": { "description": "AI gateway timeout in seconds.", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai:quota:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "ai", "quota", "get.js" ] }, "ai:workspace:create": { "aliases": [], "args": {}, "description": "Create a Copado AI workspace", "examples": [ "<%= config.bin %> <%= command.id %> --name \"Agentia CLI\"", "<%= config.bin %> <%= command.id %> --name \"Agentia CLI\" --description \"CLI workspace\" --capability Reasoning --capability CustomKnowledge" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "timeout": { "description": "AI gateway timeout in seconds.", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "capability": { "description": "Workspace capability. Can be provided multiple times.", "name": "capability", "hasDynamicHelp": false, "multiple": true, "options": [ "AgentFramework", "Artifacts", "CRTKnowledge", "CustomKnowledge", "DeepResearch", "EssentialsKnowledge", "LongTermMemory", "Mermaid", "MetadataFormatKnowledge", "Mindmap", "OtherKnowledge", "Reasoning", "SourceFormatKnowledge", "STEM", "TabularData", "WebSearch" ], "type": "option" }, "description": { "description": "Workspace description.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Workspace name.", "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai:workspace:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "ai", "workspace", "create.js" ] }, "ai:workspace:get": { "aliases": [], "args": { "id": { "description": "Copado AI workspace UUID.", "name": "id", "required": true } }, "description": "Get a Copado AI workspace", "examples": [ "<%= config.bin %> <%= command.id %> 42d0b908-37b7-4565-9ec9-86eda40c9782", "<%= config.bin %> <%= command.id %> 42d0b908-37b7-4565-9ec9-86eda40c9782 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "timeout": { "description": "AI gateway timeout in seconds.", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai:workspace:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "ai", "workspace", "get.js" ] }, "ai:workspace:list": { "aliases": [], "args": {}, "description": "List Copado AI workspaces", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "timeout": { "description": "AI gateway timeout in seconds.", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai:workspace:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "ai", "workspace", "list.js" ] }, "ai:workspace:update": { "aliases": [], "args": { "id": { "description": "Copado AI workspace UUID.", "name": "id", "required": true } }, "description": "Update a Copado AI workspace", "examples": [ "<%= config.bin %> <%= command.id %> 42d0b908-37b7-4565-9ec9-86eda40c9782 --name \"Delivery Workspace\"", "<%= config.bin %> <%= command.id %> 42d0b908-37b7-4565-9ec9-86eda40c9782 --capability Reasoning --capability CustomKnowledge" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "timeout": { "description": "AI gateway timeout in seconds.", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "capability": { "description": "Workspace capability. Can be provided multiple times and replaces the existing set when provided.", "name": "capability", "hasDynamicHelp": false, "multiple": true, "options": [ "AgentFramework", "Artifacts", "CRTKnowledge", "CustomKnowledge", "DeepResearch", "EssentialsKnowledge", "LongTermMemory", "Mermaid", "MetadataFormatKnowledge", "Mindmap", "OtherKnowledge", "Reasoning", "SourceFormatKnowledge", "STEM", "TabularData", "WebSearch" ], "type": "option" }, "default-dataset-id": { "description": "Default dataset UUID for the workspace.", "name": "default-dataset-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "description": "Workspace description.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Workspace name.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai:workspace:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "ai", "workspace", "update.js" ] }, "cicd:cloud:commit": { "aliases": [], "args": { "id": { "description": "User story ID (defaults to the active work item from `work set`)", "name": "id", "required": false } }, "description": "Create a Copado cloud metadata commit for a user story.\nPreflights the story, submits POST /release/commit, and polls the job monitor by default.\nFor local Git work, use git add/commit then `cicd work publish`. Permission and full-metadata selections belong on `cicd work publish`.\n\nNOTE: Do not use this command along with local development (git operations, cicd work push/submit).", "examples": [ "<%= config.bin %> <%= command.id %> --message \"Commit AccountService\" --metadata-name AccountService --metadata-type ApexClass --metadata-category SFDX --action Add", "<%= config.bin %> <%= command.id %> a07XXXXXXXXXXXXXXX --message \"Update Aura files\" --metadata-name accountEditor --metadata-type AuraDefinitionBundle --metadata-category SFDX --action SelectiveCommit --selection accountEditor/accountEditor.cmp --selection accountEditor/accountEditorController.js", "<%= config.bin %> <%= command.id %> --file commit-request.json # {\"message\":\"Commit AccountService\",\"changes\":[{\"a\":\"Add\",\"c\":\"SFDX\",\"n\":\"AccountService\",\"t\":\"ApexClass\"}]}", "cat commit-request.json | <%= config.bin %> <%= command.id %> --stdin --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "action": { "description": "Metadata action for simple flag input. Defaults to Add.", "name": "action", "hasDynamicHelp": false, "multiple": false, "options": [ "Add", "Delete", "RetrieveOnly", "SelectiveCommit", "Full" ], "type": "option" }, "base-branch": { "description": "Optional base branch to include in the commit request.", "name": "base-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cloud": { "description": "Ignored. Cloud is implied by cicd cloud commit.", "hidden": true, "name": "cloud", "allowNo": false, "type": "boolean" }, "commit-id": { "description": "Existing local Git commit identifier to register when --no-execute-commit is used.", "name": "commit-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "execute-commit": { "description": "Execute the Copado commit job. Use --no-execute-commit only with --commit-id.", "name": "execute-commit", "allowNo": true, "type": "boolean" }, "file": { "char": "f", "description": "Path to a JSON commit request body.", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "message": { "char": "m", "description": "Commit message. Required unless provided by JSON input.", "name": "message", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-category": { "description": "Required metadata category for simple input. Maps to change field c. For Salesforce metadata, set SFDX so Copado stores c:SFDX. Without c:SFDX, SFDX deploy steps log \"Salesforce changes not found.\" and skip the deploy while the job can still report Successful.", "name": "metadata-category", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-message": { "description": "Optional per-change message for simple flag input.", "name": "metadata-message", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-name": { "description": "Metadata full name for simple flag input.", "name": "metadata-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-raw-json": { "description": "Optional raw metadata JSON value for simple flag input.", "name": "metadata-raw-json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-type": { "description": "Metadata type for simple flag input, for example ApexClass.", "name": "metadata-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "recreate-feature-branch": { "description": "Ask Copado to recreate the feature branch before committing.", "name": "recreate-feature-branch", "allowNo": false, "type": "boolean" }, "selection": { "description": "Selected file inside a bundle for SelectiveCommit. Can be provided multiple times.", "name": "selection", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "stdin": { "description": "Read a JSON commit request body from stdin.", "name": "stdin", "allowNo": false, "type": "boolean" }, "wait": { "description": "Poll the commit job to a terminal status when a jobExecution Id is returned.", "name": "wait", "allowNo": true, "type": "boolean" }, "wait-timeout": { "description": "Maximum seconds to wait for the commit job.", "name": "wait-timeout", "default": 300, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:cloud:commit", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "cloud", "commit.js" ] }, "cicd:cloud:promote": { "aliases": [], "args": { "id": { "description": "User Story ID (defaults to the active work item from `work set`)", "name": "id", "required": false } }, "description": "Promote the explicit or active User Story through its Copado Promotion. Selects promote-only unless --deploy is passed.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> a07XXXXXXXXXXXXXXX --promotion-id a0BXXXXXXXXXXXXXXX", "<%= config.bin %> <%= command.id %> --deploy --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cloud": { "description": "Ignored. Cloud is implied by cicd cloud promote.", "hidden": true, "name": "cloud", "allowNo": false, "type": "boolean" }, "deploy": { "description": "Use merge_and_deploy instead of promote-only merge.", "name": "deploy", "allowNo": false, "type": "boolean" }, "deployment-step-id": { "description": "Ordered deployment-step Salesforce ID. Can be provided multiple times with --deploy.", "name": "deployment-step-id", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "ignored-metadata-json": { "description": "JSON array to persist through ignored-metadata before starting the promotion.", "name": "ignored-metadata-json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "promotion-id": { "description": "Explicit 18-character Promotion ID when the User Story belongs to multiple promotions.", "name": "promotion-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "recreate-promotion-branch": { "description": "Recreate the promotion branch before execution. Requires confirmation or --yes.", "name": "recreate-promotion-branch", "allowNo": false, "type": "boolean" }, "wait": { "description": "Poll promotion and deployment executions to terminal status.", "name": "wait", "allowNo": true, "type": "boolean" }, "wait-timeout": { "description": "Maximum total seconds to wait for promotion and deployment executions.", "name": "wait-timeout", "default": 900, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Confirm promotion branch recreation without prompting.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:cloud:promote", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "cloud", "promote.js" ] }, "cicd:credential:create": { "aliases": [], "args": {}, "description": "Create a Copado environment credential", "examples": [ "<%= config.bin %> <%= command.id %> --environmentid --name \"CI User\"", "<%= config.bin %> <%= command.id %> --environmentid --name \"CI User\" --default", "<%= config.bin %> <%= command.id %> --environmentid --name \"CI User\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "default": { "description": "Mark this credential as the environment default", "name": "default", "allowNo": true, "type": "boolean" }, "environmentid": { "description": "Copado environment ID", "name": "environmentid", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Credential name", "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:credential:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "credential", "create.js" ] }, "cicd:credential:list": { "aliases": [], "args": {}, "description": "List Copado credentials across environments", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --name CI", "<%= config.bin %> <%= command.id %> --page-size 50", "<%= config.bin %> <%= command.id %> --cursor NEXT --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Filter credentials by name (partial match)", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:credential:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "credential", "list.js" ] }, "cicd:credential:open": { "aliases": [], "args": { "id": { "description": "Copado credential ID", "name": "id", "required": true } }, "description": "Open a Copado credential in the browser", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:credential:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "credential", "open.js" ] }, "cicd:credential:update": { "aliases": [], "args": { "id": { "description": "Copado credential ID", "name": "id", "required": true } }, "description": "Update a Copado credential by ID", "examples": [ "<%= config.bin %> <%= command.id %> --name \"CI User\"", "<%= config.bin %> <%= command.id %> --default", "<%= config.bin %> <%= command.id %> --no-default --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "default": { "description": "Mark this credential as the environment default", "name": "default", "allowNo": true, "type": "boolean" }, "name": { "description": "Credential name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:credential:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "credential", "update.js" ] }, "cicd:environment:create": { "aliases": [], "args": { "name": { "description": "Name of the environment to create", "name": "name", "required": true } }, "description": "Create a Copado environment", "examples": [ "<%= config.bin %> <%= command.id %> Dev", "<%= config.bin %> <%= command.id %> Dev --type Sandbox --platform SFDX", "<%= config.bin %> <%= command.id %> Dev --run-local-tests --apex-test-level \"No Test Run\"", "<%= config.bin %> <%= command.id %> Dev --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "enable-rollback": { "description": "Enable rollback", "name": "enable-rollback", "allowNo": true, "type": "boolean" }, "index-back-promotion-metadata": { "description": "Index back promotion metadata", "name": "index-back-promotion-metadata", "allowNo": true, "type": "boolean" }, "run-local-tests": { "description": "Run local tests", "name": "run-local-tests", "allowNo": true, "type": "boolean" }, "apex-test-level": { "description": "Apex test level", "name": "apex-test-level", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "namespace": { "description": "Environment namespace", "name": "namespace", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "promotion-default-credential": { "description": "Default credential for promotions", "name": "promotion-default-credential", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "run-specified-tests": { "description": "Specified tests to run", "name": "run-specified-tests", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "validation-promotion-default-credential": { "description": "Default credential for validation promotions", "name": "validation-promotion-default-credential", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "platform": { "description": "Environment platform", "name": "platform", "default": "SFDX", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Environment type", "name": "type", "default": "Production/Developer", "hasDynamicHelp": false, "multiple": false, "options": [ "Production/Developer", "Sandbox", "Scratch Org", "Custom Domain" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:environment:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "environment", "create.js" ] }, "cicd:environment:get": { "aliases": [], "args": { "id": { "description": "Copado environment ID", "name": "id", "required": true } }, "description": "Get a Copado environment by ID", "examples": [ "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:environment:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "environment", "get.js" ] }, "cicd:environment:list": { "aliases": [], "args": {}, "description": "List Copado environments", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --name Dev --org-id 00D000000000000 --platform SFDX --type Sandbox", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Filter by name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "org-id": { "description": "Filter by Salesforce org ID", "name": "org-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "platform": { "description": "Filter by platform", "name": "platform", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Environment type", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "Production/Developer", "Sandbox", "Scratch Org", "Custom Domain" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:environment:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "environment", "list.js" ] }, "cicd:environment:open": { "aliases": [], "args": { "id": { "description": "Copado environment ID (defaults to the configured project default environment)", "name": "id", "required": false } }, "description": "Open a Copado environment in the browser", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:environment:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "environment", "open.js" ] }, "cicd:environment:update": { "aliases": [], "args": { "id": { "description": "Copado environment ID", "name": "id", "required": true } }, "description": "Update a Copado environment by ID", "examples": [ "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --name UAT", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --type Sandbox --enable-rollback", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --no-run-local-tests", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --name UAT --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "enable-rollback": { "description": "Enable rollback", "name": "enable-rollback", "allowNo": true, "type": "boolean" }, "index-back-promotion-metadata": { "description": "Index back promotion metadata", "name": "index-back-promotion-metadata", "allowNo": true, "type": "boolean" }, "run-local-tests": { "description": "Run local tests", "name": "run-local-tests", "allowNo": true, "type": "boolean" }, "apex-test-level": { "description": "Apex test level", "name": "apex-test-level", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Environment name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "namespace": { "description": "Environment namespace", "name": "namespace", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "platform": { "description": "Environment platform", "name": "platform", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "promotion-default-credential": { "description": "Default credential for promotions", "name": "promotion-default-credential", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "run-specified-tests": { "description": "Specified tests to run", "name": "run-specified-tests", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Environment type", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "Production/Developer", "Sandbox", "Scratch Org", "Custom Domain" ], "type": "option" }, "validation-promotion-default-credential": { "description": "Default credential for validation promotions", "name": "validation-promotion-default-credential", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:environment:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "environment", "update.js" ] }, "cicd:extension:create": { "aliases": [], "args": {}, "description": "Create or refresh a Copado extension manifest at copado/extension_manifest.json (scans copado/functions and copado/templates)", "examples": [ "<%= config.bin %> <%= command.id %> --name my-extension --version 1.0.0", "<%= config.bin %> <%= command.id %> --name my-extension --overwrite --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "name": { "char": "n", "description": "Extension name (alphanumeric, underscore, hyphen)", "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite": { "description": "Overwrite an existing extension_manifest.json", "name": "overwrite", "allowNo": false, "type": "boolean" }, "version": { "description": "Initial semver version written to the manifest (X.Y.Z)", "name": "version", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:extension:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": true, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "extension", "create.js" ] }, "cicd:extension:install": { "aliases": [], "args": { "source": { "description": "Git repository URL, owner/repo slug, or local directory path", "name": "source", "required": false } }, "description": "Install a Copado extension from a git URL or local folder: upsert functions and job templates via the CICD Gateway; deploy force-app with Salesforce CLI unless excluded", "examples": [ "<%= config.bin %> <%= command.id %> https://gitlab.com/org/my-ext.git --version 1.2.0 --yes", "<%= config.bin %> <%= command.id %> ./my-extension --version 0.1.0 --exclude-sf-deploy --yes", "<%= config.bin %> <%= command.id %> /tmp/my-extension.git --ref v0.1.0 --sf-alias destOrg --yes", "<%= config.bin %> <%= command.id %> ./my-extension --version 1.2.0 --exclude-sf-deploy --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dry-run": { "description": "Materialize and validate, print the install plan, but do not upsert or deploy", "name": "dry-run", "allowNo": false, "type": "boolean" }, "exclude-sf-deploy": { "description": "Skip Salesforce metadata deploy even when force-app is present", "name": "exclude-sf-deploy", "allowNo": false, "type": "boolean" }, "ignore-unknown-assets": { "description": "Ignore unsupported manifest asset arrays instead of failing", "name": "ignore-unknown-assets", "allowNo": false, "type": "boolean" }, "ref": { "description": "Git ref to install (tag, branch, or commit). Prefer --version for semver tags.", "name": "ref", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sf-alias": { "description": "Salesforce CLI org alias or username for force-app deploy (required when force-app is present unless --exclude-sf-deploy)", "name": "sf-alias", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source": { "description": "Git URL or local path (alternative to the positional source argument)", "name": "source", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "url": { "description": "Deprecated alias of --source", "hidden": true, "name": "url", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "description": "Semver version to install (checks out tag vX.Y.Z)", "name": "version", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip the interactive confirmation prompt (required for non-interactive / --json installs that are not --dry-run)", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:extension:install", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": true, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "extension", "install.js" ] }, "cicd:extension:package": { "aliases": [], "args": {}, "description": "Validate a Copado extension for publish (requires semver version; optional --version bump)", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --version 1.2.0 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "version": { "description": "Set or bump the manifest semver version before validating", "name": "version", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:extension:package", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": true, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "extension", "package.js" ] }, "cicd:extension:publish": { "aliases": [], "args": {}, "description": "Push the current extension commit and create an annotated semver git tag (vX.Y.Z) for install pinning", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --version 1.2.0 --remote origin --json", "<%= config.bin %> <%= command.id %> --version 0.1.0 --local --force" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "allow-dirty": { "description": "Allow publish with a dirty working tree", "name": "allow-dirty", "allowNo": false, "type": "boolean" }, "force": { "description": "Recreate the local tag and push even if the tag already exists", "name": "force", "allowNo": false, "type": "boolean" }, "local": { "description": "Create the annotated tag locally without pushing to a remote (offline / local e2e)", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Git remote to push (default origin; ignored with --local)", "name": "remote", "default": "origin", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "description": "Require this semver in the manifest before tagging (writes it only if already committed; fails if the bump is uncommitted)", "name": "version", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:extension:publish", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": true, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "extension", "publish.js" ] }, "cicd:extension:uninstall": { "aliases": [], "args": { "source": { "description": "Git repository URL, owner/repo slug, or local directory path", "name": "source", "required": false } }, "description": "Uninstall a Copado extension by deleting the functions and job templates listed in its manifest from the authenticated Copado org", "examples": [ "<%= config.bin %> <%= command.id %> ./my-extension --version 0.1.0 --yes", "<%= config.bin %> <%= command.id %> https://gitlab.com/org/my-ext.git --ref v0.1.0 --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dry-run": { "description": "Show which assets would be deleted without calling the gateway", "name": "dry-run", "allowNo": false, "type": "boolean" }, "ref": { "description": "Git ref to read the manifest from", "name": "ref", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source": { "description": "Git URL or local path (alternative to the positional source argument)", "name": "source", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "description": "Semver version whose tag (vX.Y.Z) supplies the manifest", "name": "version", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip the interactive confirmation prompt (required for non-interactive / --json uninstalls that are not --dry-run)", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:extension:uninstall", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": true, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "extension", "uninstall.js" ] }, "cicd:extension:validate": { "aliases": [], "args": {}, "description": "Validate a Copado extension manifest against copado/functions and copado/templates on disk", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --require-version --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "require-version": { "description": "Require a semver version field (needed for package/publish)", "name": "require-version", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:extension:validate", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": true, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "extension", "validate.js" ] }, "cicd:extension-configuration:get": { "aliases": [], "args": { "id": { "description": "Extension configuration ID or name", "name": "id", "required": true } }, "description": "Get a Copado extension configuration", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:extension-configuration:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "extension-configuration", "get.js" ] }, "cicd:extension-configuration:list": { "aliases": [], "args": {}, "description": "List Copado extension configurations", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --tool Selenium --active --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "active": { "description": "Filter by active status", "name": "active", "allowNo": true, "type": "boolean" }, "name": { "description": "Filter by extension configuration name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "test-type": { "description": "Filter by test type", "name": "test-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tool": { "description": "Filter by extension tool", "name": "tool", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:extension-configuration:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "extension-configuration", "list.js" ] }, "cicd:extension-configuration:open": { "aliases": [], "args": { "id": { "description": "Extension configuration Salesforce ID", "name": "id", "required": true } }, "description": "Open a Copado extension configuration in the browser", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:extension-configuration:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "extension-configuration", "open.js" ] }, "cicd:function:defaults": { "aliases": [], "args": {}, "description": "Scaffold default Copado Function metadata and script without writing to Salesforce", "examples": [ "<%= config.bin %> <%= command.id %> --name MyFunction", "<%= config.bin %> <%= command.id %> --name MyFunction --runtime python --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "image-name": { "description": "Function container image", "name": "image-name", "default": "copado-function-core:v1", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Function display name used to scaffold defaults", "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "runtime": { "description": "Script runtime", "name": "runtime", "default": "bash", "hasDynamicHelp": false, "multiple": false, "options": [ "bash", "node", "python" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:function:defaults", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "function", "defaults.js" ] }, "cicd:function:delete": { "aliases": [], "args": { "api-name": { "description": "Function API name", "name": "api-name", "required": true } }, "description": "Delete a Copado Function by API name", "examples": [ "<%= config.bin %> <%= command.id %> myFunction", "<%= config.bin %> <%= command.id %> myFunction --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:function:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "function", "delete.js" ] }, "cicd:function:get": { "aliases": [], "args": { "api-name": { "description": "Function API name", "name": "api-name", "required": true } }, "description": "Get a Copado Function by API name", "examples": [ "<%= config.bin %> <%= command.id %> myFunction", "<%= config.bin %> <%= command.id %> myFunction --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:function:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "function", "get.js" ] }, "cicd:function:list": { "aliases": [], "args": {}, "description": "List Copado Functions", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --type all", "<%= config.bin %> <%= command.id %> --name MyFunction --size S", "<%= config.bin %> <%= command.id %> --image-name copado-function-core:v1", "<%= config.bin %> <%= command.id %> --page-size 50", "<%= config.bin %> <%= command.id %> --cursor NEXT --json", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "image-name": { "description": "Filter by function container image", "name": "image-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Filter by name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "size": { "description": "Filter by function size", "name": "size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "List Custom functions only, or all functions", "name": "type", "default": "custom", "hasDynamicHelp": false, "multiple": false, "options": [ "custom", "all" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:function:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "function", "list.js" ] }, "cicd:function:open": { "aliases": [], "args": { "id": { "description": "Function ID", "name": "id", "required": true } }, "description": "Open a Copado Function in the browser", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:function:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "function", "open.js" ] }, "cicd:function:run-local": { "aliases": [], "args": { "script": { "description": "Path to the local function script (.sh, .js, or .py)", "name": "script", "required": true } }, "description": "Run a Copado Function script locally in Docker (no CICD gateway). Override --image when the Copado registry is unavailable.", "examples": [ "<%= config.bin %> <%= command.id %> copado/functions/myFunction.sh", "<%= config.bin %> <%= command.id %> ./myFunction.js --cwd . --image my-registry/function-core:v1 --parameter ENV=dev --json", "<%= config.bin %> <%= command.id %> ./myFunction.py --runtime python --platform linux/amd64" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cwd": { "description": "Host directory bind-mounted at /app inside the container (defaults to the current working directory)", "name": "cwd", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "image": { "char": "i", "description": "Docker image used to run the function. Override when the Copado image registry is unavailable (e.g. for partners).", "name": "image", "default": "copado-function-core:v1", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "parameter": { "description": "Environment variable for the script as key=value (repeatable)", "name": "parameter", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "platform": { "description": "Docker --platform value (e.g. linux/amd64 on Apple Silicon)", "name": "platform", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "runtime": { "description": "Override runtime detection from the script extension", "name": "runtime", "hasDynamicHelp": false, "multiple": false, "options": [ "bash", "node", "python" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:function:run-local", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "function", "run-local.js" ] }, "cicd:function:run": { "aliases": [], "args": { "api-name": { "description": "Function API name", "name": "api-name", "required": true } }, "description": "Run a Copado Function and return the result Id", "examples": [ "<%= config.bin %> <%= command.id %> myFunction", "<%= config.bin %> <%= command.id %> myFunction --parameter env=dev --json", "<%= config.bin %> <%= command.id %> myFunction --context-id a00... --deploy-first --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "context-id": { "description": "Execution context Id", "name": "context-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "deploy-first": { "description": "Deploy related metadata before running the function", "name": "deploy-first", "allowNo": false, "type": "boolean" }, "parameter": { "description": "Run parameter as key=value (repeatable)", "name": "parameter", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "show-validation-errors": { "description": "Surface validation errors from the gateway", "name": "show-validation-errors", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:function:run", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "function", "run.js" ] }, "cicd:function:upsert": { "aliases": [], "args": { "api-name": { "description": "Function API name", "name": "api-name", "required": true } }, "description": "Create or update a Copado Function by API name", "examples": [ "<%= config.bin %> <%= command.id %> myFunction --name \"My Function\" --script \"echo hello\"", "<%= config.bin %> <%= command.id %> myFunction --script-file ./run.sh --runtime bash --json", "<%= config.bin %> <%= command.id %> myFunction --file ./function.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "apex-class": { "description": "Apex callback class", "name": "apex-class", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "callback": { "description": "Function callback type", "name": "callback", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "description": "Function description", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "description": "Path to a JSON file with the full upsert payload (overrides individual script flags)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "flow-handler": { "description": "Flow handler name", "name": "flow-handler", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "image-name": { "description": "Function container image", "name": "image-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Function display name (defaults to the API name argument)", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "parameters-file": { "description": "Path to a JSON file containing the parameters array", "name": "parameters-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "runtime": { "description": "Script runtime", "name": "runtime", "hasDynamicHelp": false, "multiple": false, "options": [ "bash", "node", "python" ], "type": "option" }, "script": { "description": "Inline script content", "name": "script", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "script-file": { "description": "Path to a file whose contents become the script", "name": "script-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "size": { "description": "Function size", "name": "size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "Function timeout in seconds", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Function type", "name": "type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "description": "Function version", "name": "version", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:function:upsert", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "function", "upsert.js" ] }, "cicd:job:get": { "aliases": [], "args": { "id": { "description": "JobExecution Id", "name": "id", "required": true } }, "description": "Get a Copado job execution with ordered steps", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:job:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "job", "get.js" ] }, "cicd:job:kill": { "aliases": [], "args": { "id": { "description": "JobExecution Id", "name": "id", "required": true } }, "description": "Cancel a Copado job execution", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:job:kill", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "job", "kill.js" ] }, "cicd:job:list": { "aliases": [], "args": {}, "description": "List Copado job executions", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --status \"In Progress\" --page-size 50", "<%= config.bin %> <%= command.id %> --name JE- --type Deploy --parent ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "context": { "description": "Contains match on JobExecution context", "name": "context", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "id": { "description": "Exact JobExecution Id", "name": "id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "mine": { "description": "List only jobs owned by the current user", "name": "mine", "allowNo": false, "type": "boolean" }, "name": { "description": "Contains match on JobExecution name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "parent": { "description": "Exact parent record Id", "name": "parent", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Exact Copado job status", "name": "status", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Contains match on Job Template name", "name": "type", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:job:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "job", "list.js" ] }, "cicd:job:open": { "aliases": [], "args": { "id": { "description": "JobExecution ID", "name": "id", "required": true } }, "description": "Open a Copado job execution in the browser", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:job:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "job", "open.js" ] }, "cicd:job:pause": { "aliases": [], "args": { "id": { "description": "JobExecution Id", "name": "id", "required": true } }, "description": "Pause a Copado job execution (resumable cancel alias)", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:job:pause", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "job", "pause.js" ] }, "cicd:job:resume": { "aliases": [], "args": { "id": { "description": "JobExecution Id", "name": "id", "required": true } }, "description": "Resume outstanding steps for a Copado job execution", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:job:resume", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "job", "resume.js" ] }, "cicd:job:run": { "aliases": [], "args": { "id": { "description": "JobExecution Id", "name": "id", "required": true } }, "description": "Run all steps for a Copado job execution", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --restart --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "restart": { "description": "Restart the job run (gateway compatibility flag)", "name": "restart", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:job:run", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "job", "run.js" ] }, "cicd:metadata:explore": { "aliases": [], "args": {}, "description": "Explore Salesforce metadata through Org Intelligence. Uses the project default credential when --credential-id is omitted; otherwise pass --credential-id, or both --session-id and --endpoint.", "examples": [ "<%= config.bin %> <%= command.id %> --action list --object-type ApexClass", "<%= config.bin %> <%= command.id %> --action list --object-type ApexClass --pattern 'Account*'", "<%= config.bin %> <%= command.id %> --action read --object-type ApexClass --full-name MyClass", "<%= config.bin %> <%= command.id %> --action find_references --object-type ApexClass --full-name MyClass", "<%= config.bin %> <%= command.id %> --action search --pattern 'Cont*' --credential-id ", "<%= config.bin %> <%= command.id %> --action describe_type --object-type CustomObject --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "action": { "description": "Metadata action: list, search, read_documentation, describe_type, read, find_references, run_apex_tests", "name": "action", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "list", "search", "read_documentation", "describe_type", "read", "find_references", "run_apex_tests" ], "type": "option" }, "apex-unit-tests": { "description": "Comma-separated Apex test classes. Required for run_apex_tests.", "name": "apex-unit-tests", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "credential-id": { "description": "Copado credential Id for the target org. Defaults to the CICD project default credential when set.", "name": "credential-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "endpoint": { "description": "Salesforce instance URL (with --session-id) when not using a credential. Exclusive with --credential-id.", "name": "endpoint", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "full-name": { "description": "Fully qualified metadata name (required for read; list results emit this as fullName)", "name": "full-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "object-type": { "description": "Metadata type, for example ApexClass, CustomObject, or Flow", "name": "object-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pattern": { "description": "Wildcard pattern for list/search (name without namespace), for example Account* or *Info", "name": "pattern", "default": "*", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Salesforce session Id (with --endpoint) when not using a credential. Exclusive with --credential-id.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:metadata:explore", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": true, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "metadata", "explore.js" ] }, "cicd:metadata:list": { "aliases": [], "args": {}, "description": "Search the metadata index for an org", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id --source-org-id --source-credential-id ", "<%= config.bin %> <%= command.id %> --source Changed --metadata-types ApexClass --limit 100 --pipeline-id --source-org-id --source-credential-id ", "<%= config.bin %> <%= command.id %> --source NewAndChanged --find-managed-packages --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "avoid-source-tracking": { "description": "Pass avoidSourceTracking=true to the index route", "name": "avoid-source-tracking", "allowNo": false, "type": "boolean" }, "change-date-from": { "description": "Optional change-date-from filter (ISO datetime)", "name": "change-date-from", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "change-date-to": { "description": "Optional change-date-to filter (ISO datetime)", "name": "change-date-to", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "filter-type": { "description": "Optional metadata type name filter, for example ApexClass", "name": "filter-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "find-managed-packages": { "description": "Include managed package metadata in the search", "name": "find-managed-packages", "allowNo": false, "type": "boolean" }, "limit": { "description": "Maximum number of records to return", "name": "limit", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-types": { "description": "Optional comma-separated metadata types to include", "name": "metadata-types", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "modified-by": { "description": "Filter by last modified user", "name": "modified-by", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "module-type": { "description": "Optional addon module type", "name": "module-type", "hasDynamicHelp": false, "multiple": false, "options": [ "vlocity", "data_cloud" ], "type": "option" }, "order-direction": { "description": "Sort direction for last modified date", "name": "order-direction", "hasDynamicHelp": false, "multiple": false, "options": [ "ASC", "DESC" ], "type": "option" }, "pipeline-id": { "description": "Pipeline Id", "name": "pipeline-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "platform-experience": { "description": "Platform experience header", "name": "platform-experience", "default": "salesforce", "hasDynamicHelp": false, "multiple": false, "options": [ "salesforce", "sfdx", "metacache", "db" ], "type": "option" }, "source": { "description": "Index source filter", "name": "source", "hasDynamicHelp": false, "multiple": false, "options": [ "All", "Changed", "Deleted", "New", "NewAndChanged", "PreviouslyCommitted" ], "type": "option" }, "source-credential-id": { "description": "Source org credential Id", "name": "source-credential-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-org-id": { "description": "Source org Id", "name": "source-org-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org-id": { "description": "Optional target org Id", "name": "target-org-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:metadata:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "metadata", "list.js" ] }, "cicd:notification:configure": { "aliases": [], "args": {}, "description": "Configure one Slack notification subscription for the current user on a pipeline", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id --event Promotion_Failed --destination-type user --destination-id U0123ABCD --subscription user", "<%= config.bin %> <%= command.id %> -p --event Commit_Failed --destination-type channel --destination-id C0123ABCD --subscription all", "<%= config.bin %> <%= command.id %> --pipeline-id --event \"Test_Not Started\" --destination-type user --destination-id @jane --subscription user --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "destination-id": { "description": "Slack user or channel id or name", "name": "destination-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "destination-type": { "description": "Slack destination type", "name": "destination-type", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "user", "channel" ], "type": "option" }, "event": { "description": "Notification event", "name": "event", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "Promotion_Success", "Promotion_Failed", "Promotion_Conflict", "Failed_Promotion_Creation", "Deploy_Success", "Deploy_Failed", "Commit_Failed", "Successful_Snapshot", "Failed_Snapshot", "ManualTask_Assigned", "Test_Success", "Test_Failed", "Test_Cancelled", "Test_Not Started", "Quality_Gate_Success", "Quality_Gate_Failed", "Quality_Gate_Cancelled", "Quality_Gate_Not Started", "Create_Package_Success", "Create_Package_Failure", "Generate_Package_Version_Success", "Generate_Package_Version_Failure", "Import_Package_Success", "Import_Package_Failure", "Publish_Package_Success", "Publish_Package_Failure" ], "type": "option" }, "pipeline-id": { "char": "p", "description": "Copado pipeline Salesforce Id", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "subscription": { "description": "Notification audience for this event", "name": "subscription", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "user", "all" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:notification:configure", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "notification", "configure.js" ] }, "cicd:notification:get": { "aliases": [], "args": {}, "description": "List Slack notification subscriptions for the current user on a pipeline", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id ", "<%= config.bin %> <%= command.id %> -p --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "pipeline-id": { "char": "p", "description": "Copado pipeline Salesforce Id", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:notification:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "notification", "get.js" ] }, "cicd:pipeline:create": { "aliases": [], "args": { "name": { "description": "Name of the Copado pipeline to create", "name": "name", "required": true } }, "description": "Create a Copado pipeline", "examples": [ "<%= config.bin %> <%= command.id %> \"Dev Pipeline\"", "<%= config.bin %> <%= command.id %> \"Dev Pipeline\" --platform SFDX --main-branch main --active", "<%= config.bin %> <%= command.id %> \"Dev Pipeline\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "active": { "description": "Whether the pipeline is active", "name": "active", "allowNo": true, "type": "boolean" }, "block-commits": { "description": "Block commits on the pipeline", "name": "block-commits", "allowNo": true, "type": "boolean" }, "enable-smart-conflict-resolution": { "description": "Enable smart conflict resolution", "name": "enable-smart-conflict-resolution", "allowNo": true, "type": "boolean" }, "calculate-based-on": { "description": "Promotion calculation basis", "name": "calculate-based-on", "hasDynamicHelp": false, "multiple": false, "options": [ "User Story", "Branch" ], "type": "option" }, "git-repository-id": { "description": "Git repository ID", "name": "git-repository-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "main-branch": { "description": "Main branch name", "name": "main-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "platform": { "description": "Pipeline platform", "name": "platform", "hasDynamicHelp": false, "multiple": false, "options": [ "Salesforce", "SFDX", "Heroku", "Mulesoft", "Marketing", "Other" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "create.js" ] }, "cicd:pipeline:get": { "aliases": [], "args": { "id": { "description": "Pipeline Id", "name": "id", "required": true } }, "description": "Get a Copado pipeline", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "get.js" ] }, "cicd:pipeline:list": { "aliases": [], "args": {}, "description": "List Copado pipelines", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --name \"Dev Pipeline\" --active --platform SFDX", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "active": { "description": "Filter by active status", "name": "active", "allowNo": true, "type": "boolean" }, "name": { "description": "Filter by pipeline name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "platform": { "description": "Filter by pipeline platform", "name": "platform", "hasDynamicHelp": false, "multiple": false, "options": [ "Salesforce", "SFDX", "Heroku", "Mulesoft", "Marketing", "Other" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "list.js" ] }, "cicd:pipeline:open": { "aliases": [], "args": { "id": { "description": "Pipeline ID", "name": "id", "required": true } }, "description": "Open a Copado pipeline in the browser", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "open.js" ] }, "cicd:pipeline:update": { "aliases": [], "args": { "id": { "description": "Pipeline ID", "name": "id", "required": true } }, "description": "Update a Copado pipeline by ID", "examples": [ "<%= config.bin %> <%= command.id %> pipeline-1 --main-branch develop", "<%= config.bin %> <%= command.id %> pipeline-1 --platform SFDX --active", "<%= config.bin %> <%= command.id %> pipeline-1 --name \"Updated Pipeline\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "active": { "description": "Whether the pipeline is active", "name": "active", "allowNo": true, "type": "boolean" }, "block-commits": { "description": "Block commits on the pipeline", "name": "block-commits", "allowNo": true, "type": "boolean" }, "enable-smart-conflict-resolution": { "description": "Enable smart conflict resolution", "name": "enable-smart-conflict-resolution", "allowNo": true, "type": "boolean" }, "calculate-based-on": { "description": "Promotion calculation basis", "name": "calculate-based-on", "hasDynamicHelp": false, "multiple": false, "options": [ "User Story", "Branch" ], "type": "option" }, "git-repository-id": { "description": "Git repository ID", "name": "git-repository-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "main-branch": { "description": "Main branch name", "name": "main-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "platform": { "description": "Pipeline platform", "name": "platform", "hasDynamicHelp": false, "multiple": false, "options": [ "Salesforce", "SFDX", "Heroku", "Mulesoft", "Marketing", "Other" ], "type": "option" }, "name": { "description": "Pipeline name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "update.js" ] }, "cicd:project:create": { "aliases": [], "args": { "name": { "description": "Copado project name", "name": "name", "required": true } }, "description": "Create a Copado project", "examples": [ "<%= config.bin %> <%= command.id %> \"Release Project\"", "<%= config.bin %> <%= command.id %> \"Release Project\" --pipeline pipeline-1 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "description": { "description": "Project description", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "end-date": { "description": "Project end date (YYYY-MM-DD)", "name": "end-date", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline": { "description": "Pipeline ID", "name": "pipeline", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "should-index-metadata": { "description": "Whether project metadata should be indexed", "name": "should-index-metadata", "allowNo": true, "type": "boolean" }, "start-date": { "description": "Project start date (YYYY-MM-DD)", "name": "start-date", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Project status", "name": "status", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:project:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "project", "create.js" ] }, "cicd:project:delete": { "aliases": [], "args": { "id": { "description": "Copado project ID", "name": "id", "required": true } }, "description": "Delete a Copado project by ID", "examples": [ "<%= config.bin %> <%= command.id %> project-1 --yes", "<%= config.bin %> <%= command.id %> project-1 --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "yes": { "char": "y", "description": "Confirm deletion without prompting", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:project:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "project", "delete.js" ] }, "cicd:project:get": { "aliases": [], "args": { "id": { "description": "Copado project ID", "name": "id", "required": true } }, "description": "Get a Copado project by ID", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:project:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "project", "get.js" ] }, "cicd:project:list": { "aliases": [], "args": {}, "description": "List Copado projects", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --mine", "<%= config.bin %> <%= command.id %> --name Gateway", "<%= config.bin %> <%= command.id %> --mine --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "end-date-from": { "description": "Filter by end date (inclusive, YYYY-MM-DD)", "name": "end-date-from", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "end-date-to": { "description": "Filter by end date (inclusive, YYYY-MM-DD)", "name": "end-date-to", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "mine": { "description": "List only projects owned by or related to the current user", "name": "mine", "allowNo": false, "type": "boolean" }, "name": { "description": "Filter by name (partial match)", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "start-date-from": { "description": "Filter by start date (inclusive, YYYY-MM-DD)", "name": "start-date-from", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "start-date-to": { "description": "Filter by start date (inclusive, YYYY-MM-DD)", "name": "start-date-to", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Filter by project status", "name": "status", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:project:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "project", "list.js" ] }, "cicd:project:open": { "aliases": [], "args": { "id": { "description": "Copado project ID (defaults to the configured project default)", "name": "id", "required": false } }, "description": "Open a Copado project in the browser", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> a0wKC000000CmZ2AU", "<%= config.bin %> <%= command.id %> a0wKC000000CmZ2AU --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:project:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "project", "open.js" ] }, "cicd:project:update": { "aliases": [], "args": { "id": { "description": "Copado project ID", "name": "id", "required": true } }, "description": "Update a Copado project by ID", "examples": [ "<%= config.bin %> <%= command.id %> project-1 --name \"Updated Project\"", "<%= config.bin %> <%= command.id %> project-1 --status Active --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "description": { "description": "Project description", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "end-date": { "description": "Project end date (YYYY-MM-DD)", "name": "end-date", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline": { "description": "Pipeline ID", "name": "pipeline", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "should-index-metadata": { "description": "Whether project metadata should be indexed", "name": "should-index-metadata", "allowNo": true, "type": "boolean" }, "start-date": { "description": "Project start date (YYYY-MM-DD)", "name": "start-date", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Project status", "name": "status", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Project name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:project:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "project", "update.js" ] }, "cicd:promotion:get": { "aliases": [], "args": { "id": { "description": "Copado promotion ID", "name": "id", "required": true } }, "description": "Get a Copado promotion by ID", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:promotion:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "promotion", "get.js" ] }, "cicd:promotion:list": { "aliases": [], "args": {}, "description": "List Copado promotions", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --status Completed --project-name \"My Project\" --page-size 50", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "created-by-id": { "description": "Filter by creator ID", "name": "created-by-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "created-by-name": { "description": "Filter by creator name", "name": "created-by-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "destination-environment-id": { "description": "Filter by destination environment ID", "name": "destination-environment-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "destination-environment-name": { "description": "Filter by destination environment name", "name": "destination-environment-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "is-back-promotion": { "description": "Filter by back promotion", "name": "is-back-promotion", "allowNo": true, "type": "boolean" }, "name": { "description": "Filter by name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Filter by pipeline ID", "name": "pipeline-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-name": { "description": "Filter by pipeline name", "name": "pipeline-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "description": "Filter by project ID", "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-name": { "description": "Filter by project name", "name": "project-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-environment-id": { "description": "Filter by source environment ID", "name": "source-environment-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-environment-name": { "description": "Filter by source environment name", "name": "source-environment-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Filter by status", "name": "status", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "work-id": { "description": "Filter by user story ID", "name": "work-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:promotion:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "promotion", "list.js" ] }, "cicd:promotion:open": { "aliases": [], "args": { "id": { "description": "Copado promotion ID", "name": "id", "required": true } }, "description": "Open a Copado promotion in the browser", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:promotion:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "promotion", "open.js" ] }, "cicd:promotion:run": { "aliases": [], "args": { "id": { "description": "18-character Salesforce Promotion ID", "name": "id", "required": true } }, "description": "Preflight, start, and optionally wait for a Copado promotion execution. Use --resume to continue an existing failed or conflict-resolved execution without starting a duplicate promotion.", "examples": [ "<%= config.bin %> <%= command.id %> a0BXXXXXXXXXXXXXXX --operation merge", "<%= config.bin %> <%= command.id %> a0BXXXXXXXXXXXXXXX --operation merge_and_deploy --json", "<%= config.bin %> <%= command.id %> a0BXXXXXXXXXXXXXXX --resume a4NXXXXXXXXXXXXXXX" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "deployment-step-id": { "description": "Ordered deployment-step Salesforce ID. Can be provided multiple times.", "name": "deployment-step-id", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "ignored-metadata-json": { "description": "JSON array to persist through ignored-metadata before starting the promotion.", "name": "ignored-metadata-json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "operation": { "description": "Promotion operation. Required unless --resume is used.", "name": "operation", "hasDynamicHelp": false, "multiple": false, "options": [ "merge", "merge_and_deploy" ], "type": "option" }, "recreate-promotion-branch": { "description": "Recreate the promotion branch before execution. Requires confirmation or --yes.", "name": "recreate-promotion-branch", "allowNo": false, "type": "boolean" }, "resume": { "description": "Resume this existing JobExecution ID instead of calling the promotion run endpoint.", "name": "resume", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "description": "Poll promotion and deployment executions to terminal status.", "name": "wait", "allowNo": true, "type": "boolean" }, "wait-timeout": { "description": "Maximum total seconds to wait for promotion and deployment executions.", "name": "wait-timeout", "default": 900, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Confirm promotion branch recreation without prompting.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:promotion:run", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "promotion", "run.js" ] }, "cicd:repository:create": { "aliases": [], "args": { "name": { "description": "Name of the Copado Git repository to create", "name": "name", "required": true } }, "description": "Create a Copado Git repository shell", "examples": [ "<%= config.bin %> <%= command.id %> my-repo --source-format DX --provider Github", "<%= config.bin %> <%= command.id %> my-repo --source-format DX --provider GitLab --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "allow-functions-git-cache": { "description": "Allow Functions Git cache for this repository", "name": "allow-functions-git-cache", "allowNo": true, "type": "boolean" }, "copado-tunnel-enabled": { "description": "Enable Copado tunnel for this repository", "name": "copado-tunnel-enabled", "allowNo": true, "type": "boolean" }, "provider": { "description": "Git repository provider", "name": "provider", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "Github", "Bitbucket", "GitLab", "Azure", "Microsoft Team Service", "Copado Version Control", "Others" ], "type": "option" }, "source-format": { "description": "Git repository source format (default: DX)", "name": "source-format", "default": "DX", "hasDynamicHelp": false, "multiple": false, "options": [ "Metadata", "DX" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:repository:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "repository", "create.js" ] }, "cicd:repository:delete": { "aliases": [], "args": { "id": { "description": "Copado Git repository ID", "name": "id", "required": true } }, "description": "Delete a Copado Git repository by ID", "examples": [ "<%= config.bin %> <%= command.id %> repo-001", "<%= config.bin %> <%= command.id %> repo-001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:repository:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "repository", "delete.js" ] }, "cicd:repository:get": { "aliases": [], "args": { "id": { "description": "Copado Git repository ID", "name": "id", "required": true } }, "description": "Get a Copado Git repository by ID", "examples": [ "<%= config.bin %> <%= command.id %> repo-001", "<%= config.bin %> <%= command.id %> repo-001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:repository:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "repository", "get.js" ] }, "cicd:repository:list": { "aliases": [], "args": {}, "description": "List Copado Git repositories", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --page-size 50", "<%= config.bin %> <%= command.id %> --cursor NEXT --json", "<%= config.bin %> <%= command.id %> --name copado-demo --provider Github", "<%= config.bin %> <%= command.id %> --source-format DX --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Filter by name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "provider": { "description": "Filter by Git repository provider", "name": "provider", "hasDynamicHelp": false, "multiple": false, "options": [ "Github", "Bitbucket", "GitLab", "Azure", "Microsoft Team Service", "Copado Version Control", "Others" ], "type": "option" }, "source-format": { "description": "Filter by Git repository source format", "name": "source-format", "hasDynamicHelp": false, "multiple": false, "options": [ "Metadata", "DX" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:repository:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "repository", "list.js" ] }, "cicd:repository:open": { "aliases": [], "args": { "id": { "description": "Copado Git repository ID", "name": "id", "required": true } }, "description": "Open a Copado Git repository in the browser", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:repository:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "repository", "open.js" ] }, "cicd:repository:reset": { "aliases": [], "args": { "id": { "description": "Copado Git repository ID", "name": "id", "required": true } }, "description": "Reset a Copado Git repository and its authentication configuration", "examples": [ "<%= config.bin %> <%= command.id %> repo-001 --yes", "<%= config.bin %> <%= command.id %> repo-001 --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "yes": { "char": "y", "description": "Confirm reset without prompting", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:repository:reset", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "repository", "reset.js" ] }, "cicd:repository:update": { "aliases": [], "args": { "id": { "description": "Copado Git repository ID", "name": "id", "required": true } }, "description": "Update a Copado Git repository by ID", "examples": [ "<%= config.bin %> <%= command.id %> repo-001 --uri https://github.com/org/repo.git", "<%= config.bin %> <%= command.id %> repo-001 --clear-uri", "<%= config.bin %> <%= command.id %> repo-001 --provider GitLab --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "allow-functions-git-cache": { "description": "Allow Functions Git cache for this repository", "name": "allow-functions-git-cache", "allowNo": true, "type": "boolean" }, "copado-tunnel-enabled": { "description": "Enable Copado tunnel for this repository", "name": "copado-tunnel-enabled", "allowNo": true, "type": "boolean" }, "clear-branch-base-url": { "description": "Clear the repository branch base URL", "name": "clear-branch-base-url", "allowNo": false, "type": "boolean" }, "clear-commit-base-url": { "description": "Clear the repository commit base URL", "name": "clear-commit-base-url", "allowNo": false, "type": "boolean" }, "clear-pull-request-base-url": { "description": "Clear the repository pull request base URL", "name": "clear-pull-request-base-url", "allowNo": false, "type": "boolean" }, "clear-tag-base-url": { "description": "Clear the repository tag base URL", "name": "clear-tag-base-url", "allowNo": false, "type": "boolean" }, "clear-uri": { "description": "Clear the repository clone URI", "name": "clear-uri", "allowNo": false, "type": "boolean" }, "branch-base-url": { "description": "Base URL for repository branch links", "name": "branch-base-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "commit-base-url": { "description": "Base URL for repository commit links", "name": "commit-base-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pull-request-base-url": { "description": "Base URL for repository pull request links", "name": "pull-request-base-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tag-base-url": { "description": "Base URL for repository tag links", "name": "tag-base-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "uri": { "description": "Repository clone URI", "name": "uri", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Repository name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "provider": { "description": "Git repository provider", "name": "provider", "hasDynamicHelp": false, "multiple": false, "options": [ "Github", "Bitbucket", "GitLab", "Azure", "Microsoft Team Service", "Copado Version Control", "Others" ], "type": "option" }, "source-format": { "description": "Git repository source format", "name": "source-format", "hasDynamicHelp": false, "multiple": false, "options": [ "Metadata", "DX" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:repository:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "repository", "update.js" ] }, "cicd:repository:validate": { "aliases": [], "args": { "id": { "description": "Copado Git repository ID", "name": "id", "required": true } }, "description": "Validate Copado Git repository authentication", "examples": [ "<%= config.bin %> <%= command.id %> repo-001", "<%= config.bin %> <%= command.id %> repo-001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:repository:validate", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "repository", "validate.js" ] }, "cicd:stage:create": { "aliases": [], "args": { "name": { "description": "Stage name", "name": "name", "required": true } }, "description": "Create a Copado stage", "examples": [ "<%= config.bin %> <%= command.id %> Build", "<%= config.bin %> <%= command.id %> Test --meta-stage Test" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "meta-stage": { "description": "Meta stage (common values: Build, Test, Production; custom values are allowed)", "name": "meta-stage", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Stage name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:stage:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "stage", "create.js" ] }, "cicd:stage:delete": { "aliases": [], "args": { "id": { "description": "Stage ID", "name": "id", "required": true } }, "description": "Delete a Copado stage", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "yes": { "char": "y", "description": "Confirm deletion without prompting", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:stage:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "stage", "delete.js" ] }, "cicd:stage:get": { "aliases": [], "args": { "id": { "description": "Stage ID", "name": "id", "required": true } }, "description": "Get a Copado stage", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:stage:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "stage", "get.js" ] }, "cicd:stage:list": { "aliases": [], "args": {}, "description": "List Copado stages", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:stage:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "stage", "list.js" ] }, "cicd:stage:open": { "aliases": [], "args": { "id": { "description": "Stage ID", "name": "id", "required": true } }, "description": "Open a Copado stage in the browser", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:stage:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "stage", "open.js" ] }, "cicd:stage:update": { "aliases": [], "args": { "id": { "description": "Stage ID", "name": "id", "required": true } }, "description": "Update a Copado stage", "examples": [ "<%= config.bin %> <%= command.id %> --name QA", "<%= config.bin %> <%= command.id %> --meta-stage Test" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "meta-stage": { "description": "Meta stage (common values: Build, Test, Production; custom values are allowed)", "name": "meta-stage", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Stage name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:stage:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "stage", "update.js" ] }, "cicd:template:defaults": { "aliases": [], "args": {}, "description": "Scaffold default Copado Job Template metadata without writing to Salesforce (legacy create ≈ defaults --write)", "examples": [ "<%= config.bin %> <%= command.id %> --name MyTemplate", "<%= config.bin %> <%= command.id %> --name MyTemplate --api-name MyTemplate_1 --write", "<%= config.bin %> <%= command.id %> --name MyTemplate --output ./copado/templates/MyTemplate_1.metadata.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-name": { "description": "Optional template API name for the scaffold (defaults to {name}_1 on the gateway)", "name": "api-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Template display name used to scaffold defaults", "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output": { "description": "Write scaffold JSON to this path (implies a disk write)", "name": "output", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "write": { "description": "Write scaffold JSON to copado/templates/{apiName}.metadata.json (legacy create)", "name": "write", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:template:defaults", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "template", "defaults.js" ] }, "cicd:template:delete": { "aliases": [], "args": { "api-name": { "description": "Template API name", "name": "api-name", "required": true } }, "description": "Delete a Copado Job Template by API name", "examples": [ "<%= config.bin %> <%= command.id %> MyTemplate_1", "<%= config.bin %> <%= command.id %> MyTemplate_1 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:template:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "template", "delete.js" ] }, "cicd:template:get": { "aliases": [], "args": { "api-name": { "description": "Template API name", "name": "api-name", "required": true } }, "description": "Get a Copado Job Template by API name (legacy retrieve ≈ get --write)", "examples": [ "<%= config.bin %> <%= command.id %> MyTemplate_1", "<%= config.bin %> <%= command.id %> MyTemplate_1 --write", "<%= config.bin %> <%= command.id %> MyTemplate_1 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "output": { "description": "Write retrieved template JSON to this path (implies a disk write)", "name": "output", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "write": { "description": "Write retrieved JSON to copado/templates/{apiName}.metadata.json (legacy retrieve)", "name": "write", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:template:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "template", "get.js" ] }, "cicd:template:list": { "aliases": [], "args": {}, "description": "List Copado Job Templates", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --type all", "<%= config.bin %> <%= command.id %> --name Demo --page-size 50", "<%= config.bin %> <%= command.id %> --fetch-all --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "fetch-all": { "description": "Fetch all matching templates (incompatible with --cursor on the gateway)", "name": "fetch-all", "allowNo": false, "type": "boolean" }, "name": { "description": "Filter by name substring", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "List Custom templates only, or all templates", "name": "type", "default": "custom", "hasDynamicHelp": false, "multiple": false, "options": [ "custom", "all" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:template:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "template", "list.js" ] }, "cicd:template:upsert": { "aliases": [], "args": { "api-name": { "description": "Template API name", "name": "api-name", "required": true } }, "description": "Create or update a Copado Job Template by API name (legacy deploy ≈ upsert reading disk or --file)", "examples": [ "<%= config.bin %> <%= command.id %> MyTemplate_1", "<%= config.bin %> <%= command.id %> MyTemplate_1 --file ./copado/templates/MyTemplate_1.metadata.json", "<%= config.bin %> <%= command.id %> MyTemplate_1 --name \"My Template\" --steps-file ./steps.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "description": { "description": "Template description", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "description": "Path to a JSON file with the full upsert payload (legacy deploy format accepted)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Template display name (defaults to the API name argument)", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "steps-file": { "description": "Path to a JSON file containing the steps array", "name": "steps-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Template type (for example Custom)", "name": "type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "description": "Template version", "name": "version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "volume-options": { "description": "Template volume options as a JSON string or plain string", "name": "volume-options", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:template:upsert", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "template", "upsert.js" ] }, "cicd:user:get": { "aliases": [], "args": {}, "description": "Get a Copado user by ID (defaults to the authenticated user)", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --id me", "<%= config.bin %> <%= command.id %> --id 005000000000000", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "id": { "description": "User ID, or \"me\" for the authenticated user", "name": "id", "default": "me", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:user:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "user", "get.js" ] }, "cicd:work:ahead-behind": { "aliases": [], "args": { "environment": { "description": "Copado environment Id or name (defaults to the configured project default environment)", "name": "environment", "required": false } }, "description": "Compare user stories ahead of and behind the next pipeline environment. Resolves the project (and its pipeline) from the project default or --project, finds the unique next environment from pipeline connections for the given or default environment, then GET /agentia/headless/work/user-stories-ahead-behind.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> dev1", "<%= config.bin %> <%= command.id %> a0E... --project a0w...", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "description": "Copado project Id (defaults to the configured project default)", "name": "project", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:ahead-behind", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "ahead-behind.js" ] }, "cicd:work:commit": { "aliases": [], "args": { "id": { "description": "User story ID (defaults to the active work item from `work set`)", "name": "id", "required": false } }, "description": "Compatibility alias of cicd cloud commit. Create a Copado cloud metadata commit for a user story. Prefer: agentia cicd cloud commit.", "examples": [ "<%= config.bin %> cicd cloud commit --message \"Commit AccountService\" --metadata-name AccountService --metadata-type ApexClass --metadata-category SFDX --action Add", "<%= config.bin %> <%= command.id %> --cloud --message \"Commit AccountService\" --metadata-name AccountService --metadata-type ApexClass --metadata-category SFDX --action Add" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "action": { "description": "Metadata action for simple flag input. Defaults to Add.", "name": "action", "hasDynamicHelp": false, "multiple": false, "options": [ "Add", "Delete", "RetrieveOnly", "SelectiveCommit", "Full" ], "type": "option" }, "base-branch": { "description": "Optional base branch to include in the commit request.", "name": "base-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cloud": { "description": "Ignored. Cloud is implied by cicd cloud commit.", "hidden": true, "name": "cloud", "allowNo": false, "type": "boolean" }, "commit-id": { "description": "Existing local Git commit identifier to register when --no-execute-commit is used.", "name": "commit-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "execute-commit": { "description": "Execute the Copado commit job. Use --no-execute-commit only with --commit-id.", "name": "execute-commit", "allowNo": true, "type": "boolean" }, "file": { "char": "f", "description": "Path to a JSON commit request body.", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "message": { "char": "m", "description": "Commit message. Required unless provided by JSON input.", "name": "message", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-category": { "description": "Required metadata category for simple input. Maps to change field c. For Salesforce metadata, set SFDX so Copado stores c:SFDX. Without c:SFDX, SFDX deploy steps log \"Salesforce changes not found.\" and skip the deploy while the job can still report Successful.", "name": "metadata-category", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-message": { "description": "Optional per-change message for simple flag input.", "name": "metadata-message", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-name": { "description": "Metadata full name for simple flag input.", "name": "metadata-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-raw-json": { "description": "Optional raw metadata JSON value for simple flag input.", "name": "metadata-raw-json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-type": { "description": "Metadata type for simple flag input, for example ApexClass.", "name": "metadata-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "recreate-feature-branch": { "description": "Ask Copado to recreate the feature branch before committing.", "name": "recreate-feature-branch", "allowNo": false, "type": "boolean" }, "selection": { "description": "Selected file inside a bundle for SelectiveCommit. Can be provided multiple times.", "name": "selection", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "stdin": { "description": "Read a JSON commit request body from stdin.", "name": "stdin", "allowNo": false, "type": "boolean" }, "wait": { "description": "Poll the commit job to a terminal status when a jobExecution Id is returned.", "name": "wait", "allowNo": true, "type": "boolean" }, "wait-timeout": { "description": "Maximum seconds to wait for the commit job.", "name": "wait-timeout", "default": 300, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "cicd:work:commit", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "commit.js" ] }, "cicd:work:create": { "aliases": [], "args": {}, "description": "Create a Copado user story", "examples": [ "<%= config.bin %> <%= command.id %> --title \"My story\" --status Draft", "<%= config.bin %> <%= command.id %> --title \"My story\" --custom-field JIRA_Key__c=CICD-1", "<%= config.bin %> <%= command.id %> --title \"My story\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "excluded-from-cbm": { "description": "Exclude from CBM", "name": "excluded-from-cbm", "allowNo": true, "type": "boolean" }, "custom-field": { "description": "Subscriber custom field as ApiName=value (string value). Repeat for multiple fields; duplicate apiNames are rejected.", "name": "custom-field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "actual-points": { "description": "Actual points", "name": "actual-points", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "planned-points": { "description": "Planned points", "name": "planned-points", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "priority": { "description": "Priority", "name": "priority", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "acceptance-criteria": { "description": "Acceptance criteria (maximum 255 characters)", "name": "acceptance-criteria", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "as-a": { "description": "User story \"as a\" clause (maximum 255 characters)", "name": "as-a", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "assignee": { "description": "Assignee ID", "name": "assignee", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cancellation-reason": { "description": "Cancellation reason", "name": "cancellation-reason", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "close-date": { "description": "Close date", "name": "close-date", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "epic": { "description": "Epic", "name": "epic", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "feature": { "description": "Feature", "name": "feature", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "functional-requirements": { "description": "Functional requirements (maximum 30000 characters)", "name": "functional-requirements", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "owner-id": { "description": "Owner ID", "name": "owner-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project": { "description": "Project ID", "name": "project", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "record-type": { "description": "Record type", "name": "record-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "release-id": { "description": "Release ID", "name": "release-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "so-that": { "description": "User story \"so that\" clause (maximum 255 characters)", "name": "so-that", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-credential": { "description": "Source credential ID. When set, sourceEnvironment is sent as null so Salesforce assigns the environment from the credential.", "name": "source-credential", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-environment": { "description": "Source environment ID. Ignored when --source-credential is also set.", "name": "source-environment", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sprint-id": { "description": "Sprint ID", "name": "sprint-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Status", "name": "status", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "description": "Team", "name": "team", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "technical-specifications": { "description": "Technical specifications (maximum 30000 characters)", "name": "technical-specifications", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "theme": { "description": "Theme", "name": "theme", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "title": { "description": "Title (maximum 255 characters)", "name": "title", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "want-to": { "description": "User story \"want to\" clause (maximum 255 characters)", "name": "want-to", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "create.js" ] }, "cicd:work:delete": { "aliases": [], "args": { "id": { "description": "User story ID", "name": "id", "required": true } }, "description": "Delete a Copado user story by ID", "examples": [ "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "delete.js" ] }, "cicd:work:done": { "aliases": [], "args": {}, "description": "Alias of cicd work submit --done. Matches Copado UI Submit when promoting (not validate-only). Prefer: agentia cicd work submit --done.", "examples": [ "<%= config.bin %> cicd work submit --done", "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --skip-nested-metadata-detection", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "skip-nested-metadata-detection": { "description": "Do not detect the nested metadata changed across the branch when pushing (also configurable via skipNestedMetadataDetection in .agentia/config.json or .agentia/config.user.json)", "name": "skip-nested-metadata-detection", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:done", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "done.js" ] }, "cicd:work:environment-sync": { "aliases": [], "args": {}, "description": "Sync committed metadata from the next environment onto the destination environment (or current feature branch). Back-promotes every user story behind the destination environment from the next environment branch. GET user stories ahead and behind. If none are behind, log that and stop. Otherwise create a back-promotion and POST those behind stories onto the promotion. Resolves the next-environment Git branch from --destination-environment or --dev-org-branch (the dest pipeline connection destinationBranch, or that destination environment's outbound branch). Merges origin/ with --no-ff --no-commit, restores every other path from HEAD, commits the guessed pathspecs, and pushes the dest org branch (and the feature branch when HEAD starts with feature/). If guessed pathspecs still conflict, PATCH the back-promotion status to Merge Conflict, store lastEnvironmentSyncName, resolve the files, and re-run with --continue (optional --promotion). The promotion destination environment supplies the dest org branch and the next-env branch. To discard a conflicted merge, re-run with --abort (optional --promotion); runs git merge --abort and sets the back-promotion status to Draft. After a successful sync, PATCH the back-promotion status to Completed and clear lastEnvironmentSyncName. On git/merge failure (including conflicts) and after a successful --continue, uploads the captured command transcript as a Salesforce File on the back-promotion (`Environment Sync Logs .txt`) via `/agentia/headless/file/upload`. HTTP 404 is ignored until that endpoint is rolled out; other upload failures are warned and do not change the environment-sync outcome.", "examples": [ "<%= config.bin %> <%= command.id %> --destination-environment=dev1", "<%= config.bin %> <%= command.id %> --dev-org-branch=dev1-sfp", "<%= config.bin %> <%= command.id %> --continue", "<%= config.bin %> <%= command.id %> --abort", "<%= config.bin %> <%= command.id %> --promotion=P29334 --continue", "<%= config.bin %> <%= command.id %> --destination-environment=dev1 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "abort": { "description": "Abort an in-progress merge (`git merge --abort`) and set the back-promotion status to Draft. Uses --promotion or lastEnvironmentSyncName. Exclusive with --continue.", "exclusive": [ "continue" ], "name": "abort", "allowNo": false, "type": "boolean" }, "continue": { "description": "Finish after merge conflicts. If the merge is still in progress (conflicts fixed and staged, but not committed), commits it; if you already committed, continues from there through the remaining git steps. Uses --promotion or lastEnvironmentSyncName.", "exclusive": [ "abort" ], "name": "continue", "allowNo": false, "type": "boolean" }, "destination-credential": { "description": "Credential ID posted as destinationCredentialId when creating the back-promotion. Copado requires a credential on the next/source environment (PRO-033 if a dest/dev credential is sent) and then stores the dest/dev credential. Defaults to that source environment defaultCredential, otherwise the first source credential.", "name": "destination-credential", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "destination-environment": { "description": "Destination org environment name or Id. Resolves to that environment's pipeline connection Git branch.", "exclusive": [ "dev-org-branch" ], "name": "destination-environment", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dev-org-branch": { "description": "Destination org Git branch. Defaults to lastDevOrgBranch from `cicd work set`.", "exclusive": [ "destination-environment" ], "name": "dev-org-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline ID. Defaults to the active work item from `cicd work set`.", "name": "pipeline-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "promotion": { "description": "Back-promotion Id or name to PATCH when this run stops on merge conflicts, finishes successfully, continues, or aborts. Optional for --continue/--abort when lastEnvironmentSyncName was stored from a prior environment-sync run. Defaults to the back-promotion created in this run.", "name": "promotion", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:environment-sync", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "environment-sync.js" ] }, "cicd:work:get": { "aliases": [], "args": { "id": { "description": "User story ID (defaults to the active work item from `work set`)", "name": "id", "required": false } }, "description": "Get a Copado user story by ID", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --json", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --committed-metadata", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --committed-metadata --json", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --user-stories-ahead-behind", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --user-stories-ahead-behind --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "committed-metadata": { "description": "Also include the Story committed metadata list in output", "name": "committed-metadata", "allowNo": false, "type": "boolean" }, "user-stories-ahead-behind": { "description": "When the user story has a pipeline and source environment, compare user stories ahead of and behind the next pipeline environment", "name": "user-stories-ahead-behind", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "get.js" ] }, "cicd:work:list": { "aliases": [], "args": {}, "description": "List Copado user stories", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --status \"In Progress\" --project-name MyProject", "<%= config.bin %> <%= command.id %> --assigned-to-me", "<%= config.bin %> <%= command.id %> --owned-by-me", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "assigned-to-me": { "description": "Filter by the current user as assignee", "name": "assigned-to-me", "allowNo": false, "type": "boolean" }, "assignee-id": { "description": "Filter by assignee ID", "name": "assignee-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "assignee-name": { "description": "Filter by assignee name", "name": "assignee-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Filter by name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "owned-by-me": { "description": "Filter by the current user as owner", "name": "owned-by-me", "allowNo": false, "type": "boolean" }, "owner-id": { "description": "Filter by owner ID", "name": "owner-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "owner-name": { "description": "Filter by owner name", "name": "owner-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "description": "Filter by project ID", "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-name": { "description": "Filter by project name", "name": "project-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Filter by status", "name": "status", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "title": { "description": "Filter by title", "name": "title", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "list.js" ] }, "cicd:work:open": { "aliases": [], "args": { "id": { "description": "User story ID (defaults to the active work item from `work set`)", "name": "id", "required": false } }, "description": "Open a Copado user story in the browser", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "open.js" ] }, "cicd:work:promote": { "aliases": [], "args": { "userStoryIds": { "description": "User story ID. Pass more than one to merge those feature branches in order. Omit when using --promotion with --continue or --abort.", "multiple": true, "name": "userStoryIds", "required": false } }, "description": "Experimental: skips Quality Gates. Requires enableLocalPromote true in .agentia/config.json. Create a promotion for one or more user stories and merge each feature/ branch into promotion/. The promotion branch is created from the destination environment branch. Without --backpromote, the stories promote forward from their source environment to the next pipeline environment. With --backpromote, pass --destination-branch. The destination environment is the pipeline environment whose connection branch matches that name, and the source is the next environment above it. Story merges stop at the first conflict and the promotion status is set to Merge Conflict. Resolve those files, then re-run with --promotion= --continue to commit the merge, merge any remaining stories, and finish the promotion. To discard a conflicted merge, re-run with --promotion= --abort (runs git merge --abort and sets the promotion status to Draft). That continue command repeats --validate or --deploy and --sf-alias when the original command used them. After every story merges, the promotion branch is pushed. Without --validate or --deploy, the promotion status is set to Completed. With --validate or --deploy, --sf-alias is required. The command writes a temporary package.xml and postdestructivechanges.xml from the promotion metadata and runs sf project deploy start --test-level NoTestRun -o . --validate adds --dry-run, does not merge the destination branch, and sets the promotion status to Validated. --deploy merges the promotion branch into the destination branch and sets the promotion status to Completed only after that deployment succeeds. User story records are not updated.", "examples": [ "<%= config.bin %> <%= command.id %> a16P7000006By3pIAC", "<%= config.bin %> <%= command.id %> a16P7000006By3pIAC a16P7000006By4qIAC", "<%= config.bin %> <%= command.id %> a16P7000006By3pIAC --backpromote --destination-branch dev1-sfp", "<%= config.bin %> <%= command.id %> a16P7000006By3pIAC --validate --sf-alias destOrg", "<%= config.bin %> <%= command.id %> a16P7000006By3pIAC --deploy --sf-alias destOrg", "<%= config.bin %> <%= command.id %> --promotion=P29354 --continue", "<%= config.bin %> <%= command.id %> --promotion=P29354 --abort", "<%= config.bin %> <%= command.id %> a16P7000006By3pIAC --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "abort": { "description": "Abort an in-progress merge (`git merge --abort`) and set the promotion status to Draft. Requires --promotion. Exclusive with --continue.", "exclusive": [ "continue" ], "name": "abort", "allowNo": false, "type": "boolean" }, "backpromote": { "description": "Create a back promotion. Requires --destination-branch. Omit to promote forward to the next pipeline environment.", "name": "backpromote", "allowNo": false, "type": "boolean" }, "continue": { "description": "Commit a resolved merge on promotion/ and finish the remaining story merges. Requires --promotion.", "exclusive": [ "abort" ], "name": "continue", "allowNo": false, "type": "boolean" }, "deploy": { "description": "Deploy the promotion metadata with sf project deploy start, then merge the promotion branch into the destination branch and set the promotion status to Completed. Requires --sf-alias.", "exclusive": [ "validate" ], "name": "deploy", "allowNo": false, "type": "boolean" }, "destination-branch": { "dependsOn": [ "backpromote" ], "description": "Destination environment Git branch for --backpromote. The destination environment is the pipeline environment whose connection branch matches this name.", "name": "destination-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "destination-credential": { "description": "Credential ID posted as destinationCredentialId. Defaults to the destination environment default credential for a forward promotion, or the next/source environment default credential for --backpromote.", "name": "destination-credential", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "promotion": { "description": "Promotion Id or name for --continue after a merge conflict, or for --abort.", "name": "promotion", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sf-alias": { "description": "Salesforce org alias or username for --validate or --deploy. Passed to sf project deploy start -o.", "name": "sf-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "validate": { "description": "Validate the promotion metadata with sf project deploy start --dry-run. Does not merge the destination branch. Sets the promotion status to Validated. Requires --sf-alias.", "exclusive": [ "deploy" ], "name": "validate", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:promote", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": true, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "promote.js" ] }, "cicd:work:publish": { "aliases": [], "args": {}, "description": "Publish the current feature/ branch and register commits with Copado. Requires a clean working tree, base branch, and dev org branch from `.agentia/config.user.json`. Fetches origin/, then registers only commits in origin/..HEAD and diffs nested parent XML at merge-base(origin/, HEAD) versus HEAD, so origin/base-only history is ignored. When there are no commits since origin/, or origin already has HEAD, fails with \"No changes to publish\" unless `--permissions` and/or `--full-metadata` is set, in which case it creates an empty commit so a tip commit id exists. Applies Copado environment-variable then yaml replacements to the added and modified files in origin/..HEAD (passed to the jars as `--include`; yaml `-b` is the feature branch, matching Copado Commit), commits both as a single follow-up commit, locks the tip commit, runs `git push origin `, reports the nested metadata changed across the branch, such as the CustomField behind a profile field-permission edit, plus the parent components it would ignore, calls headless work/push with one changeListUpdate list of Action:MetadataType:MetadataName corrections: lastPermissionSelected and --permissions plus the nested metadata of the changed profiles and permission sets as RetrieveOnly, lastFullMetadataSelected and --full-metadata plus brand-new nested parent files as fullMetadata, the ignored parents as unchanged, the nested metadata deleted on the branch as Delete, and the remaining nested metadata as Add, then merges the feature branch into the recorded dev org branch. The changed profiles and permission sets themselves are never sent as corrections, so they stay in the change list and deploy only the permissions their RetrieveOnly entries select. Brand-new nested parent files are an exception: they are sent as fullMetadata so the complete file travels. After a successful register, uploads the captured command output as a Salesforce File on the user story (`Local Commit Logs .txt`) via `/agentia/headless/file/upload`. HTTP 404 is ignored until that endpoint is rolled out; other upload failures are warned and do not fail the publish. `--dry-run` runs commit collection, replacements, and nested detection, logs the changeListUpdate that would be sent, skips empty/replacement commits, tip lock, git push, headless register, log upload, and dev-org sync, then restores only the tracked files dirtied by replacements (untracked files are left alone). `cicd work push` is a compatibility alias of this command.\n\nLOCAL DEVELOPMENT FLOW:\n\n # prepare feature branch from pipeline settings\n agentia cicd work set \n\n # develop locally (retrieve/deploy to the Dev org as needed)\n git add … && git commit -m \" \"\n\n # optional: run local quality gates\n agentia cicd work test\n\n # push commits and register them in Copado\n agentia cicd work publish [--permissions=…] [--full-metadata=…]\n\n # validate and open the merge-request flow\n agentia cicd work submit [--skip-local-tests] [--skip-pull-request]\n\n # if warned about user stories ahead on the destination\n agentia cicd work environment-sync\n # after resolving pathspec conflicts (uses lastEnvironmentSyncName when set):\n agentia cicd work environment-sync --continue\n\n # when ready to promote and deploy\n agentia cicd work submit --done [--skip-local-tests] [--skip-pull-request]", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --dry-run", "<%= config.bin %> <%= command.id %> --permissions CustomField:Account.SLA__c,ApexClass:AccountService", "<%= config.bin %> <%= command.id %> --full-metadata PermissionSet:Sales_Onboarding", "<%= config.bin %> <%= command.id %> --skip-nested-metadata-detection", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dry-run": { "description": "Preview publish: run commit collection, Copado replacements, and nested metadata detection; log the changeListUpdate that would be registered; do not commit, push, lock, register, or sync the dev org branch. Restores dirtied tracked files afterward. Requires a clean tracked working tree.", "name": "dry-run", "allowNo": false, "type": "boolean" }, "full-metadata": { "description": "Comma-separated Type:Name metadata such as Profile:Sales_User,PermissionSet:Sales_Onboarding. Allowed types: Profile, PermissionSet, MutingPermissionSet, CustomObject, CustomObjectTranslation. Added for this publish and sent as headless push fullMetadata corrections. The named metadata is committed as a complete file, so it is never decomposed into nested metadata. Not stored.", "name": "full-metadata", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "permissions": { "description": "Comma-separated type-prefixed metadata such as CustomField:Account.SLA__c,ApexClass:AccountService, added for this publish and sent as headless push RetrieveOnly corrections. Not stored.", "name": "permissions", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "skip-nested-metadata-detection": { "description": "Do not detect the nested metadata changed across the branch (also configurable via skipNestedMetadataDetection in .agentia/config.json or .agentia/config.user.json)", "name": "skip-nested-metadata-detection", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:publish", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "publish.js" ] }, "cicd:work:push": { "aliases": [], "args": {}, "description": "Alias of cicd work publish. Publishes the current feature/ branch and registers commits with Copado. Prefer: agentia cicd work publish.", "examples": [ "<%= config.bin %> cicd work publish", "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --skip-nested-metadata-detection", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dry-run": { "description": "Preview publish: run commit collection, Copado replacements, and nested metadata detection; log the changeListUpdate that would be registered; do not commit, push, lock, register, or sync the dev org branch. Restores dirtied tracked files afterward. Requires a clean tracked working tree.", "name": "dry-run", "allowNo": false, "type": "boolean" }, "full-metadata": { "description": "Comma-separated Type:Name metadata such as Profile:Sales_User,PermissionSet:Sales_Onboarding. Allowed types: Profile, PermissionSet, MutingPermissionSet, CustomObject, CustomObjectTranslation. Added for this publish and sent as headless push fullMetadata corrections. The named metadata is committed as a complete file, so it is never decomposed into nested metadata. Not stored.", "name": "full-metadata", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "permissions": { "description": "Comma-separated type-prefixed metadata such as CustomField:Account.SLA__c,ApexClass:AccountService, added for this publish and sent as headless push RetrieveOnly corrections. Not stored.", "name": "permissions", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "skip-nested-metadata-detection": { "description": "Do not detect the nested metadata changed across the branch (also configurable via skipNestedMetadataDetection in .agentia/config.json or .agentia/config.user.json)", "name": "skip-nested-metadata-detection", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:push", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "push.js" ] }, "cicd:work:set": { "aliases": [], "args": { "id": { "description": "User story ID or name (omit with --none)", "name": "id", "required": false } }, "description": "Set the active work item and prepare a local feature branch. Calls the CICD gateway work/set endpoint, requires a clean tracked working tree, fetches the work item base branch from origin, fetches the feature branch when it exists on origin, then creates or checks out feature/ from the remote feature branch when present, otherwise from the base branch. A gateway warning prints the message, skips git, clears lastBaseBranch/lastDevOrgBranch/lastPullRequestBaseUrl, and records lastWorkItemId/lastWorkItem/lastWorkItemTitle from the returned work item. After work/set returns, compares the Story source credential with the CICD project default: warns when the Story credential is missing, skips comparison when a bound Story has no project default, and warns without changing the Story when they differ (shows the current credential and environment; use work update to change it). With --none, clears every last* key from `.agentia/config.user.json` and checks out the previous lastBaseBranch when present, else main, else master, else stays put.\n\nLOCAL DEVELOPMENT FLOW:\n\n # prepare feature branch from pipeline settings\n agentia cicd work set \n\n # develop locally (retrieve/deploy to the Dev org as needed)\n git add … && git commit -m \" \"\n\n # optional: run local quality gates\n agentia cicd work test\n\n # push commits and register them in Copado\n agentia cicd work publish [--permissions=…] [--full-metadata=…]\n\n # validate and open the merge-request flow\n agentia cicd work submit [--skip-local-tests] [--skip-pull-request]\n\n # if warned about user stories ahead on the destination\n agentia cicd work environment-sync\n # after resolving pathspec conflicts (uses lastEnvironmentSyncName when set):\n agentia cicd work environment-sync --continue\n\n # when ready to promote and deploy\n agentia cicd work submit --done [--skip-local-tests] [--skip-pull-request]", "examples": [ "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU", "<%= config.bin %> <%= command.id %> US-0001 --json", "<%= config.bin %> <%= command.id %> US-0001 --base-branch develop", "<%= config.bin %> <%= command.id %> --none" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "base-branch": { "description": "Override the base branch returned by the work/set endpoint", "name": "base-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "none": { "description": "Clear every last* key from `.agentia/config.user.json` and check out lastBaseBranch, else main, else master.", "name": "none", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:set", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "set.js" ] }, "cicd:work:status": { "aliases": [], "args": { "id": { "description": "User story ID or name (defaults to the last work item from `work set`)", "name": "id", "required": false } }, "description": "Get status for a work item, including related job executions. Includes local branch metadata when lastBaseBranch is recorded by `work set`. Uses the given user story ID/name, or the last work item from `agentia cicd work set`. Use --metadata-list-only to retrieve only local branch metadata without an API call.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> US-0001", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --json", "<%= config.bin %> <%= command.id %> --metadata-list-only" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "metadata-list-only": { "description": "Return only local branch metadata without calling the CICD API", "name": "metadata-list-only", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:status", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "status.js" ] }, "cicd:work:submit": { "aliases": [], "args": {}, "description": "Submit the current feature/ work item for pipeline quality gates and validation. Runs project-root .agentia_quality_gates.sh (macOS/Linux) or .agentia_quality_gates.cmd (Windows) when present, pushes and registers commits when the branch is ahead of origin, then calls headless work/submit (Promote Action with validate=true). When the last pending related job template name contains Commit, waits up to 5 minutes for that job before submitting. Before submit or promote, counts user stories ahead and behind between the source environment and the next pipeline environment, and warns when stories behind might cause promotion conflicts (advising `agentia cicd work environment-sync`). After a successful submit or promote, uploads the captured command output as a Salesforce File on the user story (`Local Commit Logs .txt`) via `/agentia/headless/file/upload`. HTTP 404 is ignored until that endpoint is rolled out; other upload failures are warned and do not fail the command. With --done or --deploy, matches Copado UI Submit when promoting (validate=false / headless work/done). cicd work done is a compatibility alias of this command with --done.\n\nLOCAL DEVELOPMENT FLOW:\n\n # prepare feature branch from pipeline settings\n agentia cicd work set \n\n # develop locally (retrieve/deploy to the Dev org as needed)\n git add … && git commit -m \" \"\n\n # optional: run local quality gates\n agentia cicd work test\n\n # push commits and register them in Copado\n agentia cicd work publish [--permissions=…] [--full-metadata=…]\n\n # validate and open the merge-request flow\n agentia cicd work submit [--skip-local-tests] [--skip-pull-request]\n\n # if warned about user stories ahead on the destination\n agentia cicd work environment-sync\n # after resolving pathspec conflicts (uses lastEnvironmentSyncName when set):\n agentia cicd work environment-sync --continue\n\n # when ready to promote and deploy\n agentia cicd work submit --done [--skip-local-tests] [--skip-pull-request]", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --apex-test-classes=MyTest,OtherTest", "<%= config.bin %> <%= command.id %> --skip-local-tests", "<%= config.bin %> <%= command.id %> --skip-pull-request", "<%= config.bin %> <%= command.id %> --done", "<%= config.bin %> <%= command.id %> --deploy", "<%= config.bin %> <%= command.id %> --done --skip-nested-metadata-detection", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "skip-nested-metadata-detection": { "description": "Do not detect the nested metadata changed across the branch when pushing (also configurable via skipNestedMetadataDetection in .agentia/config.json or .agentia/config.user.json)", "name": "skip-nested-metadata-detection", "allowNo": false, "type": "boolean" }, "apex-test-classes": { "description": "Comma-separated Apex test class names passed to local quality gates as AGENTIA_APEX_TEST_CLASSES", "name": "apex-test-classes", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "deploy": { "description": "Alias of --done: promote instead of validate-only (Copado UI Submit promote)", "name": "deploy", "allowNo": false, "type": "boolean" }, "done": { "description": "Promote instead of validate-only (Copado UI Submit promote); honors --skip-nested-metadata-detection. --deploy is an alias of --done.", "name": "done", "allowNo": false, "type": "boolean" }, "skip-local-tests": { "description": "Skip running local quality gates scripts in the project root", "name": "skip-local-tests", "allowNo": false, "type": "boolean" }, "skip-pull-request": { "description": "Do not open the pull request compare URL after submit (also configurable via skipPullRequest in .agentia/config.json or .agentia/config.user.json)", "name": "skip-pull-request", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:submit", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "submit.js" ] }, "cicd:work:test": { "aliases": [], "args": {}, "description": "Run quality gates for the current work item. With --local (the default) it runs project-root .agentia_quality_gates.sh (macOS/Linux) or .agentia_quality_gates.cmd (Windows) when present. When no project script exists it warns, runs the stock Agentia setup sample from a temporary file, then deletes that file. With --cloud it runs remote Copado quality gates (not implemented yet).", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --local --apex-test-classes=MyTest,OtherTest", "<%= config.bin %> <%= command.id %> --local --rerun-failed-apex-tests", "<%= config.bin %> <%= command.id %> -e SKIP_LWC_TESTS=1 -e TOOL_API_KEY=secret", "<%= config.bin %> <%= command.id %> --json", "<%= config.bin %> <%= command.id %> --cloud" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "apex-test-classes": { "description": "Comma-separated Apex test class names passed to local quality gates as AGENTIA_APEX_TEST_CLASSES", "name": "apex-test-classes", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cloud": { "description": "Run remote Copado quality gates (not implemented yet).", "name": "cloud", "allowNo": false, "type": "boolean" }, "env": { "char": "e", "description": "Extra environment variable for the quality-gate script as NAME=value. Repeatable. Applied before reserved AGENTIA_APEX_* variables.", "name": "env", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "local": { "description": "Run local project-root quality gates scripts. Used by default when --cloud is omitted.", "name": "local", "allowNo": false, "type": "boolean" }, "rerun-failed-apex-tests": { "description": "Pass AGENTIA_APEX_RERUN_FAILED=--rerun-failed-apex-tests to local quality gates so sample scripts forward that flag to work test apex.", "name": "rerun-failed-apex-tests", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:test", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "test.js" ] }, "cicd:work:update": { "aliases": [], "args": { "id": { "description": "User story ID (defaults to the active work item from `work set`)", "name": "id", "required": false } }, "description": "Update a Copado user story by ID", "examples": [ "<%= config.bin %> <%= command.id %> --title \"Updated story\"", "<%= config.bin %> <%= command.id %> --custom-field JIRA_Key__c=CICD-1", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --title \"Updated story\"", "<%= config.bin %> <%= command.id %> a0SKC000000CmZ2AU --status \"In Progress\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "excluded-from-cbm": { "description": "Exclude from CBM", "name": "excluded-from-cbm", "allowNo": true, "type": "boolean" }, "custom-field": { "description": "Subscriber custom field as ApiName=value (string value). Repeat for multiple fields; duplicate apiNames are rejected.", "name": "custom-field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "actual-points": { "description": "Actual points", "name": "actual-points", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "planned-points": { "description": "Planned points", "name": "planned-points", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "priority": { "description": "Priority", "name": "priority", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "acceptance-criteria": { "description": "Acceptance criteria (maximum 255 characters)", "name": "acceptance-criteria", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "as-a": { "description": "User story \"as a\" clause (maximum 255 characters)", "name": "as-a", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "assignee": { "description": "Assignee ID", "name": "assignee", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cancellation-reason": { "description": "Cancellation reason", "name": "cancellation-reason", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "close-date": { "description": "Close date", "name": "close-date", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "epic": { "description": "Epic", "name": "epic", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "feature": { "description": "Feature", "name": "feature", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "functional-requirements": { "description": "Functional requirements (maximum 30000 characters)", "name": "functional-requirements", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "owner-id": { "description": "Owner ID", "name": "owner-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project": { "description": "Project ID", "name": "project", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "record-type": { "description": "Record type", "name": "record-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "release-id": { "description": "Release ID", "name": "release-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "so-that": { "description": "User story \"so that\" clause (maximum 255 characters)", "name": "so-that", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-credential": { "description": "Source credential ID. When set, sourceEnvironment is sent as null so Salesforce assigns the environment from the credential.", "name": "source-credential", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-environment": { "description": "Source environment ID. Ignored when --source-credential is also set.", "name": "source-environment", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sprint-id": { "description": "Sprint ID", "name": "sprint-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Status", "name": "status", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "description": "Team", "name": "team", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "technical-specifications": { "description": "Technical specifications (maximum 30000 characters)", "name": "technical-specifications", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "theme": { "description": "Theme", "name": "theme", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "title": { "description": "Title (maximum 255 characters)", "name": "title", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "want-to": { "description": "User story \"want to\" clause (maximum 255 characters)", "name": "want-to", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "update.js" ] }, "setup:skills:create": { "aliases": [], "args": {}, "description": "Create portable Markdown-only Agentia CLI skills in this project without overwriting managed files", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --adv --target agents --no-prompt", "<%= config.bin %> <%= command.id %> --cicd --target agents --no-prompt", "<%= config.bin %> <%= command.id %> --testing --ai --target cursor --no-prompt", "<%= config.bin %> <%= command.id %> --json", "<%= config.bin %> <%= command.id %> --plugin @acme/agentia-plugin-release --target cursor --no-prompt" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "adv": { "description": "Create the Copado Pipelines Advanced skill pack", "name": "adv", "allowNo": false, "type": "boolean" }, "ai": { "description": "Create the Copado AI agent skill pack", "name": "ai", "allowNo": false, "type": "boolean" }, "cicd": { "description": "Create the Copado CICD skill pack", "name": "cicd", "allowNo": false, "type": "boolean" }, "force": { "description": "Replace conflicting unmanaged Agentia skill or rules files", "name": "force", "allowNo": false, "type": "boolean" }, "no-prompt": { "char": "n", "description": "Skip interactive prompts; defaults the target to .agents/skills when --target is omitted", "name": "no-prompt", "allowNo": false, "type": "boolean" }, "plugin": { "description": "Also install the skills this installed plugin contributes through its agentia:contribute hook (repeatable). Without pack flags only plugin skills are written", "name": "plugin", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "target": { "description": "Project skill root to write (repeatable)", "name": "target", "hasDynamicHelp": false, "multiple": true, "options": [ "agents", "cursor", "claude" ], "type": "option" }, "testing": { "description": "Create the Copado Robotic Testing skill pack", "name": "testing", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "setup:skills:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "setup", "skills", "create.js" ] }, "setup:skills:list": { "aliases": [], "args": {}, "description": "List skills that installed plugins contribute through their agentia:contribute hook (what \"setup skills create|update --plugin\" can install) and why invalid ones are skipped", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --plugin @acme/agentia-plugin-release --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "plugin": { "description": "Only list skills from this installed plugin (repeatable)", "name": "plugin", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "setup:skills:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "setup", "skills", "list.js" ] }, "setup:skills:update": { "aliases": [], "args": {}, "description": "Update Agentia-managed Markdown skill files and restore missing files in this project; without flags it also refreshes plugin skills already installed", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --ai --target cursor --no-prompt", "<%= config.bin %> <%= command.id %> --adv --target agents --no-prompt", "<%= config.bin %> <%= command.id %> --cicd --testing --target agents --no-prompt", "<%= config.bin %> <%= command.id %> --force --json", "<%= config.bin %> <%= command.id %> --prune --target cursor --no-prompt", "<%= config.bin %> <%= command.id %> --plugin @acme/agentia-plugin-release --target cursor --no-prompt" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "adv": { "description": "Update the Copado Pipelines Advanced skill pack", "name": "adv", "allowNo": false, "type": "boolean" }, "ai": { "description": "Update the Copado AI agent skill pack", "name": "ai", "allowNo": false, "type": "boolean" }, "cicd": { "description": "Update the Copado CICD skill pack", "name": "cicd", "allowNo": false, "type": "boolean" }, "force": { "description": "Replace conflicting unmanaged Agentia skill or rules files", "name": "force", "allowNo": false, "type": "boolean" }, "no-prompt": { "char": "n", "description": "Skip interactive prompts; defaults the target to .agents/skills when --target is omitted", "name": "no-prompt", "allowNo": false, "type": "boolean" }, "plugin": { "description": "Also install the skills this installed plugin contributes through its agentia:contribute hook (repeatable). Without pack flags only plugin skills are written", "name": "plugin", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "prune": { "description": "Also delete installed plugin skills whose plugin is uninstalled or no longer contributes them (only files carrying that plugin's managed marker)", "exclusive": [ "plugin" ], "name": "prune", "allowNo": false, "type": "boolean" }, "target": { "description": "Project skill root to write (repeatable)", "name": "target", "hasDynamicHelp": false, "multiple": true, "options": [ "agents", "cursor", "claude" ], "type": "option" }, "testing": { "description": "Update the Copado Robotic Testing skill pack", "name": "testing", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "setup:skills:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "setup", "skills", "update.js" ] }, "testing:data-table:create": { "aliases": [], "args": {}, "description": "Create a Copado Robotic Testing data table", "examples": [ "<%= config.bin %> <%= command.id %> --project --name Customers --file customers.csv --yes", "<%= config.bin %> <%= command.id %> --project --name Customers --json-data '[[\"name\"],[\"Alice\"]]' --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "job": { "description": "Optional CRT job ID filter.", "name": "job", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "description": "Read data from a CSV, TSV, JSON, or XLSX file.", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "header": { "description": "Location of variable headers in imported data.", "name": "header", "default": "row", "hasDynamicHelp": false, "multiple": false, "options": [ "row", "column" ], "type": "option" }, "json-data": { "description": "Inline JSON array of row arrays. Mutually exclusive with --file/--stdin.", "name": "json-data", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read CSV, TSV, or JSON data from stdin.", "name": "stdin", "allowNo": false, "type": "boolean" }, "ai-generated": { "description": "Mark the table as AI-generated.", "name": "ai-generated", "allowNo": false, "type": "boolean" }, "default-row": { "description": "Default dataset row (1-based).", "name": "default-row", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Data-table name.", "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "topics": { "description": "Comma-separated topic tags.", "name": "topics", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Confirm creation after reviewing or bypassing preview.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:data-table:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "data-table", "create.js" ] }, "testing:data-table:delete": { "aliases": [], "args": { "id": { "description": "CRT data-table ID.", "name": "id", "required": true } }, "description": "Delete a Copado Robotic Testing data table", "examples": [ "<%= config.bin %> <%= command.id %> --project --yes", "<%= config.bin %> <%= command.id %> --project --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "job": { "description": "Optional CRT job ID filter.", "name": "job", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Confirm data-table deletion.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:data-table:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "data-table", "delete.js" ] }, "testing:data-table:export": { "aliases": [], "args": { "id": { "description": "CRT data-table ID.", "name": "id", "required": true } }, "description": "Export a Copado Robotic Testing data table", "examples": [ "<%= config.bin %> <%= command.id %> --project --output table.csv", "<%= config.bin %> <%= command.id %> --project --datasets 1-3 --output table.xlsx --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "job": { "description": "Optional CRT job ID filter.", "name": "job", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "revision": { "char": "r", "description": "Specific data-table revision/version.", "name": "revision", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "datasets": { "description": "1-based dataset list/ranges to export.", "name": "datasets", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "format": { "description": "Output format; defaults to the output extension.", "name": "format", "hasDynamicHelp": false, "multiple": false, "options": [ "csv", "tsv", "xlsx" ], "type": "option" }, "output": { "char": "o", "description": "Explicit local output file.", "name": "output", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Confirm overwriting an existing output file.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:data-table:export", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "data-table", "export.js" ] }, "testing:data-table:get": { "aliases": [], "args": { "id": { "description": "CRT data-table ID.", "name": "id", "required": true } }, "description": "Get a Copado Robotic Testing data table", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --datasets 1,3-5 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "job": { "description": "Optional CRT job ID filter.", "name": "job", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "revision": { "char": "r", "description": "Specific data-table revision/version.", "name": "revision", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "datasets": { "description": "1-based dataset list/ranges to return, for example 1,3-5.", "name": "datasets", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:data-table:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "data-table", "get.js" ] }, "testing:data-table:list": { "aliases": [], "args": {}, "description": "List Copado Robotic Testing data tables", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --job --name Customers --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "job": { "description": "Optional CRT job ID filter.", "name": "job", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "revision": { "char": "r", "description": "Specific data-table revision/version.", "name": "revision", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "fields": { "description": "Comma-separated server fields to return.", "name": "fields", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Exact data-table name filter.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:data-table:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "data-table", "list.js" ] }, "testing:data-table:update": { "aliases": [], "args": { "id": { "description": "CRT data-table ID.", "name": "id", "required": true } }, "description": "Update a Copado Robotic Testing data table", "examples": [ "<%= config.bin %> <%= command.id %> --project --file customers.csv --yes", "<%= config.bin %> <%= command.id %> --project --topics smoke,regression --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "job": { "description": "Optional CRT job ID filter.", "name": "job", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "description": "Read data from a CSV, TSV, JSON, or XLSX file.", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "header": { "description": "Location of variable headers in imported data.", "name": "header", "default": "row", "hasDynamicHelp": false, "multiple": false, "options": [ "row", "column" ], "type": "option" }, "json-data": { "description": "Inline JSON array of row arrays. Mutually exclusive with --file/--stdin.", "name": "json-data", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read CSV, TSV, or JSON data from stdin.", "name": "stdin", "allowNo": false, "type": "boolean" }, "ai-generated": { "description": "Set whether the table is AI-generated.", "name": "ai-generated", "hasDynamicHelp": false, "multiple": false, "options": [ "true", "false" ], "type": "option" }, "default-row": { "description": "Default dataset row (1-based).", "name": "default-row", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "topics": { "description": "Replacement comma-separated topics; pass an empty value to clear.", "name": "topics", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Confirm update after reviewing or bypassing preview.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:data-table:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "data-table", "update.js" ] }, "testing:job:create": { "aliases": [], "args": {}, "deprecateAliases": true, "description": "Create a Copado Robotic Testing job from uploaded files or Git storage", "examples": [ "<%= config.bin %> <%= command.id %> --project --robot --name \"Smoke\" --file tests.robot", "<%= config.bin %> <%= command.id %> --project --robot --name \"Smoke\" --dir tests --json", "<%= config.bin %> <%= command.id %> --project --robot --name \"Smoke\" --git-url https://github.com/acme/crt-tests.git --git-branch main" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dir": { "description": "Directory containing Robot Framework files to upload. Can be provided multiple times.", "name": "dir", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Robot Framework file to upload. Can be provided multiple times.", "name": "file", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "git-branch": { "description": "Git branch to use for a Git-backed CRT job. Mutually exclusive with --git-tag.", "name": "git-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-domain-credential": { "description": "CRT domain credential ID to use for Git repository access.", "name": "git-domain-credential", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-password": { "description": "Git password/token for repository access. Prefer --git-domain-credential when available.", "exclusive": [ "git-password-file", "git-password-stdin" ], "name": "git-password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-password-file": { "description": "Read a bounded Git password/token from a regular file.", "exclusive": [ "git-password", "git-password-stdin" ], "name": "git-password-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-password-stdin": { "description": "Read a Git password/token from stdin.", "exclusive": [ "git-password", "git-password-file" ], "name": "git-password-stdin", "allowNo": false, "type": "boolean" }, "git-tag": { "description": "Git tag to use for a Git-backed CRT job. Mutually exclusive with --git-branch.", "name": "git-tag", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-url": { "description": "Git repository URL for a Git-backed CRT job.", "name": "git-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-use-caller-credentials": { "description": "Use caller credentials for Git repository access instead of explicit Git username/password.", "name": "git-use-caller-credentials", "allowNo": false, "type": "boolean" }, "git-username": { "description": "Git username for repository access. Prefer --git-domain-credential when available.", "name": "git-username", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "author-email": { "description": "Author email for initial file history.", "name": "author-email", "default": "agentia@copado.com", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "author-name": { "description": "Author name for initial file history.", "name": "author-name", "default": "Agentia CLI", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "base-path": { "description": "Require local files to stay within this directory.", "name": "base-path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "case-duration-change-detection": { "description": "Enable or disable duration analytics.", "name": "case-duration-change-detection", "allowNo": true, "type": "boolean" }, "description": { "description": "Job description.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dry-run": { "description": "Return a sanitized creation plan without network mutation.", "name": "dry-run", "allowNo": false, "type": "boolean" }, "message": { "description": "Commit message for initial file upload.", "name": "message", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Job name.", "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "parallel-mode": { "description": "Parallel execution mode.", "name": "parallel-mode", "hasDynamicHelp": false, "multiple": false, "options": [ "disabled", "enabled" ], "type": "option" }, "parent-commit": { "description": "Expected parent commit hash for initial upload.", "name": "parent-commit", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote-prefix": { "description": "Validated remote prefix for initial local files.", "name": "remote-prefix", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "robot": { "description": "CRT robot ID.", "name": "robot", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "screen-depth": { "description": "Screen color depth.", "name": "screen-depth", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "screen-height": { "description": "Screen height.", "name": "screen-height", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "screen-width": { "description": "Screen width.", "name": "screen-width", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "show-video-params": { "description": "Enable or disable video streaming and recording capabilities when running the test job.", "name": "show-video-params", "allowNo": true, "type": "boolean" }, "suite-type": { "description": "CRT suite/job type.", "name": "suite-type", "hasDynamicHelp": false, "multiple": false, "options": [ "bitbar", "browserstack", "browserstackdesktop", "default", "lambdatest", "lambdatestdesktop", "mobile", "paceconnectmobile", "privatemobile", "rpa", "selenese", "zap" ], "type": "option" }, "timeout": { "description": "Build timeout, for example 10m.", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "validation": { "description": "Ask CRT to validate the created job.", "name": "validation", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ "testing:create", "testing:test:create" ], "id": "testing:job:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "create.js" ] }, "testing:job:delete": { "aliases": [], "args": { "id": { "description": "CRT job ID.", "name": "id", "required": true } }, "description": "Delete a Copado Robotic Testing job", "examples": [ "<%= config.bin %> <%= command.id %> --project --yes", "<%= config.bin %> <%= command.id %> --project --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip the destructive confirmation prompt.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:job:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "delete.js" ] }, "testing:job:get": { "aliases": [], "args": { "id": { "description": "CRT job ID.", "name": "id", "required": true } }, "description": "Get a Copado Robotic Testing job from the project job list", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:job:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "get.js" ] }, "testing:job:list": { "aliases": [], "args": {}, "description": "List Copado Robotic Testing jobs in a project", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --name \"Smoke\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Case-insensitive exact job name to match client-side.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:job:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "list.js" ] }, "testing:job:refs": { "aliases": [], "args": { "id": { "description": "CRT job ID.", "name": "id", "required": true } }, "description": "List Git branches and tags for a Copado Robotic Testing job", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --shared-credentials --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "shared-credentials": { "description": "Use shared stored Git credentials.", "name": "shared-credentials", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:job:refs", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "refs.js" ] }, "testing:job:run": { "aliases": [], "args": { "id": { "description": "CRT job ID to run.", "name": "id", "required": true } }, "deprecateAliases": true, "description": "Run a Copado Robotic Testing job", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --param BROWSER=chrome --record failed", "<%= config.bin %> <%= command.id %> --project --no-wait --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "branch": { "description": "Git branch/ref to use for this run. Mutually exclusive with --tag.", "name": "branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "console-colors": { "description": "Control Robot Framework console colors.", "name": "console-colors", "hasDynamicHelp": false, "multiple": false, "options": [ "auto", "on", "ansi", "off" ], "type": "option" }, "console-width": { "description": "Set Robot Framework console width.", "name": "console-width", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "datatable": { "description": "Data table and 1-based datasets as TABLE_ID:1,2-4. Repeat for zipped table selections.", "name": "datatable", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "doc": { "description": "Set top-level Robot Framework suite documentation.", "name": "doc", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dry-run": { "description": "Validate Robot Framework data without executing library keywords.", "name": "dry-run", "allowNo": false, "type": "boolean" }, "exclude": { "description": "Robot Framework tag to exclude from this run. Can be provided multiple times.", "name": "exclude", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exit-on-error": { "description": "Stop execution when Robot Framework encounters a data or import error.", "name": "exit-on-error", "allowNo": false, "type": "boolean" }, "exit-on-failure": { "description": "Stop execution when a critical Robot Framework test fails.", "name": "exit-on-failure", "allowNo": false, "type": "boolean" }, "include": { "description": "Robot Framework tag to include in this run. Can be provided multiple times.", "name": "include", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "metadata": { "description": "Robot Framework suite metadata. Can be provided multiple times.", "name": "metadata", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "name": { "description": "Set the top-level Robot Framework suite name.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-exit-code": { "description": "Return exit code zero even when the CRT run fails.", "name": "no-exit-code", "allowNo": false, "type": "boolean" }, "param": { "description": "Execution parameter in KEY=VALUE format. Can be provided multiple times.", "name": "param", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "record": { "description": "CRT execution recording mode.", "name": "record", "hasDynamicHelp": false, "multiple": false, "options": [ "all", "failed", "none" ], "type": "option" }, "rerun-failed": { "description": "Rerun failed tests from the specified build/run ID. Mutually exclusive with --rerun-failed-from-latest.", "name": "rerun-failed", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "rerun-failed-from-latest": { "description": "Rerun failed tests from the latest failed run. Mutually exclusive with --rerun-failed.", "name": "rerun-failed-from-latest", "allowNo": false, "type": "boolean" }, "run-empty-suite": { "description": "Execute even when the selected Robot Framework suite is empty.", "name": "run-empty-suite", "allowNo": false, "type": "boolean" }, "run-type": { "description": "CRT run type. Regression is sent as normal; development is sent unchanged.", "name": "run-type", "hasDynamicHelp": false, "multiple": false, "options": [ "regression", "development" ], "type": "option" }, "save-artifacts": { "description": "Save the completed run output ZIP to this explicit file path.", "name": "save-artifacts", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "set-tag": { "description": "Set a tag on all executed tests. Can be provided multiple times.", "name": "set-tag", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "skip": { "description": "Skip tests matching this tag. Can be provided multiple times.", "name": "skip", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "skip-on-failure": { "description": "Skip failures for tests matching this tag. Can be provided multiple times.", "name": "skip-on-failure", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "stream-logs": { "description": "Print CRT run log output as the run executes (default, human output only). Use --no-stream-logs for a progress spinner instead.", "name": "stream-logs", "allowNo": true, "type": "boolean" }, "suite": { "description": "Select a Robot Framework suite. Can be provided multiple times.", "name": "suite", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "tag": { "description": "Git tag to use for this run. Mutually exclusive with --branch.", "name": "tag", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "test": { "description": "Select a Robot Framework test/task. Can be provided multiple times.", "name": "test", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "timeout": { "description": "Maximum number of minutes to wait for a terminal result.", "name": "timeout", "default": 60, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "variable": { "description": "Set a Robot Framework variable. Can be provided multiple times.", "name": "variable", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "wait": { "aliases": [ "wait-for-result" ], "deprecateAliases": true, "description": "Poll CRT until the started build reaches a terminal result (default). Use --no-wait to return once the run has been queued.", "name": "wait", "allowNo": true, "type": "boolean" }, "xunit": { "description": "Extract xunit_report.xml from completed run artifacts to this explicit file path.", "name": "xunit", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ "testing:run", "testing:build:run", "testing:test:run" ], "id": "testing:job:run", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "run.js" ] }, "testing:job:update": { "aliases": [], "args": { "id": { "description": "CRT job ID.", "name": "id", "required": true } }, "description": "Update Copado Robotic Testing job metadata", "examples": [ "<%= config.bin %> <%= command.id %> --project --name \"Smoke\"", "<%= config.bin %> <%= command.id %> --project --git-url https://github.com/acme/crt-tests.git --git-branch main", "<%= config.bin %> <%= command.id %> --project --git-branch feature/login-smoke", "<%= config.bin %> <%= command.id %> --project --timeout 10m --parallel-mode enabled --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-branch": { "description": "Git branch to use for a Git-backed CRT job. Mutually exclusive with --git-tag.", "name": "git-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-domain-credential": { "description": "CRT domain credential ID to use for Git repository access.", "name": "git-domain-credential", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-password": { "description": "Git password/token for repository access. Prefer --git-domain-credential when available.", "exclusive": [ "git-password-file", "git-password-stdin" ], "name": "git-password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-password-file": { "description": "Read a bounded Git password/token from a regular file.", "exclusive": [ "git-password", "git-password-stdin" ], "name": "git-password-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-password-stdin": { "description": "Read a Git password/token from stdin.", "exclusive": [ "git-password", "git-password-file" ], "name": "git-password-stdin", "allowNo": false, "type": "boolean" }, "git-tag": { "description": "Git tag to use for a Git-backed CRT job. Mutually exclusive with --git-branch.", "name": "git-tag", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-url": { "description": "Git repository URL for a Git-backed CRT job.", "name": "git-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-use-caller-credentials": { "description": "Use caller credentials for Git repository access instead of explicit Git username/password.", "name": "git-use-caller-credentials", "allowNo": false, "type": "boolean" }, "git-username": { "description": "Git username for repository access. Prefer --git-domain-credential when available.", "name": "git-username", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "case-duration-change-detection": { "description": "Enable or disable duration analytics.", "name": "case-duration-change-detection", "allowNo": true, "type": "boolean" }, "description": { "description": "Job description.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Job name.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "parallel-mode": { "description": "Parallel execution mode.", "name": "parallel-mode", "hasDynamicHelp": false, "multiple": false, "options": [ "disabled", "enabled" ], "type": "option" }, "robot": { "description": "CRT robot ID that should execute this job.", "name": "robot", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "screen-depth": { "description": "Screen color depth. Must be provided with --screen-width and --screen-height.", "name": "screen-depth", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "screen-height": { "description": "Screen height. Must be provided with --screen-width and --screen-depth.", "name": "screen-height", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "screen-width": { "description": "Screen width. Must be provided with --screen-height and --screen-depth.", "name": "screen-width", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "show-video-params": { "description": "Enable or disable video streaming and recording capabilities when running the test job.", "name": "show-video-params", "allowNo": true, "type": "boolean" }, "suite-type": { "description": "CRT suite/job type.", "name": "suite-type", "hasDynamicHelp": false, "multiple": false, "options": [ "bitbar", "browserstack", "browserstackdesktop", "default", "lambdatest", "lambdatestdesktop", "mobile", "paceconnectmobile", "privatemobile", "rpa", "selenese", "zap" ], "type": "option" }, "timeout": { "description": "Build timeout, for example 10s, 10m, 10h, or 10d.", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:job:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "update.js" ] }, "testing:live:continue": { "aliases": [], "args": { "job-id": { "description": "Optional CRT job ID guard.", "name": "job-id", "required": false } }, "description": "Continue paused Robot execution in the active CRT live session", "examples": [ "<%= config.bin %> <%= command.id %> --project " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Guard that must match the locally active CRT live session.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:live:continue", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "live", "continue.js" ] }, "testing:live:execute": { "aliases": [], "args": { "job-id": { "description": "Optional CRT job ID guard.", "name": "job-id", "required": false } }, "description": "Execute bounded Robot Framework keywords in an active CRT live session", "examples": [ "<%= config.bin %> <%= command.id %> --project --keyword GoTo --arg https://example.com", "<%= config.bin %> <%= command.id %> --project --file smoke.robot --section Login" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Guard that must match the locally active CRT live session.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "arg": { "description": "Keyword argument. Repeat to preserve argument boundaries.", "name": "arg", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "description": "Robot Framework input file.", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "keyword": { "description": "Robot Framework keyword name.", "name": "keyword", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "line": { "description": "Raw Robot Framework keyword line. Repeat for multiple lines.", "name": "line", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "raw": { "description": "Treat file input as raw keyword lines.", "name": "raw", "allowNo": false, "type": "boolean" }, "section": { "description": "Robot test/task name to execute.", "name": "section", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "section-index": { "description": "One-based Robot test/task index to execute.", "name": "section-index", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:live:execute", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "live", "execute.js" ] }, "testing:live:history": { "aliases": [], "args": { "job-id": { "description": "CRT job ID; defaults to the active session.", "name": "job-id", "required": false } }, "description": "Read bounded sanitized local CRT live execution history", "examples": [ "<%= config.bin %> <%= command.id %> --project --limit 20 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Guard that must match the locally active CRT live session.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "description": "Maximum records to return.", "name": "limit", "default": 10, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Execution status filter.", "name": "status", "hasDynamicHelp": false, "multiple": false, "options": [ "completed", "failed", "recorded" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:live:history", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "live", "history.js" ] }, "testing:live:inspect": { "aliases": [], "args": { "job-id": { "description": "Optional CRT job ID guard.", "name": "job-id", "required": false } }, "description": "Inspect bounded, sanitized page state from an active CRT live session", "examples": [ "<%= config.bin %> <%= command.id %> --project --json", "<%= config.bin %> <%= command.id %> --project --dom --output page.html" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Guard that must match the locally active CRT live session.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dom": { "description": "Fetch raw page DOM; requires --output.", "name": "dom", "allowNo": false, "type": "boolean" }, "output": { "dependsOn": [ "dom" ], "description": "Explicit file path for raw DOM.", "name": "output", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:live:inspect", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "live", "inspect.js" ] }, "testing:live:interrupt": { "aliases": [], "args": { "job-id": { "description": "Optional CRT job ID guard.", "name": "job-id", "required": false } }, "description": "Interrupt Robot execution in the active CRT live session", "examples": [ "<%= config.bin %> <%= command.id %> --project " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Guard that must match the locally active CRT live session.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:live:interrupt", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "live", "interrupt.js" ] }, "testing:live:recorder": { "aliases": [], "args": { "job-id": { "description": "Optional CRT job ID guard.", "name": "job-id", "required": false } }, "description": "Record CRT live interactions as bounded Robot Framework lines", "examples": [ "<%= config.bin %> <%= command.id %> --project --output recorded.robot" ], "flags": { "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Guard that must match the locally active CRT live session.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "debug": { "description": "Print frame sizes and event types without frame bodies.", "name": "debug", "allowNo": false, "type": "boolean" }, "no-enable": { "description": "Do not manage the server recorder toggle.", "name": "no-enable", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Explicit .robot file to append recorded keywords to.", "name": "output", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:live:recorder", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "live", "recorder.js" ] }, "testing:live:reports": { "aliases": [], "args": { "job-id": { "description": "Optional CRT job ID guard.", "name": "job-id", "required": false } }, "description": "List or save bounded report artifacts from an active CRT live session", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --output-dir ./reports" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Guard that must match the locally active CRT live session.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output-dir": { "description": "Explicit directory for log.html, report.html, and output.xml.", "name": "output-dir", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:live:reports", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "live", "reports.js" ] }, "testing:live:screenshot": { "aliases": [], "args": { "job-id": { "description": "Optional CRT job ID guard.", "name": "job-id", "required": false } }, "description": "Save a bounded CRT live browser screenshot to an explicit file", "examples": [ "<%= config.bin %> <%= command.id %> --project --output screenshot.png" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Guard that must match the locally active CRT live session.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output": { "char": "o", "description": "Explicit screenshot output path.", "name": "output", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:live:screenshot", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "live", "screenshot.js" ] }, "testing:live:set-options": { "aliases": [], "args": { "job-id": { "description": "Optional CRT job ID guard.", "name": "job-id", "required": false } }, "description": "Set the complete validated CRT live recorder option block", "examples": [ "<%= config.bin %> <%= command.id %> --project --enable --scroll-text --table-keywords" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Guard that must match the locally active CRT live session.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "enable": { "description": "Enable or disable interaction recording.", "name": "enable", "allowNo": true, "type": "boolean" }, "healing-context": { "description": "Capture recorder healing context.", "name": "healing-context", "allowNo": true, "type": "boolean" }, "hover-text": { "description": "Capture HoverText interactions.", "name": "hover-text", "allowNo": true, "type": "boolean" }, "scroll-text": { "description": "Capture ScrollText interactions.", "name": "scroll-text", "allowNo": true, "type": "boolean" }, "system-state": { "description": "Capture console/network system state.", "name": "system-state", "allowNo": true, "type": "boolean" }, "table-keywords": { "description": "Prefer table-aware interaction keywords.", "name": "table-keywords", "allowNo": true, "type": "boolean" }, "verify-text": { "description": "Capture VerifyText interactions.", "name": "verify-text", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:live:set-options", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "live", "set-options.js" ] }, "testing:live:start": { "aliases": [], "args": { "job-id": { "description": "CRT job ID.", "name": "job-id", "required": true } }, "description": "Start and bootstrap a bounded Copado Robotic Testing live session", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --file smoke.robot --section \"Login\"" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Guard that must match the locally active CRT live session.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "description": "Nonsecret session label.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "description": "Robot Framework file used to bootstrap a selected test/task.", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "jap-ime": { "description": "Enable Japanese IME in the live environment.", "name": "jap-ime", "allowNo": false, "type": "boolean" }, "library": { "description": "Robot Framework library to bootstrap.", "name": "library", "default": "QWeb", "hasDynamicHelp": false, "multiple": false, "options": [ "QWeb", "QForce", "QMobile" ], "type": "option" }, "no-bootstrap": { "description": "Create the host without readiness/bootstrap calls.", "name": "no-bootstrap", "allowNo": false, "type": "boolean" }, "no-browser": { "description": "Do not open Chrome during QWeb/QForce bootstrap.", "name": "no-browser", "allowNo": false, "type": "boolean" }, "poll-interval": { "description": "Readiness polling interval in seconds.", "name": "poll-interval", "default": 3, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "screen": { "description": "Session screen as WIDTHxHEIGHTxDEPTH.", "name": "screen", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "section": { "description": "Robot test/task name to bootstrap.", "name": "section", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "section-index": { "description": "One-based Robot test/task index to bootstrap.", "name": "section-index", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-version": { "description": "CRT live environment version.", "name": "session-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "Readiness timeout in seconds.", "name": "timeout", "default": 120, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "viewport": { "description": "Session viewport as WIDTHxHEIGHT (24-bit depth).", "name": "viewport", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:live:start", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "live", "start.js" ] }, "testing:live:status": { "aliases": [], "args": { "job-id": { "description": "Optional CRT job ID guard.", "name": "job-id", "required": false } }, "description": "Inspect sanitized status for the active CRT live session", "examples": [ "<%= config.bin %> <%= command.id %> --project --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Guard that must match the locally active CRT live session.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:live:status", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "live", "status.js" ] }, "testing:live:stop": { "aliases": [], "args": { "job-id": { "description": "Optional CRT job ID guard.", "name": "job-id", "required": false } }, "description": "Stop the active Copado Robotic Testing live session", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Guard that must match the locally active CRT live session.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Confirm live session shutdown.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:live:stop", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "live", "stop.js" ] }, "testing:live:view": { "aliases": [], "args": {}, "description": "Open the authenticated CRT run/session page without putting viewer secrets in the URL", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --no-open --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "session-id": { "description": "Guard that must match the locally active CRT live session.", "name": "session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "interactive": { "description": "Request interactive viewer controls when available.", "name": "interactive", "allowNo": false, "type": "boolean" }, "no-open": { "description": "Return the nonsecret URL without opening a browser.", "name": "no-open", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:live:view", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "live", "view.js" ] }, "testing:project:create": { "aliases": [], "args": {}, "description": "Create a Copado Robotic Testing project", "examples": [ "<%= config.bin %> <%= command.id %> --name \"QA Tests\"", "<%= config.bin %> <%= command.id %> --name \"QA Tests\" --description \"Smoke suite\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "description": { "description": "Project description.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Project name.", "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:project:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "project", "create.js" ] }, "testing:project:delete": { "aliases": [], "args": { "id": { "description": "CRT project ID.", "name": "id", "required": true } }, "description": "Delete a Copado Robotic Testing project", "examples": [ "<%= config.bin %> <%= command.id %> --yes", "<%= config.bin %> <%= command.id %> --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "yes": { "char": "y", "description": "Skip the destructive confirmation prompt.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:project:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "project", "delete.js" ] }, "testing:project:get": { "aliases": [], "args": { "id": { "description": "CRT project ID.", "name": "id", "required": true } }, "description": "Get a Copado Robotic Testing project from the project list", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:project:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "project", "get.js" ] }, "testing:project:list": { "aliases": [], "args": {}, "description": "List Copado Robotic Testing projects", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --name \"QA Tests\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "name": { "description": "Exact project name to match client-side.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:project:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "project", "list.js" ] }, "testing:project:update": { "aliases": [], "args": { "id": { "description": "CRT project ID.", "name": "id", "required": true } }, "description": "Update a Copado Robotic Testing project", "examples": [ "<%= config.bin %> <%= command.id %> --name \"QA Updated\"", "<%= config.bin %> <%= command.id %> --description \"Regression suites\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "description": { "description": "New project description.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "New project name.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:project:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "project", "update.js" ] }, "testing:robot:create": { "aliases": [], "args": {}, "description": "Create a Copado Robotic Testing robot", "examples": [ "<%= config.bin %> <%= command.id %> --project --name \"Cloud Robot\"", "<%= config.bin %> <%= command.id %> --project --name \"QConnect Robot\" --run-environment QConnect --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "description": "Description for the robot (defaults to empty if omitted).", "name": "description", "default": "", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "fw-version": { "description": "Test framework release channel (for example stable).", "name": "fw-version", "default": "stable", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "label": { "description": "Optional label for the robot.", "name": "label", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Name for the new robot.", "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reporting": { "description": "Which test results to keep after a run (all or nothing); only in effect when QConnect is used:\n- all: Keep all test results from the robot's runs\n- nothing: Do not keep any test results", "name": "reporting", "hasDynamicHelp": false, "multiple": false, "options": [ "all", "nothing" ], "type": "option" }, "robot-type": { "description": "What kind of tests the robot runs:\n- bitbar: Run mobile tests on BitBar cloud devices\n- browserstack: Run mobile tests on BrowserStack cloud devices\n- browserstackdesktop: Run desktop browser tests on BrowserStack\n- default: Standard robot for web and desktop tests (the usual choice)\n- lambdatest: Run mobile tests on LambdaTest cloud devices\n- lambdatestdesktop: Run desktop browser tests on LambdaTest\n- mobile: Run mobile tests on cloud-hosted devices\n- pabot: Run test suites in parallel\n- privatemobile: Run mobile tests on your own private devices\n- paceconnectmobile: Run mobile tests through a self-hosted agent in your own network", "name": "robot-type", "default": "default", "hasDynamicHelp": false, "multiple": false, "options": [ "bitbar", "browserstack", "browserstackdesktop", "default", "lambdatest", "lambdatestdesktop", "mobile", "pabot", "paceconnectmobile", "privatemobile" ], "type": "option" }, "run-environment": { "description": "Where the robot's tests run:\n- cloud: Run tests on cloud machines hosted by Copado (the usual choice)\n- QConnect: Run tests on a self-hosted agent installed in your own network", "name": "run-environment", "default": "cloud", "hasDynamicHelp": false, "multiple": false, "options": [ "cloud", "QConnect" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:robot:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "robot", "create.js" ] }, "testing:robot:delete": { "aliases": [], "args": { "id": { "description": "CRT robot ID.", "name": "id", "required": true } }, "description": "Delete a Copado Robotic Testing robot", "examples": [ "<%= config.bin %> <%= command.id %> --project --yes", "<%= config.bin %> <%= command.id %> --project --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip the destructive confirmation prompt.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:robot:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "robot", "delete.js" ] }, "testing:robot:get": { "aliases": [], "args": { "id": { "description": "CRT robot ID.", "name": "id", "required": true } }, "description": "Get a Copado Robotic Testing robot from the project robot list", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:robot:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "robot", "get.js" ] }, "testing:robot:list": { "aliases": [], "args": {}, "description": "List Copado Robotic Testing robots in a project", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:robot:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "robot", "list.js" ] }, "testing:robot:update": { "aliases": [], "args": { "id": { "description": "CRT robot ID.", "name": "id", "required": true } }, "description": "Update a Copado Robotic Testing robot", "examples": [ "<%= config.bin %> <%= command.id %> --project --name \"Updated Robot\"", "<%= config.bin %> <%= command.id %> --project --robot-type default --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "description": "New robot description.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "fw-version": { "description": "New Robot Framework release channel.", "name": "fw-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "label": { "description": "New robot label.", "name": "label", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "New robot name.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reporting": { "description": "Which test results to keep after a run (all or nothing); only in effect when QConnect is used:\n- all: Keep all test results from the robot's runs\n- nothing: Do not keep any test results", "name": "reporting", "hasDynamicHelp": false, "multiple": false, "options": [ "all", "nothing" ], "type": "option" }, "robot-type": { "description": "What kind of tests the robot runs:\n- bitbar: Run mobile tests on BitBar cloud devices\n- browserstack: Run mobile tests on BrowserStack cloud devices\n- browserstackdesktop: Run desktop browser tests on BrowserStack\n- default: Standard robot for web and desktop tests (the usual choice)\n- lambdatest: Run mobile tests on LambdaTest cloud devices\n- lambdatestdesktop: Run desktop browser tests on LambdaTest\n- mobile: Run mobile tests on cloud-hosted devices\n- pabot: Run test suites in parallel\n- privatemobile: Run mobile tests on your own private devices\n- paceconnectmobile: Run mobile tests through a self-hosted agent in your own network", "name": "robot-type", "hasDynamicHelp": false, "multiple": false, "options": [ "bitbar", "browserstack", "browserstackdesktop", "default", "lambdatest", "lambdatestdesktop", "mobile", "pabot", "paceconnectmobile", "privatemobile" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:robot:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "robot", "update.js" ] }, "testing:user-parameter:create": { "aliases": [], "args": {}, "description": "Create an account-scoped Copado Robotic Testing user parameter", "examples": [ "<%= config.bin %> <%= command.id %> --key BASE_URL --value https://example.com", "<%= config.bin %> <%= command.id %> --key TOKEN --value-stdin --sensitive --unique --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "description": { "description": "Parameter description.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "key": { "description": "Parameter key.", "name": "key", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sensitive": { "description": "Mark the parameter as sensitive.", "name": "sensitive", "allowNo": true, "type": "boolean" }, "type": { "description": "CRT user-parameter type.", "name": "type", "default": "parameter", "hasDynamicHelp": false, "multiple": false, "options": [ "parameter" ], "type": "option" }, "unique": { "description": "Reject an existing parameter with the same key.", "name": "unique", "allowNo": false, "type": "boolean" }, "no-trim": { "description": "Preserve leading and trailing whitespace in the supplied value.", "exclusive": [ "trim" ], "name": "no-trim", "allowNo": false, "type": "boolean" }, "trim": { "description": "Trim leading and trailing whitespace (the default policy).", "exclusive": [ "no-trim" ], "name": "trim", "allowNo": false, "type": "boolean" }, "value": { "description": "Value supplied directly. Prefer file/stdin for sensitive values.", "exclusive": [ "value-file", "value-stdin" ], "name": "value", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "value-file": { "description": "Read the value from a bounded regular file.", "exclusive": [ "value", "value-stdin" ], "name": "value-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "value-stdin": { "description": "Read the value from stdin.", "exclusive": [ "value", "value-file" ], "name": "value-stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:user-parameter:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "user-parameter", "create.js" ] }, "testing:user-parameter:delete": { "aliases": [], "args": { "id": { "description": "CRT user-parameter ID.", "name": "id", "required": true } }, "description": "Delete an account-scoped Copado Robotic Testing user parameter", "examples": [ "<%= config.bin %> <%= command.id %> --yes", "<%= config.bin %> <%= command.id %> --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "yes": { "char": "y", "description": "Skip the destructive confirmation prompt.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:user-parameter:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "user-parameter", "delete.js" ] }, "testing:user-parameter:get": { "aliases": [], "args": { "id": { "description": "CRT user-parameter ID.", "name": "id", "required": true } }, "description": "Get an account-scoped Copado Robotic Testing user parameter", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:user-parameter:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "user-parameter", "get.js" ] }, "testing:user-parameter:list": { "aliases": [], "args": {}, "description": "List account-scoped Copado Robotic Testing user parameters", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --key BASE_URL --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "job": { "description": "Defensive client-side job scope filter.", "name": "job", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "key": { "description": "Exact parameter key filter.", "name": "key", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project": { "description": "Defensive client-side project scope filter.", "name": "project", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:user-parameter:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "user-parameter", "list.js" ] }, "testing:user-parameter:update": { "aliases": [], "args": { "id": { "description": "CRT user-parameter ID.", "name": "id", "required": true } }, "description": "Update an account-scoped Copado Robotic Testing user parameter", "examples": [ "<%= config.bin %> <%= command.id %> --description \"Updated\"", "<%= config.bin %> <%= command.id %> --value-file ./value.txt --no-trim --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "description": { "description": "New parameter description.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "key": { "description": "New parameter key.", "name": "key", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "unique": { "description": "Reject another parameter with the same new key.", "name": "unique", "allowNo": false, "type": "boolean" }, "no-trim": { "description": "Preserve leading and trailing whitespace in the supplied value.", "exclusive": [ "trim" ], "name": "no-trim", "allowNo": false, "type": "boolean" }, "trim": { "description": "Trim leading and trailing whitespace (the default policy).", "exclusive": [ "no-trim" ], "name": "trim", "allowNo": false, "type": "boolean" }, "value": { "description": "Value supplied directly. Prefer file/stdin for sensitive values.", "exclusive": [ "value-file", "value-stdin" ], "name": "value", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "value-file": { "description": "Read the value from a bounded regular file.", "exclusive": [ "value", "value-stdin" ], "name": "value-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "value-stdin": { "description": "Read the value from stdin.", "exclusive": [ "value", "value-file" ], "name": "value-stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:user-parameter:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "user-parameter", "update.js" ] }, "testing:variable:create": { "aliases": [], "args": {}, "description": "Create a Copado Robotic Testing variable/secret", "examples": [ "<%= config.bin %> <%= command.id %> --project --key BASE_URL --value https://example.com", "<%= config.bin %> <%= command.id %> --project --key TOKEN --value secret --sensitive --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "description": "Variable description.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "job": { "description": "Scope the variable to a CRT job ID.", "exclusive": [ "robot" ], "name": "job", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "key": { "description": "Variable key.", "name": "key", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "robot": { "description": "Scope the variable to a CRT robot ID.", "exclusive": [ "job" ], "name": "robot", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sensitive": { "description": "Mark the variable as sensitive.", "name": "sensitive", "allowNo": true, "type": "boolean" }, "type": { "description": "CRT variable type.", "name": "type", "default": "secret", "hasDynamicHelp": false, "multiple": false, "options": [ "clp", "config", "dataset", "secret" ], "type": "option" }, "user-specific": { "description": "Create a user-specific variable.", "name": "user-specific", "allowNo": false, "type": "boolean" }, "no-trim": { "description": "Preserve leading and trailing whitespace in the supplied value.", "exclusive": [ "trim" ], "name": "no-trim", "allowNo": false, "type": "boolean" }, "trim": { "description": "Trim leading and trailing whitespace (the default policy).", "exclusive": [ "no-trim" ], "name": "trim", "allowNo": false, "type": "boolean" }, "value": { "description": "Value supplied directly. Prefer file/stdin for sensitive values.", "exclusive": [ "value-file", "value-stdin" ], "name": "value", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "value-file": { "description": "Read the value from a bounded regular file.", "exclusive": [ "value", "value-stdin" ], "name": "value-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "value-stdin": { "description": "Read the value from stdin.", "exclusive": [ "value", "value-file" ], "name": "value-stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:variable:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "variable", "create.js" ] }, "testing:variable:delete": { "aliases": [], "args": { "id": { "description": "CRT variable/secret ID.", "name": "id", "required": true } }, "description": "Delete a Copado Robotic Testing variable/secret", "examples": [ "<%= config.bin %> <%= command.id %> --project --yes", "<%= config.bin %> <%= command.id %> --project --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip the destructive confirmation prompt.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:variable:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "variable", "delete.js" ] }, "testing:variable:get": { "aliases": [], "args": { "id": { "description": "CRT variable/secret ID.", "name": "id", "required": true } }, "description": "Get a Copado Robotic Testing variable/secret", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:variable:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "variable", "get.js" ] }, "testing:variable:list": { "aliases": [], "args": {}, "description": "List Copado Robotic Testing variables/secrets", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --job --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "job": { "description": "Filter for a CRT job ID.", "exclusive": [ "robot" ], "name": "job", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "key": { "description": "Filter by exact variable key.", "name": "key", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "robot": { "description": "Filter for a CRT robot ID.", "exclusive": [ "job" ], "name": "robot", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sensitive": { "description": "Filter by sensitive status.", "name": "sensitive", "allowNo": true, "type": "boolean" }, "type": { "description": "Filter by CRT variable type.", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "clp", "config", "dataset", "secret" ], "type": "option" }, "user-specific": { "description": "Filter by user-specific status.", "name": "user-specific", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:variable:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "variable", "list.js" ] }, "testing:variable:update": { "aliases": [], "args": { "id": { "description": "CRT variable/secret ID.", "name": "id", "required": true } }, "description": "Update a Copado Robotic Testing variable/secret", "examples": [ "<%= config.bin %> <%= command.id %> --project --value https://example.com", "<%= config.bin %> <%= command.id %> --project --not-sensitive --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "description": "Variable description.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "key": { "description": "Variable key.", "name": "key", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "not-sensitive": { "description": "Mark the variable as not sensitive.", "name": "not-sensitive", "allowNo": false, "type": "boolean" }, "sensitive": { "description": "Mark the variable as sensitive.", "name": "sensitive", "allowNo": true, "type": "boolean" }, "type": { "description": "CRT variable type.", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "clp", "config", "dataset", "secret" ], "type": "option" }, "no-trim": { "description": "Preserve leading and trailing whitespace in the supplied value.", "exclusive": [ "trim" ], "name": "no-trim", "allowNo": false, "type": "boolean" }, "trim": { "description": "Trim leading and trailing whitespace (the default policy).", "exclusive": [ "no-trim" ], "name": "trim", "allowNo": false, "type": "boolean" }, "value": { "description": "Value supplied directly. Prefer file/stdin for sensitive values.", "exclusive": [ "value-file", "value-stdin" ], "name": "value", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "value-file": { "description": "Read the value from a bounded regular file.", "exclusive": [ "value", "value-stdin" ], "name": "value-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "value-stdin": { "description": "Read the value from stdin.", "exclusive": [ "value", "value-file" ], "name": "value-stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:variable:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "variable", "update.js" ] }, "ai:workspace:member:invite": { "aliases": [], "args": { "workspace": { "description": "Copado AI workspace UUID.", "name": "workspace", "required": true } }, "description": "Invite a member to a Copado AI workspace", "examples": [ "<%= config.bin %> <%= command.id %> 42d0b908-37b7-4565-9ec9-86eda40c9782 --user-id 12345 --permission Access", "<%= config.bin %> <%= command.id %> 42d0b908-37b7-4565-9ec9-86eda40c9782 --user-id 12345 --permission Manage --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "timeout": { "description": "AI gateway timeout in seconds.", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "permission": { "description": "Workspace permission for the invited member.", "name": "permission", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "Access", "Manage" ], "type": "option" }, "user-id": { "description": "Copado AI user ID to invite.", "name": "user-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai:workspace:member:invite", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "ai", "workspace", "member", "invite.js" ] }, "ai:workspace:member:list": { "aliases": [], "args": { "workspace": { "description": "Copado AI workspace UUID.", "name": "workspace", "required": true } }, "description": "List members for a Copado AI workspace", "examples": [ "<%= config.bin %> <%= command.id %> 42d0b908-37b7-4565-9ec9-86eda40c9782", "<%= config.bin %> <%= command.id %> 42d0b908-37b7-4565-9ec9-86eda40c9782 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "timeout": { "description": "AI gateway timeout in seconds.", "name": "timeout", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai:workspace:member:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "ai", "workspace", "member", "list.js" ] }, "cicd:credential:auth:status": { "aliases": [], "args": { "id": { "description": "Copado credential ID", "name": "id", "required": true } }, "description": "Validate the authentication status of a credential by ID", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:credential:auth:status", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "credential", "auth", "status.js" ] }, "cicd:data:commit:create": { "aliases": [], "args": {}, "description": "Create a data commit for a user story", "examples": [ "<%= config.bin %> <%= command.id %> --file commit.json", "<%= config.bin %> <%= command.id %> --stdin --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "file": { "char": "f", "description": "Path to a JSON file body", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read the JSON body from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:commit:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "commit", "create.js" ] }, "cicd:data:commit:list": { "aliases": [], "args": { "userStoryId": { "description": "User story Id", "name": "userStoryId", "required": true } }, "description": "List data commits for a user story", "examples": [ "<%= config.bin %> <%= command.id %> a16P7000006AyU5IAK", "<%= config.bin %> <%= command.id %> a16P7000006AyU5IAK --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:commit:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "commit", "list.js" ] }, "cicd:data:dataset-file:content": { "aliases": [], "args": { "contentVersionId": { "description": "ContentVersion Id", "name": "contentVersionId", "required": true } }, "description": "Get dataset file content by ContentVersion Id", "examples": [ "<%= config.bin %> <%= command.id %> 068000000000001", "<%= config.bin %> <%= command.id %> 068000000000001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:dataset-file:content", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "dataset-file", "content.js" ] }, "cicd:data:dataset-file:list": { "aliases": [], "args": { "userStoryDataCommitId": { "description": "User story data commit Id", "name": "userStoryDataCommitId", "required": true } }, "description": "List dataset files for a user story data commit", "examples": [ "<%= config.bin %> <%= command.id %> a1A000000000001", "<%= config.bin %> <%= command.id %> a1A000000000001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:dataset-file:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "dataset-file", "list.js" ] }, "cicd:data:filter:add": { "aliases": [], "args": { "dataTemplateId": { "description": "Data template Id", "name": "dataTemplateId", "required": true } }, "description": "Add an advanced filter to a data template", "examples": [ "<%= config.bin %> <%= command.id %> a0X000000000001 --file filter.json", "<%= config.bin %> <%= command.id %> a0X000000000001 --stdin --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "file": { "char": "f", "description": "Path to a JSON file body", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read the JSON body from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:filter:add", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "filter", "add.js" ] }, "cicd:data:filter:delete": { "aliases": [], "args": { "dataTemplateId": { "description": "Data template Id", "name": "dataTemplateId", "required": true }, "uuid": { "description": "Advanced filter UUID", "name": "uuid", "required": true } }, "description": "Delete an advanced filter from a data template", "examples": [ "<%= config.bin %> <%= command.id %> a0X000000000001 550e8400-e29b-41d4-a716-446655440000", "<%= config.bin %> <%= command.id %> a0X000000000001 550e8400-e29b-41d4-a716-446655440000 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:filter:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "filter", "delete.js" ] }, "cicd:data:filter:list": { "aliases": [], "args": { "dataTemplateId": { "description": "Data template Id", "name": "dataTemplateId", "required": true } }, "description": "List advanced filters for a data template", "examples": [ "<%= config.bin %> <%= command.id %> a0X000000000001", "<%= config.bin %> <%= command.id %> a0X000000000001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:filter:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "filter", "list.js" ] }, "cicd:data:filter:update": { "aliases": [], "args": { "dataTemplateId": { "description": "Data template Id", "name": "dataTemplateId", "required": true }, "uuid": { "description": "Advanced filter UUID", "name": "uuid", "required": true } }, "description": "Update an advanced filter on a data template", "examples": [ "<%= config.bin %> <%= command.id %> a0X000000000001 550e8400-e29b-41d4-a716-446655440000 --file filter.json", "<%= config.bin %> <%= command.id %> a0X000000000001 550e8400-e29b-41d4-a716-446655440000 --stdin --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "file": { "char": "f", "description": "Path to a JSON file body", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read the JSON body from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:filter:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "filter", "update.js" ] }, "cicd:data:formula:create": { "aliases": [], "args": { "dataTemplateId": { "description": "Data template Id", "name": "dataTemplateId", "required": true } }, "description": "Create a record matching formula for a data template", "examples": [ "<%= config.bin %> <%= command.id %> a0X... --name MatchByName --object-api-name Account --fields Name,BillingCity", "<%= config.bin %> <%= command.id %> a0X... --name MatchByName --object-api-name Account --fields Name --fields BillingCity --hash-formula --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Formula fields (repeatable or comma-separated, up to 3)", "name": "fields", "required": true, "hasDynamicHelp": false, "multiple": true, "type": "option" }, "hash-formula": { "description": "Enable hash formula", "name": "hash-formula", "allowNo": false, "type": "boolean" }, "name": { "description": "Formula name", "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "object-api-name": { "description": "sObject API name", "name": "object-api-name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:formula:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "formula", "create.js" ] }, "cicd:data:formula:list": { "aliases": [], "args": { "objectApiName": { "description": "sObject API name", "name": "objectApiName", "required": true } }, "description": "List record matching formulas for an sObject", "examples": [ "<%= config.bin %> <%= command.id %> Account", "<%= config.bin %> <%= command.id %> Account --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:formula:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "formula", "list.js" ] }, "cicd:data:formula:update": { "aliases": [], "args": { "formulaId": { "description": "Record matching formula Id", "name": "formulaId", "required": true } }, "description": "Update a record matching formula", "examples": [ "<%= config.bin %> <%= command.id %> a0F... --name MatchByName --object-api-name Account --fields Name,BillingCity", "<%= config.bin %> <%= command.id %> a0F... --file formula.json", "<%= config.bin %> <%= command.id %> a0F... --stdin --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Formula fields (repeatable or comma-separated, up to 3)", "name": "fields", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "hash-formula": { "description": "Enable or disable hash formula", "name": "hash-formula", "allowNo": true, "type": "boolean" }, "name": { "description": "Formula name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "object-api-name": { "description": "sObject API name", "name": "object-api-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "char": "f", "description": "Path to a JSON file body", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read the JSON body from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:formula:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "formula", "update.js" ] }, "cicd:data:records:match": { "aliases": [], "args": {}, "description": "Match a source data record to a destination org", "examples": [ "<%= config.bin %> <%= command.id %> --file match.json", "<%= config.bin %> <%= command.id %> --stdin --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "file": { "char": "f", "description": "Path to a JSON file body", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read the JSON body from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:records:match", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "records", "match.js" ] }, "cicd:data:records:search": { "aliases": [], "args": {}, "description": "Search data records for a data template", "examples": [ "<%= config.bin %> <%= command.id %> --credential-id a0Y... --data-template-id a0X...", "<%= config.bin %> <%= command.id %> --credential-id a0Y... --data-template-id a0X... --file request.json", "<%= config.bin %> <%= command.id %> --credential-id a0Y... --data-template-id a0X... --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "changed-date-from": { "description": "Optional changed-date-from filter (ISO datetime)", "name": "changed-date-from", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "credential-id": { "description": "Org credential Id", "name": "credential-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "data-template-id": { "description": "Data template Id", "name": "data-template-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "char": "f", "description": "Path to a JSON file body", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read the JSON body from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:records:search", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "records", "search.js" ] }, "cicd:data:sobject:fields": { "aliases": [], "args": { "sobjectApiName": { "description": "sObject API name", "name": "sobjectApiName", "required": true } }, "description": "Describe fields for an sObject via a credential", "examples": [ "<%= config.bin %> <%= command.id %> Account --credential-id a0Y...", "<%= config.bin %> <%= command.id %> Account --credential-id a0Y... --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "credential-id": { "description": "Org credential Id", "name": "credential-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:sobject:fields", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "sobject", "fields.js" ] }, "cicd:data:sobject:relationships": { "aliases": [], "args": { "sobjectApiName": { "description": "sObject API name", "name": "sobjectApiName", "required": true } }, "description": "Describe relationships for an sObject via a credential", "examples": [ "<%= config.bin %> <%= command.id %> Account --credential-id a0Y...", "<%= config.bin %> <%= command.id %> Account --credential-id a0Y... --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "credential-id": { "description": "Org credential Id", "name": "credential-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:sobject:relationships", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "sobject", "relationships.js" ] }, "cicd:data:sync:apply": { "aliases": [], "args": {}, "description": "Apply data template field sync entries", "examples": [ "<%= config.bin %> <%= command.id %> --file sync.json", "<%= config.bin %> <%= command.id %> --stdin --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "file": { "char": "f", "description": "Path to a JSON file body", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read the JSON body from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:sync:apply", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "sync", "apply.js" ] }, "cicd:data:sync:preview-updates": { "aliases": [], "args": {}, "description": "Preview data template updates from metadata commit changes", "examples": [ "<%= config.bin %> <%= command.id %> --file preview.json", "<%= config.bin %> <%= command.id %> --stdin --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "file": { "char": "f", "description": "Path to a JSON file body", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read the JSON body from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:sync:preview-updates", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "sync", "preview-updates.js" ] }, "cicd:data:template:convert-old": { "aliases": [], "args": { "id": { "description": "Legacy data template Id", "name": "id", "required": true } }, "description": "Convert a legacy data template graph to v2", "examples": [ "<%= config.bin %> <%= command.id %> a0X000000000001", "<%= config.bin %> <%= command.id %> a0X000000000001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:template:convert-old", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "template", "convert-old.js" ] }, "cicd:data:template:create": { "aliases": [], "args": {}, "description": "Create a Copado data template", "examples": [ "<%= config.bin %> <%= command.id %> --credential-id a0Y... --template-name Accounts --api-name Accounts --main-object-api-name Account --main-object-label Account", "<%= config.bin %> <%= command.id %> --credential-id a0Y... --template-name Accounts --api-name Accounts --main-object-api-name Account --main-object-label Account --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-name": { "description": "Template API name", "name": "api-name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "credential-id": { "description": "Org credential Id", "name": "credential-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "main-object-api-name": { "description": "Main sObject API name", "name": "main-object-api-name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "main-object-label": { "description": "Main sObject label", "name": "main-object-label", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "template-name": { "description": "Template display name", "name": "template-name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:template:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "template", "create.js" ] }, "cicd:data:template:delete": { "aliases": [], "args": { "id": { "description": "Data template Id", "name": "id", "required": true } }, "description": "Delete a Copado data template", "examples": [ "<%= config.bin %> <%= command.id %> a0X000000000001", "<%= config.bin %> <%= command.id %> a0X000000000001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:template:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "template", "delete.js" ] }, "cicd:data:template:get-detail": { "aliases": [], "args": { "id": { "description": "Data template Id", "name": "id", "required": true } }, "description": "Get the raw v2 data template detail payload", "examples": [ "<%= config.bin %> <%= command.id %> a0X000000000001", "<%= config.bin %> <%= command.id %> a0X000000000001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:template:get-detail", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "template", "get-detail.js" ] }, "cicd:data:template:get": { "aliases": [], "args": { "id": { "description": "Data template Id", "name": "id", "required": true } }, "description": "Get a data template export graph (selected columns only)", "examples": [ "<%= config.bin %> <%= command.id %> a0X000000000001", "<%= config.bin %> <%= command.id %> a0X000000000001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:template:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "template", "get.js" ] }, "cicd:data:template:list": { "aliases": [], "args": {}, "description": "List Copado data templates", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --fetch-related --active", "<%= config.bin %> <%= command.id %> --no-active --json", "<%= config.bin %> <%= command.id %> --name Accounts --main-object Account" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "active": { "description": "Filter by active flag (--active / --no-active)", "name": "active", "allowNo": true, "type": "boolean" }, "fetch-related": { "description": "Include related template information", "name": "fetch-related", "allowNo": false, "type": "boolean" }, "main-object": { "description": "Filter by main sObject API name", "name": "main-object", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Filter by name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:template:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "template", "list.js" ] }, "cicd:data:template:open": { "aliases": [], "args": { "id": { "description": "Data template Id", "name": "id", "required": true } }, "description": "Open a Copado data template in the browser", "examples": [ "<%= config.bin %> <%= command.id %> a0X000000000001", "<%= config.bin %> <%= command.id %> a0X000000000001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:template:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "template", "open.js" ] }, "cicd:data:template:save-detail": { "aliases": [], "args": { "id": { "description": "Data template Id", "name": "id", "required": true } }, "description": "Save a v2 data template detail payload", "examples": [ "<%= config.bin %> <%= command.id %> a0X000000000001 --file detail.json", "<%= config.bin %> <%= command.id %> a0X000000000001 --stdin --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "file": { "char": "f", "description": "Path to a JSON file body", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read the JSON body from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:data:template:save-detail", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "data", "template", "save-detail.js" ] }, "cicd:environment:auth:status": { "aliases": [], "args": { "id": { "description": "Copado environment ID (optional when --credentialid is provided)", "name": "id", "required": false } }, "description": "Validate the authentication status of an environment credential", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --credentialid ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "credentialid": { "description": "Credential ID to validate; when set without an environment ID, resolves the environment from the credential", "name": "credentialid", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:environment:auth:status", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "environment", "auth", "status.js" ] }, "cicd:function:result:get": { "aliases": [], "args": { "result-id": { "description": "Function result Id", "name": "result-id", "required": true } }, "description": "Get Copado Function execution status by result Id", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:function:result:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "function", "result", "get.js" ] }, "cicd:job:log:get": { "aliases": [], "args": { "id": { "description": "JobExecution Id", "name": "id", "required": true } }, "description": "Get log output for a Copado job execution step", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --step ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "step": { "description": "Job step Id (defaults to the first step with a result Id)", "name": "step", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:job:log:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "job", "log", "get.js" ] }, "cicd:job:result-file:get": { "aliases": [], "args": { "resultId": { "description": "Copado Result Id", "name": "resultId", "required": true } }, "description": "Get a File linked to a Copado job Result", "examples": [ "<%= config.bin %> <%= command.id %> --file-id ", "<%= config.bin %> <%= command.id %> --file-id --output-file ./result.zip", "<%= config.bin %> <%= command.id %> --file-id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "file-id": { "description": "File Id returned by result-file list", "name": "file-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output-file": { "description": "Explicit file path to receive decoded content", "name": "output-file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:job:result-file:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "job", "result-file", "get.js" ] }, "cicd:job:result-file:list": { "aliases": [], "args": { "resultId": { "description": "Copado Result Id", "name": "resultId", "required": true } }, "description": "List Files linked to a Copado job Result", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:job:result-file:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "job", "result-file", "list.js" ] }, "cicd:metadata:content:compare": { "aliases": [], "args": {}, "description": "Compare metadata file content between two orgs or Git branches", "examples": [ "<%= config.bin %> <%= command.id %> --metadata-type ApexClass --api-name MyClass --pipeline-id --source-org-id --source-credential-id --target-org-id ", "<%= config.bin %> <%= command.id %> --metadata-type ApexClass --api-name MyClass --source REPOSITORY --source-branch feature/us-123 --target-source REPOSITORY --target-branch main", "<%= config.bin %> <%= command.id %> --metadata-type ApexClass --api-name MyClass --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-name": { "description": "Metadata API name", "name": "api-name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file-name": { "description": "Optional metadata file name", "name": "file-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-type": { "description": "Metadata type, for example ApexClass", "name": "metadata-type", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline Id", "name": "pipeline-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source": { "description": "Content source for the source side", "name": "source", "default": "ENVIRONMENT", "hasDynamicHelp": false, "multiple": false, "options": [ "ENVIRONMENT", "REPOSITORY", "GIT_MIRROR", "ORG_CACHE" ], "type": "option" }, "source-branch": { "description": "Git branch for the source side when source is REPOSITORY or GIT_MIRROR", "name": "source-branch", "default": "", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-credential-id": { "description": "Source org credential Id", "name": "source-credential-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-org-id": { "description": "Source org Id", "name": "source-org-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-branch": { "description": "Git branch for the target side when target source is REPOSITORY or GIT_MIRROR", "name": "target-branch", "default": "", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-credential-id": { "description": "Target org credential Id; defaults to the source credential", "name": "target-credential-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org-id": { "description": "Target org Id", "name": "target-org-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-source": { "description": "Content source for the target side", "name": "target-source", "default": "ENVIRONMENT", "hasDynamicHelp": false, "multiple": false, "options": [ "ENVIRONMENT", "REPOSITORY", "GIT_MIRROR", "ORG_CACHE" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:metadata:content:compare", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "metadata", "content", "compare.js" ] }, "cicd:metadata:content:get": { "aliases": [], "args": {}, "description": "Retrieve metadata file content", "examples": [ "<%= config.bin %> <%= command.id %> --metadata-type ApexClass --api-name MyClass --pipeline-id --source-org-id ", "<%= config.bin %> <%= command.id %> --metadata-type ApexClass --api-name MyClass --show", "<%= config.bin %> <%= command.id %> --file requests.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-name": { "description": "Metadata API name", "name": "api-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "branch": { "description": "Git branch when source is REPOSITORY or GIT_MIRROR", "name": "branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "description": "Path to a JSON file with an array of metadata content requests", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file-name": { "description": "Optional metadata file name", "name": "file-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-type": { "description": "Metadata type, for example ApexClass", "name": "metadata-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output-file": { "description": "Write decoded content from the first result to this file path", "name": "output-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline Id", "name": "pipeline-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "result-id": { "description": "Optional result Id from a prior metadata operation", "name": "result-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "show": { "description": "Print decoded metadata content to stdout after retrieval", "name": "show", "allowNo": false, "type": "boolean" }, "source": { "description": "Content source", "name": "source", "default": "ENVIRONMENT", "hasDynamicHelp": false, "multiple": false, "options": [ "ENVIRONMENT", "REPOSITORY", "GIT_MIRROR", "ORG_CACHE" ], "type": "option" }, "source-credential-id": { "description": "Source org credential Id", "name": "source-credential-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-org-id": { "description": "Source org Id", "name": "source-org-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:metadata:content:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "metadata", "content", "get.js" ] }, "cicd:metadata:dependency:list": { "aliases": [], "args": {}, "description": "Retrieve metadata dependencies", "examples": [ "<%= config.bin %> <%= command.id %> --metadata-name MyClass --metadata-type ApexClass --pipeline-id --source-org-id --source-credential-id ", "cat request.json | <%= config.bin %> <%= command.id %> --stdin", "<%= config.bin %> <%= command.id %> --from-changes --base-ref origin/main --retrieve-mode all --pipeline-id --source-org-id --source-credential-id " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "base-ref": { "description": "Base Git ref used with --from-changes", "name": "base-ref", "default": "origin/main", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "char": "f", "description": "Path to a JSON dependency request body", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "from-changes": { "description": "Build metadata selections from committed branch changes and staged index files", "name": "from-changes", "allowNo": false, "type": "boolean" }, "metadata-category": { "description": "Optional metadata category", "name": "metadata-category", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-name": { "description": "Metadata component name", "name": "metadata-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-raw-json": { "description": "Optional raw metadata JSON for the selection", "name": "metadata-raw-json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-type": { "description": "Metadata type, for example ApexClass", "name": "metadata-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "module-type": { "description": "Optional addon module type", "name": "module-type", "hasDynamicHelp": false, "multiple": false, "options": [ "vlocity", "data_cloud" ], "type": "option" }, "pipeline-id": { "description": "Pipeline Id", "name": "pipeline-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "platform-experience": { "description": "Platform experience header", "name": "platform-experience", "default": "salesforce", "hasDynamicHelp": false, "multiple": false, "options": [ "salesforce", "sfdx", "metacache", "db" ], "type": "option" }, "result-id": { "description": "Optional result Id from a prior metadata operation", "name": "result-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "retrieve-mode": { "description": "Dependency retrieve mode", "name": "retrieve-mode", "hasDynamicHelp": false, "multiple": false, "options": [ "all", "diff_only" ], "type": "option" }, "source-credential-id": { "description": "Source org credential Id", "name": "source-credential-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-org-id": { "description": "Source org Id", "name": "source-org-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read a JSON dependency request body from stdin", "name": "stdin", "allowNo": false, "type": "boolean" }, "target-org-id": { "description": "Target org Id", "name": "target-org-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:metadata:dependency:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "metadata", "dependency", "list.js" ] }, "cicd:metadata:index:compare": { "aliases": [], "args": {}, "description": "Compare metadata between orgs or Git branches", "examples": [ "<%= config.bin %> <%= command.id %> --comparison-mode BRANCH_COMPARE --pipeline-id --source-org-id --source-credential-id --target-org-id ", "<%= config.bin %> <%= command.id %> --comparison-mode INDEX_FILE --filter-type ApexClass --pipeline-id --source-org-id --source-credential-id --target-org-id ", "<%= config.bin %> <%= command.id %> --comparison-mode MIX --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "comparison-mode": { "description": "Comparison mode", "name": "comparison-mode", "default": "BRANCH_COMPARE", "hasDynamicHelp": false, "multiple": false, "options": [ "BRANCH_COMPARE", "INDEX_FILE", "MIX" ], "type": "option" }, "filter-type": { "description": "Optional metadata type filter, for example ApexClass", "name": "filter-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline Id", "name": "pipeline-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-credential-id": { "description": "Source org credential Id", "name": "source-credential-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-org-id": { "description": "Source org Id", "name": "source-org-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org-id": { "description": "Target org Id", "name": "target-org-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:metadata:index:compare", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "metadata", "index", "compare.js" ] }, "cicd:metadata:refresh:deleted": { "aliases": [], "args": {}, "description": "Refresh the deleted metadata index", "examples": [ "<%= config.bin %> <%= command.id %> --env ", "<%= config.bin %> <%= command.id %> --env --module-type vlocity --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "env": { "description": "Copado environment Id used to resolve the credential", "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "module-type": { "description": "Optional addon module type", "name": "module-type", "hasDynamicHelp": false, "multiple": false, "options": [ "vlocity", "data_cloud" ], "type": "option" }, "source-credential-id": { "description": "Override source credential Id resolved from --env", "name": "source-credential-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-org-id": { "description": "Override source org Id resolved from --env validation", "name": "source-org-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:metadata:refresh:deleted", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "metadata", "refresh", "deleted.js" ] }, "cicd:metadata:refresh:run": { "aliases": [], "args": {}, "description": "Trigger a metadata index refresh", "examples": [ "<%= config.bin %> <%= command.id %> --env ", "<%= config.bin %> <%= command.id %> --env --all --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "all": { "description": "Request replacing the metadata index instead of merging it", "name": "all", "allowNo": false, "type": "boolean" }, "env": { "description": "Copado environment Id used to resolve source org and credential", "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-files": { "description": "Comma-separated Git file paths to refresh", "name": "git-files", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "module-type": { "description": "Optional addon module type", "name": "module-type", "hasDynamicHelp": false, "multiple": false, "options": [ "vlocity", "data_cloud" ], "type": "option" }, "pipeline-id": { "description": "Optional pipeline Id", "name": "pipeline-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "platform-experience": { "description": "Platform experience header", "name": "platform-experience", "default": "salesforce", "hasDynamicHelp": false, "multiple": false, "options": [ "salesforce", "sfdx", "metacache", "db" ], "type": "option" }, "refresh-mode": { "description": "Optional refresh mode", "name": "refresh-mode", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "selected-name": { "description": "Optional selected metadata API name", "name": "selected-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "selected-type": { "description": "Optional selected metadata type", "name": "selected-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-credential-id": { "description": "Override source credential Id resolved from --env", "name": "source-credential-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-org-id": { "description": "Override source org Id resolved from --env", "name": "source-org-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org-id": { "description": "Optional target org Id", "name": "target-org-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:metadata:refresh:run", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "metadata", "refresh", "run.js" ] }, "cicd:metadata:refresh:status": { "aliases": [], "args": {}, "description": "Get metadata index refresh status", "examples": [ "<%= config.bin %> <%= command.id %> --job-id ", "<%= config.bin %> <%= command.id %> --job-id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "job-id": { "description": "Metadata refresh event Id", "name": "job-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "module-type": { "description": "Optional addon module type used by the trigger request", "name": "module-type", "hasDynamicHelp": false, "multiple": false, "options": [ "vlocity", "data_cloud" ], "type": "option" }, "platform-experience": { "description": "Platform experience header used by the trigger request", "name": "platform-experience", "default": "salesforce", "hasDynamicHelp": false, "multiple": false, "options": [ "salesforce", "sfdx", "metacache", "db" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:metadata:refresh:status", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "metadata", "refresh", "status.js" ] }, "cicd:pipeline:automation:activate": { "aliases": [], "args": { "id": { "description": "Automation rule Salesforce ID (not name)", "name": "id", "required": true } }, "description": "Activate a Copado pipeline automation rule", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id ", "<%= config.bin %> <%= command.id %> --pipeline-id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:automation:activate", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "automation", "activate.js" ] }, "cicd:pipeline:automation:create": { "aliases": [], "args": {}, "description": "Create an inactive Copado pipeline automation rule", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id --name \"Promote after successful deploy\" --scope promotion --execution-time Immediate --promotion-trigger automated --environment-id ", "<%= config.bin %> <%= command.id %> --pipeline-id --name \"Nightly back promote\" --scope backPromotion --execution-time Scheduled --cron-expression \"0 2 * * *\" --stage-id --json", "<%= config.bin %> <%= command.id %> --pipeline-id --name \"Promote matching stories\" --scope promotion --execution-time Immediate --promotion-trigger manual --environment-id --filter-criteria '{\"mode\":\"builder\",\"logic\":\"AND\",\"conditions\":[{\"field\":\"Name\",\"operator\":\"contains\",\"value\":\"US-\"}]}'", "<%= config.bin %> <%= command.id %> --pipeline-id --name \"Custom after commit\" --scope advanced --execution-time Immediate --source-action Commit --source-action-status Successful --custom-automation-connector --environment-id " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "callback-action": { "description": "Callback action for the automation rule", "name": "callback-action", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cron-expression": { "description": "Cron expression (required when execution time is Scheduled)", "name": "cron-expression", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "custom-automation-connector": { "description": "Custom automation connector (required for advanced scope)", "name": "custom-automation-connector", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "description": "Automation rule description", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment-id": { "description": "Environment ID target (repeatable; at least one --stage-id or --environment-id is required on create)", "name": "environment-id", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "environment-sync-source": { "description": "Source environment ID (required for environmentSyncBackPromotion scope)", "name": "environment-sync-source", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "execution-time": { "description": "When the rule runs (Immediate, Scheduled); Scheduled requires --cron-expression", "name": "execution-time", "hasDynamicHelp": false, "multiple": false, "options": [ "Immediate", "Scheduled" ], "type": "option" }, "filter-criteria": { "description": "User-story filter as JSON. Restricts which user stories the rule applies to. Builder mode matches field conditions with AND/OR logic: '{\"mode\":\"builder\",\"logic\":\"AND\",\"conditions\":[{\"field\":\"Name\",\"operator\":\"equals\",\"value\":\"US-1\"}]}'. Custom mode sends a SOQL-like whereCondition: '{\"mode\":\"custom\",\"whereCondition\":\"Name LIKE \\'US-%\\'\"}'. Operators: equals, notEquals, contains, notContains, greaterThan, greaterOrEqual, lessThan, lessOrEqual.", "exclusive": [ "filter-criteria-file" ], "name": "filter-criteria", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "filter-criteria-file": { "description": "Path to a JSON file with the user-story filter shape documented on --filter-criteria (builder or custom mode)", "exclusive": [ "filter-criteria" ], "name": "filter-criteria-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Automation rule name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "promotion-trigger": { "description": "Promotion trigger for promotion scope (manual, automated); manual maps to SubmitUserStories, automated to PromotionDeployment", "name": "promotion-trigger", "hasDynamicHelp": false, "multiple": false, "options": [ "manual", "automated" ], "type": "option" }, "scope": { "description": "Automation scope (promotion, backPromotion, environmentSyncBackPromotion, advanced); immutable after create", "name": "scope", "hasDynamicHelp": false, "multiple": false, "options": [ "promotion", "backPromotion", "environmentSyncBackPromotion", "advanced" ], "type": "option" }, "source-action": { "description": "Source action for advanced scope (Promotion, PromotionDeployment, Commit, CreatePackage, CreatePackageVersion, PublishPackageVersion, ImportPackage, TakeSnapshot, Rollback, PackageDistribution, Platform, SubmitUserStories, Submit)", "name": "source-action", "hasDynamicHelp": false, "multiple": false, "options": [ "Promotion", "PromotionDeployment", "Commit", "CreatePackage", "CreatePackageVersion", "PublishPackageVersion", "ImportPackage", "TakeSnapshot", "Rollback", "PackageDistribution", "Platform", "SubmitUserStories", "Submit" ], "type": "option" }, "source-action-status": { "description": "Source action status for advanced scope (Successful, Error)", "name": "source-action-status", "hasDynamicHelp": false, "multiple": false, "options": [ "Successful", "Error" ], "type": "option" }, "stage-id": { "description": "Stage ID target (repeatable; at least one --stage-id or --environment-id is required on create)", "name": "stage-id", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:automation:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "automation", "create.js" ] }, "cicd:pipeline:automation:deactivate": { "aliases": [], "args": { "id": { "description": "Automation rule Salesforce ID (not name)", "name": "id", "required": true } }, "description": "Deactivate a Copado pipeline automation rule", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id ", "<%= config.bin %> <%= command.id %> --pipeline-id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:automation:deactivate", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "automation", "deactivate.js" ] }, "cicd:pipeline:automation:delete": { "aliases": [], "args": { "id": { "description": "Automation rule ID or name", "name": "id", "required": true } }, "description": "Delete a Copado pipeline automation rule", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id --yes", "<%= config.bin %> <%= command.id %> --pipeline-id --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Confirm deletion without prompting", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:automation:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "automation", "delete.js" ] }, "cicd:pipeline:automation:get": { "aliases": [], "args": { "id": { "description": "Automation rule ID or name", "name": "id", "required": true } }, "description": "Get a Copado pipeline automation rule", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id ", "<%= config.bin %> <%= command.id %> --pipeline-id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:automation:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "automation", "get.js" ] }, "cicd:pipeline:automation:list": { "aliases": [], "args": {}, "description": "List Copado pipeline automation rules", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id ", "<%= config.bin %> <%= command.id %> --pipeline-id --active --json", "<%= config.bin %> <%= command.id %> --pipeline-id --include-system-generated" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "active": { "description": "Filter by active status", "name": "active", "allowNo": true, "type": "boolean" }, "execution-time": { "description": "Filter by execution time (Immediate, Scheduled)", "name": "execution-time", "hasDynamicHelp": false, "multiple": false, "options": [ "Immediate", "Scheduled" ], "type": "option" }, "include-system-generated": { "description": "Include system-generated automation rules", "name": "include-system-generated", "allowNo": false, "type": "boolean" }, "name": { "description": "Filter by automation rule name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-action": { "description": "Filter by source action (Promotion, PromotionDeployment, Commit, CreatePackage, CreatePackageVersion, PublishPackageVersion, ImportPackage, TakeSnapshot, Rollback, PackageDistribution, Platform, SubmitUserStories, Submit)", "name": "source-action", "hasDynamicHelp": false, "multiple": false, "options": [ "Promotion", "PromotionDeployment", "Commit", "CreatePackage", "CreatePackageVersion", "PublishPackageVersion", "ImportPackage", "TakeSnapshot", "Rollback", "PackageDistribution", "Platform", "SubmitUserStories", "Submit" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:automation:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "automation", "list.js" ] }, "cicd:pipeline:automation:open": { "aliases": [], "args": { "id": { "description": "Automation rule Salesforce ID", "name": "id", "required": true } }, "description": "Open a Copado pipeline automation rule in the browser", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:automation:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "automation", "open.js" ] }, "cicd:pipeline:automation:update": { "aliases": [], "args": { "id": { "description": "Automation rule ID or name", "name": "id", "required": true } }, "description": "Update a Copado pipeline automation rule", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id --name \"Renamed rule\"", "<%= config.bin %> <%= command.id %> --pipeline-id --execution-time Scheduled --cron-expression \"0 2 * * *\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "callback-action": { "description": "Callback action for the automation rule", "name": "callback-action", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cron-expression": { "description": "Cron expression (required when execution time is Scheduled)", "name": "cron-expression", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "custom-automation-connector": { "description": "Custom automation connector (required for advanced scope)", "name": "custom-automation-connector", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "description": "Automation rule description", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment-id": { "description": "Environment ID target (repeatable; at least one --stage-id or --environment-id is required on create)", "name": "environment-id", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "environment-sync-source": { "description": "Source environment ID (required for environmentSyncBackPromotion scope)", "name": "environment-sync-source", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "execution-time": { "description": "When the rule runs (Immediate, Scheduled); Scheduled requires --cron-expression", "name": "execution-time", "hasDynamicHelp": false, "multiple": false, "options": [ "Immediate", "Scheduled" ], "type": "option" }, "filter-criteria": { "description": "User-story filter as JSON. Restricts which user stories the rule applies to. Builder mode matches field conditions with AND/OR logic: '{\"mode\":\"builder\",\"logic\":\"AND\",\"conditions\":[{\"field\":\"Name\",\"operator\":\"equals\",\"value\":\"US-1\"}]}'. Custom mode sends a SOQL-like whereCondition: '{\"mode\":\"custom\",\"whereCondition\":\"Name LIKE \\'US-%\\'\"}'. Operators: equals, notEquals, contains, notContains, greaterThan, greaterOrEqual, lessThan, lessOrEqual.", "exclusive": [ "filter-criteria-file" ], "name": "filter-criteria", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "filter-criteria-file": { "description": "Path to a JSON file with the user-story filter shape documented on --filter-criteria (builder or custom mode)", "exclusive": [ "filter-criteria" ], "name": "filter-criteria-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Automation rule name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "promotion-trigger": { "description": "Promotion trigger for promotion scope (manual, automated); manual maps to SubmitUserStories, automated to PromotionDeployment", "name": "promotion-trigger", "hasDynamicHelp": false, "multiple": false, "options": [ "manual", "automated" ], "type": "option" }, "scope": { "description": "Automation scope (promotion, backPromotion, environmentSyncBackPromotion, advanced); immutable after create", "name": "scope", "hasDynamicHelp": false, "multiple": false, "options": [ "promotion", "backPromotion", "environmentSyncBackPromotion", "advanced" ], "type": "option" }, "source-action": { "description": "Source action for advanced scope (Promotion, PromotionDeployment, Commit, CreatePackage, CreatePackageVersion, PublishPackageVersion, ImportPackage, TakeSnapshot, Rollback, PackageDistribution, Platform, SubmitUserStories, Submit)", "name": "source-action", "hasDynamicHelp": false, "multiple": false, "options": [ "Promotion", "PromotionDeployment", "Commit", "CreatePackage", "CreatePackageVersion", "PublishPackageVersion", "ImportPackage", "TakeSnapshot", "Rollback", "PackageDistribution", "Platform", "SubmitUserStories", "Submit" ], "type": "option" }, "source-action-status": { "description": "Source action status for advanced scope (Successful, Error)", "name": "source-action-status", "hasDynamicHelp": false, "multiple": false, "options": [ "Successful", "Error" ], "type": "option" }, "stage-id": { "description": "Stage ID target (repeatable; at least one --stage-id or --environment-id is required on create)", "name": "stage-id", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:automation:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "automation", "update.js" ] }, "cicd:pipeline:connection:create": { "aliases": [], "args": {}, "description": "Create one or more Copado pipeline connections", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id pipeline-1 --source-environment-id env-1 --destination-environment-id env-2 --branch main", "<%= config.bin %> <%= command.id %> --pipeline-id pipeline-1 --file connections.json", "<%= config.bin %> <%= command.id %> --pipeline-id pipeline-1 --source-environment-id env-1 --destination-environment-id env-2 --branch main --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "branch": { "description": "Source branch for the connection", "name": "branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-id": { "description": "Pipeline connection ID (required for single-connection update or delete)", "name": "connection-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "destination-branch": { "description": "Destination branch for the connection", "name": "destination-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "destination-environment-id": { "description": "Destination environment ID", "name": "destination-environment-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-environment-id": { "description": "Source environment ID", "name": "source-environment-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stage-connection-id": { "description": "Stage connection ID", "name": "stage-connection-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sync-merge-state": { "description": "Sync merge state", "name": "sync-merge-state", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sync-pull-state": { "description": "Sync pull state", "name": "sync-pull-state", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "char": "f", "description": "Path to a JSON array of pipeline connections to create", "exclusive": [ "branch", "destination-branch", "destination-environment-id", "source-environment-id", "stage-connection-id", "sync-merge-state", "sync-pull-state" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:connection:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "connection", "create.js" ] }, "cicd:pipeline:connection:delete": { "aliases": [], "args": {}, "description": "Delete one or more Copado pipeline connections", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id pipeline-1 --connection-id conn-1 --yes", "<%= config.bin %> <%= command.id %> --pipeline-id pipeline-1 --connection-id conn-1 --connection-id conn-2 --yes", "<%= config.bin %> <%= command.id %> --pipeline-id pipeline-1 --file connection-ids.json --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "connection-id": { "description": "Pipeline connection ID to delete (repeatable)", "name": "connection-id", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to a JSON array of connection IDs or an object with connectionIds", "exclusive": [ "connection-id" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Confirm deletion without prompting", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:connection:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "connection", "delete.js" ] }, "cicd:pipeline:connection:list": { "aliases": [], "args": {}, "description": "List connections for a Copado pipeline", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id ", "<%= config.bin %> <%= command.id %> --pipeline-id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "pipeline-id": { "description": "Pipeline Id whose connections should be listed", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:connection:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "connection", "list.js" ] }, "cicd:pipeline:connection:open": { "aliases": [], "args": { "id": { "description": "Pipeline connection ID", "name": "id", "required": true } }, "description": "Open a Copado pipeline connection in the browser", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:connection:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "connection", "open.js" ] }, "cicd:pipeline:connection:update": { "aliases": [], "args": {}, "description": "Update one or more Copado pipeline connections", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id pipeline-1 --connection-id conn-1 --destination-branch develop", "<%= config.bin %> <%= command.id %> --pipeline-id pipeline-1 --file connections.json", "<%= config.bin %> <%= command.id %> --pipeline-id pipeline-1 --connection-id conn-1 --branch main --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "branch": { "description": "Source branch for the connection", "name": "branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-id": { "description": "Pipeline connection ID (required for single-connection update or delete)", "name": "connection-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "destination-branch": { "description": "Destination branch for the connection", "name": "destination-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "destination-environment-id": { "description": "Destination environment ID", "name": "destination-environment-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-environment-id": { "description": "Source environment ID", "name": "source-environment-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stage-connection-id": { "description": "Stage connection ID", "name": "stage-connection-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sync-merge-state": { "description": "Sync merge state", "name": "sync-merge-state", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sync-pull-state": { "description": "Sync pull state", "name": "sync-pull-state", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "char": "f", "description": "Path to a JSON array of pipeline connections to update (each item requires id)", "exclusive": [ "branch", "connection-id", "destination-branch", "destination-environment-id", "source-environment-id", "stage-connection-id", "sync-merge-state", "sync-pull-state" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:connection:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "connection", "update.js" ] }, "cicd:pipeline:quality-gate:activate": { "aliases": [], "args": { "id": { "description": "Quality gate Salesforce ID (not name)", "name": "id", "required": true } }, "description": "Activate a Copado pipeline quality gate", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id ", "<%= config.bin %> <%= command.id %> --pipeline-id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:quality-gate:activate", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "quality-gate", "activate.js" ] }, "cicd:pipeline:quality-gate:create": { "aliases": [], "args": {}, "description": "Create inactive Copado pipeline quality gates", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id --tool Selenium --execution-sequence After --action Deployment --extension-configuration-id --environment-id --tests-from \"User Story\"", "<%= config.bin %> <%= command.id %> --pipeline-id --tool PMD --execution-sequence Before --action Commit --extension-configuration-id --entire-pipeline --json", "<%= config.bin %> <%= command.id %> --pipeline-id --tool PMD --execution-sequence Before --action Commit --extension-configuration-id --stage-id --filter-criteria '{\"conditions\":[{\"field\":\"Type\",\"operator\":\"equals\",\"value\":\"ApexClass\"},{\"field\":\"Name\",\"operator\":\"startsWith\",\"value\":\"Account\"}],\"logic\":\"1 AND 2\"}'" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "action": { "description": "Pipeline action the gate runs for (for example Commit, Promotion, Deployment)", "name": "action", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "entire-pipeline": { "description": "Apply the quality gate to the entire pipeline (mutually exclusive with --stage-id/--environment-id)", "exclusive": [ "environment-id", "stage-id" ], "name": "entire-pipeline", "allowNo": false, "type": "boolean" }, "environment-id": { "description": "Environment ID target (repeatable; provide --entire-pipeline or at least one stage/environment target)", "name": "environment-id", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "execution-sequence": { "description": "When the gate runs relative to the action (Before, After)", "name": "execution-sequence", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "Before", "After" ], "type": "option" }, "extension-configuration-id": { "description": "Active extension configuration ID whose tool matches --tool", "name": "extension-configuration-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "filter-criteria": { "description": "Metadata-change filter as JSON. Limits which metadata changes trigger the gate. Example: '{\"conditions\":[{\"field\":\"Type\",\"operator\":\"equals\",\"value\":\"ApexClass\"},{\"field\":\"Name\",\"operator\":\"startsWith\",\"value\":\"Account\"}],\"logic\":\"1 AND 2\"}'. Fields: Name, Type, Directory. Operators: startsWith, endsWith, equals, notEquals, contains, notContains. logic is optional for a single condition; otherwise reference each condition number exactly once with AND/OR and parentheses.", "exclusive": [ "filter-criteria-file" ], "name": "filter-criteria", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "filter-criteria-file": { "description": "Path to a JSON file with the metadata-change filter shape documented on --filter-criteria", "exclusive": [ "filter-criteria" ], "name": "filter-criteria-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stage-id": { "description": "Stage ID target (repeatable; provide --entire-pipeline or at least one stage/environment target)", "name": "stage-id", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "tests-from": { "description": "Where selected tests come from when the tool supports it (User Story, Feature, Application)", "name": "tests-from", "hasDynamicHelp": false, "multiple": false, "options": [ "User Story", "Feature", "Application" ], "type": "option" }, "tool": { "description": "Quality gate tool name (must be available for the tenant and match the extension configuration)", "name": "tool", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:quality-gate:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "quality-gate", "create.js" ] }, "cicd:pipeline:quality-gate:deactivate": { "aliases": [], "args": { "id": { "description": "Quality gate Salesforce ID (not name)", "name": "id", "required": true } }, "description": "Deactivate a Copado pipeline quality gate", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id ", "<%= config.bin %> <%= command.id %> --pipeline-id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:quality-gate:deactivate", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "quality-gate", "deactivate.js" ] }, "cicd:pipeline:quality-gate:delete": { "aliases": [], "args": { "id": { "description": "Quality gate ID or name", "name": "id", "required": true } }, "description": "Delete an inactive Copado pipeline quality gate", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id --yes", "<%= config.bin %> <%= command.id %> --pipeline-id --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Confirm deletion without prompting", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:quality-gate:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "quality-gate", "delete.js" ] }, "cicd:pipeline:quality-gate:get": { "aliases": [], "args": { "id": { "description": "Quality gate ID or name", "name": "id", "required": true } }, "description": "Get a Copado pipeline quality gate", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id ", "<%= config.bin %> <%= command.id %> --pipeline-id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:quality-gate:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "quality-gate", "get.js" ] }, "cicd:pipeline:quality-gate:list": { "aliases": [], "args": {}, "description": "List Copado pipeline quality gates", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id ", "<%= config.bin %> <%= command.id %> --pipeline-id --tool Selenium --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "cursor": { "description": "Opaque pagination cursor from a previous list response (nextCursor)", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of records per page (1-200)", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Filter by quality gate name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tool": { "description": "Filter by quality gate tool", "name": "tool", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:quality-gate:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "quality-gate", "list.js" ] }, "cicd:pipeline:quality-gate:open": { "aliases": [], "args": { "id": { "description": "Quality gate Salesforce ID", "name": "id", "required": true } }, "description": "Open a Copado pipeline quality gate in the browser", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:quality-gate:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "quality-gate", "open.js" ] }, "cicd:pipeline:quality-gate:update": { "aliases": [], "args": { "id": { "description": "Quality gate ID or name", "name": "id", "required": true } }, "description": "Update an inactive Copado pipeline quality gate", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id --execution-sequence Before", "<%= config.bin %> <%= command.id %> --pipeline-id --environment-id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "action": { "description": "Pipeline action the gate runs for (for example Commit, Promotion, Deployment)", "name": "action", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "entire-pipeline": { "description": "Apply the quality gate to the entire pipeline (mutually exclusive with --stage-id/--environment-id)", "name": "entire-pipeline", "allowNo": true, "type": "boolean" }, "environment-id": { "description": "Environment ID target (singular for update)", "name": "environment-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "execution-sequence": { "description": "When the gate runs relative to the action (Before, After)", "name": "execution-sequence", "hasDynamicHelp": false, "multiple": false, "options": [ "Before", "After" ], "type": "option" }, "extension-configuration-id": { "description": "Active extension configuration ID whose tool matches the gate tool", "name": "extension-configuration-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "filter-criteria": { "description": "Metadata-change filter as JSON. Limits which metadata changes trigger the gate. Example: '{\"conditions\":[{\"field\":\"Type\",\"operator\":\"equals\",\"value\":\"ApexClass\"},{\"field\":\"Name\",\"operator\":\"startsWith\",\"value\":\"Account\"}],\"logic\":\"1 AND 2\"}'. Fields: Name, Type, Directory. Operators: startsWith, endsWith, equals, notEquals, contains, notContains. logic is optional for a single condition; otherwise reference each condition number exactly once with AND/OR and parentheses.", "exclusive": [ "filter-criteria-file" ], "name": "filter-criteria", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "filter-criteria-file": { "description": "Path to a JSON file with the metadata-change filter shape documented on --filter-criteria", "exclusive": [ "filter-criteria" ], "name": "filter-criteria-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline ID or name", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stage-id": { "description": "Stage ID target (singular for update)", "name": "stage-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tests-from": { "description": "Where selected tests come from when the tool supports it (User Story, Feature, Application)", "name": "tests-from", "hasDynamicHelp": false, "multiple": false, "options": [ "User Story", "Feature", "Application" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:quality-gate:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "quality-gate", "update.js" ] }, "cicd:pipeline:stage-connection:create": { "aliases": [], "args": {}, "description": "Create a pipeline stage connection", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id pipeline-1 --stage-id stage-1" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "next-pipeline-stage-connection-id": { "description": "Next pipeline stage connection ID", "name": "next-pipeline-stage-connection-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stage-id": { "description": "Stage ID", "name": "stage-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline ID", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:stage-connection:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "stage-connection", "create.js" ] }, "cicd:pipeline:stage-connection:delete": { "aliases": [], "args": { "id": { "description": "Pipeline stage connection ID", "name": "id", "required": true } }, "description": "Delete a pipeline stage connection", "examples": [ "<%= config.bin %> <%= command.id %> connection-1 --pipeline-id pipeline-1 --yes" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "pipeline-id": { "description": "Pipeline ID", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Confirm deletion without prompting", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:stage-connection:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "stage-connection", "delete.js" ] }, "cicd:pipeline:stage-connection:list": { "aliases": [], "args": {}, "description": "List stage connections for a Copado pipeline", "examples": [ "<%= config.bin %> <%= command.id %> --pipeline-id ", "<%= config.bin %> <%= command.id %> --pipeline-id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "pipeline-id": { "description": "Pipeline ID whose stage connections should be listed", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:stage-connection:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "stage-connection", "list.js" ] }, "cicd:pipeline:stage-connection:open": { "aliases": [], "args": { "id": { "description": "Pipeline stage connection ID", "name": "id", "required": true } }, "description": "Open a pipeline stage connection in the browser", "examples": [ "<%= config.bin %> <%= command.id %> connection-1", "<%= config.bin %> <%= command.id %> connection-1 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:stage-connection:open", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "stage-connection", "open.js" ] }, "cicd:pipeline:stage-connection:update": { "aliases": [], "args": { "id": { "description": "Pipeline stage connection ID", "name": "id", "required": true } }, "description": "Update a pipeline stage connection", "examples": [ "<%= config.bin %> <%= command.id %> connection-1 --pipeline-id pipeline-1 --next-pipeline-stage-connection-id connection-2" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "next-pipeline-stage-connection-id": { "description": "Next pipeline stage connection ID", "name": "next-pipeline-stage-connection-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stage-id": { "description": "Stage ID", "name": "stage-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pipeline-id": { "description": "Pipeline ID", "name": "pipeline-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:pipeline:stage-connection:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "pipeline", "stage-connection", "update.js" ] }, "cicd:project:default:get": { "aliases": [], "args": {}, "description": "Show project default values for the current project or globally", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --project --environment", "<%= config.bin %> <%= command.id %> --global", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "assign-me": { "description": "Select the assign-me default", "name": "assign-me", "allowNo": false, "type": "boolean" }, "credential": { "description": "Select the default source credential", "name": "credential", "allowNo": false, "type": "boolean" }, "environment": { "description": "Select the default environment", "name": "environment", "allowNo": false, "type": "boolean" }, "epic": { "description": "Select the default epic", "name": "epic", "allowNo": false, "type": "boolean" }, "feature": { "description": "Select the default feature", "name": "feature", "allowNo": false, "type": "boolean" }, "global": { "description": "Use machine-wide defaults instead of project-local defaults", "name": "global", "allowNo": false, "type": "boolean" }, "project": { "description": "Select the default project", "name": "project", "allowNo": false, "type": "boolean" }, "sprint": { "description": "Select the default sprint", "name": "sprint", "allowNo": false, "type": "boolean" }, "team": { "description": "Select the default team", "name": "team", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:project:default:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "project", "default", "get.js" ] }, "cicd:project:default:set": { "aliases": [], "args": {}, "description": "Set project default values for the current project or globally", "examples": [ "<%= config.bin %> <%= command.id %> --project my-project --team platform", "<%= config.bin %> <%= command.id %> --environment dev --assign-me", "<%= config.bin %> <%= command.id %> --project my-project --global", "<%= config.bin %> <%= command.id %> --project my-project --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "credential": { "description": "Default source credential", "name": "credential", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "description": "Default environment", "name": "environment", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "epic": { "description": "Default epic", "name": "epic", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "feature": { "description": "Default feature", "name": "feature", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project": { "description": "Default project", "name": "project", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sprint": { "description": "Default sprint", "name": "sprint", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "description": "Default team", "name": "team", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "assign-me": { "description": "Assign work items to the current user by default", "name": "assign-me", "allowNo": false, "type": "boolean" }, "global": { "description": "Use machine-wide defaults instead of project-local defaults", "name": "global", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:project:default:set", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "project", "default", "set.js" ] }, "cicd:project:default:unset": { "aliases": [], "args": {}, "description": "Remove project default values from the current project or globally", "examples": [ "<%= config.bin %> <%= command.id %> --project", "<%= config.bin %> <%= command.id %> --environment --team", "<%= config.bin %> <%= command.id %> --assign-me --global", "<%= config.bin %> <%= command.id %> --project --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "assign-me": { "description": "Select the assign-me default", "name": "assign-me", "allowNo": false, "type": "boolean" }, "credential": { "description": "Select the default source credential", "name": "credential", "allowNo": false, "type": "boolean" }, "environment": { "description": "Select the default environment", "name": "environment", "allowNo": false, "type": "boolean" }, "epic": { "description": "Select the default epic", "name": "epic", "allowNo": false, "type": "boolean" }, "feature": { "description": "Select the default feature", "name": "feature", "allowNo": false, "type": "boolean" }, "global": { "description": "Use machine-wide defaults instead of project-local defaults", "name": "global", "allowNo": false, "type": "boolean" }, "project": { "description": "Select the default project", "name": "project", "allowNo": false, "type": "boolean" }, "sprint": { "description": "Select the default sprint", "name": "sprint", "allowNo": false, "type": "boolean" }, "team": { "description": "Select the default team", "name": "team", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:project:default:unset", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "project", "default", "unset.js" ] }, "cicd:promotion:conflict:get": { "aliases": [], "args": { "id": { "description": "Conflict attachment Id", "name": "id", "required": true } }, "description": "Get raw merge-conflict content for a promotion file", "examples": [ "<%= config.bin %> <%= command.id %> --promotion ", "<%= config.bin %> <%= command.id %> -p --output ./MyClass.cls", "<%= config.bin %> <%= command.id %> -p --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "output": { "description": "Write raw conflict content to this file path", "name": "output", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "promotion": { "char": "p", "description": "Copado promotion Id", "name": "promotion", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:promotion:conflict:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "promotion", "conflict", "get.js" ] }, "cicd:promotion:conflict:list": { "aliases": [], "args": {}, "description": "List merge conflicts for a Copado promotion", "examples": [ "<%= config.bin %> <%= command.id %> --promotion ", "<%= config.bin %> <%= command.id %> -p --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "promotion": { "char": "p", "description": "Copado promotion Id", "name": "promotion", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:promotion:conflict:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "promotion", "conflict", "list.js" ] }, "cicd:promotion:conflict:resolve": { "aliases": [], "args": { "id": { "description": "Conflict attachment Id", "name": "id", "required": true } }, "description": "Resolve a promotion merge conflict automatically or from a file", "examples": [ "<%= config.bin %> <%= command.id %> --promotion --mode auto", "<%= config.bin %> <%= command.id %> -p --mode manual --file ./MyClass.cls", "<%= config.bin %> <%= command.id %> -p --mode auto --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "file": { "description": "Path to manually resolved conflict content", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "mode": { "description": "Conflict resolution mode", "name": "mode", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "auto", "manual" ], "type": "option" }, "promotion": { "char": "p", "description": "Copado promotion Id", "name": "promotion", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:promotion:conflict:resolve", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "promotion", "conflict", "resolve.js" ] }, "cicd:promotion:conflict:unresolve": { "aliases": [], "args": { "id": { "description": "Conflict attachment Id", "name": "id", "required": true } }, "description": "Undo a promotion conflict resolution", "examples": [ "<%= config.bin %> <%= command.id %> --promotion ", "<%= config.bin %> <%= command.id %> -p --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "promotion": { "char": "p", "description": "Copado promotion Id", "name": "promotion", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:promotion:conflict:unresolve", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "promotion", "conflict", "unresolve.js" ] }, "cicd:promotion:job-step:update": { "aliases": [], "args": { "id": { "description": "Promotion job step ID", "name": "id", "required": true } }, "description": "Update a promotion manual task", "examples": [ "<%= config.bin %> <%= command.id %> --promotion --status Complete", "<%= config.bin %> <%= command.id %> -p --task-comments \"Completed by QA\"", "<%= config.bin %> <%= command.id %> -p --assignee-id 005... --assignee-name \"Jane Doe\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "assignee-id": { "description": "Salesforce user ID assigned to the manual task", "name": "assignee-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "assignee-name": { "description": "Name of the user assigned to the manual task", "name": "assignee-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "promotion": { "char": "p", "description": "Copado promotion ID or name", "name": "promotion", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Manual task status", "name": "status", "hasDynamicHelp": false, "multiple": false, "options": [ "Complete", "Incomplete", "Pending" ], "type": "option" }, "task-comments": { "description": "Manual task comments", "name": "task-comments", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "task-description": { "description": "Manual task description", "name": "task-description", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:promotion:job-step:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "promotion", "job-step", "update.js" ] }, "cicd:repository:auth:setup": { "aliases": [], "args": { "id": { "description": "Copado Git repository ID", "name": "id", "required": true } }, "description": "Interactively configure repository authentication; OAuth is selected by default", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "overwrite": { "description": "Replace an existing HTTPS or SSH credential", "name": "overwrite", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:repository:auth:setup", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "repository", "auth", "setup.js" ] }, "cicd:work:deployment-step:create": { "aliases": [], "args": {}, "description": "Create a deployment step for a user story", "examples": [ "<%= config.bin %> <%= command.id %> --interactive", "<%= config.bin %> <%= command.id %> --name \"Run robotic smoke test\" --type \"Robotic Test\" --crt-test-id a1t... --crt-run-on destination", "<%= config.bin %> <%= command.id %> --name \"Run post-deploy flow\" --type \"Salesforce Flow\" --sequence after --config-json '{\"flowName\":\"Post_Deploy\",\"parameters\":[]}'", "<%= config.bin %> <%= command.id %> --name \"Deploy Mule application\" --custom-step-api-name Deploy_Mule --config-file config.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "apex-script": { "description": "Apex script for a guided Apex step", "exclusive": [ "apex-script-file" ], "name": "apex-script", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "apex-script-file": { "description": "Path to an Apex script for a guided Apex step", "exclusive": [ "apex-script" ], "name": "apex-script-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "assignee-id": { "description": "Manual Task assignee Salesforce user ID", "name": "assignee-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "assignee-name": { "description": "Manual Task assignee display name", "name": "assignee-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config-file": { "description": "Path to deployment step config JSON", "exclusive": [ "config-json" ], "name": "config-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config-json": { "description": "Inline deployment step config JSON", "exclusive": [ "config-file" ], "name": "config-json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "crt-run-on": { "description": "Environment where the Robotic Test runs", "name": "crt-run-on", "hasDynamicHelp": false, "multiple": false, "options": [ "source", "destination" ], "type": "option" }, "crt-test-id": { "description": "Robotic Test Salesforce ID", "name": "crt-test-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "custom-step-api-name": { "description": "Custom deployment step API name", "exclusive": [ "type" ], "name": "custom-step-api-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "data-set-id": { "description": "Salesforce Data Set ID", "name": "data-set-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "data-template-id": { "description": "Salesforce Data Template ID", "name": "data-template-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "description": "Manual Task execution environment", "name": "environment", "hasDynamicHelp": false, "multiple": false, "options": [ "source", "destination", "both" ], "type": "option" }, "flow-name": { "description": "Salesforce Flow API name", "name": "flow-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "function-name": { "description": "Function name", "name": "function-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "instructions": { "description": "Manual Task instructions", "name": "instructions", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "interactive": { "description": "Prompt for the type and all required configuration", "name": "interactive", "allowNo": false, "type": "boolean" }, "name": { "description": "Deployment step name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "parameter": { "description": "Flow or Function parameter as name=value (repeatable)", "name": "parameter", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "queue-name": { "description": "Queue name", "name": "queue-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "run-on-validation": { "description": "Run or skip the step during validation", "name": "run-on-validation", "allowNo": true, "type": "boolean" }, "sequence": { "description": "Place the deployment step before or after deployment", "name": "sequence", "hasDynamicHelp": false, "multiple": false, "options": [ "before", "after" ], "type": "option" }, "skip-back-promotion": { "description": "Skip or include the step during back promotion", "name": "skip-back-promotion", "allowNo": true, "type": "boolean" }, "skip-condition": { "description": "Deployment step skip condition", "name": "skip-condition", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Standard deployment step type", "exclusive": [ "custom-step-api-name" ], "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "Manual Task", "Salesforce Flow", "Function", "Apex", "Data Set - Salesforce", "Data Template - Salesforce", "Robotic Test" ], "type": "option" }, "user-story": { "description": "User story ID (defaults to the active work item from `work set`)", "name": "user-story", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:deployment-step:create", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "deployment-step", "create.js" ] }, "cicd:work:deployment-step:delete": { "aliases": [], "args": {}, "description": "Delete a user story deployment step", "examples": [ "<%= config.bin %> <%= command.id %> --step a2D...", "<%= config.bin %> <%= command.id %> --step a2D... --user-story a16... --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "step": { "description": "Deployment step ID", "name": "step", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "user-story": { "description": "User story ID (defaults to the active work item from `work set`)", "name": "user-story", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:deployment-step:delete", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "deployment-step", "delete.js" ] }, "cicd:work:deployment-step:list": { "aliases": [], "args": {}, "description": "List deployment steps for a user story", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --user-story a16P700000000001AAA --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "user-story": { "description": "User story ID (defaults to the active work item from `work set`)", "name": "user-story", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:deployment-step:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "deployment-step", "list.js" ] }, "cicd:work:deployment-step:reorder": { "aliases": [], "args": {}, "description": "Replace the complete deployment step order", "examples": [ "<%= config.bin %> <%= command.id %> --file order.json", "cat order.json | <%= config.bin %> <%= command.id %> --stdin --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "file": { "description": "Path to a complete deployment step order JSON file", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read the complete deployment step order from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" }, "user-story": { "description": "User story ID (defaults to the active work item from `work set`)", "name": "user-story", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:deployment-step:reorder", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "deployment-step", "reorder.js" ] }, "cicd:work:deployment-step:salesforce-flows": { "aliases": [], "args": {}, "description": "List Salesforce Flows available to deployment steps in the Copado org", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:deployment-step:salesforce-flows", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "deployment-step", "salesforce-flows.js" ] }, "cicd:work:deployment-step:types": { "aliases": [], "args": {}, "description": "List available deployment step types", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:deployment-step:types", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "deployment-step", "types.js" ] }, "cicd:work:deployment-step:update": { "aliases": [], "args": {}, "description": "Update a user story deployment step", "examples": [ "<%= config.bin %> <%= command.id %> --step a2D... --name \"Updated step\"", "<%= config.bin %> <%= command.id %> --step a2D... --clear-queue-name --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "clear-queue-name": { "description": "Clear the queue name", "exclusive": [ "queue-name" ], "name": "clear-queue-name", "allowNo": false, "type": "boolean" }, "clear-skip-condition": { "description": "Clear the skip condition", "exclusive": [ "skip-condition" ], "name": "clear-skip-condition", "allowNo": false, "type": "boolean" }, "config-file": { "description": "Path to deployment step config JSON", "exclusive": [ "config-json" ], "name": "config-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config-json": { "description": "Inline deployment step config JSON", "exclusive": [ "config-file" ], "name": "config-json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Deployment step name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "queue-name": { "description": "Queue name", "exclusive": [ "clear-queue-name" ], "name": "queue-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "run-on-validation": { "description": "Run or skip the step during validation", "name": "run-on-validation", "allowNo": true, "type": "boolean" }, "skip-back-promotion": { "description": "Skip or include the step during back promotion", "name": "skip-back-promotion", "allowNo": true, "type": "boolean" }, "skip-condition": { "description": "Deployment step skip condition", "exclusive": [ "clear-skip-condition" ], "name": "skip-condition", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "step": { "description": "Deployment step ID", "name": "step", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "user-story": { "description": "User story ID (defaults to the active work item from `work set`)", "name": "user-story", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:deployment-step:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "deployment-step", "update.js" ] }, "cicd:work:test:apex": { "aliases": [], "args": {}, "description": "Run specified Apex test classes via Salesforce CLI (`sf apex run test`) with code coverage. Usually run from project-root local quality gates (`.agentia_quality_gates.sh` / `.agentia_quality_gates.cmd`) when those scripts are configured. When `--apex-test-classes` is omitted or empty, logs that no Apex tests were specified and exits without running Salesforce CLI. Failed runs save `.agentia/apex.tests..json`; successful runs delete that file. `--rerun-failed-apex-tests` runs the previously failed classes (optionally filtered by `--apex-test-classes`). Prints the test-run summary when the run passes, or failing tests with their messages and stack traces when it fails. Exits with the same process exit code as Salesforce CLI (`sf`), including 100 when Apex tests fail.", "examples": [ "<%= config.bin %> <%= command.id %> -t HelloWorldTest", "<%= config.bin %> <%= command.id %> --apex-test-classes=MyTest,OtherTest", "<%= config.bin %> <%= command.id %> -t MyTest,OtherTest -w 10 --json", "<%= config.bin %> <%= command.id %> -t \"$AGENTIA_APEX_TEST_CLASSES\"", "<%= config.bin %> <%= command.id %> --rerun-failed-apex-tests" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "apex-test-classes": { "char": "t", "description": "Comma-separated Apex test class names to run. Omit or leave empty to skip without running Salesforce CLI.", "name": "apex-test-classes", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "rerun-failed-apex-tests": { "description": "Rerun Apex classes saved from the last failure for this user story (`.agentia/apex.tests..json`). Combined with --apex-test-classes, only matching failed classes run.", "name": "rerun-failed-apex-tests", "allowNo": false, "type": "boolean" }, "wait": { "char": "w", "description": "Minutes to wait for Salesforce CLI Apex test results", "name": "wait", "default": 60, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:work:test:apex", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "work", "test", "apex.js" ] }, "testing:job:files:download": { "aliases": [], "args": { "id": { "description": "CRT job ID.", "name": "id", "required": true } }, "deprecateAliases": true, "description": "Download files from a Copado Robotic Testing job", "examples": [ "<%= config.bin %> <%= command.id %> --project --file tests.robot", "<%= config.bin %> <%= command.id %> --project --file tests.robot --output-dir ./crt-files --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "branch": { "description": "Optional CRT branch name for file operations.", "name": "branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "char": "f", "description": "Remote CRT file path to download. Can be provided multiple times.", "name": "file", "required": true, "hasDynamicHelp": false, "multiple": true, "type": "option" }, "output-dir": { "char": "o", "description": "Directory to write downloaded files.", "name": "output-dir", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ "testing:job:download" ], "id": "testing:job:files:download", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "files", "download.js" ] }, "testing:job:files:list": { "aliases": [], "args": { "id": { "description": "CRT job ID.", "name": "id", "required": true } }, "deprecateAliases": true, "description": "List files for a Copado Robotic Testing job", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --branch main --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "branch": { "description": "Optional CRT branch name for file operations.", "name": "branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "shared-credentials": { "description": "Use shared stored Git credentials.", "name": "shared-credentials", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ "testing:job:files" ], "id": "testing:job:files:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "files", "list.js" ] }, "testing:job:files:upload": { "aliases": [], "args": { "id": { "description": "CRT job ID.", "name": "id", "required": true } }, "deprecateAliases": true, "description": "Upload file operations to a Copado Robotic Testing job", "examples": [ "<%= config.bin %> <%= command.id %> --project --add tests.robot", "<%= config.bin %> <%= command.id %> --project --replace local.robot:tests.robot --remove old.robot --json", "<%= config.bin %> <%= command.id %> --project --add tests/smoke.robot --base-path tests --remote-prefix suites --dry-run --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "branch": { "description": "Optional CRT branch name for file operations.", "name": "branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "add": { "description": "Add a file using local[:remote] syntax. Can be provided multiple times.", "name": "add", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "remove": { "description": "Remove a remote CRT file path. Can be provided multiple times.", "name": "remove", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "replace": { "description": "Replace a file using local[:remote] syntax. Can be provided multiple times.", "name": "replace", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "author-email": { "description": "Author email for CRT file history.", "name": "author-email", "default": "agentia@copado.com", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "author-name": { "description": "Author name for CRT file history.", "name": "author-name", "default": "Agentia CLI", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "base-path": { "description": "Require local upload files to stay within this directory and derive relative paths from it.", "name": "base-path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dry-run": { "description": "Return a sanitized upload plan without making a network mutation.", "name": "dry-run", "allowNo": false, "type": "boolean" }, "message": { "description": "Commit message for CRT file history.", "name": "message", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "parent-commit": { "description": "Expected parent commit hash.", "name": "parent-commit", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote-prefix": { "description": "Validated remote path prefix for all operations.", "name": "remote-prefix", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ "testing:job:upload", "testing:update", "testing:test:update" ], "id": "testing:job:files:upload", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "files", "upload.js" ] }, "testing:job:runs:abort": { "aliases": [], "args": { "id": { "description": "CRT build/run ID.", "name": "id", "required": true } }, "deprecateAliases": true, "description": "Abort a Copado Robotic Testing job run", "examples": [ "<%= config.bin %> <%= command.id %> --project --job --yes", "<%= config.bin %> <%= command.id %> --project --job --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "job": { "char": "j", "description": "CRT job ID.", "name": "job", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip the destructive confirmation prompt.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ "testing:build:abort" ], "id": "testing:job:runs:abort", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "runs", "abort.js" ] }, "testing:job:runs:get": { "aliases": [], "args": { "id": { "description": "CRT build/run ID.", "name": "id", "required": true } }, "deprecateAliases": true, "description": "Get the result of a Copado Robotic Testing job run", "examples": [ "<%= config.bin %> <%= command.id %> --project --job ", "<%= config.bin %> <%= command.id %> --project --job --full --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "job": { "char": "j", "description": "CRT job ID.", "name": "job", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "full": { "description": "Fetch the full build result instead of the compact summary.", "name": "full", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ "testing:build:get" ], "id": "testing:job:runs:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "runs", "get.js" ] }, "testing:job:runs:list": { "aliases": [], "args": {}, "deprecateAliases": true, "description": "List Copado Robotic Testing job runs", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --status failed --json", "<%= config.bin %> <%= command.id %> --project --job --status succeeded --json", "<%= config.bin %> <%= command.id %> --project --job --count" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "count": { "description": "Return only the number of builds. Requires --job.", "name": "count", "allowNo": false, "type": "boolean" }, "job": { "description": "Limit builds to one CRT job ID.", "name": "job", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page": { "description": "CRT build page number.", "name": "page", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "description": "Number of CRT builds per page.", "name": "page-size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "result-size": { "description": "CRT build result size.", "name": "result-size", "default": "compact", "hasDynamicHelp": false, "multiple": false, "options": [ "compact" ], "type": "option" }, "status": { "description": "Build status filter.", "name": "status", "hasDynamicHelp": false, "multiple": false, "options": [ "aborted", "executing", "failed", "finished", "queued", "succeeded" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ "testing:build:list", "testing:build:latest", "testing:status", "testing:test:status" ], "id": "testing:job:runs:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "runs", "list.js" ] }, "testing:job:runs:logs": { "aliases": [], "args": { "id": { "description": "CRT build/run ID.", "name": "id", "required": true } }, "deprecateAliases": true, "description": "Get logs for a Copado Robotic Testing job run", "examples": [ "<%= config.bin %> <%= command.id %> --project --job ", "<%= config.bin %> <%= command.id %> --project --job --tail-lines 200", "<%= config.bin %> <%= command.id %> --project --job --output log.html --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "job": { "char": "j", "description": "CRT job ID.", "name": "job", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "container": { "description": "Read a specific CRT log stream/container.", "name": "container", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit-bytes": { "description": "Limit fetched log data to this many bytes.", "name": "limit-bytes", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pretty": { "description": "Request readable log formatting.", "name": "pretty", "allowNo": false, "type": "boolean" }, "since-seconds": { "description": "Fetch log lines from the last N seconds.", "name": "since-seconds", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tail-lines": { "description": "Return only the last N log lines.", "name": "tail-lines", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timestamps": { "description": "Add timestamps to log lines.", "name": "timestamps", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Write raw output to this file path.", "name": "output", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ "testing:logs", "testing:test:logs", "testing:build:logs" ], "id": "testing:job:runs:logs", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "runs", "logs.js" ] }, "testing:job:runs:search": { "aliases": [], "args": {}, "deprecateAliases": true, "description": "Search Copado Robotic Testing job run metrics", "examples": [ "<%= config.bin %> <%= command.id %> --project --job --status failed", "<%= config.bin %> <%= command.id %> --project --job --run-type regression --count --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "job": { "char": "j", "description": "CRT job ID.", "name": "job", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "count": { "description": "Return only the filtered build count.", "name": "count", "allowNo": false, "type": "boolean" }, "from": { "description": "Include builds at or after this ISO-8601 date or epoch value.", "name": "from", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "order": { "name": "order", "default": "desc", "hasDynamicHelp": false, "multiple": false, "options": [ "asc", "desc" ], "type": "option" }, "page": { "name": "page", "default": 1, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page-size": { "name": "page-size", "default": 50, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "robot": { "description": "Robot ID filter. Can be provided multiple times.", "name": "robot", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "run-type": { "description": "Run type filter. Can be provided multiple times.", "name": "run-type", "hasDynamicHelp": false, "multiple": true, "options": [ "regression", "development" ], "type": "option" }, "sort": { "name": "sort", "default": "date", "hasDynamicHelp": false, "multiple": false, "options": [ "date", "duration", "id", "status" ], "type": "option" }, "status": { "description": "Status filter. Can be provided multiple times.", "name": "status", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "to": { "description": "Include builds at or before this ISO-8601 date or epoch value.", "name": "to", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ "testing:build:search" ], "id": "testing:job:runs:search", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "runs", "search.js" ] }, "testing:job:schedule:get": { "aliases": [], "args": { "id": { "description": "CRT job ID.", "name": "id", "required": true } }, "description": "Get the schedule for a Copado Robotic Testing job", "examples": [ "<%= config.bin %> <%= command.id %> --project ", "<%= config.bin %> <%= command.id %> --project --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:job:schedule:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "schedule", "get.js" ] }, "testing:job:schedule:remove": { "aliases": [], "args": { "id": { "description": "CRT job ID.", "name": "id", "required": true } }, "description": "Remove the schedule from a Copado Robotic Testing job", "examples": [ "<%= config.bin %> <%= command.id %> --project --yes", "<%= config.bin %> <%= command.id %> --project --yes --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Confirm schedule removal.", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:job:schedule:remove", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "schedule", "remove.js" ] }, "testing:job:schedule:set": { "aliases": [], "args": { "id": { "description": "CRT job ID.", "name": "id", "required": true } }, "description": "Create or update a Copado Robotic Testing job schedule", "examples": [ "<%= config.bin %> <%= command.id %> --project --cron \"0 6 * * 1-5\"", "<%= config.bin %> <%= command.id %> --project --cron \"0 6 * * *\" --timezone Europe/Helsinki --record failed --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "project": { "char": "p", "description": "CRT project ID.", "name": "project", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cron": { "description": "Cron expression for the schedule.", "name": "cron", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "record": { "description": "Recording mode for scheduled runs.", "name": "record", "hasDynamicHelp": false, "multiple": false, "options": [ "all", "failed", "none" ], "type": "option" }, "timezone": { "description": "Timezone for the schedule, for example Europe/Helsinki.", "name": "timezone", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:job:schedule:set", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "job", "schedule", "set.js" ] }, "testing:project:permission:get": { "aliases": [], "args": { "project": { "description": "CRT project ID.", "name": "project", "required": true } }, "description": "Get the caller's permission on a Copado Robotic Testing project", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:project:permission:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "project", "permission", "get.js" ] }, "testing:project:permission:list": { "aliases": [], "args": { "project": { "description": "CRT project ID.", "name": "project", "required": true } }, "description": "List assignments for a Copado Robotic Testing project", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:project:permission:list", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "project", "permission", "list.js" ] }, "testing:project:permission:set": { "aliases": [], "args": { "project": { "description": "CRT project ID.", "name": "project", "required": true } }, "description": "Set a user or group permission on a Copado Robotic Testing project", "examples": [ "<%= config.bin %> <%= command.id %> --user --view", "<%= config.bin %> <%= command.id %> --group --view --edit --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "edit": { "description": "Grant edit access.", "name": "edit", "allowNo": false, "type": "boolean" }, "group": { "description": "Platform group ID.", "exclusive": [ "user" ], "name": "group", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "user": { "description": "Platform user ID.", "exclusive": [ "group" ], "name": "user", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "view": { "description": "Grant view access.", "name": "view", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:project:permission:set", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "project", "permission", "set.js" ] }, "testing:project:permission:update": { "aliases": [], "args": { "project": { "description": "CRT project ID.", "name": "project", "required": true } }, "description": "Update a user or group permission on a Copado Robotic Testing project", "examples": [ "<%= config.bin %> <%= command.id %> --user --view --edit", "<%= config.bin %> <%= command.id %> --group --view --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "edit": { "description": "Set edit access.", "name": "edit", "allowNo": false, "type": "boolean" }, "group": { "description": "Platform group ID.", "exclusive": [ "user" ], "name": "group", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "user": { "description": "Platform user ID.", "exclusive": [ "group" ], "name": "user", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "view": { "description": "Set view access.", "name": "view", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "testing:project:permission:update", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "testing", "project", "permission", "update.js" ] }, "cicd:credential:auth:web:login": { "aliases": [], "args": { "id": { "description": "Copado credential ID", "name": "id", "required": true } }, "description": "Authenticate a credential via browser web login", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --port 8085 --timeout 120", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "port": { "description": "Local loopback port (default: scan 8080-8090)", "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "Max seconds to wait for browser login", "name": "timeout", "default": 300, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:credential:auth:web:login", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "credential", "auth", "web", "login.js" ] }, "cicd:environment:auth:web:login": { "aliases": [], "args": { "id": { "description": "Copado environment ID (optional when --credentialid is provided)", "name": "id", "required": false } }, "description": "Authenticate an environment credential via browser web login", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --credentialid ", "<%= config.bin %> <%= command.id %> --port 8085 --timeout 120", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "credentialid": { "description": "Credential ID to authenticate; when set without an environment ID, resolves the environment from the credential", "name": "credentialid", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "Local loopback port (default: scan 8080-8090)", "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "Max seconds to wait for browser login", "name": "timeout", "default": 300, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:environment:auth:web:login", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "environment", "auth", "web", "login.js" ] }, "cicd:function:result:log:get": { "aliases": [], "args": { "result-id": { "description": "Function result Id", "name": "result-id", "required": true } }, "description": "Get log output for a Copado Function result", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --type stdout", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "type": { "description": "Optional log file type filter", "name": "type", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:function:result:log:get", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "function", "result", "log", "get.js" ] }, "cicd:repository:auth:https:configure": { "aliases": [], "args": { "id": { "description": "Copado Git repository ID", "name": "id", "required": true } }, "description": "Configure HTTPS authentication. Use a personal access token as the password when required by the provider.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "input-stdin": { "description": "Read the complete HTTPS authentication JSON payload from stdin", "name": "input-stdin", "allowNo": false, "type": "boolean" }, "overwrite": { "description": "Replace an existing validated HTTPS credential", "name": "overwrite", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:repository:auth:https:configure", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "repository", "auth", "https", "configure.js" ] }, "cicd:repository:auth:oauth:login": { "aliases": [], "args": { "id": { "description": "Copado Git repository ID", "name": "id", "required": true } }, "description": "Authenticate a repository through browser OAuth and select a remote repository", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "port": { "description": "Local callback port (default: scan 8080-8090)", "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "Seconds to wait for browser authentication", "name": "timeout", "default": 300, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:repository:auth:oauth:login", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "repository", "auth", "oauth", "login.js" ] }, "cicd:repository:auth:ssh:configure": { "aliases": [], "args": { "id": { "description": "Copado Git repository ID", "name": "id", "required": true } }, "description": "Generate SSH authentication and a public key. Add the key to your Git provider as a deploy, access, or SSH key.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "overwrite": { "description": "Replace an existing SSH key after confirmation", "name": "overwrite", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cicd:repository:auth:ssh:configure", "pluginAlias": "@copado/agentia-cli", "pluginName": "@copado/agentia-cli", "pluginType": "core", "strict": true, "enableJsonFlag": true, "experimental": false, "isESM": true, "relativePath": [ "dist", "commands", "cicd", "repository", "auth", "ssh", "configure.js" ] } }, "version": "1.2.0" }