{ "commands": { "api": { "aliases": [], "args": { "endpoint": { "description": "API endpoint path (e.g. /v1/checks).", "name": "endpoint", "required": true } }, "description": "Make an authenticated HTTP request to the Checkly API.\nPass-through for any endpoint — handles auth automatically.\nSee https://www.checklyhq.com/docs/api for available endpoints.\nOpenAPI spec: https://api.checklyhq.com/openapi.json", "examples": [ "checkly api /v1/checks", "checkly api /v1/checks -X GET --jq '.[].name'", "checkly api /v1/checks -X POST -F name=MyCheck -F activated:=true", "checkly api /v1/checks -X GET -F limit=5", "echo '{\"name\":\"New\"}' | checkly api /v1/checks -X POST --input -" ], "flags": { "method": { "char": "X", "description": "HTTP method.", "name": "method", "hasDynamicHelp": false, "multiple": false, "options": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "type": "option" }, "field": { "char": "F", "description": "Add a field: key=value (string) or key:=value (parsed as JSON).", "name": "field", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "header": { "char": "H", "description": "Custom HTTP header: \"Key: Value\".", "name": "header", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "jq": { "description": "Filter JSON output with a jq expression (requires jq installed).", "name": "jq", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "input": { "description": "Request body from file path, or \"-\" for stdin.", "name": "input", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "include": { "char": "i", "description": "Include HTTP status and response headers in the output.", "name": "include", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Print request and response headers to stderr.", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "api", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": true, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "api.js" ] }, "authCommand": { "aliases": [], "args": {}, "flags": {}, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "authCommand", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "authCommand.js" ] }, "baseCommand": { "aliases": [], "args": {}, "flags": {}, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "baseCommand", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "baseCommand.js" ] }, "deploy": { "aliases": [], "args": {}, "description": "Deploy your project to your Checkly account.", "flags": { "preview": { "char": "p", "description": "Show a preview of the changes made by the deploy command.", "name": "preview", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Shows the changes made after the deploy command.", "name": "output", "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "description": "Show resource names and IDs in the deploy output.", "name": "verbose", "allowNo": false, "type": "boolean" }, "schedule-on-deploy": { "description": "Enables automatic check scheduling after a deploy.", "name": "schedule-on-deploy", "allowNo": true, "type": "boolean" }, "force": { "char": "f", "description": "Skip confirmation prompt.", "name": "force", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verify-runtime-dependencies": { "description": "[default: true] Return an error if checks import dependencies that are not supported by the selected runtime.", "env": "CHECKLY_VERIFY_RUNTIME_DEPENDENCIES", "name": "verify-runtime-dependencies", "allowNo": true, "type": "boolean" }, "debug-bundle": { "description": "Output the project bundle to a file without deploying any resources.", "hidden": true, "name": "debug-bundle", "allowNo": false, "type": "boolean" }, "debug-bundle-output-file": { "description": "The file to output the debug debug bundle to.", "hidden": true, "name": "debug-bundle-output-file", "default": "./debug-bundle.json", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "deploy", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": true, "readOnly": false, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "deploy.js" ] }, "destroy": { "aliases": [], "args": {}, "description": "Destroy your project with all its related resources.", "flags": { "force": { "char": "f", "description": "Skip confirmation prompt.", "name": "force", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "preserve-resources": { "description": "Preserve all project resources (checks, groups, dashboards, etc.) when destroying the project. Resources become normal account-level resources.", "name": "preserve-resources", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "destroy", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": true, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "destroy.js" ] }, "help": { "aliases": [], "args": {}, "description": "Display help for <%= config.bin %>.", "flags": {}, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "help", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "help.js" ] }, "init": { "aliases": [], "args": {}, "description": "Initialize Checkly in your project", "examples": [ "$ npx checkly init", "$ npx checkly init --target claude", "$ CI=true npx checkly init" ], "flags": { "target": { "char": "t", "description": "Install the Checkly skill for a specific AI agent (amp, claude, cline, codex, continue, cursor, gemini-cli, github-copilot, goose, opencode, roo, windsurf).", "name": "target", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "init", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": true, "readOnly": false, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "init.js" ] }, "login": { "aliases": [], "args": {}, "description": "Login to your Checkly account or create a new one.", "flags": {}, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "login", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "login.js" ] }, "logout": { "aliases": [], "args": {}, "description": "Log out and clear any local credentials.", "flags": { "force": { "char": "f", "description": "Force mode. Skips the confirmation dialog.", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "logout", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "logout.js" ] }, "members": { "aliases": [], "args": {}, "description": "List account members and pending invites.", "flags": { "search": { "char": "s", "description": "Search members and invites by name or email.", "name": "search", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Filter by item type: member or invite.", "name": "type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "role": { "description": "Filter by member or invite role: owner, admin, read_write, read_run, read_only.", "name": "role", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Filter by member or invite status: active, pending, expired.", "name": "status", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "char": "l", "description": "Number of account members to return (1-100). Enables cursor pagination.", "name": "limit", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "next-id": { "description": "Cursor for next page. Requires --limit.", "name": "next-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "hide-id": { "description": "Hide member and invite IDs in table output.", "name": "hide-id", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [ "account members" ], "id": "members", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "members.js" ] }, "pw-test": { "aliases": [], "args": {}, "description": "Test your Playwright Tests on Checkly.", "flags": { "location": { "char": "l", "description": "The location to run the checks at.", "name": "location", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "private-location": { "description": "The private location to run checks at.", "exclusive": [ "location" ], "name": "private-location", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "char": "e", "description": "Env vars to be passed to the test run.", "exclusive": [ "env-file" ], "name": "env", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "env-file": { "description": "dotenv file path to be passed. For example --env-file=\"./.env\"", "exclusive": [ "env" ], "name": "env-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "A timeout (in seconds) to wait for checks to complete.", "name": "timeout", "default": 1200, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "description": "Always show the full logs of the checks.", "name": "verbose", "allowNo": false, "type": "boolean" }, "reporter": { "description": "A list of custom reporters for the test output.", "name": "reporter", "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "options": [ "list", "dot", "ci", "github", "json" ], "type": "option" }, "config": { "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "record": { "description": "[default: true] Record test results in Checkly as a test session with full logs, traces and videos.", "name": "record", "allowNo": true, "type": "boolean" }, "test-session-name": { "description": "A name to use when storing results in Checkly", "name": "test-session-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "create-check": { "description": "Create a Checkly check from the Playwright test.", "name": "create-check", "allowNo": false, "type": "boolean" }, "frequency": { "char": "f", "description": "The frequency in minutes for the created check.", "name": "frequency", "default": 10, "hasDynamicHelp": false, "multiple": false, "options": [ "1", "2", "5", "10", "15", "30", "60", "120", "180", "360", "720", "1440" ], "type": "option" }, "stream-logs": { "description": "Stream logs from the test run to the console.", "name": "stream-logs", "allowNo": true, "type": "boolean" }, "include": { "char": "i", "description": "File patterns to include when bundling the test project (e.g., \"utils/**/*\").", "name": "include", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "install-command": { "description": "Command to install dependencies before running tests.", "name": "install-command", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "refresh-cache": { "description": "Force a fresh install of dependencies and update the cached version.", "name": "refresh-cache", "allowNo": false, "type": "boolean" }, "detach": { "char": "d", "description": "Start checks in the cloud and exit after printing the test session ID.", "name": "detach", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "pw-test", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": true, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "pw-test.js" ] }, "rules": { "aliases": [], "args": {}, "description": "Generate a rules file to use with AI IDEs and Copilots.", "flags": {}, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "rules", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "rules.js" ] }, "runtimes": { "aliases": [], "args": {}, "description": "List all supported runtimes and dependencies.", "flags": {}, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "runtimes", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "runtimes.js" ] }, "switch": { "aliases": [], "args": {}, "description": "Switch user account.", "flags": { "account-id": { "char": "a", "description": "The id of the account you want to switch to.", "name": "account-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "switch", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "switch.js" ] }, "sync-playwright": { "aliases": [], "args": {}, "description": "Copy Playwright config into the Checkly config file.", "flags": {}, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "sync-playwright", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "sync-playwright.js" ] }, "test": { "aliases": [], "args": { "fileArgs": { "default": ".*", "description": "Only run checks where the file name matches a regular expression", "name": "fileArgs", "required": false } }, "description": "Test your checks on Checkly.", "flags": { "location": { "char": "l", "description": "The location to run the checks at.", "name": "location", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "private-location": { "description": "The private location to run checks at.", "exclusive": [ "location" ], "name": "private-location", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "grep": { "char": "g", "description": "Only run checks where the check name matches a regular expression.", "name": "grep", "default": ".*", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tags": { "char": "t", "description": "Filter the checks to be run using a comma separated list of tags. Checks will only be run if they contain all of the specified tags. Multiple --tags flags can be passed, in which case checks will be run if they match any of the --tags filters. F.ex. `--tags production,webapp --tags production,backend` will run checks with tags (production AND webapp) OR (production AND backend).", "name": "tags", "required": false, "hasDynamicHelp": false, "multiple": true, "type": "option" }, "env": { "char": "e", "description": "Env vars to be passed to the test run.", "exclusive": [ "env-file" ], "name": "env", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "env-file": { "description": "dotenv file path to be passed. For example --env-file=\"./.env\"", "exclusive": [ "env" ], "name": "env-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "list": { "description": "list all checks but don't run them.", "name": "list", "allowNo": false, "type": "boolean" }, "timeout": { "description": "A timeout (in seconds) to wait for checks to complete.", "name": "timeout", "default": 600, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "char": "v", "description": "Always show the full logs of the checks.", "name": "verbose", "allowNo": true, "type": "boolean" }, "reporter": { "char": "r", "description": "A list of custom reporters for the test output.", "name": "reporter", "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "options": [ "list", "dot", "ci", "github", "json" ], "type": "option" }, "config": { "char": "c", "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "record": { "description": "[default: true] Record test results in Checkly as a test session with full logs, traces and videos.", "name": "record", "allowNo": true, "type": "boolean" }, "test-session-name": { "char": "n", "description": "A name to use when storing results in Checkly.", "name": "test-session-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "update-snapshots": { "char": "u", "description": "Update any snapshots using the actual result of this test run.", "name": "update-snapshots", "allowNo": false, "type": "boolean" }, "retries": { "description": "[default: 0, max: 3] How many times to retry a failing test run.", "name": "retries", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verify-runtime-dependencies": { "description": "[default: true] Return an error if checks import dependencies that are not supported by the selected runtime.", "env": "CHECKLY_VERIFY_RUNTIME_DEPENDENCIES", "name": "verify-runtime-dependencies", "allowNo": true, "type": "boolean" }, "refresh-cache": { "description": "Force a fresh install of dependencies and update the cached version.", "name": "refresh-cache", "allowNo": false, "type": "boolean" }, "detach": { "char": "d", "description": "Start checks in the cloud and exit after printing the test session ID.", "name": "detach", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "test", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": false, "enableJsonFlag": false, "coreCommand": true, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "test.js" ] }, "trigger": { "aliases": [], "args": {}, "description": "Trigger your existing checks on Checkly.", "flags": { "location": { "char": "l", "description": "The location to run the checks at.", "name": "location", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "private-location": { "description": "The private location to run checks at.", "exclusive": [ "location" ], "name": "private-location", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tags": { "char": "t", "description": "Filter the checks to be run using a comma separated list of tags. Checks will only be run if they contain all of the specified tags. Multiple --tags flags can be passed, in which case checks will be run if they match any of the --tags filters. F.ex. `--tags production,webapp --tags production,backend` will run checks with tags (production AND webapp) OR (production AND backend).", "name": "tags", "required": false, "hasDynamicHelp": false, "multiple": true, "type": "option" }, "check-id": { "description": "Trigger specific checks by ID. Accepts a comma separated list and can be passed multiple times. Can be combined with --tags to further filter the matching checks.", "name": "check-id", "required": false, "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "config": { "char": "c", "description": "The Checkly CLI config filename.", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "A timeout (in seconds) to wait for checks to complete.", "name": "timeout", "default": 600, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "char": "v", "description": "Always show the full logs of the checks.", "name": "verbose", "allowNo": true, "type": "boolean" }, "fail-on-no-matching": { "description": "Exit with a failing status code when there are no matching tests. Enabled by default.", "name": "fail-on-no-matching", "allowNo": true, "type": "boolean" }, "reporter": { "char": "r", "description": "A list of custom reporters for the test output.", "name": "reporter", "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "options": [ "list", "dot", "ci", "github", "json" ], "type": "option" }, "env": { "char": "e", "description": "Env vars to be passed to the check run.", "exclusive": [ "env-file" ], "name": "env", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "env-file": { "description": "dotenv file path to be passed. For example --env-file=\"./.env\"", "exclusive": [ "env" ], "name": "env-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "record": { "description": "[default: true] Record check results in Checkly as a test session with full logs, traces and videos.", "name": "record", "allowNo": true, "type": "boolean" }, "test-session-name": { "char": "n", "description": "A name to use when storing results in Checkly.", "name": "test-session-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "retries": { "description": "[default: 0, max: 3] How many times to retry a check run.", "name": "retries", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "refresh-cache": { "description": "Force a fresh install of dependencies and update the cached version.", "name": "refresh-cache", "allowNo": false, "type": "boolean" }, "detach": { "char": "d", "description": "Start checks in the cloud and exit after printing the test session ID.", "name": "detach", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "trigger", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": true, "readOnly": false, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "trigger.js" ] }, "validate": { "aliases": [], "args": {}, "description": "Validate your project.", "flags": { "config": { "char": "c", "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verify-runtime-dependencies": { "description": "[default: true] Return an error if checks import dependencies that are not supported by the selected runtime.", "env": "CHECKLY_VERIFY_RUNTIME_DEPENDENCIES", "name": "verify-runtime-dependencies", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "validate", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": true, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "validate.js" ] }, "whoami": { "aliases": [], "args": {}, "description": "See your currently logged in account and user.", "flags": {}, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "whoami", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "whoami.js" ] }, "account:plan": { "aliases": [], "args": { "key": { "description": "Entitlement key to look up (e.g. BROWSER_CHECKS). Shows detail view.", "name": "key", "required": false } }, "description": "Show your account plan, entitlements, and feature limits.", "flags": { "type": { "char": "t", "description": "Filter entitlements by type.", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "metered", "flag" ], "type": "option" }, "search": { "char": "s", "description": "Search entitlements by name or description.", "name": "search", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "disabled": { "description": "Show only entitlements not included in your plan.", "name": "disabled", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "account:plan", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "account", "plan.js" ] }, "alert-channels:get": { "aliases": [], "args": { "id": { "description": "The alert channel ID to retrieve.", "name": "id", "required": true } }, "description": "Get details of an alert channel.", "flags": { "output": { "char": "o", "description": "Output format.", "name": "output", "default": "detail", "hasDynamicHelp": false, "multiple": false, "options": [ "detail", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "alert-channels:get", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "alert-channels", "get.js" ] }, "alert-channels:list": { "aliases": [], "args": {}, "description": "List all alert channels in your account.", "flags": { "limit": { "char": "l", "description": "Number of alert channels to return (1-100).", "name": "limit", "default": 25, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page": { "char": "p", "description": "Page number.", "name": "page", "default": 1, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "alert-channels:list", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "alert-channels", "list.js" ] }, "alert-channels:logs": { "aliases": [], "args": { "id": { "description": "The alert channel ID to retrieve logs for.", "name": "id", "required": true } }, "description": "List notification logs for an alert channel.", "flags": { "limit": { "char": "l", "description": "Number of logs to return (1-100).", "name": "limit", "default": 25, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page": { "char": "p", "description": "Page number.", "name": "page", "default": 1, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "from": { "description": "Unix timestamp for the start of the log window.", "name": "from", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "to": { "description": "Unix timestamp for the end of the log window.", "name": "to", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "char": "s", "description": "Filter logs by status.", "name": "status", "hasDynamicHelp": false, "multiple": false, "options": [ "failed" ], "type": "option" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "alert-channels:logs", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "alert-channels", "logs.js" ] }, "assets:download": { "aliases": [], "args": {}, "description": "Download result assets.", "flags": { "check-id": { "description": "Check ID for a scheduled check result.", "name": "check-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "test-session-id": { "description": "Test session ID for a test-session result.", "name": "test-session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "result-id": { "description": "Check result ID or test-session result ID.", "name": "result-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Select assets by type.", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "log", "trace", "video", "screenshot", "pcap", "report", "file", "all" ], "type": "option" }, "asset": { "description": "Select an asset by exact Asset/Name value or glob.", "name": "asset", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dir": { "description": "Directory to write assets into.", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "description": "Overwrite existing files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-existing": { "description": "Skip files that already exist.", "name": "skip-existing", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "assets:download", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "assets", "download.js" ] }, "assets:list": { "aliases": [], "args": {}, "description": "List result assets.", "flags": { "check-id": { "description": "Check ID for a scheduled check result.", "name": "check-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "test-session-id": { "description": "Test session ID for a test-session result.", "name": "test-session-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "result-id": { "description": "Check result ID or test-session result ID.", "name": "result-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Filter assets by type.", "name": "type", "default": "all", "hasDynamicHelp": false, "multiple": false, "options": [ "log", "trace", "video", "screenshot", "pcap", "report", "file", "all" ], "type": "option" }, "asset": { "description": "Filter assets by exact Asset/Name value or glob.", "name": "asset", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "view": { "description": "Human output view. Ignored with --output json.", "name": "view", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "tree" ], "type": "option" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "assets:list", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "assets", "list.js" ] }, "checks:delete": { "aliases": [], "args": { "id": { "description": "The ID of the check to delete.", "name": "id", "required": true } }, "description": "Delete a check by ID. Checks managed by a CLI project are recreated on the next deploy — remove those from your project code instead.", "flags": { "force": { "char": "f", "description": "Skip confirmation prompt.", "name": "force", "allowNo": false, "type": "boolean" }, "dry-run": { "description": "Preview what would happen without executing.", "name": "dry-run", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "checks:delete", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": true, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "checks", "delete.js" ] }, "checks:get": { "aliases": [], "args": { "id": { "description": "The ID of the check to retrieve.", "name": "id", "required": true } }, "description": "Get details of a specific check, including recent results. Use --result to drill into a specific result.", "flags": { "result": { "char": "r", "description": "Show details for a specific result ID.", "name": "result", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "include-attempts": { "dependsOn": [ "result" ], "description": "Show individual retry attempts for the result (use with --result).", "name": "include-attempts", "allowNo": false, "type": "boolean" }, "error-group": { "char": "e", "description": "Show full details for a specific error group ID.", "name": "error-group", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "results-limit": { "description": "Number of recent results to show.", "name": "results-limit", "default": 10, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "results-cursor": { "description": "Cursor for results pagination (from previous output).", "name": "results-cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stats-range": { "description": "Time range for stats.", "name": "stats-range", "default": "last24Hours", "hasDynamicHelp": false, "multiple": false, "options": [ "last24Hours", "last7Days", "last30Days", "thisWeek", "thisMonth", "lastWeek", "lastMonth" ], "type": "option" }, "group-by": { "description": "Group stats by dimension.", "name": "group-by", "hasDynamicHelp": false, "multiple": false, "options": [ "location", "statusCode" ], "type": "option" }, "metrics": { "description": "Comma-separated list of metrics to show (overrides defaults).", "name": "metrics", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "filter-status": { "description": "Only include runs with this status in stats.", "name": "filter-status", "hasDynamicHelp": false, "multiple": false, "options": [ "success", "failure" ], "type": "option" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "detail", "hasDynamicHelp": false, "multiple": false, "options": [ "detail", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "checks:get", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "checks", "get.js" ], "MAX_SEQUENCE_SPAN_SECONDS": 1800, "MAX_RESULT_PAGES": 15 }, "checks:list": { "aliases": [], "args": {}, "description": "List all checks in your account.", "flags": { "limit": { "char": "l", "description": "Number of checks to return (1-100).", "name": "limit", "default": 25, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page": { "char": "p", "description": "Page number.", "name": "page", "default": 1, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tag": { "char": "t", "description": "Filter by tag. Can be specified multiple times.", "name": "tag", "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "search": { "char": "s", "description": "Filter checks by name (case-insensitive).", "name": "search", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Filter by check type.", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "API", "BROWSER", "HEARTBEAT", "MULTI_STEP", "PLAYWRIGHT", "TCP", "ICMP", "DNS", "URL", "AGENTIC" ], "type": "option" }, "status": { "description": "Filter by check status.", "name": "status", "hasDynamicHelp": false, "multiple": false, "options": [ "passing", "failing", "degraded" ], "type": "option" }, "hide-id": { "description": "Hide check IDs in table output.", "name": "hide-id", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "checks:list", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "checks", "list.js" ] }, "checks:stats": { "aliases": [], "args": { "checkIds": { "description": "One or more check IDs to get stats for.", "name": "checkIds", "required": false } }, "description": "Show analytics stats for your checks.", "flags": { "range": { "char": "r", "description": "Time range for stats.", "name": "range", "default": "last24Hours", "hasDynamicHelp": false, "multiple": false, "options": [ "last24Hours", "last7Days", "thisWeek", "lastWeek", "lastMonth" ], "type": "option" }, "limit": { "char": "l", "description": "Number of checks to return (1-100).", "name": "limit", "default": 25, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "page": { "char": "p", "description": "Page number.", "name": "page", "default": 1, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tag": { "char": "t", "description": "Filter by tag. Can be specified multiple times.", "name": "tag", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "search": { "char": "s", "description": "Filter checks by name (case-insensitive).", "name": "search", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Filter by check type.", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "API", "BROWSER", "HEARTBEAT", "MULTI_STEP", "PLAYWRIGHT", "TCP", "ICMP", "DNS", "URL", "AGENTIC" ], "type": "option" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "checks:stats", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": false, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "checks", "stats.js" ] }, "debug:parse-file": { "aliases": [], "args": {}, "description": "Parses and outputs relevant details of a code file.", "flags": { "file": { "name": "file", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "restricted": { "name": "restricted", "allowNo": false, "type": "boolean" }, "detect-workspace": { "name": "detect-workspace", "allowNo": true, "type": "boolean" }, "supported-module": { "name": "supported-module", "default": [], "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "check-unsupported-modules": { "name": "check-unsupported-modules", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "debug:parse-file", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "debug", "parse-file.js" ] }, "debug:parse-playwright-config": { "aliases": [], "args": {}, "description": "Parses and outputs relevant details of a Playwright configuration file.", "flags": { "file": { "env": "CHECKLY_PLAYWRIGHT_CONFIG_FILE", "name": "file", "default": "/home/runner/work/checkly-cli/checkly-cli/packages/cli/playwright.config.ts", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "debug:parse-playwright-config", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "debug", "parse-playwright-config.js" ] }, "debug:parse-project": { "aliases": [], "args": {}, "description": "Parses a Checkly project.", "flags": { "config": { "char": "c", "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.", "env": "CHECKLY_CONFIG_FILE", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "default-runtime": { "description": "The default runtime to use if none is specified.", "env": "CHECKLY_DEFAULT_RUNTIME", "name": "default-runtime", "default": "2025.04", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verify-runtime-dependencies": { "description": "[default: true] Return an error if checks import dependencies that are not supported by the selected runtime.", "env": "CHECKLY_VERIFY_RUNTIME_DEPENDENCIES", "name": "verify-runtime-dependencies", "allowNo": true, "type": "boolean" }, "emulate-pw-test": { "description": "Pretend to be the pw-test command. Affects validation.", "env": "CHECKLY_EMULATE_PW_TEST", "name": "emulate-pw-test", "allowNo": false, "type": "boolean" }, "include": { "description": "File patterns to include when bundling the test project (e.g., \"utils/**/*\").", "name": "include", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "inject-private-location": { "description": "Pretend that the given private location exists (e.g., \"70c4ded4-2229-45a7-acf4-6b1eb56a86df:my-external-private-location\").", "name": "inject-private-location", "default": [], "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "stats": { "description": "Print parse/bundle/synthesize timing and heap usage to stderr. Run with NODE_OPTIONS=--expose-gc to also report the retained (post-GC) heap.", "name": "stats", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "debug:parse-project", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "debug", "parse-project.js" ] }, "env:add": { "aliases": [], "args": { "key": { "description": "Environment variable key.", "name": "key", "required": true }, "value": { "description": "Environment variable value.", "name": "value", "required": false } }, "description": "Add environment variable via \"checkly env add \".", "flags": { "locked": { "char": "l", "description": "Indicate that the environment variable will be locked.", "name": "locked", "allowNo": false, "type": "boolean" }, "secret": { "char": "s", "description": "Indicate that the environment variable will be secret.", "exclusive": [ "locked" ], "name": "secret", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "env:add", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "env", "add.js" ] }, "env:ls": { "aliases": [], "args": {}, "description": "List all Checkly environment variables via \"checkly env ls\".", "flags": {}, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "env:ls", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "env", "ls.js" ] }, "env:pull": { "aliases": [], "args": { "filename": { "default": ".env", "description": "Filename of the generated file.", "name": "filename", "required": false } }, "description": "Pull Checkly environment variables via \"checkly env pull \".", "flags": { "force": { "char": "f", "description": "Force to overwrite existing file.", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "env:pull", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "env", "pull.js" ] }, "env:rm": { "aliases": [], "args": { "key": { "description": "Environment variable key to remove.", "name": "key", "required": true } }, "description": "Remove environment variable via \"checkly env rm \".", "flags": { "force": { "char": "f", "description": "Skip confirmation prompt.", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "env:rm", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": true, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "env", "rm.js" ] }, "env:update": { "aliases": [], "args": { "key": { "description": "Environment variable key.", "name": "key", "required": true }, "value": { "description": "Environment variable value.", "name": "value", "required": false } }, "description": "Update environment variable via \"checkly env update \".", "flags": { "locked": { "char": "l", "description": "Indicate if environment variable is locked.", "name": "locked", "allowNo": false, "type": "boolean" }, "secret": { "char": "s", "description": "Indicate if environment variable is secret.", "exclusive": [ "locked" ], "name": "secret", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "env:update", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "env", "update.js" ] }, "import:apply": { "aliases": [], "args": {}, "description": "Attach imported resources into your project in a pending state.", "flags": { "config": { "char": "c", "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "import:apply", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "import", "apply.js" ] }, "import:cancel": { "aliases": [], "args": {}, "description": "Cancels an ongoing import plan that has not been committed yet.", "flags": { "config": { "char": "c", "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "all": { "description": "Cancel all plans.", "name": "all", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "import:cancel", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "import", "cancel.js" ] }, "import:commit": { "aliases": [], "args": {}, "description": "Permanently commit imported resources into your project.", "flags": { "config": { "char": "c", "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "import:commit", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "import", "commit.js" ] }, "import:plan": { "aliases": [], "args": { "resource": { "description": "A specific resource to import.", "name": "resource", "required": false } }, "description": "Import existing resources from your Checkly account to your project.\n\nBy default, all resources that can be imported will be imported. However, you\nmay fine-tune the process by including or excluding any combination of\nresources.\n\nThe import process consists of three steps:\n\n1. Creating a plan, which generates the appropriate code for your resources\n2. Applying the plan, which links your resources to the generated code\n3. Committing the plan, which finalizes the import session\n\nCREATING A PLAN\n\nCreating a plan carries no risk as no concrete links to your Checkly resources\nare made at this point. However, if you accidentally deploy the generated code\nbefore applying the plan, you will end up with duplicate resources and will\nnot be able to complete the import session without first deleting the\nduplicates.\n\nFor the curious, you may also preview the generated code with the '--preview'\noption. No plan will be created, allowing you to leisurely inspect the\ngenerated code. However keep in mind that you will need to create a plan to\nactually import any resources, at which point the code will be generated\nagain.\n\nYou may cancel any plan you've created without affecting any of the\nunderlying resources.\n\nAPPLYING A PLAN\n\nApplying a plan links your existing resources to the generated code. You\nshould carefully review the generated code to make sure that it contains the\nresources you expect before applying a plan. After a plan has been applied,\nany deployments of those resources will irreversibly modify the underlying\nCheckly resources. However, as a fail safe against concurrent use, any\ndeployments not including the imported resources will not delete the\nunderlying resources (or the links to the resources). This means that there\nis no need to block deployments while working on an import session.\n\nEven after you've applied a plan, you may still cancel it, which will unlink\nthe underlying resources from your project once more. However, keep in mind\nthat any changes to the resources that you've already deployed cannot be\nundone.\n\nCOMMITTING A PLAN\n\nFinally, committing a plan removes all fail safes and permanently links the\nimported resources to your project. Any resources you remove from your code\nwill result in the underlying resources also getting irrevocably deleted on\nthe next deploy. You should only commit your plan once you are sure that all\nfuture deployments include the imported resources.", "flags": { "config": { "char": "c", "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "root": { "description": "The root folder in which to write generated code files.", "name": "root", "default": "__checks__", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "preview": { "description": "Preview generated code without creating an actual import plan.", "name": "preview", "allowNo": false, "type": "boolean" }, "debug-import-plan": { "description": "Output the import plan to a file.", "hidden": true, "name": "debug-import-plan", "allowNo": false, "type": "boolean" }, "debug-import-plan-input-file": { "description": "A file to load an import plan from.", "hidden": true, "name": "debug-import-plan-input-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "debug-import-plan-output-file": { "description": "The file to output the import plan to.", "hidden": true, "name": "debug-import-plan-output-file", "default": "./debug-import-plan.json", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [ "import" ], "id": "import:plan", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": false, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "import", "plan.js" ] }, "incidents:create": { "aliases": [], "args": {}, "description": "Declare a new incident on a status page.", "flags": { "status-page-id": { "description": "Target status page ID.", "name": "status-page-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "title": { "description": "Incident title.", "name": "title", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "services": { "description": "Affected service IDs. Repeat the flag for multiple services.", "name": "services", "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "severity": { "description": "Incident severity.", "name": "severity", "default": "minor", "hasDynamicHelp": false, "multiple": false, "options": [ "minor", "medium", "major", "critical" ], "type": "option" }, "message": { "description": "Initial incident update message.", "name": "message", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "notify-subscribers": { "description": "Notify status page subscribers about this incident update.", "name": "notify-subscribers", "allowNo": true, "type": "boolean" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" }, "force": { "char": "f", "description": "Skip confirmation prompt.", "name": "force", "allowNo": false, "type": "boolean" }, "dry-run": { "description": "Preview what would happen without executing.", "name": "dry-run", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "incidents:create", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "incidents", "create.js" ] }, "incidents:list": { "aliases": [], "args": {}, "description": "List incidents, optionally filtered by status page or status.", "flags": { "limit": { "char": "l", "description": "Number of incidents to return (1-100).", "name": "limit", "default": 25, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status-page-id": { "description": "Filter incidents by status page ID.", "name": "status-page-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Filter by incident status.", "name": "status", "default": "open", "hasDynamicHelp": false, "multiple": false, "options": [ "open", "resolved", "all" ], "type": "option" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "incidents:list", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "incidents", "list.js" ] }, "incidents:resolve": { "aliases": [], "args": { "id": { "description": "The incident ID.", "name": "id", "required": true } }, "description": "Resolve an incident.", "flags": { "message": { "description": "Optional closing note.", "name": "message", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "notify-subscribers": { "description": "Notify status page subscribers about this incident update.", "name": "notify-subscribers", "allowNo": true, "type": "boolean" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" }, "force": { "char": "f", "description": "Skip confirmation prompt.", "name": "force", "allowNo": false, "type": "boolean" }, "dry-run": { "description": "Preview what would happen without executing.", "name": "dry-run", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "incidents:resolve", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "incidents", "resolve.js" ] }, "incidents:update": { "aliases": [], "args": { "id": { "description": "The incident ID.", "name": "id", "required": true } }, "description": "Post a progress update to an incident.", "flags": { "message": { "description": "Update message.", "name": "message", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Incident progress status.", "name": "status", "default": "investigating", "hasDynamicHelp": false, "multiple": false, "options": [ "investigating", "identified", "monitoring" ], "type": "option" }, "severity": { "description": "Update the overall incident severity.", "name": "severity", "hasDynamicHelp": false, "multiple": false, "options": [ "minor", "medium", "major", "critical" ], "type": "option" }, "notify-subscribers": { "description": "Notify status page subscribers about this incident update.", "name": "notify-subscribers", "allowNo": true, "type": "boolean" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" }, "force": { "char": "f", "description": "Skip confirmation prompt.", "name": "force", "allowNo": false, "type": "boolean" }, "dry-run": { "description": "Preview what would happen without executing.", "name": "dry-run", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "incidents:update", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "incidents", "update.js" ] }, "members:delete": { "aliases": [], "args": { "member": { "description": "The account member email or user ID.", "name": "member", "required": true } }, "description": "Delete an account member.", "flags": { "email": { "description": "Treat the member argument as an email address.", "exclusive": [ "id" ], "name": "email", "allowNo": false, "type": "boolean" }, "id": { "description": "Treat the member argument as a user ID.", "exclusive": [ "email" ], "name": "id", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Skip confirmation prompt.", "name": "force", "allowNo": false, "type": "boolean" }, "dry-run": { "description": "Preview what would happen without executing.", "name": "dry-run", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [ "account members delete" ], "id": "members:delete", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": true, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "members", "delete.js" ] }, "members:update": { "aliases": [], "args": { "member": { "description": "The account member email or user ID.", "name": "member", "required": true } }, "description": "Update an account member role.", "flags": { "role": { "char": "r", "description": "New member role: admin, read_write, read_run, read_only.", "name": "role", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "email": { "description": "Treat the member argument as an email address.", "exclusive": [ "id" ], "name": "email", "allowNo": false, "type": "boolean" }, "id": { "description": "Treat the member argument as a user ID.", "exclusive": [ "email" ], "name": "id", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" }, "force": { "char": "f", "description": "Skip confirmation prompt.", "name": "force", "allowNo": false, "type": "boolean" }, "dry-run": { "description": "Preview what would happen without executing.", "name": "dry-run", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [ "account members update" ], "id": "members:update", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "members", "update.js" ] }, "rca:get": { "aliases": [], "args": { "id": { "description": "The RCA ID to retrieve.", "name": "id", "required": true } }, "description": "Retrieve a root cause analysis by ID.", "flags": { "watch": { "char": "w", "description": "Wait for the analysis to complete if still generating.", "name": "watch", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "detail", "hasDynamicHelp": false, "multiple": false, "options": [ "detail", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "rca:get", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "rca", "get.js" ] }, "rca:run": { "aliases": [], "args": {}, "description": "Trigger a root cause analysis for a check or test session error group.", "flags": { "error-group": { "char": "e", "description": "The error group ID to analyze.", "exclusive": [ "test-session-error-group" ], "name": "error-group", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "test-session-error-group": { "description": "The test session error group ID to analyze.", "helpLabel": "-te, --test-session-error-group", "name": "test-session-error-group", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "user-context": { "description": "Extra context to pass into the root cause analysis.", "name": "user-context", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "watch": { "char": "w", "description": "Wait for the analysis to complete and display the result.", "name": "watch", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "detail", "hasDynamicHelp": false, "multiple": false, "options": [ "detail", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "rca:run", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "usage": "rca run [-e | -te ] [--user-context ] [-w] [-o detail|json|md]", "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "rca", "run.js" ] }, "skills": { "aliases": [], "args": { "action": { "description": "The action name (e.g. \"configure\", \"initialize\").", "name": "action", "required": false }, "reference": { "description": "A specific reference within the action (e.g. \"api-checks\").", "name": "reference", "required": false } }, "description": "Show Checkly AI skills, actions and their references.", "flags": {}, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "skills", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": false, "isESM": true, "relativePath": [ "dist", "commands", "skills", "index.js" ] }, "skills:install": { "aliases": [], "args": {}, "description": "Install the Checkly agent skill (SKILL.md) into your project.", "flags": { "target": { "char": "t", "description": "Platform to install the skill for (amp, claude, cline, codex, continue, cursor, gemini-cli, github-copilot, goose, opencode, roo, windsurf).", "exclusive": [ "path" ], "name": "target", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "char": "p", "description": "Custom target directory to install the skill into.", "exclusive": [ "target" ], "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrite existing SKILL.md without confirmation.", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "skills:install", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": false, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "skills", "install.js" ] }, "status-pages:get": { "aliases": [], "args": { "id": { "description": "The ID of the status page to retrieve.", "name": "id", "required": true } }, "description": "Get details of a status page, including its cards and services.", "flags": { "output": { "char": "o", "description": "Output format.", "name": "output", "default": "detail", "hasDynamicHelp": false, "multiple": false, "options": [ "detail", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "status-pages:get", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "status-pages", "get.js" ] }, "status-pages:list": { "aliases": [], "args": {}, "description": "List all status pages in your account.", "flags": { "limit": { "char": "l", "description": "Number of status pages to return (1-100).", "name": "limit", "default": 25, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cursor": { "description": "Cursor for next page (from previous output).", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "compact": { "description": "Show one row per status page instead of per service.", "name": "compact", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "status-pages:list", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "status-pages", "list.js" ] }, "test-sessions:get": { "aliases": [], "args": { "id": { "description": "The ID of the test session to retrieve.", "name": "id", "required": true } }, "description": "Get details of a recorded test session, including result error groups for RCA.", "flags": { "result": { "char": "r", "description": "Show details for a specific test session result ID.", "name": "result", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "error-group": { "description": "Show details for a test session error group ID from this session.", "name": "error-group", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "error-groups-limit": { "description": "Number of error group IDs to show in the session summary.", "name": "error-groups-limit", "default": 5, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "full-error": { "description": "Print the complete raw error when showing a test session error group.", "name": "full-error", "allowNo": false, "type": "boolean" }, "watch": { "char": "w", "description": "Watch a running test session until it completes before rendering.", "name": "watch", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "detail", "hasDynamicHelp": false, "multiple": false, "options": [ "detail", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "test-sessions:get", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "test-sessions", "get.js" ] }, "test-sessions:list": { "aliases": [], "args": {}, "description": "List recorded test sessions.", "flags": { "limit": { "char": "l", "description": "Number of test sessions to return (1-100).", "name": "limit", "default": 20, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cursor": { "description": "Cursor for next page (from previous output).", "name": "cursor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "from": { "description": "Only include test sessions created at or after this ISO date or Unix timestamp.", "name": "from", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "to": { "description": "Only include test sessions created before this ISO date or Unix timestamp.", "name": "to", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Filter by test session status: running, failed, passed, cancelled. Can be specified multiple times.", "name": "status", "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "branch": { "description": "Filter by Git branch name. Can be specified multiple times.", "name": "branch", "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "user": { "description": "Filter by commit owner or invoking user ID. Can be specified multiple times.", "name": "user", "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "no-users": { "description": "Include sessions with no commit owner and no invoking user.", "name": "no-users", "allowNo": false, "type": "boolean" }, "provider": { "description": "Filter by test session provider: github, vercel, api, trigger, pw_reporter. Can be specified multiple times.", "name": "provider", "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "search": { "char": "s", "description": "Search test session text fields (3-200 characters).", "name": "search", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "error-group": { "description": "Filter by test-session error group ID.", "name": "error-group", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output": { "char": "o", "description": "Output format.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json", "md" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": false, "hiddenAliases": [], "id": "test-sessions:list", "pluginAlias": "checkly", "pluginName": "checkly", "pluginType": "core", "strict": true, "enableJsonFlag": false, "coreCommand": false, "readOnly": true, "destructive": false, "idempotent": true, "isESM": true, "relativePath": [ "dist", "commands", "test-sessions", "list.js" ] } }, "version": "8.8.0" }