checkly 7.7.0-prerelease-a0c39b4 → 7.7.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/checkly.rules.md +12 -0
- package/dist/ai-context/context.d.ts +11 -0
- package/dist/ai-context/context.js +12 -1
- package/dist/ai-context/context.js.map +1 -1
- package/dist/ai-context/public-skills/checkly/SKILL.md +12 -0
- package/dist/ai-context/skills-command/references/communicate-incidents.md +5 -1
- package/dist/ai-context/skills-command/references/configure.md +12 -0
- package/dist/ai-context/skills-command/references/initialize.md +22 -4
- package/dist/ai-context/skills-command/references/investigate-checks.md +22 -0
- package/dist/ai-context/skills-command/references/manage-plan.md +49 -0
- package/dist/ai-context/skills-command/references/manage.md +27 -0
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/oclif.manifest.json +193 -193
- package/package.json +1 -1
|
@@ -115,6 +115,18 @@ Email (`EmailAlertChannel`), Phone (`PhoneCallAlertChannel`), and Slack (`SlackA
|
|
|
115
115
|
### `npx checkly skills configure supporting-constructs`
|
|
116
116
|
Status pages (`StatusPage`), dashboards (`Dashboard`), maintenance windows (`MaintenanceWindow`), and private locations (`PrivateLocation`)
|
|
117
117
|
|
|
118
|
+
## Check Locations and Plan Entitlements
|
|
119
|
+
|
|
120
|
+
Not all features and locations are available on all plans. **Before configuring checks, run:**
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
npx checkly account plan --output json
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
This returns your exact entitlements and available locations. Use only locations where `available` is `true` in the `locations.all` array. If a feature is disabled, the response includes an `upgradeUrl` to share with the user.
|
|
127
|
+
|
|
128
|
+
Run `npx checkly skills manage plan` for the full reference.
|
|
129
|
+
|
|
118
130
|
## Testing and Debugging
|
|
119
131
|
|
|
120
132
|
- Test checks using the `npx checkly test` command. Pass environment variables with the `-e` flag, use `--record` to persist results, and use `--verbose` to see all errors.
|
|
@@ -43,6 +43,10 @@ export declare const COMMUNICATE_REFERENCES: readonly [{
|
|
|
43
43
|
readonly id: "communicate-incidents";
|
|
44
44
|
readonly description: "Incident lifecycle (`incidents create`, `update`, `resolve`, `list`) and status pages";
|
|
45
45
|
}];
|
|
46
|
+
export declare const MANAGE_REFERENCES: readonly [{
|
|
47
|
+
readonly id: "manage-plan";
|
|
48
|
+
readonly description: "Check account plan, entitlements, feature limits, and available locations (`account plan`)";
|
|
49
|
+
}];
|
|
46
50
|
export declare const SKILL: {
|
|
47
51
|
readonly name: "checkly";
|
|
48
52
|
readonly description: "Get all the information and context to let your agent initialize, set up, create, test and manage your monitoring checks using the Checkly CLI.";
|
|
@@ -104,6 +108,13 @@ export declare const ACTIONS: readonly [{
|
|
|
104
108
|
readonly id: "communicate-incidents";
|
|
105
109
|
readonly description: "Incident lifecycle (`incidents create`, `update`, `resolve`, `list`) and status pages";
|
|
106
110
|
}];
|
|
111
|
+
}, {
|
|
112
|
+
readonly id: "manage";
|
|
113
|
+
readonly description: "Understand your account plan, entitlements, and feature limits.";
|
|
114
|
+
readonly references: readonly [{
|
|
115
|
+
readonly id: "manage-plan";
|
|
116
|
+
readonly description: "Check account plan, entitlements, feature limits, and available locations (`account plan`)";
|
|
117
|
+
}];
|
|
107
118
|
}];
|
|
108
119
|
interface ExampleConfig {
|
|
109
120
|
templateString: string;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.EXAMPLE_CONFIGS = exports.ACTIONS = exports.SKILL = exports.COMMUNICATE_REFERENCES = exports.INVESTIGATE_REFERENCES = exports.REFERENCES = void 0;
|
|
3
|
+
exports.EXAMPLE_CONFIGS = exports.ACTIONS = exports.SKILL = exports.MANAGE_REFERENCES = exports.COMMUNICATE_REFERENCES = exports.INVESTIGATE_REFERENCES = exports.REFERENCES = void 0;
|
|
4
4
|
exports.REFERENCES = [
|
|
5
5
|
{
|
|
6
6
|
id: 'configure-api-checks',
|
|
@@ -63,6 +63,12 @@ exports.COMMUNICATE_REFERENCES = [
|
|
|
63
63
|
description: 'Incident lifecycle (`incidents create`, `update`, `resolve`, `list`) and status pages',
|
|
64
64
|
},
|
|
65
65
|
];
|
|
66
|
+
exports.MANAGE_REFERENCES = [
|
|
67
|
+
{
|
|
68
|
+
id: 'manage-plan',
|
|
69
|
+
description: 'Check account plan, entitlements, feature limits, and available locations (`account plan`)',
|
|
70
|
+
},
|
|
71
|
+
];
|
|
66
72
|
exports.SKILL = {
|
|
67
73
|
name: 'checkly',
|
|
68
74
|
description: 'Get all the information and context to let your agent initialize, set up, create, test and manage your monitoring checks using the Checkly CLI.',
|
|
@@ -87,6 +93,11 @@ exports.ACTIONS = [
|
|
|
87
93
|
description: 'Open incidents and lead customer communications via status pages.',
|
|
88
94
|
references: exports.COMMUNICATE_REFERENCES,
|
|
89
95
|
},
|
|
96
|
+
{
|
|
97
|
+
id: 'manage',
|
|
98
|
+
description: 'Understand your account plan, entitlements, and feature limits.',
|
|
99
|
+
references: exports.MANAGE_REFERENCES,
|
|
100
|
+
},
|
|
90
101
|
];
|
|
91
102
|
exports.EXAMPLE_CONFIGS = {
|
|
92
103
|
CHECKLY_CONFIG: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/ai-context/context.ts"],"names":[],"mappings":";;;AAAa,QAAA,UAAU,GAAG;IACxB;QACE,EAAE,EAAE,sBAAsB;QAC1B,WAAW,EAAE,gFAAgF;KAC9F;IACD;QACE,EAAE,EAAE,0BAA0B;QAC9B,WAAW,EAAE,qEAAqE;KACnF;IACD;QACE,EAAE,EAAE,6BAA6B;QACjC,WAAW,EAAE,oFAAoF;KAClG;IACD;QACE,EAAE,EAAE,4BAA4B;QAChC,WAAW,EAAE,qEAAqE;KACnF;IACD;QACE,EAAE,EAAE,wBAAwB;QAC5B,WAAW,EAAE,sDAAsD;KACpE;IACD;QACE,EAAE,EAAE,wBAAwB;QAC5B,WAAW,EAAE,sDAAsD;KACpE;IACD;QACE,EAAE,EAAE,wBAAwB;QAC5B,WAAW,EAAE,sDAAsD;KACpE;IACD;QACE,EAAE,EAAE,yBAAyB;QAC7B,WAAW,EAAE,gFAAgF;KAC9F;IACD;QACE,EAAE,EAAE,8BAA8B;QAClC,WAAW,EAAE,kDAAkD;KAChE;IACD;QACE,EAAE,EAAE,wBAAwB;QAC5B,WAAW,EAAE,+DAA+D;KAC7E;IACD;QACE,EAAE,EAAE,0BAA0B;QAC9B,WAAW,EAAE,8GAA8G;KAC5H;IACD;QACE,EAAE,EAAE,iCAAiC;QACrC,WAAW,EAAE,6IAA6I;KAC3J;CACO,CAAA;AAEG,QAAA,sBAAsB,GAAG;IACpC;QACE,EAAE,EAAE,oBAAoB;QACxB,WAAW,EAAE,+EAA+E;KAC7F;CACO,CAAA;AAEG,QAAA,sBAAsB,GAAG;IACpC;QACE,EAAE,EAAE,uBAAuB;QAC3B,WAAW,EAAE,uFAAuF;KACrG;CACO,CAAA;AAEG,QAAA,KAAK,GAAG;IACnB,IAAI,EAAE,SAAS;IACf,WAAW,EAAE,iJAAiJ;CACtJ,CAAA;AAEG,QAAA,OAAO,GAAG;IACrB;QACE,EAAE,EAAE,YAAY;QAChB,WAAW,EAAE,4EAA4E;KAC1F;IACD;QACE,EAAE,EAAE,WAAW;QACf,WAAW,EAAE,wFAAwF;QACrG,UAAU,EAAE,kBAAU;KACvB;IACD;QACE,EAAE,EAAE,aAAa;QACjB,WAAW,EAAE,gEAAgE;QAC7E,UAAU,EAAE,8BAAsB;KACnC;IACD;QACE,EAAE,EAAE,aAAa;QACjB,WAAW,EAAE,mEAAmE;QAChF,UAAU,EAAE,8BAAsB;KACnC;CACO,CAAA;AASG,QAAA,eAAe,GAAkC;IAC5D,cAAc,EAAE;QACd,cAAc,EAAE,kCAAkC;QAClD,aAAa,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgClB;QACG,SAAS,EAAE,oDAAoD;KAChE;IACD,aAAa,EAAE;QACb,cAAc,EAAE,iCAAiC;QACjD,iBAAiB,EACf,+EAA+E;QACjF,SAAS,EAAE,0DAA0D;KACtE;IACD,gBAAgB,EAAE;QAChB,cAAc,EAAE,oCAAoC;QACpD,aAAa,EAAE;;;;;;;;;CASlB;QACG,SAAS,EAAE,6DAA6D;KACzE;IACD,SAAS,EAAE;QACT,cAAc,EAAE,6BAA6B;QAC7C,iBAAiB,EACf,mEAAmE;QACrE,SAAS,EAAE,sDAAsD;KAClE;IACD,eAAe,EAAE;QACf,cAAc,EAAE,mCAAmC;QACnD,iBAAiB,EACf,sFAAsF;QACxF,SAAS,EAAE,4DAA4D;KACxE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,iBAAiB,EAAE;QACjB,cAAc,EAAE,qCAAqC;QACrD,iBAAiB,EACf,iEAAiE;QACnE,SAAS,EAAE,8DAA8D;KAC1E;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,YAAY,EAAE;QACZ,cAAc,EAAE,gCAAgC;QAChD,iBAAiB,EAAE,uDAAuD;QAC1E,SAAS,EAAE,yDAAyD;KACrE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EACf,4DAA4D;QAC9D,SAAS,EAAE,wDAAwD;KACpE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,mBAAmB,EAAE;QACnB,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EACf,0DAA0D;QAC5D,SAAS,EAAE,gEAAgE;KAC5E;IACD,SAAS,EAAE;QACT,cAAc,EAAE,6BAA6B;QAC7C,iBAAiB,EACf,mEAAmE;QACrE,SAAS,EAAE,sDAAsD;KAClE;IACD,kBAAkB,EAAE;QAClB,cAAc,EAAE,sCAAsC;QACtD,iBAAiB,EACf,mEAAmE;QACrE,SAAS,EAAE,+DAA+D;KAC3E;IACD,gBAAgB,EAAE;QAChB,cAAc,EAAE,oCAAoC;QACpD,iBAAiB,EACf,+DAA+D;QACjE,SAAS,EAAE,6DAA6D;KACzE;IACD,mBAAmB,EAAE;QACnB,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EAAE,8CAA8C;QACjE,SAAS,EAAE,gEAAgE;KAC5E;IACD,wBAAwB,EAAE;QACxB,cAAc,EAAE,4CAA4C;QAC5D,iBAAiB,EAAE,wDAAwD;QAC3E,SAAS,EAAE,qEAAqE;KACjF;IACD,mBAAmB,EAAE;QACnB,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EAAE,iDAAiD;QACpE,SAAS,EAAE,gEAAgE;KAC5E;CACF,CAAA"}
|
|
1
|
+
{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/ai-context/context.ts"],"names":[],"mappings":";;;AAAa,QAAA,UAAU,GAAG;IACxB;QACE,EAAE,EAAE,sBAAsB;QAC1B,WAAW,EAAE,gFAAgF;KAC9F;IACD;QACE,EAAE,EAAE,0BAA0B;QAC9B,WAAW,EAAE,qEAAqE;KACnF;IACD;QACE,EAAE,EAAE,6BAA6B;QACjC,WAAW,EAAE,oFAAoF;KAClG;IACD;QACE,EAAE,EAAE,4BAA4B;QAChC,WAAW,EAAE,qEAAqE;KACnF;IACD;QACE,EAAE,EAAE,wBAAwB;QAC5B,WAAW,EAAE,sDAAsD;KACpE;IACD;QACE,EAAE,EAAE,wBAAwB;QAC5B,WAAW,EAAE,sDAAsD;KACpE;IACD;QACE,EAAE,EAAE,wBAAwB;QAC5B,WAAW,EAAE,sDAAsD;KACpE;IACD;QACE,EAAE,EAAE,yBAAyB;QAC7B,WAAW,EAAE,gFAAgF;KAC9F;IACD;QACE,EAAE,EAAE,8BAA8B;QAClC,WAAW,EAAE,kDAAkD;KAChE;IACD;QACE,EAAE,EAAE,wBAAwB;QAC5B,WAAW,EAAE,+DAA+D;KAC7E;IACD;QACE,EAAE,EAAE,0BAA0B;QAC9B,WAAW,EAAE,8GAA8G;KAC5H;IACD;QACE,EAAE,EAAE,iCAAiC;QACrC,WAAW,EAAE,6IAA6I;KAC3J;CACO,CAAA;AAEG,QAAA,sBAAsB,GAAG;IACpC;QACE,EAAE,EAAE,oBAAoB;QACxB,WAAW,EAAE,+EAA+E;KAC7F;CACO,CAAA;AAEG,QAAA,sBAAsB,GAAG;IACpC;QACE,EAAE,EAAE,uBAAuB;QAC3B,WAAW,EAAE,uFAAuF;KACrG;CACO,CAAA;AAEG,QAAA,iBAAiB,GAAG;IAC/B;QACE,EAAE,EAAE,aAAa;QACjB,WAAW,EAAE,4FAA4F;KAC1G;CACO,CAAA;AAEG,QAAA,KAAK,GAAG;IACnB,IAAI,EAAE,SAAS;IACf,WAAW,EAAE,iJAAiJ;CACtJ,CAAA;AAEG,QAAA,OAAO,GAAG;IACrB;QACE,EAAE,EAAE,YAAY;QAChB,WAAW,EAAE,4EAA4E;KAC1F;IACD;QACE,EAAE,EAAE,WAAW;QACf,WAAW,EAAE,wFAAwF;QACrG,UAAU,EAAE,kBAAU;KACvB;IACD;QACE,EAAE,EAAE,aAAa;QACjB,WAAW,EAAE,gEAAgE;QAC7E,UAAU,EAAE,8BAAsB;KACnC;IACD;QACE,EAAE,EAAE,aAAa;QACjB,WAAW,EAAE,mEAAmE;QAChF,UAAU,EAAE,8BAAsB;KACnC;IACD;QACE,EAAE,EAAE,QAAQ;QACZ,WAAW,EAAE,iEAAiE;QAC9E,UAAU,EAAE,yBAAiB;KAC9B;CACO,CAAA;AASG,QAAA,eAAe,GAAkC;IAC5D,cAAc,EAAE;QACd,cAAc,EAAE,kCAAkC;QAClD,aAAa,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgClB;QACG,SAAS,EAAE,oDAAoD;KAChE;IACD,aAAa,EAAE;QACb,cAAc,EAAE,iCAAiC;QACjD,iBAAiB,EACf,+EAA+E;QACjF,SAAS,EAAE,0DAA0D;KACtE;IACD,gBAAgB,EAAE;QAChB,cAAc,EAAE,oCAAoC;QACpD,aAAa,EAAE;;;;;;;;;CASlB;QACG,SAAS,EAAE,6DAA6D;KACzE;IACD,SAAS,EAAE;QACT,cAAc,EAAE,6BAA6B;QAC7C,iBAAiB,EACf,mEAAmE;QACrE,SAAS,EAAE,sDAAsD;KAClE;IACD,eAAe,EAAE;QACf,cAAc,EAAE,mCAAmC;QACnD,iBAAiB,EACf,sFAAsF;QACxF,SAAS,EAAE,4DAA4D;KACxE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,iBAAiB,EAAE;QACjB,cAAc,EAAE,qCAAqC;QACrD,iBAAiB,EACf,iEAAiE;QACnE,SAAS,EAAE,8DAA8D;KAC1E;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,YAAY,EAAE;QACZ,cAAc,EAAE,gCAAgC;QAChD,iBAAiB,EAAE,uDAAuD;QAC1E,SAAS,EAAE,yDAAyD;KACrE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EACf,4DAA4D;QAC9D,SAAS,EAAE,wDAAwD;KACpE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,mBAAmB,EAAE;QACnB,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EACf,0DAA0D;QAC5D,SAAS,EAAE,gEAAgE;KAC5E;IACD,SAAS,EAAE;QACT,cAAc,EAAE,6BAA6B;QAC7C,iBAAiB,EACf,mEAAmE;QACrE,SAAS,EAAE,sDAAsD;KAClE;IACD,kBAAkB,EAAE;QAClB,cAAc,EAAE,sCAAsC;QACtD,iBAAiB,EACf,mEAAmE;QACrE,SAAS,EAAE,+DAA+D;KAC3E;IACD,gBAAgB,EAAE;QAChB,cAAc,EAAE,oCAAoC;QACpD,iBAAiB,EACf,+DAA+D;QACjE,SAAS,EAAE,6DAA6D;KACzE;IACD,mBAAmB,EAAE;QACnB,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EAAE,8CAA8C;QACjE,SAAS,EAAE,gEAAgE;KAC5E;IACD,wBAAwB,EAAE;QACxB,cAAc,EAAE,4CAA4C;QAC5D,iBAAiB,EAAE,wDAAwD;QAC3E,SAAS,EAAE,qEAAqE;KACjF;IACD,mBAAmB,EAAE;QACnB,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EAAE,iDAAiD;QACpE,SAAS,EAAE,gEAAgE;KAC5E;CACF,CAAA"}
|
|
@@ -24,6 +24,12 @@ The skill is structured for efficient context usage:
|
|
|
24
24
|
|
|
25
25
|
Agents load what they need for each task.
|
|
26
26
|
|
|
27
|
+
## Plan Awareness
|
|
28
|
+
|
|
29
|
+
Before configuring checks, run `npx checkly account plan --output json` to see what features, locations, and limits are available on the current plan. Disabled features include an `upgradeUrl` pointing to the self-service checkout page or the enterprise contact sales page — share these with the user when they need a feature that's not on their plan.
|
|
30
|
+
|
|
31
|
+
Run `npx checkly skills manage` for the full reference.
|
|
32
|
+
|
|
27
33
|
## Confirmation Protocol
|
|
28
34
|
|
|
29
35
|
Write commands (e.g. `incidents create`, `deploy`, `destroy`) return exit code 2 with a `confirmation_required` JSON envelope instead of executing. **Always present the `changes` to the user and wait for approval before running the `confirmCommand`.** Never auto-append `--force`. This applies to every write command individually — updates and resolutions need confirmation too, not just the initial create.
|
|
@@ -83,3 +89,9 @@ Open incidents and lead customer communications via status pages.
|
|
|
83
89
|
|
|
84
90
|
#### `npx checkly skills communicate incidents`
|
|
85
91
|
Incident lifecycle (`incidents create`, `update`, `resolve`, `list`) and status pages
|
|
92
|
+
|
|
93
|
+
### `npx checkly skills manage`
|
|
94
|
+
Understand your account plan, entitlements, and feature limits.
|
|
95
|
+
|
|
96
|
+
#### `npx checkly skills manage plan`
|
|
97
|
+
Check account plan, entitlements, feature limits, and available locations (`account plan`)
|
|
@@ -67,9 +67,13 @@ Flags:
|
|
|
67
67
|
|
|
68
68
|
## Status pages
|
|
69
69
|
|
|
70
|
-
Use `npx checkly status-pages list` to find status page IDs and
|
|
70
|
+
Use `npx checkly status-pages list` to find status page IDs, and `npx checkly status-pages get` for full details including cards and services.
|
|
71
71
|
|
|
72
72
|
```bash
|
|
73
73
|
npx checkly status-pages list
|
|
74
74
|
npx checkly status-pages list --output json
|
|
75
|
+
npx checkly status-pages get <status-page-id>
|
|
76
|
+
npx checkly status-pages get <status-page-id> --output json
|
|
75
77
|
```
|
|
78
|
+
|
|
79
|
+
Use `--output json` to get machine-readable service IDs for incident creation.
|
|
@@ -115,6 +115,18 @@ Email (`EmailAlertChannel`), Phone (`PhoneCallAlertChannel`), and Slack (`SlackA
|
|
|
115
115
|
### `npx checkly skills configure supporting-constructs`
|
|
116
116
|
Status pages (`StatusPage`), dashboards (`Dashboard`), maintenance windows (`MaintenanceWindow`), and private locations (`PrivateLocation`)
|
|
117
117
|
|
|
118
|
+
## Check Locations and Plan Entitlements
|
|
119
|
+
|
|
120
|
+
Not all features and locations are available on all plans. **Before configuring checks, run:**
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
npx checkly account plan --output json
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
This returns your exact entitlements and available locations. Use only locations where `available` is `true` in the `locations.all` array. If a feature is disabled, the response includes an `upgradeUrl` to share with the user.
|
|
127
|
+
|
|
128
|
+
Run `npx checkly skills manage plan` for the full reference.
|
|
129
|
+
|
|
118
130
|
## Testing and Debugging
|
|
119
131
|
|
|
120
132
|
- Test checks using the `npx checkly test` command. Pass environment variables with the `-e` flag, use `--record` to persist results, and use `--verbose` to see all errors.
|
|
@@ -70,7 +70,25 @@ Run `npx checkly skills configure alert-channels` to access up-to-date informati
|
|
|
70
70
|
- **next to the resource** — place the `check.ts` files next to page routes, api endpoints etc.
|
|
71
71
|
|
|
72
72
|
|
|
73
|
-
#### Step 3 —
|
|
73
|
+
#### Step 3 — Check your account plan
|
|
74
|
+
|
|
75
|
+
Before writing checks, verify what your account can do:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
npx checkly account plan --output json
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
This shows your entitlements, limits, and available locations. Use this data when creating the config:
|
|
82
|
+
|
|
83
|
+
- **Only use locations** from `locations.all` where `available` is `true`. Using unavailable locations will cause deploy failures.
|
|
84
|
+
- **Check feature availability** before configuring constructs like private locations, advanced alert channels, or higher-frequency schedules.
|
|
85
|
+
- **Respect metered limits** — the `quantity` field shows maximums for each metered feature.
|
|
86
|
+
|
|
87
|
+
If a feature the user wants is disabled, the response includes an `upgradeUrl` — share it so they can upgrade their plan.
|
|
88
|
+
|
|
89
|
+
Run `npx checkly skills manage plan` for the full reference.
|
|
90
|
+
|
|
91
|
+
#### Step 4 — Create the config file
|
|
74
92
|
|
|
75
93
|
Run the following command to retrieve the configure skill reference:
|
|
76
94
|
|
|
@@ -80,13 +98,13 @@ npx checkly skills configure
|
|
|
80
98
|
|
|
81
99
|
Use the output to create a `checkly.config.ts` (or `checkly.config.js` if the user chose JavaScript) in the project root.
|
|
82
100
|
|
|
83
|
-
Adjust the `checkMatch` property according to previous selection.
|
|
101
|
+
Adjust the `checkMatch` property according to previous selection. Use only locations verified as available in the previous step.
|
|
84
102
|
|
|
85
103
|
Present the generated configuration to the user and ask if it looks correct. Allow the user to make changes.
|
|
86
104
|
|
|
87
105
|
Congratulate the user on completing the config. Now it's time to test the configuration and turn everything into monitoring!
|
|
88
106
|
|
|
89
|
-
#### Step
|
|
107
|
+
#### Step 5: Log in to Checkly CLI
|
|
90
108
|
|
|
91
109
|
To use the Checkly CLI the user needs to be logged in. Run the following command:
|
|
92
110
|
|
|
@@ -101,7 +119,7 @@ If the user is NOT logged in, present two options:
|
|
|
101
119
|
- **Option A: Interactive login** — The user runs `npx checkly login` themselves. This command opens a browser for OAuth authentication and cannot be completed by an AI agent. Tell the user to run the command, complete the browser flow, and let you know when they're done so you can re-run `npx checkly whoami` to verify.
|
|
102
120
|
- **Option B: Environment variables (recommended for agentic / CI use)** — The user sets `CHECKLY_API_KEY` and `CHECKLY_ACCOUNT_ID` as environment variables. They can create an API key in the Checkly dashboard under **User Settings > API Keys**. Once both variables are set, re-run `npx checkly whoami` to verify.
|
|
103
121
|
|
|
104
|
-
#### Step
|
|
122
|
+
#### Step 6: Summarize and test the new monitoring configuration
|
|
105
123
|
|
|
106
124
|
Read the generated `checkly.config.ts` (or `checkly.config.js`) and summarize the configured checks, locations, and frequencies.
|
|
107
125
|
|
|
@@ -37,6 +37,28 @@ npx checkly checks get <check-id> --result <result-id>
|
|
|
37
37
|
npx checkly checks get <check-id> --error-group <error-group-id>
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
+
## Check analytics and stats
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npx checkly checks stats
|
|
44
|
+
npx checkly checks stats --range last7Days --tag production
|
|
45
|
+
npx checkly checks stats <check-id-1> <check-id-2>
|
|
46
|
+
npx checkly checks stats --output json
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Shows availability, response times, error counts, and other metrics for your checks.
|
|
50
|
+
|
|
51
|
+
Flags:
|
|
52
|
+
- `-r, --range <range>` — time range: `last24Hours` (default), `last7Days`, `thisWeek`, `lastWeek`, `lastMonth`
|
|
53
|
+
- `-t, --tag <tag>` — filter by tag (repeat for multiple)
|
|
54
|
+
- `--type <type>` — filter by check type
|
|
55
|
+
- `-s, --search <name>` — filter by name
|
|
56
|
+
- `-l, --limit <n>` — max checks to return (1-100, default 25)
|
|
57
|
+
- `-p, --page <n>` — page number
|
|
58
|
+
- `-o, --output <format>` — `table` (default), `json`, or `md`
|
|
59
|
+
|
|
60
|
+
Pass one or more check IDs as positional arguments to get stats for specific checks only.
|
|
61
|
+
|
|
40
62
|
## Trigger checks
|
|
41
63
|
|
|
42
64
|
```bash
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Account Plan and Entitlements
|
|
2
|
+
|
|
3
|
+
Show your account plan, entitlements, feature limits, and available locations.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx checkly account plan # Summary view (metered limits + flag count)
|
|
9
|
+
npx checkly account plan --output json # Full JSON (recommended for agents)
|
|
10
|
+
npx checkly account plan --disabled # Show only features not on your plan
|
|
11
|
+
npx checkly account plan --disabled --type flag # Disabled flags only
|
|
12
|
+
npx checkly account plan --type metered # Metered limits only
|
|
13
|
+
npx checkly account plan --search "browser" # Search by name or description
|
|
14
|
+
npx checkly account plan BROWSER_CHECKS # Detail view for one entitlement
|
|
15
|
+
npx checkly account plan --help # Full flag reference
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## JSON response shape (abbreviated)
|
|
19
|
+
|
|
20
|
+
```json
|
|
21
|
+
{
|
|
22
|
+
"plan": "hobby",
|
|
23
|
+
"planDisplayName": "Hobby",
|
|
24
|
+
"checkoutUrl": "https://app.checklyhq.com/accounts/.../billing/checkout",
|
|
25
|
+
"contactSalesUrl": "https://www.checklyhq.com/contact-sales/",
|
|
26
|
+
"locations": {
|
|
27
|
+
"all": [
|
|
28
|
+
{ "id": "us-east-1", "name": "N. Virginia", "available": true },
|
|
29
|
+
{ "id": "eu-west-1", "name": "Ireland", "available": false }
|
|
30
|
+
],
|
|
31
|
+
"maxPerCheck": 3
|
|
32
|
+
},
|
|
33
|
+
"entitlements": [
|
|
34
|
+
{ "key": "BROWSER_CHECKS", "type": "metered", "enabled": true, "quantity": 10 },
|
|
35
|
+
{
|
|
36
|
+
"key": "PRIVATE_LOCATIONS", "type": "metered", "enabled": false,
|
|
37
|
+
"requiredPlan": "TEAM", "requiredPlanDisplayName": "Team",
|
|
38
|
+
"upgradeUrl": "https://app.checklyhq.com/accounts/.../billing/checkout"
|
|
39
|
+
}
|
|
40
|
+
]
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## How to use this data
|
|
45
|
+
|
|
46
|
+
1. **Locations:** Filter `locations.all` to entries where `available === true`. Use only those IDs in `checkly.config.ts` and check constructs. Respect `maxPerCheck` as the upper bound per check.
|
|
47
|
+
2. **Metered entitlements:** Check `quantity` for limits. `enabled: false` means the feature is not available.
|
|
48
|
+
3. **Flag entitlements:** `enabled: true` means available, `false` means not on this plan.
|
|
49
|
+
4. **Disabled features:** Each includes an `upgradeUrl`. Share this with the user — it points to the self-service checkout page or the enterprise contact sales page depending on the required plan.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Account Management
|
|
2
|
+
|
|
3
|
+
Understand your account's plan, entitlements, and limits.
|
|
4
|
+
|
|
5
|
+
## Plan-aware workflow
|
|
6
|
+
|
|
7
|
+
Checkly accounts have different capabilities depending on the plan (Hobby, Starter, Team, Enterprise) and add-ons (Communicate, Resolve). Features like locations, retry strategies, frequencies, and alert channels vary by plan.
|
|
8
|
+
|
|
9
|
+
**Before writing or modifying checks, run:**
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npx checkly account plan --output json
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
This returns your entitlements (enabled/disabled with limits), available locations, and upgrade URLs. Use this to:
|
|
16
|
+
|
|
17
|
+
- **Filter locations** to only those where `available` is `true` in `locations.all`
|
|
18
|
+
- **Check feature flags** before using constructs (e.g. private locations, advanced alert channels)
|
|
19
|
+
- **Respect metered limits** (e.g. max browser checks, max alert channels)
|
|
20
|
+
- **Surface upgrade paths** when a feature is disabled — each disabled entitlement includes an `upgradeUrl` pointing to the self-service checkout or the contact sales page
|
|
21
|
+
|
|
22
|
+
## Available Commands
|
|
23
|
+
|
|
24
|
+
Parse and read further reference documentation for any of the following:
|
|
25
|
+
|
|
26
|
+
### `npx checkly skills manage plan`
|
|
27
|
+
Check account plan, entitlements, feature limits, and available locations (`account plan`)
|