checkly 8.17.1 → 8.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/ai-context/context.d.ts +4 -4
- package/dist/ai-context/context.js +17 -2
- package/dist/ai-context/context.js.map +1 -1
- package/dist/ai-context/skills-command/references/configure-alert-channels.md +48 -0
- package/dist/ai-context/skills-command/references/configure.md +1 -1
- package/dist/ai-context/skills-command/references/investigate-checks.md +18 -2
- package/dist/ai-context/skills-command/references/investigate.md +1 -1
- package/dist/commands/checks/run.d.ts +18 -0
- package/dist/commands/checks/run.js +139 -0
- package/dist/commands/checks/run.js.map +1 -0
- package/dist/constructs/msteams-alert-channel-codegen.js +1 -1
- package/dist/constructs/msteams-alert-channel-codegen.js.map +1 -1
- package/dist/constructs/telegram-alert-channel-codegen.js +5 -1
- package/dist/constructs/telegram-alert-channel-codegen.js.map +1 -1
- package/dist/constructs/telegram-alert-channel.d.ts +5 -0
- package/dist/constructs/telegram-alert-channel.js +4 -1
- package/dist/constructs/telegram-alert-channel.js.map +1 -1
- package/dist/formatters/check-sessions.d.ts +5 -0
- package/dist/formatters/check-sessions.js +113 -0
- package/dist/formatters/check-sessions.js.map +1 -0
- package/dist/rest/api.d.ts +2 -0
- package/dist/rest/api.js +2 -0
- package/dist/rest/api.js.map +1 -1
- package/dist/rest/check-sessions.d.ts +63 -0
- package/dist/rest/check-sessions.js +66 -0
- package/dist/rest/check-sessions.js.map +1 -0
- package/dist/rest/test-sessions.d.ts +50 -1
- package/dist/rest/test-sessions.js +43 -1
- package/dist/rest/test-sessions.js.map +1 -1
- package/dist/services/abstract-check-runner.d.ts +16 -0
- package/dist/services/abstract-check-runner.js +70 -3
- package/dist/services/abstract-check-runner.js.map +1 -1
- package/dist/services/test-runner.d.ts +1 -0
- package/dist/services/test-runner.js +2 -2
- package/dist/services/test-runner.js.map +1 -1
- package/oclif.manifest.json +778 -694
- package/package.json +8 -8
package/oclif.manifest.json
CHANGED
|
@@ -1693,6 +1693,168 @@
|
|
|
1693
1693
|
"list.js"
|
|
1694
1694
|
]
|
|
1695
1695
|
},
|
|
1696
|
+
"debug:parse-file": {
|
|
1697
|
+
"aliases": [],
|
|
1698
|
+
"args": {},
|
|
1699
|
+
"description": "Parses and outputs relevant details of a code file.",
|
|
1700
|
+
"flags": {
|
|
1701
|
+
"file": {
|
|
1702
|
+
"name": "file",
|
|
1703
|
+
"required": true,
|
|
1704
|
+
"hasDynamicHelp": false,
|
|
1705
|
+
"multiple": false,
|
|
1706
|
+
"type": "option"
|
|
1707
|
+
},
|
|
1708
|
+
"restricted": {
|
|
1709
|
+
"name": "restricted",
|
|
1710
|
+
"allowNo": false,
|
|
1711
|
+
"type": "boolean"
|
|
1712
|
+
},
|
|
1713
|
+
"detect-workspace": {
|
|
1714
|
+
"name": "detect-workspace",
|
|
1715
|
+
"allowNo": true,
|
|
1716
|
+
"type": "boolean"
|
|
1717
|
+
},
|
|
1718
|
+
"supported-module": {
|
|
1719
|
+
"name": "supported-module",
|
|
1720
|
+
"default": [],
|
|
1721
|
+
"delimiter": ",",
|
|
1722
|
+
"hasDynamicHelp": false,
|
|
1723
|
+
"multiple": true,
|
|
1724
|
+
"type": "option"
|
|
1725
|
+
},
|
|
1726
|
+
"check-unsupported-modules": {
|
|
1727
|
+
"name": "check-unsupported-modules",
|
|
1728
|
+
"allowNo": false,
|
|
1729
|
+
"type": "boolean"
|
|
1730
|
+
}
|
|
1731
|
+
},
|
|
1732
|
+
"hasDynamicHelp": false,
|
|
1733
|
+
"hidden": true,
|
|
1734
|
+
"hiddenAliases": [],
|
|
1735
|
+
"id": "debug:parse-file",
|
|
1736
|
+
"pluginAlias": "checkly",
|
|
1737
|
+
"pluginName": "checkly",
|
|
1738
|
+
"pluginType": "core",
|
|
1739
|
+
"strict": true,
|
|
1740
|
+
"enableJsonFlag": false,
|
|
1741
|
+
"isESM": true,
|
|
1742
|
+
"relativePath": [
|
|
1743
|
+
"dist",
|
|
1744
|
+
"commands",
|
|
1745
|
+
"debug",
|
|
1746
|
+
"parse-file.js"
|
|
1747
|
+
]
|
|
1748
|
+
},
|
|
1749
|
+
"debug:parse-playwright-config": {
|
|
1750
|
+
"aliases": [],
|
|
1751
|
+
"args": {},
|
|
1752
|
+
"description": "Parses and outputs relevant details of a Playwright configuration file.",
|
|
1753
|
+
"flags": {
|
|
1754
|
+
"file": {
|
|
1755
|
+
"env": "CHECKLY_PLAYWRIGHT_CONFIG_FILE",
|
|
1756
|
+
"name": "file",
|
|
1757
|
+
"default": "/home/runner/work/checkly-cli/checkly-cli/packages/cli/playwright.config.ts",
|
|
1758
|
+
"hasDynamicHelp": false,
|
|
1759
|
+
"multiple": false,
|
|
1760
|
+
"type": "option"
|
|
1761
|
+
}
|
|
1762
|
+
},
|
|
1763
|
+
"hasDynamicHelp": false,
|
|
1764
|
+
"hidden": true,
|
|
1765
|
+
"hiddenAliases": [],
|
|
1766
|
+
"id": "debug:parse-playwright-config",
|
|
1767
|
+
"pluginAlias": "checkly",
|
|
1768
|
+
"pluginName": "checkly",
|
|
1769
|
+
"pluginType": "core",
|
|
1770
|
+
"strict": true,
|
|
1771
|
+
"enableJsonFlag": false,
|
|
1772
|
+
"isESM": true,
|
|
1773
|
+
"relativePath": [
|
|
1774
|
+
"dist",
|
|
1775
|
+
"commands",
|
|
1776
|
+
"debug",
|
|
1777
|
+
"parse-playwright-config.js"
|
|
1778
|
+
]
|
|
1779
|
+
},
|
|
1780
|
+
"debug:parse-project": {
|
|
1781
|
+
"aliases": [],
|
|
1782
|
+
"args": {},
|
|
1783
|
+
"description": "Parses a Checkly project.",
|
|
1784
|
+
"flags": {
|
|
1785
|
+
"config": {
|
|
1786
|
+
"char": "c",
|
|
1787
|
+
"description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
|
|
1788
|
+
"env": "CHECKLY_CONFIG_FILE",
|
|
1789
|
+
"name": "config",
|
|
1790
|
+
"hasDynamicHelp": false,
|
|
1791
|
+
"multiple": false,
|
|
1792
|
+
"type": "option"
|
|
1793
|
+
},
|
|
1794
|
+
"default-runtime": {
|
|
1795
|
+
"description": "The default runtime to use if none is specified.",
|
|
1796
|
+
"env": "CHECKLY_DEFAULT_RUNTIME",
|
|
1797
|
+
"name": "default-runtime",
|
|
1798
|
+
"default": "2025.04",
|
|
1799
|
+
"hasDynamicHelp": false,
|
|
1800
|
+
"multiple": false,
|
|
1801
|
+
"type": "option"
|
|
1802
|
+
},
|
|
1803
|
+
"verify-runtime-dependencies": {
|
|
1804
|
+
"description": "[default: true] Return an error if checks import dependencies that are not supported by the selected runtime.",
|
|
1805
|
+
"env": "CHECKLY_VERIFY_RUNTIME_DEPENDENCIES",
|
|
1806
|
+
"name": "verify-runtime-dependencies",
|
|
1807
|
+
"allowNo": true,
|
|
1808
|
+
"type": "boolean"
|
|
1809
|
+
},
|
|
1810
|
+
"emulate-pw-test": {
|
|
1811
|
+
"description": "Pretend to be the pw-test command. Affects validation.",
|
|
1812
|
+
"env": "CHECKLY_EMULATE_PW_TEST",
|
|
1813
|
+
"name": "emulate-pw-test",
|
|
1814
|
+
"allowNo": false,
|
|
1815
|
+
"type": "boolean"
|
|
1816
|
+
},
|
|
1817
|
+
"include": {
|
|
1818
|
+
"description": "File patterns to include when bundling the test project (e.g., \"utils/**/*\").",
|
|
1819
|
+
"name": "include",
|
|
1820
|
+
"default": [],
|
|
1821
|
+
"hasDynamicHelp": false,
|
|
1822
|
+
"multiple": true,
|
|
1823
|
+
"type": "option"
|
|
1824
|
+
},
|
|
1825
|
+
"inject-private-location": {
|
|
1826
|
+
"description": "Pretend that the given private location exists (e.g., \"70c4ded4-2229-45a7-acf4-6b1eb56a86df:my-external-private-location\").",
|
|
1827
|
+
"name": "inject-private-location",
|
|
1828
|
+
"default": [],
|
|
1829
|
+
"delimiter": ",",
|
|
1830
|
+
"hasDynamicHelp": false,
|
|
1831
|
+
"multiple": true,
|
|
1832
|
+
"type": "option"
|
|
1833
|
+
},
|
|
1834
|
+
"stats": {
|
|
1835
|
+
"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.",
|
|
1836
|
+
"name": "stats",
|
|
1837
|
+
"allowNo": false,
|
|
1838
|
+
"type": "boolean"
|
|
1839
|
+
}
|
|
1840
|
+
},
|
|
1841
|
+
"hasDynamicHelp": false,
|
|
1842
|
+
"hidden": true,
|
|
1843
|
+
"hiddenAliases": [],
|
|
1844
|
+
"id": "debug:parse-project",
|
|
1845
|
+
"pluginAlias": "checkly",
|
|
1846
|
+
"pluginName": "checkly",
|
|
1847
|
+
"pluginType": "core",
|
|
1848
|
+
"strict": true,
|
|
1849
|
+
"enableJsonFlag": false,
|
|
1850
|
+
"isESM": true,
|
|
1851
|
+
"relativePath": [
|
|
1852
|
+
"dist",
|
|
1853
|
+
"commands",
|
|
1854
|
+
"debug",
|
|
1855
|
+
"parse-project.js"
|
|
1856
|
+
]
|
|
1857
|
+
},
|
|
1696
1858
|
"checks:delete": {
|
|
1697
1859
|
"aliases": [],
|
|
1698
1860
|
"args": {
|
|
@@ -1990,6 +2152,90 @@
|
|
|
1990
2152
|
"list.js"
|
|
1991
2153
|
]
|
|
1992
2154
|
},
|
|
2155
|
+
"checks:run": {
|
|
2156
|
+
"aliases": [],
|
|
2157
|
+
"args": {},
|
|
2158
|
+
"description": "Run deployed checks now using their configured locations and alerting rules.",
|
|
2159
|
+
"flags": {
|
|
2160
|
+
"tags": {
|
|
2161
|
+
"char": "t",
|
|
2162
|
+
"description": "Select checks using a comma-separated list of tags. Checks must contain all tags in one --tags filter. Repeat --tags to match any of multiple filters.",
|
|
2163
|
+
"name": "tags",
|
|
2164
|
+
"hasDynamicHelp": false,
|
|
2165
|
+
"multiple": true,
|
|
2166
|
+
"type": "option"
|
|
2167
|
+
},
|
|
2168
|
+
"check-id": {
|
|
2169
|
+
"description": "Run specific checks by ID. Accepts comma-separated values and can be repeated.",
|
|
2170
|
+
"name": "check-id",
|
|
2171
|
+
"delimiter": ",",
|
|
2172
|
+
"hasDynamicHelp": false,
|
|
2173
|
+
"multiple": true,
|
|
2174
|
+
"type": "option"
|
|
2175
|
+
},
|
|
2176
|
+
"refresh-cache": {
|
|
2177
|
+
"description": "Refresh the selected checks cache before running.",
|
|
2178
|
+
"name": "refresh-cache",
|
|
2179
|
+
"allowNo": false,
|
|
2180
|
+
"type": "boolean"
|
|
2181
|
+
},
|
|
2182
|
+
"timeout": {
|
|
2183
|
+
"description": "A timeout (in seconds) to wait for all check sessions to complete.",
|
|
2184
|
+
"name": "timeout",
|
|
2185
|
+
"default": 600,
|
|
2186
|
+
"hasDynamicHelp": false,
|
|
2187
|
+
"multiple": false,
|
|
2188
|
+
"type": "option"
|
|
2189
|
+
},
|
|
2190
|
+
"detach": {
|
|
2191
|
+
"char": "d",
|
|
2192
|
+
"description": "Start the check sessions and exit without waiting for results.",
|
|
2193
|
+
"name": "detach",
|
|
2194
|
+
"allowNo": false,
|
|
2195
|
+
"type": "boolean"
|
|
2196
|
+
},
|
|
2197
|
+
"fail-on-no-matching": {
|
|
2198
|
+
"description": "Exit with a failing status code when there are no matching checks. Enabled by default.",
|
|
2199
|
+
"name": "fail-on-no-matching",
|
|
2200
|
+
"allowNo": true,
|
|
2201
|
+
"type": "boolean"
|
|
2202
|
+
},
|
|
2203
|
+
"output": {
|
|
2204
|
+
"char": "o",
|
|
2205
|
+
"description": "Output format.",
|
|
2206
|
+
"name": "output",
|
|
2207
|
+
"default": "table",
|
|
2208
|
+
"hasDynamicHelp": false,
|
|
2209
|
+
"multiple": false,
|
|
2210
|
+
"options": [
|
|
2211
|
+
"table",
|
|
2212
|
+
"json",
|
|
2213
|
+
"md"
|
|
2214
|
+
],
|
|
2215
|
+
"type": "option"
|
|
2216
|
+
}
|
|
2217
|
+
},
|
|
2218
|
+
"hasDynamicHelp": false,
|
|
2219
|
+
"hidden": false,
|
|
2220
|
+
"hiddenAliases": [],
|
|
2221
|
+
"id": "checks:run",
|
|
2222
|
+
"pluginAlias": "checkly",
|
|
2223
|
+
"pluginName": "checkly",
|
|
2224
|
+
"pluginType": "core",
|
|
2225
|
+
"strict": true,
|
|
2226
|
+
"enableJsonFlag": false,
|
|
2227
|
+
"coreCommand": false,
|
|
2228
|
+
"readOnly": false,
|
|
2229
|
+
"destructive": false,
|
|
2230
|
+
"idempotent": false,
|
|
2231
|
+
"isESM": true,
|
|
2232
|
+
"relativePath": [
|
|
2233
|
+
"dist",
|
|
2234
|
+
"commands",
|
|
2235
|
+
"checks",
|
|
2236
|
+
"run.js"
|
|
2237
|
+
]
|
|
2238
|
+
},
|
|
1993
2239
|
"checks:stats": {
|
|
1994
2240
|
"aliases": [],
|
|
1995
2241
|
"args": {
|
|
@@ -2109,175 +2355,13 @@
|
|
|
2109
2355
|
"stats.js"
|
|
2110
2356
|
]
|
|
2111
2357
|
},
|
|
2112
|
-
"
|
|
2358
|
+
"env:add": {
|
|
2113
2359
|
"aliases": [],
|
|
2114
|
-
"args": {
|
|
2115
|
-
|
|
2116
|
-
|
|
2117
|
-
|
|
2118
|
-
"
|
|
2119
|
-
"required": true,
|
|
2120
|
-
"hasDynamicHelp": false,
|
|
2121
|
-
"multiple": false,
|
|
2122
|
-
"type": "option"
|
|
2123
|
-
},
|
|
2124
|
-
"restricted": {
|
|
2125
|
-
"name": "restricted",
|
|
2126
|
-
"allowNo": false,
|
|
2127
|
-
"type": "boolean"
|
|
2128
|
-
},
|
|
2129
|
-
"detect-workspace": {
|
|
2130
|
-
"name": "detect-workspace",
|
|
2131
|
-
"allowNo": true,
|
|
2132
|
-
"type": "boolean"
|
|
2133
|
-
},
|
|
2134
|
-
"supported-module": {
|
|
2135
|
-
"name": "supported-module",
|
|
2136
|
-
"default": [],
|
|
2137
|
-
"delimiter": ",",
|
|
2138
|
-
"hasDynamicHelp": false,
|
|
2139
|
-
"multiple": true,
|
|
2140
|
-
"type": "option"
|
|
2141
|
-
},
|
|
2142
|
-
"check-unsupported-modules": {
|
|
2143
|
-
"name": "check-unsupported-modules",
|
|
2144
|
-
"allowNo": false,
|
|
2145
|
-
"type": "boolean"
|
|
2146
|
-
}
|
|
2147
|
-
},
|
|
2148
|
-
"hasDynamicHelp": false,
|
|
2149
|
-
"hidden": true,
|
|
2150
|
-
"hiddenAliases": [],
|
|
2151
|
-
"id": "debug:parse-file",
|
|
2152
|
-
"pluginAlias": "checkly",
|
|
2153
|
-
"pluginName": "checkly",
|
|
2154
|
-
"pluginType": "core",
|
|
2155
|
-
"strict": true,
|
|
2156
|
-
"enableJsonFlag": false,
|
|
2157
|
-
"isESM": true,
|
|
2158
|
-
"relativePath": [
|
|
2159
|
-
"dist",
|
|
2160
|
-
"commands",
|
|
2161
|
-
"debug",
|
|
2162
|
-
"parse-file.js"
|
|
2163
|
-
]
|
|
2164
|
-
},
|
|
2165
|
-
"debug:parse-playwright-config": {
|
|
2166
|
-
"aliases": [],
|
|
2167
|
-
"args": {},
|
|
2168
|
-
"description": "Parses and outputs relevant details of a Playwright configuration file.",
|
|
2169
|
-
"flags": {
|
|
2170
|
-
"file": {
|
|
2171
|
-
"env": "CHECKLY_PLAYWRIGHT_CONFIG_FILE",
|
|
2172
|
-
"name": "file",
|
|
2173
|
-
"default": "/home/runner/work/checkly-cli/checkly-cli/packages/cli/playwright.config.ts",
|
|
2174
|
-
"hasDynamicHelp": false,
|
|
2175
|
-
"multiple": false,
|
|
2176
|
-
"type": "option"
|
|
2177
|
-
}
|
|
2178
|
-
},
|
|
2179
|
-
"hasDynamicHelp": false,
|
|
2180
|
-
"hidden": true,
|
|
2181
|
-
"hiddenAliases": [],
|
|
2182
|
-
"id": "debug:parse-playwright-config",
|
|
2183
|
-
"pluginAlias": "checkly",
|
|
2184
|
-
"pluginName": "checkly",
|
|
2185
|
-
"pluginType": "core",
|
|
2186
|
-
"strict": true,
|
|
2187
|
-
"enableJsonFlag": false,
|
|
2188
|
-
"isESM": true,
|
|
2189
|
-
"relativePath": [
|
|
2190
|
-
"dist",
|
|
2191
|
-
"commands",
|
|
2192
|
-
"debug",
|
|
2193
|
-
"parse-playwright-config.js"
|
|
2194
|
-
]
|
|
2195
|
-
},
|
|
2196
|
-
"debug:parse-project": {
|
|
2197
|
-
"aliases": [],
|
|
2198
|
-
"args": {},
|
|
2199
|
-
"description": "Parses a Checkly project.",
|
|
2200
|
-
"flags": {
|
|
2201
|
-
"config": {
|
|
2202
|
-
"char": "c",
|
|
2203
|
-
"description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
|
|
2204
|
-
"env": "CHECKLY_CONFIG_FILE",
|
|
2205
|
-
"name": "config",
|
|
2206
|
-
"hasDynamicHelp": false,
|
|
2207
|
-
"multiple": false,
|
|
2208
|
-
"type": "option"
|
|
2209
|
-
},
|
|
2210
|
-
"default-runtime": {
|
|
2211
|
-
"description": "The default runtime to use if none is specified.",
|
|
2212
|
-
"env": "CHECKLY_DEFAULT_RUNTIME",
|
|
2213
|
-
"name": "default-runtime",
|
|
2214
|
-
"default": "2025.04",
|
|
2215
|
-
"hasDynamicHelp": false,
|
|
2216
|
-
"multiple": false,
|
|
2217
|
-
"type": "option"
|
|
2218
|
-
},
|
|
2219
|
-
"verify-runtime-dependencies": {
|
|
2220
|
-
"description": "[default: true] Return an error if checks import dependencies that are not supported by the selected runtime.",
|
|
2221
|
-
"env": "CHECKLY_VERIFY_RUNTIME_DEPENDENCIES",
|
|
2222
|
-
"name": "verify-runtime-dependencies",
|
|
2223
|
-
"allowNo": true,
|
|
2224
|
-
"type": "boolean"
|
|
2225
|
-
},
|
|
2226
|
-
"emulate-pw-test": {
|
|
2227
|
-
"description": "Pretend to be the pw-test command. Affects validation.",
|
|
2228
|
-
"env": "CHECKLY_EMULATE_PW_TEST",
|
|
2229
|
-
"name": "emulate-pw-test",
|
|
2230
|
-
"allowNo": false,
|
|
2231
|
-
"type": "boolean"
|
|
2232
|
-
},
|
|
2233
|
-
"include": {
|
|
2234
|
-
"description": "File patterns to include when bundling the test project (e.g., \"utils/**/*\").",
|
|
2235
|
-
"name": "include",
|
|
2236
|
-
"default": [],
|
|
2237
|
-
"hasDynamicHelp": false,
|
|
2238
|
-
"multiple": true,
|
|
2239
|
-
"type": "option"
|
|
2240
|
-
},
|
|
2241
|
-
"inject-private-location": {
|
|
2242
|
-
"description": "Pretend that the given private location exists (e.g., \"70c4ded4-2229-45a7-acf4-6b1eb56a86df:my-external-private-location\").",
|
|
2243
|
-
"name": "inject-private-location",
|
|
2244
|
-
"default": [],
|
|
2245
|
-
"delimiter": ",",
|
|
2246
|
-
"hasDynamicHelp": false,
|
|
2247
|
-
"multiple": true,
|
|
2248
|
-
"type": "option"
|
|
2249
|
-
},
|
|
2250
|
-
"stats": {
|
|
2251
|
-
"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.",
|
|
2252
|
-
"name": "stats",
|
|
2253
|
-
"allowNo": false,
|
|
2254
|
-
"type": "boolean"
|
|
2255
|
-
}
|
|
2256
|
-
},
|
|
2257
|
-
"hasDynamicHelp": false,
|
|
2258
|
-
"hidden": true,
|
|
2259
|
-
"hiddenAliases": [],
|
|
2260
|
-
"id": "debug:parse-project",
|
|
2261
|
-
"pluginAlias": "checkly",
|
|
2262
|
-
"pluginName": "checkly",
|
|
2263
|
-
"pluginType": "core",
|
|
2264
|
-
"strict": true,
|
|
2265
|
-
"enableJsonFlag": false,
|
|
2266
|
-
"isESM": true,
|
|
2267
|
-
"relativePath": [
|
|
2268
|
-
"dist",
|
|
2269
|
-
"commands",
|
|
2270
|
-
"debug",
|
|
2271
|
-
"parse-project.js"
|
|
2272
|
-
]
|
|
2273
|
-
},
|
|
2274
|
-
"env:add": {
|
|
2275
|
-
"aliases": [],
|
|
2276
|
-
"args": {
|
|
2277
|
-
"key": {
|
|
2278
|
-
"description": "Environment variable key.",
|
|
2279
|
-
"name": "key",
|
|
2280
|
-
"required": true
|
|
2360
|
+
"args": {
|
|
2361
|
+
"key": {
|
|
2362
|
+
"description": "Environment variable key.",
|
|
2363
|
+
"name": "key",
|
|
2364
|
+
"required": true
|
|
2281
2365
|
},
|
|
2282
2366
|
"value": {
|
|
2283
2367
|
"description": "Environment variable value.",
|
|
@@ -2488,86 +2572,29 @@
|
|
|
2488
2572
|
"update.js"
|
|
2489
2573
|
]
|
|
2490
2574
|
},
|
|
2491
|
-
"
|
|
2575
|
+
"import:apply": {
|
|
2492
2576
|
"aliases": [],
|
|
2493
2577
|
"args": {},
|
|
2494
|
-
"description": "
|
|
2578
|
+
"description": "Attach imported resources into your project in a pending state.",
|
|
2495
2579
|
"flags": {
|
|
2496
|
-
"
|
|
2497
|
-
"
|
|
2498
|
-
"
|
|
2499
|
-
"
|
|
2500
|
-
"hasDynamicHelp": false,
|
|
2501
|
-
"multiple": false,
|
|
2502
|
-
"type": "option"
|
|
2503
|
-
},
|
|
2504
|
-
"title": {
|
|
2505
|
-
"description": "Incident title.",
|
|
2506
|
-
"name": "title",
|
|
2507
|
-
"required": true,
|
|
2508
|
-
"hasDynamicHelp": false,
|
|
2509
|
-
"multiple": false,
|
|
2510
|
-
"type": "option"
|
|
2511
|
-
},
|
|
2512
|
-
"services": {
|
|
2513
|
-
"description": "Affected service IDs. Repeat the flag for multiple services.",
|
|
2514
|
-
"name": "services",
|
|
2515
|
-
"delimiter": ",",
|
|
2516
|
-
"hasDynamicHelp": false,
|
|
2517
|
-
"multiple": true,
|
|
2518
|
-
"type": "option"
|
|
2519
|
-
},
|
|
2520
|
-
"severity": {
|
|
2521
|
-
"description": "Incident severity.",
|
|
2522
|
-
"name": "severity",
|
|
2523
|
-
"default": "minor",
|
|
2524
|
-
"hasDynamicHelp": false,
|
|
2525
|
-
"multiple": false,
|
|
2526
|
-
"options": [
|
|
2527
|
-
"minor",
|
|
2528
|
-
"medium",
|
|
2529
|
-
"major",
|
|
2530
|
-
"critical"
|
|
2531
|
-
],
|
|
2532
|
-
"type": "option"
|
|
2533
|
-
},
|
|
2534
|
-
"message": {
|
|
2535
|
-
"description": "Initial incident update message.",
|
|
2536
|
-
"name": "message",
|
|
2580
|
+
"config": {
|
|
2581
|
+
"char": "c",
|
|
2582
|
+
"description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
|
|
2583
|
+
"name": "config",
|
|
2537
2584
|
"hasDynamicHelp": false,
|
|
2538
2585
|
"multiple": false,
|
|
2539
2586
|
"type": "option"
|
|
2540
2587
|
},
|
|
2541
|
-
"
|
|
2542
|
-
"description": "
|
|
2543
|
-
"name": "
|
|
2544
|
-
"allowNo": true,
|
|
2545
|
-
"type": "boolean"
|
|
2546
|
-
},
|
|
2547
|
-
"output": {
|
|
2548
|
-
"char": "o",
|
|
2549
|
-
"description": "Output format.",
|
|
2550
|
-
"name": "output",
|
|
2551
|
-
"default": "table",
|
|
2588
|
+
"plan-id": {
|
|
2589
|
+
"description": "Target a specific import plan by ID, skipping interactive plan selection.",
|
|
2590
|
+
"name": "plan-id",
|
|
2552
2591
|
"hasDynamicHelp": false,
|
|
2553
2592
|
"multiple": false,
|
|
2554
|
-
"options": [
|
|
2555
|
-
"table",
|
|
2556
|
-
"json",
|
|
2557
|
-
"md"
|
|
2558
|
-
],
|
|
2559
2593
|
"type": "option"
|
|
2560
2594
|
},
|
|
2561
|
-
"
|
|
2562
|
-
"
|
|
2563
|
-
"
|
|
2564
|
-
"name": "force",
|
|
2565
|
-
"allowNo": false,
|
|
2566
|
-
"type": "boolean"
|
|
2567
|
-
},
|
|
2568
|
-
"dry-run": {
|
|
2569
|
-
"description": "Preview what would happen without executing.",
|
|
2570
|
-
"name": "dry-run",
|
|
2595
|
+
"no-commit": {
|
|
2596
|
+
"description": "Apply only. Leave the plan pending and skip the commit prompt.",
|
|
2597
|
+
"name": "no-commit",
|
|
2571
2598
|
"allowNo": false,
|
|
2572
2599
|
"type": "boolean"
|
|
2573
2600
|
}
|
|
@@ -2575,7 +2602,7 @@
|
|
|
2575
2602
|
"hasDynamicHelp": false,
|
|
2576
2603
|
"hidden": false,
|
|
2577
2604
|
"hiddenAliases": [],
|
|
2578
|
-
"id": "
|
|
2605
|
+
"id": "import:apply",
|
|
2579
2606
|
"pluginAlias": "checkly",
|
|
2580
2607
|
"pluginName": "checkly",
|
|
2581
2608
|
"pluginType": "core",
|
|
@@ -2589,116 +2616,89 @@
|
|
|
2589
2616
|
"relativePath": [
|
|
2590
2617
|
"dist",
|
|
2591
2618
|
"commands",
|
|
2592
|
-
"
|
|
2593
|
-
"
|
|
2619
|
+
"import",
|
|
2620
|
+
"apply.js"
|
|
2594
2621
|
]
|
|
2595
2622
|
},
|
|
2596
|
-
"
|
|
2623
|
+
"import:cancel": {
|
|
2597
2624
|
"aliases": [],
|
|
2598
2625
|
"args": {},
|
|
2599
|
-
"description": "
|
|
2626
|
+
"description": "Cancels an ongoing import plan that has not been committed yet.",
|
|
2600
2627
|
"flags": {
|
|
2601
|
-
"
|
|
2602
|
-
"char": "
|
|
2603
|
-
"description": "
|
|
2604
|
-
"name": "
|
|
2605
|
-
"default": 25,
|
|
2628
|
+
"config": {
|
|
2629
|
+
"char": "c",
|
|
2630
|
+
"description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
|
|
2631
|
+
"name": "config",
|
|
2606
2632
|
"hasDynamicHelp": false,
|
|
2607
2633
|
"multiple": false,
|
|
2608
2634
|
"type": "option"
|
|
2609
2635
|
},
|
|
2610
|
-
"
|
|
2611
|
-
"description": "
|
|
2612
|
-
"name": "
|
|
2613
|
-
"
|
|
2614
|
-
"
|
|
2615
|
-
"type": "option"
|
|
2636
|
+
"all": {
|
|
2637
|
+
"description": "Cancel all plans.",
|
|
2638
|
+
"name": "all",
|
|
2639
|
+
"allowNo": false,
|
|
2640
|
+
"type": "boolean"
|
|
2616
2641
|
},
|
|
2617
|
-
"
|
|
2618
|
-
"description": "
|
|
2619
|
-
"name": "
|
|
2620
|
-
"default": "open",
|
|
2642
|
+
"plan-id": {
|
|
2643
|
+
"description": "Target a specific import plan by ID, skipping interactive plan selection.",
|
|
2644
|
+
"name": "plan-id",
|
|
2621
2645
|
"hasDynamicHelp": false,
|
|
2622
2646
|
"multiple": false,
|
|
2623
|
-
"options": [
|
|
2624
|
-
"open",
|
|
2625
|
-
"resolved",
|
|
2626
|
-
"all"
|
|
2627
|
-
],
|
|
2628
2647
|
"type": "option"
|
|
2629
2648
|
},
|
|
2630
|
-
"
|
|
2631
|
-
"char": "
|
|
2632
|
-
"description": "
|
|
2633
|
-
"name": "
|
|
2634
|
-
"
|
|
2635
|
-
"
|
|
2636
|
-
|
|
2637
|
-
|
|
2638
|
-
|
|
2639
|
-
|
|
2640
|
-
|
|
2641
|
-
|
|
2642
|
-
"type": "option"
|
|
2649
|
+
"force": {
|
|
2650
|
+
"char": "f",
|
|
2651
|
+
"description": "Skip confirmation prompt.",
|
|
2652
|
+
"name": "force",
|
|
2653
|
+
"allowNo": false,
|
|
2654
|
+
"type": "boolean"
|
|
2655
|
+
},
|
|
2656
|
+
"dry-run": {
|
|
2657
|
+
"description": "Preview what would happen without executing.",
|
|
2658
|
+
"name": "dry-run",
|
|
2659
|
+
"allowNo": false,
|
|
2660
|
+
"type": "boolean"
|
|
2643
2661
|
}
|
|
2644
2662
|
},
|
|
2645
2663
|
"hasDynamicHelp": false,
|
|
2646
2664
|
"hidden": false,
|
|
2647
2665
|
"hiddenAliases": [],
|
|
2648
|
-
"id": "
|
|
2666
|
+
"id": "import:cancel",
|
|
2649
2667
|
"pluginAlias": "checkly",
|
|
2650
2668
|
"pluginName": "checkly",
|
|
2651
2669
|
"pluginType": "core",
|
|
2652
2670
|
"strict": true,
|
|
2653
2671
|
"enableJsonFlag": false,
|
|
2654
2672
|
"coreCommand": false,
|
|
2655
|
-
"readOnly":
|
|
2656
|
-
"destructive":
|
|
2673
|
+
"readOnly": false,
|
|
2674
|
+
"destructive": true,
|
|
2657
2675
|
"idempotent": true,
|
|
2658
2676
|
"isESM": true,
|
|
2659
2677
|
"relativePath": [
|
|
2660
2678
|
"dist",
|
|
2661
2679
|
"commands",
|
|
2662
|
-
"
|
|
2663
|
-
"
|
|
2680
|
+
"import",
|
|
2681
|
+
"cancel.js"
|
|
2664
2682
|
]
|
|
2665
2683
|
},
|
|
2666
|
-
"
|
|
2684
|
+
"import:commit": {
|
|
2667
2685
|
"aliases": [],
|
|
2668
|
-
"args": {
|
|
2669
|
-
|
|
2670
|
-
"description": "The incident ID.",
|
|
2671
|
-
"name": "id",
|
|
2672
|
-
"required": true
|
|
2673
|
-
}
|
|
2674
|
-
},
|
|
2675
|
-
"description": "Resolve an incident.",
|
|
2686
|
+
"args": {},
|
|
2687
|
+
"description": "Permanently commit imported resources into your project.",
|
|
2676
2688
|
"flags": {
|
|
2677
|
-
"
|
|
2678
|
-
"
|
|
2679
|
-
"
|
|
2689
|
+
"config": {
|
|
2690
|
+
"char": "c",
|
|
2691
|
+
"description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
|
|
2692
|
+
"name": "config",
|
|
2680
2693
|
"hasDynamicHelp": false,
|
|
2681
2694
|
"multiple": false,
|
|
2682
2695
|
"type": "option"
|
|
2683
2696
|
},
|
|
2684
|
-
"
|
|
2685
|
-
"description": "
|
|
2686
|
-
"name": "
|
|
2687
|
-
"allowNo": true,
|
|
2688
|
-
"type": "boolean"
|
|
2689
|
-
},
|
|
2690
|
-
"output": {
|
|
2691
|
-
"char": "o",
|
|
2692
|
-
"description": "Output format.",
|
|
2693
|
-
"name": "output",
|
|
2694
|
-
"default": "table",
|
|
2697
|
+
"plan-id": {
|
|
2698
|
+
"description": "Target a specific import plan by ID, skipping interactive plan selection.",
|
|
2699
|
+
"name": "plan-id",
|
|
2695
2700
|
"hasDynamicHelp": false,
|
|
2696
2701
|
"multiple": false,
|
|
2697
|
-
"options": [
|
|
2698
|
-
"table",
|
|
2699
|
-
"json",
|
|
2700
|
-
"md"
|
|
2701
|
-
],
|
|
2702
2702
|
"type": "option"
|
|
2703
2703
|
},
|
|
2704
2704
|
"force": {
|
|
@@ -2718,7 +2718,7 @@
|
|
|
2718
2718
|
"hasDynamicHelp": false,
|
|
2719
2719
|
"hidden": false,
|
|
2720
2720
|
"hiddenAliases": [],
|
|
2721
|
-
"id": "
|
|
2721
|
+
"id": "import:commit",
|
|
2722
2722
|
"pluginAlias": "checkly",
|
|
2723
2723
|
"pluginName": "checkly",
|
|
2724
2724
|
"pluginType": "core",
|
|
@@ -2732,45 +2732,124 @@
|
|
|
2732
2732
|
"relativePath": [
|
|
2733
2733
|
"dist",
|
|
2734
2734
|
"commands",
|
|
2735
|
-
"
|
|
2736
|
-
"
|
|
2735
|
+
"import",
|
|
2736
|
+
"commit.js"
|
|
2737
2737
|
]
|
|
2738
2738
|
},
|
|
2739
|
-
"
|
|
2739
|
+
"import:plan": {
|
|
2740
2740
|
"aliases": [],
|
|
2741
2741
|
"args": {
|
|
2742
|
-
"
|
|
2743
|
-
"description": "
|
|
2744
|
-
"name": "
|
|
2745
|
-
"required":
|
|
2742
|
+
"resource": {
|
|
2743
|
+
"description": "A specific resource to import.",
|
|
2744
|
+
"name": "resource",
|
|
2745
|
+
"required": false
|
|
2746
2746
|
}
|
|
2747
2747
|
},
|
|
2748
|
-
"description": "
|
|
2748
|
+
"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.",
|
|
2749
2749
|
"flags": {
|
|
2750
|
-
"
|
|
2751
|
-
"
|
|
2752
|
-
"
|
|
2750
|
+
"config": {
|
|
2751
|
+
"char": "c",
|
|
2752
|
+
"description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
|
|
2753
|
+
"name": "config",
|
|
2754
|
+
"hasDynamicHelp": false,
|
|
2755
|
+
"multiple": false,
|
|
2756
|
+
"type": "option"
|
|
2757
|
+
},
|
|
2758
|
+
"root": {
|
|
2759
|
+
"description": "The root folder in which to write generated code files.",
|
|
2760
|
+
"name": "root",
|
|
2761
|
+
"default": "__checks__",
|
|
2762
|
+
"hasDynamicHelp": false,
|
|
2763
|
+
"multiple": false,
|
|
2764
|
+
"type": "option"
|
|
2765
|
+
},
|
|
2766
|
+
"preview": {
|
|
2767
|
+
"description": "Preview generated code without creating an actual import plan.",
|
|
2768
|
+
"name": "preview",
|
|
2769
|
+
"allowNo": false,
|
|
2770
|
+
"type": "boolean"
|
|
2771
|
+
},
|
|
2772
|
+
"debug-import-plan": {
|
|
2773
|
+
"description": "Output the import plan to a file.",
|
|
2774
|
+
"hidden": true,
|
|
2775
|
+
"name": "debug-import-plan",
|
|
2776
|
+
"allowNo": false,
|
|
2777
|
+
"type": "boolean"
|
|
2778
|
+
},
|
|
2779
|
+
"debug-import-plan-input-file": {
|
|
2780
|
+
"description": "A file to load an import plan from.",
|
|
2781
|
+
"hidden": true,
|
|
2782
|
+
"name": "debug-import-plan-input-file",
|
|
2783
|
+
"hasDynamicHelp": false,
|
|
2784
|
+
"multiple": false,
|
|
2785
|
+
"type": "option"
|
|
2786
|
+
},
|
|
2787
|
+
"debug-import-plan-output-file": {
|
|
2788
|
+
"description": "The file to output the import plan to.",
|
|
2789
|
+
"hidden": true,
|
|
2790
|
+
"name": "debug-import-plan-output-file",
|
|
2791
|
+
"default": "./debug-import-plan.json",
|
|
2792
|
+
"hasDynamicHelp": false,
|
|
2793
|
+
"multiple": false,
|
|
2794
|
+
"type": "option"
|
|
2795
|
+
}
|
|
2796
|
+
},
|
|
2797
|
+
"hasDynamicHelp": false,
|
|
2798
|
+
"hidden": false,
|
|
2799
|
+
"hiddenAliases": [
|
|
2800
|
+
"import"
|
|
2801
|
+
],
|
|
2802
|
+
"id": "import:plan",
|
|
2803
|
+
"pluginAlias": "checkly",
|
|
2804
|
+
"pluginName": "checkly",
|
|
2805
|
+
"pluginType": "core",
|
|
2806
|
+
"strict": false,
|
|
2807
|
+
"enableJsonFlag": false,
|
|
2808
|
+
"coreCommand": false,
|
|
2809
|
+
"readOnly": true,
|
|
2810
|
+
"destructive": false,
|
|
2811
|
+
"idempotent": true,
|
|
2812
|
+
"isESM": true,
|
|
2813
|
+
"relativePath": [
|
|
2814
|
+
"dist",
|
|
2815
|
+
"commands",
|
|
2816
|
+
"import",
|
|
2817
|
+
"plan.js"
|
|
2818
|
+
]
|
|
2819
|
+
},
|
|
2820
|
+
"incidents:create": {
|
|
2821
|
+
"aliases": [],
|
|
2822
|
+
"args": {},
|
|
2823
|
+
"description": "Declare a new incident on a status page.",
|
|
2824
|
+
"flags": {
|
|
2825
|
+
"status-page-id": {
|
|
2826
|
+
"description": "Target status page ID.",
|
|
2827
|
+
"name": "status-page-id",
|
|
2753
2828
|
"required": true,
|
|
2754
2829
|
"hasDynamicHelp": false,
|
|
2755
2830
|
"multiple": false,
|
|
2756
2831
|
"type": "option"
|
|
2757
2832
|
},
|
|
2758
|
-
"
|
|
2759
|
-
"description": "Incident
|
|
2760
|
-
"name": "
|
|
2761
|
-
"
|
|
2833
|
+
"title": {
|
|
2834
|
+
"description": "Incident title.",
|
|
2835
|
+
"name": "title",
|
|
2836
|
+
"required": true,
|
|
2762
2837
|
"hasDynamicHelp": false,
|
|
2763
2838
|
"multiple": false,
|
|
2764
|
-
"
|
|
2765
|
-
|
|
2766
|
-
|
|
2767
|
-
|
|
2768
|
-
|
|
2839
|
+
"type": "option"
|
|
2840
|
+
},
|
|
2841
|
+
"services": {
|
|
2842
|
+
"description": "Affected service IDs. Repeat the flag for multiple services.",
|
|
2843
|
+
"name": "services",
|
|
2844
|
+
"delimiter": ",",
|
|
2845
|
+
"hasDynamicHelp": false,
|
|
2846
|
+
"multiple": true,
|
|
2769
2847
|
"type": "option"
|
|
2770
2848
|
},
|
|
2771
2849
|
"severity": {
|
|
2772
|
-
"description": "
|
|
2850
|
+
"description": "Incident severity.",
|
|
2773
2851
|
"name": "severity",
|
|
2852
|
+
"default": "minor",
|
|
2774
2853
|
"hasDynamicHelp": false,
|
|
2775
2854
|
"multiple": false,
|
|
2776
2855
|
"options": [
|
|
@@ -2781,6 +2860,13 @@
|
|
|
2781
2860
|
],
|
|
2782
2861
|
"type": "option"
|
|
2783
2862
|
},
|
|
2863
|
+
"message": {
|
|
2864
|
+
"description": "Initial incident update message.",
|
|
2865
|
+
"name": "message",
|
|
2866
|
+
"hasDynamicHelp": false,
|
|
2867
|
+
"multiple": false,
|
|
2868
|
+
"type": "option"
|
|
2869
|
+
},
|
|
2784
2870
|
"notify-subscribers": {
|
|
2785
2871
|
"description": "Notify status page subscribers about this incident update.",
|
|
2786
2872
|
"name": "notify-subscribers",
|
|
@@ -2818,7 +2904,7 @@
|
|
|
2818
2904
|
"hasDynamicHelp": false,
|
|
2819
2905
|
"hidden": false,
|
|
2820
2906
|
"hiddenAliases": [],
|
|
2821
|
-
"id": "incidents:
|
|
2907
|
+
"id": "incidents:create",
|
|
2822
2908
|
"pluginAlias": "checkly",
|
|
2823
2909
|
"pluginName": "checkly",
|
|
2824
2910
|
"pluginType": "core",
|
|
@@ -2833,111 +2919,101 @@
|
|
|
2833
2919
|
"dist",
|
|
2834
2920
|
"commands",
|
|
2835
2921
|
"incidents",
|
|
2836
|
-
"
|
|
2922
|
+
"create.js"
|
|
2837
2923
|
]
|
|
2838
2924
|
},
|
|
2839
|
-
"
|
|
2925
|
+
"incidents:list": {
|
|
2840
2926
|
"aliases": [],
|
|
2841
|
-
"args": {
|
|
2842
|
-
|
|
2843
|
-
"description": "The account member email or user ID.",
|
|
2844
|
-
"name": "member",
|
|
2845
|
-
"required": true
|
|
2846
|
-
}
|
|
2847
|
-
},
|
|
2848
|
-
"description": "Delete an account member.",
|
|
2927
|
+
"args": {},
|
|
2928
|
+
"description": "List incidents, optionally filtered by status page or status.",
|
|
2849
2929
|
"flags": {
|
|
2850
|
-
"
|
|
2851
|
-
"
|
|
2852
|
-
"
|
|
2853
|
-
|
|
2854
|
-
|
|
2855
|
-
"
|
|
2856
|
-
"
|
|
2857
|
-
"type": "
|
|
2858
|
-
},
|
|
2859
|
-
"id": {
|
|
2860
|
-
"description": "Treat the member argument as a user ID.",
|
|
2861
|
-
"exclusive": [
|
|
2862
|
-
"email"
|
|
2863
|
-
],
|
|
2864
|
-
"name": "id",
|
|
2865
|
-
"allowNo": false,
|
|
2866
|
-
"type": "boolean"
|
|
2930
|
+
"limit": {
|
|
2931
|
+
"char": "l",
|
|
2932
|
+
"description": "Number of incidents to return (1-100).",
|
|
2933
|
+
"name": "limit",
|
|
2934
|
+
"default": 25,
|
|
2935
|
+
"hasDynamicHelp": false,
|
|
2936
|
+
"multiple": false,
|
|
2937
|
+
"type": "option"
|
|
2867
2938
|
},
|
|
2868
|
-
"
|
|
2869
|
-
"
|
|
2870
|
-
"
|
|
2871
|
-
"
|
|
2872
|
-
"
|
|
2873
|
-
"type": "
|
|
2939
|
+
"status-page-id": {
|
|
2940
|
+
"description": "Filter incidents by status page ID.",
|
|
2941
|
+
"name": "status-page-id",
|
|
2942
|
+
"hasDynamicHelp": false,
|
|
2943
|
+
"multiple": false,
|
|
2944
|
+
"type": "option"
|
|
2874
2945
|
},
|
|
2875
|
-
"
|
|
2876
|
-
"description": "
|
|
2877
|
-
"name": "
|
|
2878
|
-
"
|
|
2879
|
-
"
|
|
2946
|
+
"status": {
|
|
2947
|
+
"description": "Filter by incident status.",
|
|
2948
|
+
"name": "status",
|
|
2949
|
+
"default": "open",
|
|
2950
|
+
"hasDynamicHelp": false,
|
|
2951
|
+
"multiple": false,
|
|
2952
|
+
"options": [
|
|
2953
|
+
"open",
|
|
2954
|
+
"resolved",
|
|
2955
|
+
"all"
|
|
2956
|
+
],
|
|
2957
|
+
"type": "option"
|
|
2958
|
+
},
|
|
2959
|
+
"output": {
|
|
2960
|
+
"char": "o",
|
|
2961
|
+
"description": "Output format.",
|
|
2962
|
+
"name": "output",
|
|
2963
|
+
"default": "table",
|
|
2964
|
+
"hasDynamicHelp": false,
|
|
2965
|
+
"multiple": false,
|
|
2966
|
+
"options": [
|
|
2967
|
+
"table",
|
|
2968
|
+
"json",
|
|
2969
|
+
"md"
|
|
2970
|
+
],
|
|
2971
|
+
"type": "option"
|
|
2880
2972
|
}
|
|
2881
2973
|
},
|
|
2882
2974
|
"hasDynamicHelp": false,
|
|
2883
2975
|
"hidden": false,
|
|
2884
|
-
"hiddenAliases": [
|
|
2885
|
-
|
|
2886
|
-
],
|
|
2887
|
-
"id": "members:delete",
|
|
2976
|
+
"hiddenAliases": [],
|
|
2977
|
+
"id": "incidents:list",
|
|
2888
2978
|
"pluginAlias": "checkly",
|
|
2889
2979
|
"pluginName": "checkly",
|
|
2890
2980
|
"pluginType": "core",
|
|
2891
2981
|
"strict": true,
|
|
2892
2982
|
"enableJsonFlag": false,
|
|
2893
2983
|
"coreCommand": false,
|
|
2894
|
-
"readOnly":
|
|
2895
|
-
"destructive":
|
|
2984
|
+
"readOnly": true,
|
|
2985
|
+
"destructive": false,
|
|
2896
2986
|
"idempotent": true,
|
|
2897
2987
|
"isESM": true,
|
|
2898
2988
|
"relativePath": [
|
|
2899
2989
|
"dist",
|
|
2900
2990
|
"commands",
|
|
2901
|
-
"
|
|
2902
|
-
"
|
|
2991
|
+
"incidents",
|
|
2992
|
+
"list.js"
|
|
2903
2993
|
]
|
|
2904
2994
|
},
|
|
2905
|
-
"
|
|
2995
|
+
"incidents:resolve": {
|
|
2906
2996
|
"aliases": [],
|
|
2907
2997
|
"args": {
|
|
2908
|
-
"
|
|
2909
|
-
"description": "The
|
|
2910
|
-
"name": "
|
|
2998
|
+
"id": {
|
|
2999
|
+
"description": "The incident ID.",
|
|
3000
|
+
"name": "id",
|
|
2911
3001
|
"required": true
|
|
2912
3002
|
}
|
|
2913
3003
|
},
|
|
2914
|
-
"description": "
|
|
3004
|
+
"description": "Resolve an incident.",
|
|
2915
3005
|
"flags": {
|
|
2916
|
-
"
|
|
2917
|
-
"
|
|
2918
|
-
"
|
|
2919
|
-
"name": "role",
|
|
2920
|
-
"required": true,
|
|
3006
|
+
"message": {
|
|
3007
|
+
"description": "Optional closing note.",
|
|
3008
|
+
"name": "message",
|
|
2921
3009
|
"hasDynamicHelp": false,
|
|
2922
3010
|
"multiple": false,
|
|
2923
3011
|
"type": "option"
|
|
2924
3012
|
},
|
|
2925
|
-
"
|
|
2926
|
-
"description": "
|
|
2927
|
-
"
|
|
2928
|
-
|
|
2929
|
-
],
|
|
2930
|
-
"name": "email",
|
|
2931
|
-
"allowNo": false,
|
|
2932
|
-
"type": "boolean"
|
|
2933
|
-
},
|
|
2934
|
-
"id": {
|
|
2935
|
-
"description": "Treat the member argument as a user ID.",
|
|
2936
|
-
"exclusive": [
|
|
2937
|
-
"email"
|
|
2938
|
-
],
|
|
2939
|
-
"name": "id",
|
|
2940
|
-
"allowNo": false,
|
|
3013
|
+
"notify-subscribers": {
|
|
3014
|
+
"description": "Notify status page subscribers about this incident update.",
|
|
3015
|
+
"name": "notify-subscribers",
|
|
3016
|
+
"allowNo": true,
|
|
2941
3017
|
"type": "boolean"
|
|
2942
3018
|
},
|
|
2943
3019
|
"output": {
|
|
@@ -2970,10 +3046,8 @@
|
|
|
2970
3046
|
},
|
|
2971
3047
|
"hasDynamicHelp": false,
|
|
2972
3048
|
"hidden": false,
|
|
2973
|
-
"hiddenAliases": [
|
|
2974
|
-
|
|
2975
|
-
],
|
|
2976
|
-
"id": "members:update",
|
|
3049
|
+
"hiddenAliases": [],
|
|
3050
|
+
"id": "incidents:resolve",
|
|
2977
3051
|
"pluginAlias": "checkly",
|
|
2978
3052
|
"pluginName": "checkly",
|
|
2979
3053
|
"pluginType": "core",
|
|
@@ -2982,131 +3056,102 @@
|
|
|
2982
3056
|
"coreCommand": false,
|
|
2983
3057
|
"readOnly": false,
|
|
2984
3058
|
"destructive": false,
|
|
2985
|
-
"idempotent":
|
|
3059
|
+
"idempotent": false,
|
|
2986
3060
|
"isESM": true,
|
|
2987
3061
|
"relativePath": [
|
|
2988
3062
|
"dist",
|
|
2989
3063
|
"commands",
|
|
2990
|
-
"
|
|
2991
|
-
"
|
|
3064
|
+
"incidents",
|
|
3065
|
+
"resolve.js"
|
|
2992
3066
|
]
|
|
2993
3067
|
},
|
|
2994
|
-
"
|
|
3068
|
+
"incidents:update": {
|
|
2995
3069
|
"aliases": [],
|
|
2996
3070
|
"args": {
|
|
2997
3071
|
"id": {
|
|
2998
|
-
"description": "The
|
|
3072
|
+
"description": "The incident ID.",
|
|
2999
3073
|
"name": "id",
|
|
3000
3074
|
"required": true
|
|
3001
3075
|
}
|
|
3002
3076
|
},
|
|
3003
|
-
"description": "
|
|
3004
|
-
"flags": {
|
|
3005
|
-
"watch": {
|
|
3006
|
-
"char": "w",
|
|
3007
|
-
"description": "Wait for the analysis to complete if still generating.",
|
|
3008
|
-
"name": "watch",
|
|
3009
|
-
"allowNo": false,
|
|
3010
|
-
"type": "boolean"
|
|
3011
|
-
},
|
|
3012
|
-
"output": {
|
|
3013
|
-
"char": "o",
|
|
3014
|
-
"description": "Output format.",
|
|
3015
|
-
"name": "output",
|
|
3016
|
-
"default": "detail",
|
|
3017
|
-
"hasDynamicHelp": false,
|
|
3018
|
-
"multiple": false,
|
|
3019
|
-
"options": [
|
|
3020
|
-
"detail",
|
|
3021
|
-
"json",
|
|
3022
|
-
"md"
|
|
3023
|
-
],
|
|
3024
|
-
"type": "option"
|
|
3025
|
-
}
|
|
3026
|
-
},
|
|
3027
|
-
"hasDynamicHelp": false,
|
|
3028
|
-
"hidden": false,
|
|
3029
|
-
"hiddenAliases": [],
|
|
3030
|
-
"id": "rca:get",
|
|
3031
|
-
"pluginAlias": "checkly",
|
|
3032
|
-
"pluginName": "checkly",
|
|
3033
|
-
"pluginType": "core",
|
|
3034
|
-
"strict": true,
|
|
3035
|
-
"enableJsonFlag": false,
|
|
3036
|
-
"coreCommand": false,
|
|
3037
|
-
"readOnly": true,
|
|
3038
|
-
"destructive": false,
|
|
3039
|
-
"idempotent": true,
|
|
3040
|
-
"isESM": true,
|
|
3041
|
-
"relativePath": [
|
|
3042
|
-
"dist",
|
|
3043
|
-
"commands",
|
|
3044
|
-
"rca",
|
|
3045
|
-
"get.js"
|
|
3046
|
-
]
|
|
3047
|
-
},
|
|
3048
|
-
"rca:run": {
|
|
3049
|
-
"aliases": [],
|
|
3050
|
-
"args": {},
|
|
3051
|
-
"description": "Trigger a root cause analysis for a check or test session error group.",
|
|
3077
|
+
"description": "Post a progress update to an incident.",
|
|
3052
3078
|
"flags": {
|
|
3053
|
-
"
|
|
3054
|
-
"
|
|
3055
|
-
"
|
|
3056
|
-
"
|
|
3057
|
-
"test-session-error-group"
|
|
3058
|
-
],
|
|
3059
|
-
"name": "error-group",
|
|
3079
|
+
"message": {
|
|
3080
|
+
"description": "Update message.",
|
|
3081
|
+
"name": "message",
|
|
3082
|
+
"required": true,
|
|
3060
3083
|
"hasDynamicHelp": false,
|
|
3061
3084
|
"multiple": false,
|
|
3062
3085
|
"type": "option"
|
|
3063
3086
|
},
|
|
3064
|
-
"
|
|
3065
|
-
"description": "
|
|
3066
|
-
"
|
|
3067
|
-
"
|
|
3087
|
+
"status": {
|
|
3088
|
+
"description": "Incident progress status.",
|
|
3089
|
+
"name": "status",
|
|
3090
|
+
"default": "investigating",
|
|
3068
3091
|
"hasDynamicHelp": false,
|
|
3069
3092
|
"multiple": false,
|
|
3093
|
+
"options": [
|
|
3094
|
+
"investigating",
|
|
3095
|
+
"identified",
|
|
3096
|
+
"monitoring"
|
|
3097
|
+
],
|
|
3070
3098
|
"type": "option"
|
|
3071
3099
|
},
|
|
3072
|
-
"
|
|
3073
|
-
"description": "
|
|
3074
|
-
"name": "
|
|
3100
|
+
"severity": {
|
|
3101
|
+
"description": "Update the overall incident severity.",
|
|
3102
|
+
"name": "severity",
|
|
3075
3103
|
"hasDynamicHelp": false,
|
|
3076
3104
|
"multiple": false,
|
|
3105
|
+
"options": [
|
|
3106
|
+
"minor",
|
|
3107
|
+
"medium",
|
|
3108
|
+
"major",
|
|
3109
|
+
"critical"
|
|
3110
|
+
],
|
|
3077
3111
|
"type": "option"
|
|
3078
3112
|
},
|
|
3079
|
-
"
|
|
3080
|
-
"
|
|
3081
|
-
"
|
|
3082
|
-
"
|
|
3083
|
-
"allowNo": false,
|
|
3113
|
+
"notify-subscribers": {
|
|
3114
|
+
"description": "Notify status page subscribers about this incident update.",
|
|
3115
|
+
"name": "notify-subscribers",
|
|
3116
|
+
"allowNo": true,
|
|
3084
3117
|
"type": "boolean"
|
|
3085
3118
|
},
|
|
3086
3119
|
"output": {
|
|
3087
3120
|
"char": "o",
|
|
3088
3121
|
"description": "Output format.",
|
|
3089
3122
|
"name": "output",
|
|
3090
|
-
"default": "
|
|
3123
|
+
"default": "table",
|
|
3091
3124
|
"hasDynamicHelp": false,
|
|
3092
3125
|
"multiple": false,
|
|
3093
3126
|
"options": [
|
|
3094
|
-
"
|
|
3127
|
+
"table",
|
|
3095
3128
|
"json",
|
|
3096
3129
|
"md"
|
|
3097
3130
|
],
|
|
3098
3131
|
"type": "option"
|
|
3132
|
+
},
|
|
3133
|
+
"force": {
|
|
3134
|
+
"char": "f",
|
|
3135
|
+
"description": "Skip confirmation prompt.",
|
|
3136
|
+
"name": "force",
|
|
3137
|
+
"allowNo": false,
|
|
3138
|
+
"type": "boolean"
|
|
3139
|
+
},
|
|
3140
|
+
"dry-run": {
|
|
3141
|
+
"description": "Preview what would happen without executing.",
|
|
3142
|
+
"name": "dry-run",
|
|
3143
|
+
"allowNo": false,
|
|
3144
|
+
"type": "boolean"
|
|
3099
3145
|
}
|
|
3100
3146
|
},
|
|
3101
3147
|
"hasDynamicHelp": false,
|
|
3102
3148
|
"hidden": false,
|
|
3103
3149
|
"hiddenAliases": [],
|
|
3104
|
-
"id": "
|
|
3150
|
+
"id": "incidents:update",
|
|
3105
3151
|
"pluginAlias": "checkly",
|
|
3106
3152
|
"pluginName": "checkly",
|
|
3107
3153
|
"pluginType": "core",
|
|
3108
3154
|
"strict": true,
|
|
3109
|
-
"usage": "rca run [-e <value> | -te <value>] [--user-context <text>] [-w] [-o detail|json|md]",
|
|
3110
3155
|
"enableJsonFlag": false,
|
|
3111
3156
|
"coreCommand": false,
|
|
3112
3157
|
"readOnly": false,
|
|
@@ -3116,92 +3161,59 @@
|
|
|
3116
3161
|
"relativePath": [
|
|
3117
3162
|
"dist",
|
|
3118
3163
|
"commands",
|
|
3119
|
-
"
|
|
3120
|
-
"
|
|
3164
|
+
"incidents",
|
|
3165
|
+
"update.js"
|
|
3121
3166
|
]
|
|
3122
3167
|
},
|
|
3123
|
-
"
|
|
3168
|
+
"members:delete": {
|
|
3124
3169
|
"aliases": [],
|
|
3125
3170
|
"args": {
|
|
3126
|
-
"
|
|
3127
|
-
"description": "
|
|
3128
|
-
"name": "
|
|
3129
|
-
"required":
|
|
3130
|
-
},
|
|
3131
|
-
"reference": {
|
|
3132
|
-
"description": "Reference to open for the selected action. Available references are listed below.",
|
|
3133
|
-
"name": "reference",
|
|
3134
|
-
"required": false
|
|
3171
|
+
"member": {
|
|
3172
|
+
"description": "The account member email or user ID.",
|
|
3173
|
+
"name": "member",
|
|
3174
|
+
"required": true
|
|
3135
3175
|
}
|
|
3136
3176
|
},
|
|
3137
|
-
"description": "
|
|
3138
|
-
"examples": [
|
|
3139
|
-
"checkly skills",
|
|
3140
|
-
"checkly skills configure",
|
|
3141
|
-
"checkly skills configure api-checks",
|
|
3142
|
-
"checkly skills investigate alerting"
|
|
3143
|
-
],
|
|
3144
|
-
"flags": {},
|
|
3145
|
-
"hasDynamicHelp": false,
|
|
3146
|
-
"hidden": false,
|
|
3147
|
-
"hiddenAliases": [],
|
|
3148
|
-
"id": "skills",
|
|
3149
|
-
"pluginAlias": "checkly",
|
|
3150
|
-
"pluginName": "checkly",
|
|
3151
|
-
"pluginType": "core",
|
|
3152
|
-
"strict": true,
|
|
3153
|
-
"enableJsonFlag": false,
|
|
3154
|
-
"coreCommand": false,
|
|
3155
|
-
"readOnly": true,
|
|
3156
|
-
"destructive": false,
|
|
3157
|
-
"idempotent": true,
|
|
3158
|
-
"isESM": true,
|
|
3159
|
-
"relativePath": [
|
|
3160
|
-
"dist",
|
|
3161
|
-
"commands",
|
|
3162
|
-
"skills",
|
|
3163
|
-
"index.js"
|
|
3164
|
-
]
|
|
3165
|
-
},
|
|
3166
|
-
"skills:install": {
|
|
3167
|
-
"aliases": [],
|
|
3168
|
-
"args": {},
|
|
3169
|
-
"description": "Install the Checkly agent skill (SKILL.md) into your project.",
|
|
3177
|
+
"description": "Delete an account member.",
|
|
3170
3178
|
"flags": {
|
|
3171
|
-
"
|
|
3172
|
-
"
|
|
3173
|
-
"description": "Platform to install the skill for (amp, claude, cline, codex, continue, cursor, gemini-cli, github-copilot, goose, opencode, roo, windsurf).",
|
|
3179
|
+
"email": {
|
|
3180
|
+
"description": "Treat the member argument as an email address.",
|
|
3174
3181
|
"exclusive": [
|
|
3175
|
-
"
|
|
3182
|
+
"id"
|
|
3176
3183
|
],
|
|
3177
|
-
"name": "
|
|
3178
|
-
"
|
|
3179
|
-
"
|
|
3180
|
-
"type": "option"
|
|
3184
|
+
"name": "email",
|
|
3185
|
+
"allowNo": false,
|
|
3186
|
+
"type": "boolean"
|
|
3181
3187
|
},
|
|
3182
|
-
"
|
|
3183
|
-
"
|
|
3184
|
-
"description": "Custom target directory to install the skill into.",
|
|
3188
|
+
"id": {
|
|
3189
|
+
"description": "Treat the member argument as a user ID.",
|
|
3185
3190
|
"exclusive": [
|
|
3186
|
-
"
|
|
3191
|
+
"email"
|
|
3187
3192
|
],
|
|
3188
|
-
"name": "
|
|
3189
|
-
"
|
|
3190
|
-
"
|
|
3191
|
-
"type": "option"
|
|
3193
|
+
"name": "id",
|
|
3194
|
+
"allowNo": false,
|
|
3195
|
+
"type": "boolean"
|
|
3192
3196
|
},
|
|
3193
3197
|
"force": {
|
|
3194
3198
|
"char": "f",
|
|
3195
|
-
"description": "
|
|
3199
|
+
"description": "Skip confirmation prompt.",
|
|
3196
3200
|
"name": "force",
|
|
3197
3201
|
"allowNo": false,
|
|
3198
3202
|
"type": "boolean"
|
|
3203
|
+
},
|
|
3204
|
+
"dry-run": {
|
|
3205
|
+
"description": "Preview what would happen without executing.",
|
|
3206
|
+
"name": "dry-run",
|
|
3207
|
+
"allowNo": false,
|
|
3208
|
+
"type": "boolean"
|
|
3199
3209
|
}
|
|
3200
3210
|
},
|
|
3201
3211
|
"hasDynamicHelp": false,
|
|
3202
3212
|
"hidden": false,
|
|
3203
|
-
"hiddenAliases": [
|
|
3204
|
-
|
|
3213
|
+
"hiddenAliases": [
|
|
3214
|
+
"account members delete"
|
|
3215
|
+
],
|
|
3216
|
+
"id": "members:delete",
|
|
3205
3217
|
"pluginAlias": "checkly",
|
|
3206
3218
|
"pluginName": "checkly",
|
|
3207
3219
|
"pluginType": "core",
|
|
@@ -3209,88 +3221,66 @@
|
|
|
3209
3221
|
"enableJsonFlag": false,
|
|
3210
3222
|
"coreCommand": false,
|
|
3211
3223
|
"readOnly": false,
|
|
3212
|
-
"destructive":
|
|
3224
|
+
"destructive": true,
|
|
3213
3225
|
"idempotent": true,
|
|
3214
3226
|
"isESM": true,
|
|
3215
3227
|
"relativePath": [
|
|
3216
3228
|
"dist",
|
|
3217
3229
|
"commands",
|
|
3218
|
-
"
|
|
3219
|
-
"
|
|
3230
|
+
"members",
|
|
3231
|
+
"delete.js"
|
|
3220
3232
|
]
|
|
3221
3233
|
},
|
|
3222
|
-
"
|
|
3234
|
+
"members:update": {
|
|
3223
3235
|
"aliases": [],
|
|
3224
|
-
"args": {
|
|
3225
|
-
|
|
3236
|
+
"args": {
|
|
3237
|
+
"member": {
|
|
3238
|
+
"description": "The account member email or user ID.",
|
|
3239
|
+
"name": "member",
|
|
3240
|
+
"required": true
|
|
3241
|
+
}
|
|
3242
|
+
},
|
|
3243
|
+
"description": "Update an account member role.",
|
|
3226
3244
|
"flags": {
|
|
3227
|
-
"
|
|
3228
|
-
"char": "
|
|
3229
|
-
"description": "
|
|
3230
|
-
"name": "
|
|
3231
|
-
"
|
|
3232
|
-
"multiple": false,
|
|
3233
|
-
"type": "option"
|
|
3234
|
-
},
|
|
3235
|
-
"plan-id": {
|
|
3236
|
-
"description": "Target a specific import plan by ID, skipping interactive plan selection.",
|
|
3237
|
-
"name": "plan-id",
|
|
3245
|
+
"role": {
|
|
3246
|
+
"char": "r",
|
|
3247
|
+
"description": "New member role: admin, read_write, read_run, read_only.",
|
|
3248
|
+
"name": "role",
|
|
3249
|
+
"required": true,
|
|
3238
3250
|
"hasDynamicHelp": false,
|
|
3239
3251
|
"multiple": false,
|
|
3240
3252
|
"type": "option"
|
|
3241
3253
|
},
|
|
3242
|
-
"
|
|
3243
|
-
"description": "
|
|
3244
|
-
"
|
|
3254
|
+
"email": {
|
|
3255
|
+
"description": "Treat the member argument as an email address.",
|
|
3256
|
+
"exclusive": [
|
|
3257
|
+
"id"
|
|
3258
|
+
],
|
|
3259
|
+
"name": "email",
|
|
3245
3260
|
"allowNo": false,
|
|
3246
3261
|
"type": "boolean"
|
|
3247
|
-
}
|
|
3248
|
-
},
|
|
3249
|
-
"hasDynamicHelp": false,
|
|
3250
|
-
"hidden": false,
|
|
3251
|
-
"hiddenAliases": [],
|
|
3252
|
-
"id": "import:apply",
|
|
3253
|
-
"pluginAlias": "checkly",
|
|
3254
|
-
"pluginName": "checkly",
|
|
3255
|
-
"pluginType": "core",
|
|
3256
|
-
"strict": true,
|
|
3257
|
-
"enableJsonFlag": false,
|
|
3258
|
-
"coreCommand": false,
|
|
3259
|
-
"readOnly": false,
|
|
3260
|
-
"destructive": false,
|
|
3261
|
-
"idempotent": false,
|
|
3262
|
-
"isESM": true,
|
|
3263
|
-
"relativePath": [
|
|
3264
|
-
"dist",
|
|
3265
|
-
"commands",
|
|
3266
|
-
"import",
|
|
3267
|
-
"apply.js"
|
|
3268
|
-
]
|
|
3269
|
-
},
|
|
3270
|
-
"import:cancel": {
|
|
3271
|
-
"aliases": [],
|
|
3272
|
-
"args": {},
|
|
3273
|
-
"description": "Cancels an ongoing import plan that has not been committed yet.",
|
|
3274
|
-
"flags": {
|
|
3275
|
-
"config": {
|
|
3276
|
-
"char": "c",
|
|
3277
|
-
"description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
|
|
3278
|
-
"name": "config",
|
|
3279
|
-
"hasDynamicHelp": false,
|
|
3280
|
-
"multiple": false,
|
|
3281
|
-
"type": "option"
|
|
3282
3262
|
},
|
|
3283
|
-
"
|
|
3284
|
-
"description": "
|
|
3285
|
-
"
|
|
3263
|
+
"id": {
|
|
3264
|
+
"description": "Treat the member argument as a user ID.",
|
|
3265
|
+
"exclusive": [
|
|
3266
|
+
"email"
|
|
3267
|
+
],
|
|
3268
|
+
"name": "id",
|
|
3286
3269
|
"allowNo": false,
|
|
3287
3270
|
"type": "boolean"
|
|
3288
3271
|
},
|
|
3289
|
-
"
|
|
3290
|
-
"
|
|
3291
|
-
"
|
|
3272
|
+
"output": {
|
|
3273
|
+
"char": "o",
|
|
3274
|
+
"description": "Output format.",
|
|
3275
|
+
"name": "output",
|
|
3276
|
+
"default": "table",
|
|
3292
3277
|
"hasDynamicHelp": false,
|
|
3293
3278
|
"multiple": false,
|
|
3279
|
+
"options": [
|
|
3280
|
+
"table",
|
|
3281
|
+
"json",
|
|
3282
|
+
"md"
|
|
3283
|
+
],
|
|
3294
3284
|
"type": "option"
|
|
3295
3285
|
},
|
|
3296
3286
|
"force": {
|
|
@@ -3309,8 +3299,10 @@
|
|
|
3309
3299
|
},
|
|
3310
3300
|
"hasDynamicHelp": false,
|
|
3311
3301
|
"hidden": false,
|
|
3312
|
-
"hiddenAliases": [
|
|
3313
|
-
|
|
3302
|
+
"hiddenAliases": [
|
|
3303
|
+
"account members update"
|
|
3304
|
+
],
|
|
3305
|
+
"id": "members:update",
|
|
3314
3306
|
"pluginAlias": "checkly",
|
|
3315
3307
|
"pluginName": "checkly",
|
|
3316
3308
|
"pluginType": "core",
|
|
@@ -3318,150 +3310,143 @@
|
|
|
3318
3310
|
"enableJsonFlag": false,
|
|
3319
3311
|
"coreCommand": false,
|
|
3320
3312
|
"readOnly": false,
|
|
3321
|
-
"destructive":
|
|
3313
|
+
"destructive": false,
|
|
3322
3314
|
"idempotent": true,
|
|
3323
3315
|
"isESM": true,
|
|
3324
3316
|
"relativePath": [
|
|
3325
3317
|
"dist",
|
|
3326
3318
|
"commands",
|
|
3327
|
-
"
|
|
3328
|
-
"
|
|
3319
|
+
"members",
|
|
3320
|
+
"update.js"
|
|
3329
3321
|
]
|
|
3330
3322
|
},
|
|
3331
|
-
"
|
|
3323
|
+
"rca:get": {
|
|
3332
3324
|
"aliases": [],
|
|
3333
|
-
"args": {
|
|
3334
|
-
|
|
3325
|
+
"args": {
|
|
3326
|
+
"id": {
|
|
3327
|
+
"description": "The RCA ID to retrieve.",
|
|
3328
|
+
"name": "id",
|
|
3329
|
+
"required": true
|
|
3330
|
+
}
|
|
3331
|
+
},
|
|
3332
|
+
"description": "Retrieve a root cause analysis by ID.",
|
|
3335
3333
|
"flags": {
|
|
3336
|
-
"
|
|
3337
|
-
"char": "
|
|
3338
|
-
"description": "
|
|
3339
|
-
"name": "
|
|
3340
|
-
"
|
|
3341
|
-
"
|
|
3342
|
-
"type": "option"
|
|
3334
|
+
"watch": {
|
|
3335
|
+
"char": "w",
|
|
3336
|
+
"description": "Wait for the analysis to complete if still generating.",
|
|
3337
|
+
"name": "watch",
|
|
3338
|
+
"allowNo": false,
|
|
3339
|
+
"type": "boolean"
|
|
3343
3340
|
},
|
|
3344
|
-
"
|
|
3345
|
-
"
|
|
3346
|
-
"
|
|
3341
|
+
"output": {
|
|
3342
|
+
"char": "o",
|
|
3343
|
+
"description": "Output format.",
|
|
3344
|
+
"name": "output",
|
|
3345
|
+
"default": "detail",
|
|
3347
3346
|
"hasDynamicHelp": false,
|
|
3348
3347
|
"multiple": false,
|
|
3348
|
+
"options": [
|
|
3349
|
+
"detail",
|
|
3350
|
+
"json",
|
|
3351
|
+
"md"
|
|
3352
|
+
],
|
|
3349
3353
|
"type": "option"
|
|
3350
|
-
},
|
|
3351
|
-
"force": {
|
|
3352
|
-
"char": "f",
|
|
3353
|
-
"description": "Skip confirmation prompt.",
|
|
3354
|
-
"name": "force",
|
|
3355
|
-
"allowNo": false,
|
|
3356
|
-
"type": "boolean"
|
|
3357
|
-
},
|
|
3358
|
-
"dry-run": {
|
|
3359
|
-
"description": "Preview what would happen without executing.",
|
|
3360
|
-
"name": "dry-run",
|
|
3361
|
-
"allowNo": false,
|
|
3362
|
-
"type": "boolean"
|
|
3363
3354
|
}
|
|
3364
3355
|
},
|
|
3365
3356
|
"hasDynamicHelp": false,
|
|
3366
3357
|
"hidden": false,
|
|
3367
3358
|
"hiddenAliases": [],
|
|
3368
|
-
"id": "
|
|
3359
|
+
"id": "rca:get",
|
|
3369
3360
|
"pluginAlias": "checkly",
|
|
3370
3361
|
"pluginName": "checkly",
|
|
3371
3362
|
"pluginType": "core",
|
|
3372
3363
|
"strict": true,
|
|
3373
3364
|
"enableJsonFlag": false,
|
|
3374
3365
|
"coreCommand": false,
|
|
3375
|
-
"readOnly":
|
|
3366
|
+
"readOnly": true,
|
|
3376
3367
|
"destructive": false,
|
|
3377
|
-
"idempotent":
|
|
3368
|
+
"idempotent": true,
|
|
3378
3369
|
"isESM": true,
|
|
3379
3370
|
"relativePath": [
|
|
3380
3371
|
"dist",
|
|
3381
3372
|
"commands",
|
|
3382
|
-
"
|
|
3383
|
-
"
|
|
3373
|
+
"rca",
|
|
3374
|
+
"get.js"
|
|
3384
3375
|
]
|
|
3385
3376
|
},
|
|
3386
|
-
"
|
|
3377
|
+
"rca:run": {
|
|
3387
3378
|
"aliases": [],
|
|
3388
|
-
"args": {
|
|
3389
|
-
|
|
3390
|
-
"description": "A specific resource to import.",
|
|
3391
|
-
"name": "resource",
|
|
3392
|
-
"required": false
|
|
3393
|
-
}
|
|
3394
|
-
},
|
|
3395
|
-
"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.",
|
|
3379
|
+
"args": {},
|
|
3380
|
+
"description": "Trigger a root cause analysis for a check or test session error group.",
|
|
3396
3381
|
"flags": {
|
|
3397
|
-
"
|
|
3398
|
-
"char": "
|
|
3399
|
-
"description": "The
|
|
3400
|
-
"
|
|
3382
|
+
"error-group": {
|
|
3383
|
+
"char": "e",
|
|
3384
|
+
"description": "The error group ID to analyze.",
|
|
3385
|
+
"exclusive": [
|
|
3386
|
+
"test-session-error-group"
|
|
3387
|
+
],
|
|
3388
|
+
"name": "error-group",
|
|
3401
3389
|
"hasDynamicHelp": false,
|
|
3402
3390
|
"multiple": false,
|
|
3403
3391
|
"type": "option"
|
|
3404
3392
|
},
|
|
3405
|
-
"
|
|
3406
|
-
"description": "The
|
|
3407
|
-
"
|
|
3408
|
-
"
|
|
3393
|
+
"test-session-error-group": {
|
|
3394
|
+
"description": "The test session error group ID to analyze.",
|
|
3395
|
+
"helpLabel": "-te, --test-session-error-group",
|
|
3396
|
+
"name": "test-session-error-group",
|
|
3409
3397
|
"hasDynamicHelp": false,
|
|
3410
3398
|
"multiple": false,
|
|
3411
3399
|
"type": "option"
|
|
3412
3400
|
},
|
|
3413
|
-
"
|
|
3414
|
-
"description": "
|
|
3415
|
-
"name": "
|
|
3416
|
-
"allowNo": false,
|
|
3417
|
-
"type": "boolean"
|
|
3418
|
-
},
|
|
3419
|
-
"debug-import-plan": {
|
|
3420
|
-
"description": "Output the import plan to a file.",
|
|
3421
|
-
"hidden": true,
|
|
3422
|
-
"name": "debug-import-plan",
|
|
3423
|
-
"allowNo": false,
|
|
3424
|
-
"type": "boolean"
|
|
3425
|
-
},
|
|
3426
|
-
"debug-import-plan-input-file": {
|
|
3427
|
-
"description": "A file to load an import plan from.",
|
|
3428
|
-
"hidden": true,
|
|
3429
|
-
"name": "debug-import-plan-input-file",
|
|
3401
|
+
"user-context": {
|
|
3402
|
+
"description": "Extra context to pass into the root cause analysis.",
|
|
3403
|
+
"name": "user-context",
|
|
3430
3404
|
"hasDynamicHelp": false,
|
|
3431
3405
|
"multiple": false,
|
|
3432
3406
|
"type": "option"
|
|
3433
3407
|
},
|
|
3434
|
-
"
|
|
3435
|
-
"
|
|
3436
|
-
"
|
|
3437
|
-
"name": "
|
|
3438
|
-
"
|
|
3408
|
+
"watch": {
|
|
3409
|
+
"char": "w",
|
|
3410
|
+
"description": "Wait for the analysis to complete and display the result.",
|
|
3411
|
+
"name": "watch",
|
|
3412
|
+
"allowNo": false,
|
|
3413
|
+
"type": "boolean"
|
|
3414
|
+
},
|
|
3415
|
+
"output": {
|
|
3416
|
+
"char": "o",
|
|
3417
|
+
"description": "Output format.",
|
|
3418
|
+
"name": "output",
|
|
3419
|
+
"default": "detail",
|
|
3439
3420
|
"hasDynamicHelp": false,
|
|
3440
3421
|
"multiple": false,
|
|
3422
|
+
"options": [
|
|
3423
|
+
"detail",
|
|
3424
|
+
"json",
|
|
3425
|
+
"md"
|
|
3426
|
+
],
|
|
3441
3427
|
"type": "option"
|
|
3442
3428
|
}
|
|
3443
3429
|
},
|
|
3444
3430
|
"hasDynamicHelp": false,
|
|
3445
3431
|
"hidden": false,
|
|
3446
|
-
"hiddenAliases": [
|
|
3447
|
-
|
|
3448
|
-
],
|
|
3449
|
-
"id": "import:plan",
|
|
3432
|
+
"hiddenAliases": [],
|
|
3433
|
+
"id": "rca:run",
|
|
3450
3434
|
"pluginAlias": "checkly",
|
|
3451
3435
|
"pluginName": "checkly",
|
|
3452
3436
|
"pluginType": "core",
|
|
3453
|
-
"strict":
|
|
3437
|
+
"strict": true,
|
|
3438
|
+
"usage": "rca run [-e <value> | -te <value>] [--user-context <text>] [-w] [-o detail|json|md]",
|
|
3454
3439
|
"enableJsonFlag": false,
|
|
3455
3440
|
"coreCommand": false,
|
|
3456
|
-
"readOnly":
|
|
3441
|
+
"readOnly": false,
|
|
3457
3442
|
"destructive": false,
|
|
3458
|
-
"idempotent":
|
|
3443
|
+
"idempotent": false,
|
|
3459
3444
|
"isESM": true,
|
|
3460
3445
|
"relativePath": [
|
|
3461
3446
|
"dist",
|
|
3462
3447
|
"commands",
|
|
3463
|
-
"
|
|
3464
|
-
"
|
|
3448
|
+
"rca",
|
|
3449
|
+
"run.js"
|
|
3465
3450
|
]
|
|
3466
3451
|
},
|
|
3467
3452
|
"status-pages:get": {
|
|
@@ -3574,6 +3559,105 @@
|
|
|
3574
3559
|
"list.js"
|
|
3575
3560
|
]
|
|
3576
3561
|
},
|
|
3562
|
+
"skills": {
|
|
3563
|
+
"aliases": [],
|
|
3564
|
+
"args": {
|
|
3565
|
+
"action": {
|
|
3566
|
+
"description": "Action to open. Available actions are listed below.",
|
|
3567
|
+
"name": "action",
|
|
3568
|
+
"required": false
|
|
3569
|
+
},
|
|
3570
|
+
"reference": {
|
|
3571
|
+
"description": "Reference to open for the selected action. Available references are listed below.",
|
|
3572
|
+
"name": "reference",
|
|
3573
|
+
"required": false
|
|
3574
|
+
}
|
|
3575
|
+
},
|
|
3576
|
+
"description": "Show Checkly AI skills, actions and their references.\n\nRun `checkly skills` to print the full catalog, `checkly skills <action>` for an action guide, or `checkly skills <action> <reference>` for a specific reference.\n\nAvailable actions and references:\n checkly skills\n |- initialize\n |- configure\n | |- agentic-checks\n | |- api-checks\n | |- browser-checks\n | |- playwright-checks\n | |- multistep-checks\n | |- tcp-monitors\n | |- url-monitors\n | |- dns-monitors\n | |- icmp-monitors\n | |- grpc-monitors\n | |- ssl-monitors\n | |- traceroute-monitors\n | |- heartbeat-monitors\n | |- check-groups\n | |- alert-channels\n | |- supporting-constructs\n | |- environment\n |- investigate\n | |- checks\n | |- alerting\n | |- test-sessions\n |- communicate\n | |- incidents\n |- manage\n | |- plan\n | |- account-members\n\nUse `checkly skills <action>` or `checkly skills <action> <reference>` to open the detailed guidance.",
|
|
3577
|
+
"examples": [
|
|
3578
|
+
"checkly skills",
|
|
3579
|
+
"checkly skills configure",
|
|
3580
|
+
"checkly skills configure api-checks",
|
|
3581
|
+
"checkly skills investigate alerting"
|
|
3582
|
+
],
|
|
3583
|
+
"flags": {},
|
|
3584
|
+
"hasDynamicHelp": false,
|
|
3585
|
+
"hidden": false,
|
|
3586
|
+
"hiddenAliases": [],
|
|
3587
|
+
"id": "skills",
|
|
3588
|
+
"pluginAlias": "checkly",
|
|
3589
|
+
"pluginName": "checkly",
|
|
3590
|
+
"pluginType": "core",
|
|
3591
|
+
"strict": true,
|
|
3592
|
+
"enableJsonFlag": false,
|
|
3593
|
+
"coreCommand": false,
|
|
3594
|
+
"readOnly": true,
|
|
3595
|
+
"destructive": false,
|
|
3596
|
+
"idempotent": true,
|
|
3597
|
+
"isESM": true,
|
|
3598
|
+
"relativePath": [
|
|
3599
|
+
"dist",
|
|
3600
|
+
"commands",
|
|
3601
|
+
"skills",
|
|
3602
|
+
"index.js"
|
|
3603
|
+
]
|
|
3604
|
+
},
|
|
3605
|
+
"skills:install": {
|
|
3606
|
+
"aliases": [],
|
|
3607
|
+
"args": {},
|
|
3608
|
+
"description": "Install the Checkly agent skill (SKILL.md) into your project.",
|
|
3609
|
+
"flags": {
|
|
3610
|
+
"target": {
|
|
3611
|
+
"char": "t",
|
|
3612
|
+
"description": "Platform to install the skill for (amp, claude, cline, codex, continue, cursor, gemini-cli, github-copilot, goose, opencode, roo, windsurf).",
|
|
3613
|
+
"exclusive": [
|
|
3614
|
+
"path"
|
|
3615
|
+
],
|
|
3616
|
+
"name": "target",
|
|
3617
|
+
"hasDynamicHelp": false,
|
|
3618
|
+
"multiple": false,
|
|
3619
|
+
"type": "option"
|
|
3620
|
+
},
|
|
3621
|
+
"path": {
|
|
3622
|
+
"char": "p",
|
|
3623
|
+
"description": "Custom target directory to install the skill into.",
|
|
3624
|
+
"exclusive": [
|
|
3625
|
+
"target"
|
|
3626
|
+
],
|
|
3627
|
+
"name": "path",
|
|
3628
|
+
"hasDynamicHelp": false,
|
|
3629
|
+
"multiple": false,
|
|
3630
|
+
"type": "option"
|
|
3631
|
+
},
|
|
3632
|
+
"force": {
|
|
3633
|
+
"char": "f",
|
|
3634
|
+
"description": "Overwrite existing SKILL.md without confirmation.",
|
|
3635
|
+
"name": "force",
|
|
3636
|
+
"allowNo": false,
|
|
3637
|
+
"type": "boolean"
|
|
3638
|
+
}
|
|
3639
|
+
},
|
|
3640
|
+
"hasDynamicHelp": false,
|
|
3641
|
+
"hidden": false,
|
|
3642
|
+
"hiddenAliases": [],
|
|
3643
|
+
"id": "skills:install",
|
|
3644
|
+
"pluginAlias": "checkly",
|
|
3645
|
+
"pluginName": "checkly",
|
|
3646
|
+
"pluginType": "core",
|
|
3647
|
+
"strict": true,
|
|
3648
|
+
"enableJsonFlag": false,
|
|
3649
|
+
"coreCommand": false,
|
|
3650
|
+
"readOnly": false,
|
|
3651
|
+
"destructive": false,
|
|
3652
|
+
"idempotent": true,
|
|
3653
|
+
"isESM": true,
|
|
3654
|
+
"relativePath": [
|
|
3655
|
+
"dist",
|
|
3656
|
+
"commands",
|
|
3657
|
+
"skills",
|
|
3658
|
+
"install.js"
|
|
3659
|
+
]
|
|
3660
|
+
},
|
|
3577
3661
|
"test-sessions:get": {
|
|
3578
3662
|
"aliases": [],
|
|
3579
3663
|
"args": {
|
|
@@ -3782,5 +3866,5 @@
|
|
|
3782
3866
|
]
|
|
3783
3867
|
}
|
|
3784
3868
|
},
|
|
3785
|
-
"version": "8.
|
|
3869
|
+
"version": "8.18.0"
|
|
3786
3870
|
}
|