Skip to content

Commit ca1e8af

Browse files
Dgiordano33Dgiordano33
committed
cleaned skills page
1 parent a1bcfb2 commit ca1e8af

6 files changed

Lines changed: 1249 additions & 3844 deletions

File tree

‎.claude/skills/checkly/SKILL.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
name: checkly
3+
description: Set up, create, test and manage monitoring checks using the Checkly CLI. Use when working with API Checks, Browser Checks, URL Monitors, ICMP Monitors, Playwright Check Suites, Heartbeat Monitors, Alert Channels, Dashboards, or Status Pages.
4+
allowed-tools: Bash(npx:checkly:*) Bash(npm:install:*)
5+
metadata:
6+
author: checkly
7+
---
8+
9+
# Checkly
10+
11+
The Checkly CLI provides all the required information via the `npx checkly skills` command.
12+
13+
Use `npx checkly skills install` to install this skill into your project (supports Claude Code, Cursor, Codex and more).
14+
15+
Use `npx checkly skills` to list all available actions, and `npx checkly skills <action>` to access up-to-date information on how to use the Checkly CLI for each action.
16+
17+
## Progressive Disclosure via `npx checkly skills`
18+
19+
The skill is structured for efficient context usage:
20+
21+
1. **Metadata** (~80 tokens): Name and description in frontmatter
22+
2. **Core Instructions** (~1K tokens): Main SKILL.md content with links to reference commands
23+
3. **Reference Commands** (loaded on demand): Detailed construct documentation with examples
24+
25+
Agents load what they need for each task.
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+
33+
## Confirmation Protocol
34+
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.
36+
37+
Run `npx checkly skills communicate` for the full protocol details.
38+
39+
### `npx checkly skills initialize`
40+
Learn how to initialize and set up a new Checkly CLI project from scratch.
41+
42+
### `npx checkly skills configure`
43+
Learn how to create and manage monitoring checks using Checkly constructs and the CLI.
44+
45+
#### `npx checkly skills configure api-checks`
46+
Api Check construct (`ApiCheck`), assertions, and authentication setup scripts
47+
48+
#### `npx checkly skills configure browser-checks`
49+
Browser Check construct (`BrowserCheck`) with Playwright test files
50+
51+
#### `npx checkly skills configure playwright-checks`
52+
Playwright Check Suite construct (`PlaywrightCheck`) for multi-browser test suites
53+
54+
#### `npx checkly skills configure multistep-checks`
55+
Multistep Check construct (`MultiStepCheck`) for complex user flows
56+
57+
#### `npx checkly skills configure tcp-monitors`
58+
TCP Monitor construct (`TcpMonitor`) with assertions
59+
60+
#### `npx checkly skills configure url-monitors`
61+
URL Monitor construct (`UrlMonitor`) with assertions
62+
63+
#### `npx checkly skills configure dns-monitors`
64+
DNS Monitor construct (`DnsMonitor`) with assertions
65+
66+
#### `npx checkly skills configure icmp-monitors`
67+
ICMP Monitor construct (`IcmpMonitor`) with latency and packet loss assertions
68+
69+
#### `npx checkly skills configure heartbeat-monitors`
70+
Heartbeat Monitor construct (`HeartbeatMonitor`)
71+
72+
#### `npx checkly skills configure check-groups`
73+
CheckGroupV2 construct (`CheckGroupV2`) for organizing checks
74+
75+
#### `npx checkly skills configure alert-channels`
76+
Email (`EmailAlertChannel`), Phone (`PhoneCallAlertChannel`), and Slack (`SlackAlertChannel`) alert channels
77+
78+
#### `npx checkly skills configure supporting-constructs`
79+
Status pages (`StatusPage`), dashboards (`Dashboard`), maintenance windows (`MaintenanceWindow`), and private locations (`PrivateLocation`)
80+
81+
### `npx checkly skills investigate`
82+
Access check status, analyze failures, and investigate errors.
83+
84+
#### `npx checkly skills investigate checks`
85+
Inspecting checks (`checks list`, `checks get`) and triggering on-demand runs
86+
87+
### `npx checkly skills communicate`
88+
Open incidents and lead customer communications via status pages.
89+
90+
#### `npx checkly skills communicate incidents`
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`)

‎ai/rules.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: 'Checkly Rules'
33
description: 'Add Checkly rules files to your AI agent to provide monitoring context for your coding workflow.'
4-
sidebarTitle: 'Rules'
4+
sidebarTitle: 'Agent Rules'
5+
hidden: true
56
---
67

78
import AgentExamples from "/snippets/agent-example.mdx"

‎ai/skills.mdx‎

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,32 @@
11
---
22
title: 'Checkly Skills'
3-
description: 'Install Checkly skills to give your AI agent on-demand monitoring context and capabilities.'
3+
description: 'Official Checkly skills to give any AI agent on-demand best practices, context, and product capabilities.'
44
sidebarTitle: 'Agent Skills'
55
---
66

7-
Skills are reusable and modular capabilities for AI agents. They provide procedural knowledge that helps agents accomplish Checkly tasks more effectively. Think of Checkly Skills as plugins or extensions that enhance what your AI agent can do with your monitoring infrastructure.
7+
import AgentExamples from "/snippets/agent-example.mdx"
88

9-
[Agent Skills](https://agentskills.io) are an open standard supported by many AI agents and coding assistants including Claude Code, Cursor, OpenAI Codex, Gemini CLI, GitHub Copilot, and others. If your agent supports skills, you can use the Checkly Skills to manage your monitoring setup.
9+
[Agent Skills](https://agentskills.io) are an open standard supported by many AI agents and coding assistants including Claude Code, Cursor, OpenAI Codex, and others. Skills are reusable and modular capabilities for AI agents. They provide procedural knowledge that helps agents accomplish Checkly tasks more effectively.
10+
11+
Think of Checkly Skills as an extension of your AI agent that enhances it with Checkly specific best practices and capabilities.
12+
13+
### Installation
1014

1115
Use [the Checkly CLI `skills` command](/cli/checkly-skills#checkly-skills-install) to install [Checkly skills](https://github.com/checkly/checkly-cli/tree/main/skills/checkly) globally or in your project:
1216

1317
```bash
1418
npx checkly skills install
1519

