Skip to content

Commit 44c92e0

Browse files
thebiglabaskyclaude
thebiglabasky
and
claude
committed
Add docs for checkly account plan and expand checkly skills
Document the new `checkly account` command with its `plan` subcommand, and expand the `checkly skills` page with `investigate`, `communicate`, `manage` actions and the `install` command. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 275565f commit 44c92e0

3 files changed

Lines changed: 351 additions & 5 deletions

File tree

‎cli/checkly-account.mdx‎

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
---
2+
title: checkly account
3+
description: 'View your Checkly account plan, entitlements, and feature limits.'
4+
sidebarTitle: 'checkly account'
5+
---
6+
7+
<Note>Available since CLI v7.7.0.</Note>
8+
9+
The `checkly account` command lets you view your account plan, entitlements, and feature limits directly from the terminal. Use it to check which features are available on your plan, inspect metered limits, and discover available check locations.
10+
11+
<Accordion title="Prerequisites">
12+
Before using `checkly account`, ensure you have:
13+
14+
- Checkly CLI installed
15+
- Valid Checkly account authentication (run `npx checkly login` if needed)
16+
17+
For additional setup information, see [CLI overview](/cli/overview).
18+
</Accordion>
19+
20+
## Usage
21+
22+
```bash Terminal
23+
npx checkly account <subcommand> [arguments] [options]
24+
```
25+
26+
## Subcommands
27+
28+
| Subcommand | Description |
29+
|------------|-------------|
30+
| `plan` | Show your account plan, entitlements, and feature limits. |
31+
32+
## `checkly account plan`
33+
34+
Show your account plan, entitlements, and feature limits. The default view displays a summary of metered entitlements with their limits. Use `--output=json` for the full response including locations, feature flags, and upgrade URLs.
35+
36+
**Usage:**
37+
38+
```bash Terminal
39+
npx checkly account plan [key] [options]
40+
```
41+
42+
**Arguments:**
43+
44+
| Argument | Description |
45+
|----------|-------------|
46+
| `key` | Entitlement key to look up (e.g. `BROWSER_CHECKS`). Shows a detail view for that entitlement. |
47+
48+
**Options:**
49+
50+
| Option | Required | Description |
51+
|--------|----------|-------------|
52+
| `--type, -t` | - | Filter entitlements by type: `metered` or `flag`. |
53+
| `--search, -s` | - | Search entitlements by name or description. |
54+
| `--disabled` | - | Show only entitlements not included in your plan. |
55+
| `--output, -o` | - | Output format: `table`, `json`, or `md`. Default: `table`. |
56+
57+
### Plan Options
58+
59+
<ResponseField name="key" type="string">
60+
61+
Pass an entitlement key as a positional argument to see a detail view for that specific entitlement, including its type, status, limit, and upgrade URL if applicable.
62+
63+
**Usage:**
64+
65+
```bash Terminal
66+
npx checkly account plan BROWSER_CHECKS
67+
npx checkly account plan PRIVATE_LOCATIONS
68+
```
69+
70+
</ResponseField>
71+
72+
<ResponseField name="--type, -t" type="string">
73+
74+
Filter entitlements by type. Use `metered` to see entitlements with numeric limits, or `flag` to see boolean feature flags.
75+
76+
**Usage:**
77+
78+
```bash Terminal
79+
npx checkly account plan --type=metered
80+
npx checkly account plan -t flag
81+
```
82+
83+
</ResponseField>
84+
85+
<ResponseField name="--search, -s" type="string">
86+
87+
Search entitlements by name or description using a case-insensitive match.
88+
89+
**Usage:**
90+
91+
```bash Terminal
92+
npx checkly account plan --search="browser"
93+
npx checkly account plan -s "alert"
94+
```
95+
96+
</ResponseField>
97+
98+
<ResponseField name="--disabled" type="boolean">
99+
100+
Show only entitlements that are not included in your current plan. Each disabled entitlement includes the required plan and an upgrade URL.
101+
102+
**Usage:**
103+
104+
```bash Terminal
105+
npx checkly account plan --disabled
106+
npx checkly account plan --disabled --type=flag
107+
```
108+
109+
</ResponseField>
110+
111+
<ResponseField name="--output, -o" type="string" default="table">
112+
113+
Set the output format. Use `json` for the full response including locations, all entitlements, and upgrade URLs. Use `md` for markdown.
114+
115+
**Usage:**
116+
117+
```bash Terminal
118+
npx checkly account plan --output=json
119+
npx checkly account plan -o md
120+
```
121+
122+
</ResponseField>
123+
124+
### Plan Examples
125+
126+
```bash Terminal
127+
# Show account plan summary (metered limits + flag count)
128+
npx checkly account plan
129+
130+
# Get the full response as JSON (recommended for agents)
131+
npx checkly account plan --output=json
132+
133+
# Show only metered entitlements
134+
npx checkly account plan --type=metered
135+
136+
# Show only feature flags
137+
npx checkly account plan --type=flag
138+
139+
# Search for specific entitlements
140+
npx checkly account plan --search="browser"
141+
142+
# Show features not included in your plan
143+
npx checkly account plan --disabled
144+
145+
# Look up a specific entitlement
146+
npx checkly account plan BROWSER_CHECKS
147+
```
148+
149+
### JSON Response
150+
151+
The `--output=json` format returns a structured response useful for programmatic access and AI agents.
152+
153+
```json
154+
{
155+
"plan": "hobby",
156+
"planDisplayName": "Hobby",
157+
"checkoutUrl": "https://app.checklyhq.com/accounts/.../billing/checkout",
158+
"contactSalesUrl": "https://www.checklyhq.com/contact-sales/",
159+
"locations": {
160+
"all": [
161+
{ "id": "us-east-1", "name": "N. Virginia", "available": true },
162+
{ "id": "eu-west-1", "name": "Ireland", "available": false }
163+
],
164+
"maxPerCheck": 3
165+
},
166+
"entitlements": [
167+
{
168+
"key": "BROWSER_CHECKS",
169+
"type": "metered",
170+
"enabled": true,
171+
"quantity": 10
172+
},
173+
{
174+
"key": "PRIVATE_LOCATIONS",
175+
"type": "metered",
176+
"enabled": false,
177+
"requiredPlan": "TEAM",
178+
"requiredPlanDisplayName": "Team",
179+
"upgradeUrl": "https://app.checklyhq.com/accounts/.../billing/checkout"
180+
}
181+
]
182+
}
183+
```
184+
185+
Key fields:
186+
187+
- **`locations.all`** — filter to entries where `available` is `true` to get valid locations for your checks. Respect `maxPerCheck` as the upper bound per check.
188+
- **`entitlements`** — metered entitlements include a `quantity` limit. Disabled entitlements include `requiredPlan` and `upgradeUrl`.
189+
190+
## Related Commands
191+
192+
- [`checkly skills manage`](/cli/checkly-skills#checkly-skills-manage-resource) - Account management context for AI agents
193+
- [`checkly whoami`](/cli/checkly-whoami) - Display current account information
194+
- [`checkly switch`](/cli/checkly-switch) - Switch between Checkly accounts

‎cli/checkly-skills.mdx‎

Lines changed: 156 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,25 @@ npx checkly skills
2727
npx checkly skills <action> [resource]
2828
```
2929

30-
## Subcommands
30+
## Actions
3131

32-
| Subcommand | Description |
33-
|------------|-------------|
32+
| Action | Description |
33+
|--------|-------------|
3434
| `initialize` | Let your agent initialize [a new Checkly project](/constructs/project). |
3535
| `configure` | Let your agent configure [Checkly constructs](/constructs/overview). |
36+
| `investigate` | Access check status, analyze failures, and investigate errors. |
37+
| `communicate` | Open incidents and lead customer communications via status pages. |
38+
| `manage` | Understand your account plan, entitlements, and feature limits. |
39+
40+
## Commands
41+
42+
| Command | Description |
43+
|---------|-------------|
44+
| `install` | Install the Checkly agent skill (SKILL.md) into your project. |
3645

3746
## `checkly skills initialize` (experimental)
3847

39-
The `initialize` subcommand outputs LLM-optimized Markdown with all the context an agent needs to set up a new Checkly project from scratch. The context will instruct your agent to install required packages, create config files and scan your current project for resources to monitor.
48+
The `initialize` action outputs LLM-optimized Markdown with all the context an agent needs to set up a new Checkly project from scratch. The context will instruct your agent to install required packages, create config files and scan your current project for resources to monitor.
4049

4150
**Usage:**
4251

@@ -50,7 +59,7 @@ You can prompt your agent with **"run `npx checkly skills initialize` and follow
5059

5160
## `checkly skills configure [resource]`
5261

53-
The `configure` subcommand is an umbrella command that provides Markdown context about all available Checkly resources. The CLI outputs everything your agent needs to configure [Checkly constructs](/constructs/overview) directly — no additional docs fetching or file reading required.
62+
The `configure` action is an umbrella command that provides Markdown context about all available Checkly resources. The CLI outputs everything your agent needs to configure [Checkly constructs](/constructs/overview) directly — no additional docs fetching or file reading required.
5463

5564
Run `configure` without arguments to see all available resources, or pass a specific resource name to get targeted context.
5665

@@ -62,3 +71,145 @@ npx checkly skills configure api-checks
6271
npx checkly skills configure browser-checks
6372
# ...and more
6473
```
74+
75+
## `checkly skills investigate [resource]`
76+
77+
The `investigate` action provides context for inspecting check status, analyzing failures, and investigating errors across your Checkly account.
78+
79+
Run `investigate` without arguments to see all available resources, or pass a specific resource name for targeted context.
80+
81+
**Usage:**
82+
83+
```bash Terminal
84+
npx checkly skills investigate
85+
npx checkly skills investigate checks
86+
```
87+
88+
**Available resources:**
89+
90+
| Resource | Description |
91+
|----------|-------------|
92+
| `checks` | Inspecting checks (`checks list`, `checks get`) and triggering on-demand runs. |
93+
94+
## `checkly skills communicate [resource]`
95+
96+
The `communicate` action provides context for managing incidents and customer communications through status pages. Write commands like `incidents create`, `incidents update`, and `incidents resolve` follow a confirmation protocol — the CLI returns a JSON envelope for agent review before execution.
97+
98+
Run `communicate` without arguments to see all available resources, or pass a specific resource name for targeted context.
99+
100+
**Usage:**
101+
102+
```bash Terminal
103+
npx checkly skills communicate
104+
npx checkly skills communicate incidents
105+
```
106+
107+
**Available resources:**
108+
109+
| Resource | Description |
110+
|----------|-------------|
111+
| `incidents` | Incident lifecycle (`incidents create`, `update`, `resolve`, `list`) and status pages. |
112+
113+
## `checkly skills manage [resource]`
114+
115+
The `manage` action provides context about your account's plan, entitlements, and limits. Use this to understand what features and locations are available before configuring checks.
116+
117+
Run `manage` without arguments to see all available resources, or pass a specific resource name for targeted context.
118+
119+
**Usage:**
120+
121+
```bash Terminal
122+
npx checkly skills manage
123+
npx checkly skills manage plan
124+
```
125+
126+
**Available resources:**
127+
128+
| Resource | Description |
129+
|----------|-------------|
130+
| `plan` | Check account plan, entitlements, feature limits, and available locations ([`account plan`](/cli/checkly-account)). |
131+
132+
<Tip>
133+
The `manage plan` resource documents the [`checkly account plan`](/cli/checkly-account) command. Your agent can use the `account plan` command to query entitlements and available locations before writing check configurations.
134+
</Tip>
135+
136+
## `checkly skills install`
137+
138+
The `install` command installs the Checkly agent skill file (SKILL.md) into your project. This file lets your AI agent automatically discover and use the `checkly skills` command.
139+
140+
**Usage:**
141+
142+
```bash Terminal
143+
npx checkly skills install
144+
npx checkly skills install --target <platform>
145+
npx checkly skills install --path <directory>
146+
```
147+
148+
**Options:**
149+
150+
| Option | Required | Description |
151+
|--------|----------|-------------|
152+
| `--target, -t` | - | Platform to install the skill for. |
153+
| `--path, -p` | - | Custom target directory to install the skill into. |
154+
| `--force, -f` | - | Overwrite existing SKILL.md without confirmation. |
155+
156+
### Install Options
157+
158+
<ResponseField name="--target, -t" type="string">
159+
160+
The target platform determines where and how the skill file is installed. Available platforms: `amp`, `claude`, `cline`, `codex`, `continue`, `cursor`, `gemini-cli`, `github-copilot`, `goose`, `opencode`, `roo`, `windsurf`.
161+
162+
**Usage:**
163+
164+
```bash Terminal
165+
npx checkly skills install --target=claude
166+
npx checkly skills install -t cursor
167+
```
168+
169+
</ResponseField>
170+
171+
<ResponseField name="--path, -p" type="string">
172+
173+
Custom target directory to install the skill file into. Use this when the default location for your platform does not match your project structure.
174+
175+
**Usage:**
176+
177+
```bash Terminal
178+
npx checkly skills install --path=./my-agent-config
179+
```
180+
181+
</ResponseField>
182+
183+
<ResponseField name="--force, -f" type="boolean">
184+
185+
Overwrite an existing SKILL.md without asking for confirmation.
186+
187+
**Usage:**
188+
189+
```bash Terminal
190+
npx checkly skills install --force
191+
```
192+
193+
</ResponseField>
194+
195+
### Install Examples
196+
197+
```bash Terminal
198+
# Install for Claude Code
199+
npx checkly skills install --target=claude
200+
201+
# Install for Cursor
202+
npx checkly skills install --target=cursor
203+
204+
# Install to a custom directory
205+
npx checkly skills install --path=./agents
206+
207+
# Overwrite an existing skill file
208+
npx checkly skills install --target=claude --force
209+
```
210+
211+
## Related Commands
212+
213+
- [`checkly account`](/cli/checkly-account) - View and manage your Checkly account
214+
- [`checkly checks`](/cli/checkly-checks) - List, inspect, and analyze checks
215+
- [`checkly incidents`](/cli/checkly-incidents) - Create, update, and resolve incidents

‎docs.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -534,6 +534,7 @@
534534
{
535535
"group": "CLI Commands",
536536
"pages": [
537+
"cli/checkly-account",
537538
"cli/checkly-checks",
538539
"cli/checkly-deploy",
539540
"cli/checkly-destroy",

0 commit comments

Comments
 (0)