checkly 7.2.0 → 7.3.0

package/oclif.manifest.json

@@ -858,6 +858,177 @@
         "whoami.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"
+        },
+        "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"
+        },
+        "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,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "checks",
+        "get.js"
+      ]
+    },
+    "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",
+          "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",
+            "MULTI_STEP",
+            "HEARTBEAT",
+            "PLAYWRIGHT",
+            "TCP",
+            "DNS",
+            "ICMP",
+            "URL"
+          ],
+          "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,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "checks",
+        "list.js"
+      ]
+    },
     "debug:parse-file": {
       "aliases": [],
       "args": {},
@@ -1004,6 +1175,186 @@
         "parse-project.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,
+      "isESM": false,
+      "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,
+      "isESM": false,
+      "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,
+      "isESM": false,
+      "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,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "import",
+        "plan.js"
+      ]
+    },
     "env:add": {
       "aliases": [],
       "args": {
@@ -1206,62 +1557,36 @@
         "update.js"
       ]
     },
-    "import:apply": {
+    "status-pages:get": {
       "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"
+      "args": {
+        "id": {
+          "description": "The ID of the status page to retrieve.",
+          "name": "id",
+          "required": true
         }
       },
-      "hasDynamicHelp": false,
-      "hidden": false,
-      "hiddenAliases": [],
-      "id": "import:apply",
-      "pluginAlias": "checkly",
-      "pluginName": "checkly",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "coreCommand": false,
-      "isESM": false,
-      "relativePath": [
-        "dist",
-        "commands",
-        "import",
-        "apply.js"
-      ]
-    },
-    "import:cancel": {
-      "aliases": [],
-      "args": {},
-      "description": "Cancels an ongoing import plan that has not been committed yet.",
+      "description": "Get details of a status page, including its cards and services.",
       "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",
+        "output": {
+          "char": "o",
+          "description": "Output format.",
+          "name": "output",
+          "default": "detail",
           "hasDynamicHelp": false,
           "multiple": false,
+          "options": [
+            "detail",
+            "json",
+            "md"
+          ],
           "type": "option"
-        },
-        "all": {
-          "description": "Cancel all plans.",
-          "name": "all",
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hidden": false,
       "hiddenAliases": [],
-      "id": "import:cancel",
+      "id": "status-pages:get",
       "pluginAlias": "checkly",
       "pluginName": "checkly",
       "pluginType": "core",
@@ -1272,120 +1597,70 @@
       "relativePath": [
         "dist",
         "commands",
-        "import",
-        "cancel.js"
+        "status-pages",
+        "get.js"
       ]
     },
-    "import:commit": {
+    "status-pages:list": {
       "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,
-      "isESM": false,
-      "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.",
+      "description": "List all status pages in your account.",
       "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",
+        "limit": {
+          "char": "l",
+          "description": "Number of status pages to return (1-100).",
+          "name": "limit",
+          "default": 25,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "root": {
-          "description": "The root folder in which to write generated code files.",
-          "name": "root",
-          "default": "__checks__",
+        "cursor": {
+          "description": "Cursor for next page (from previous output).",
+          "name": "cursor",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "preview": {
-          "description": "Preview generated code without creating an actual import plan.",
-          "name": "preview",
+        "compact": {
+          "description": "Show one row per status page instead of per service.",
+          "name": "compact",
           "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",
+        "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": [
-        "import"
-      ],
-      "id": "import:plan",
+      "hiddenAliases": [],
+      "id": "status-pages:list",
       "pluginAlias": "checkly",
       "pluginName": "checkly",
       "pluginType": "core",
-      "strict": false,
+      "strict": true,
       "enableJsonFlag": false,
       "coreCommand": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "import",
-        "plan.js"
+        "status-pages",
+        "list.js"
       ]
     }
   },
-  "version": "7.2.0"
+  "version": "7.3.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "checkly",
-  "version": "7.2.0",
+  "version": "7.3.0",
   "description": "Checkly CLI",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -64,11 +64,17 @@
       "message": "<%= config.name %> update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>. To update, run `npm install -D checkly@latest`"
     },
     "topics": {
+      "checks": {
+        "description": "List and inspect checks in your Checkly account."
+      },
       "env": {
         "description": "Manage Checkly environment variables."
       },
       "import": {
         "description": "Import existing resources from your Checkly account to your project."
+      },
+      "status-pages": {
+        "description": "List and manage status pages in your Checkly account."
       }
     },
     "helpClass": "./dist/help/help-extension"