1620
# or if you prefer the `skills` CLI
21+
1722
npx skills add checkly/checkly-cli
1823
```
1924

20-
This will make the Checkly Skills available to your AI agent. When your agent needs to perform a Checkly-related task, it can automatically pull in the relevant context and use the provided instructions and resources to execute the task effectively.
25+
After installation, restart your AI agent to load the skills.
26+
27+
## Usage
28+
29+
Now when your agent needs to perform a Checkly-related task, it can automatically pull in the relevant context and use the provided instructions and resources to execute the task effectively.
2130

2231
```txt Claude Code Example highlight={3-4, 8-9}
2332
❯ Can you create a new URLMonitor with Checkly for example.com?
@@ -35,7 +44,15 @@ This will make the Checkly Skills available to your AI agent. When your agent ne
3544
⏺ I'll create a new URLMonitor for example.com!
3645
```
3746

38-
Using [Monitoring as Code](/concepts/monitoring-as-code), you can now control your monitoring setup with AI agents without needing a specific MCP server or API for your monitoring. Tell your agent what you want to do and it will access the necessary context and use the CLI to manage your monitoring setup effectively.
47+
### Examples
48+
49+
**The Monitoring as Code workflow is by default AI-native** because LLMs are excellent at writing and editing Checkly constructs code and modern AI agents can execute CLI commands easily.
50+
51+
Provide the necessary Checkly context and let your AI agent of choice do the rest.
52+
53+
<AgentExamples />
54+
55+
Using Checkly, you can now control your monitoring setup with AI agents without needing a specific MCP server or API for your monitoring. Tell your agent what you want to do and it will access the necessary context and use the CLI to manage your monitoring setup effectively.
3956

4057
## Additional resources
4158

‎docs.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@
340340
"group": "AI",
341341
"pages": [
342342
"ai/rocky-ai",
343-
"ai/overview",
343+
"ai/overview",
344344
"ai/skills",
345345
"ai/rules"
346346
]

0 commit comments

Comments
 (0)