checkly

Category: Ops & Delivery | Uploader: checkly | Downloads: 0 | Version: v1.0（Latest）

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.

Changelog: Source: GitHub https://github.com/checkly/checkly-cli

Directory Structure

Current level: tree/main/packages/cli/src/ai-context/

📁 onboarding-boilerplate/
- 📁 __checks__/
  - 📄 api.check.ts 642 B
  - 📄 heartbeat.check.ts 579 B
  - 📄 homepage.spec.ts 506 B
  - 📄 url.check.ts 504 B
- 📄 checkly-config-template.ts 2.1 KB
📁 onboarding-prompts/
- 📄 base.md 235 B
- 📄 playwright.md 356 B
📁 references/
- 📄 communicate-incidents.md 2.5 KB
- 📄 communicate.md 1.5 KB
- 📄 configure-alert-channels.md 807 B
- 📄 configure-api-checks.md 2.5 KB
- 📄 configure-browser-checks.md 697 B
- 📄 configure-check-groups.md 297 B
- 📄 configure-dns-monitors.md 577 B
- 📄 configure-heartbeat-monitors.md 127 B
- 📄 configure-icmp-monitors.md 783 B
- 📄 configure-multistep-checks.md 317 B
- 📄 configure-playwright-checks.md 257 B
- 📄 configure-supporting-constructs.md 1.2 KB
- 📄 configure-tcp-monitors.md 470 B
- 📄 configure-url-monitors.md 589 B
- 📄 configure.md 3.2 KB
- 📄 initialize.md 5.6 KB
- 📄 investigate-checks.md 1.8 KB
- 📄 investigate.md 347 B
- 📄 manage-plan.md 2.1 KB
- 📄 manage.md 2.5 KB
📄 context.fixtures.json 36.0 KB
📄 context.ts 9.1 KB
📄 README.md 1.8 KB
📄 skill.md 2.1 KB

SKILL.md

---
name: checkly
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.
allowed-tools: Bash(npx:checkly:*) Bash(npm:install:*)
metadata:
  author: checkly
---

# Checkly

The Checkly CLI provides all the required information via the `npx checkly skills` command.

Use `npx checkly skills install` to install this skill into your project (supports Claude Code, Cursor, Codex and more).

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.

## Progressive Disclosure via `npx checkly skills`

The skill is structured for efficient context usage:

1. **Metadata** (~80 tokens): Name and description in frontmatter
2. **Core Instructions** (~1K tokens): Main SKILL.md content with links to reference commands
3. **Reference Commands** (loaded on demand): Detailed construct documentation with examples

Agents load what they need for each task.

## Plan Awareness

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.

Run `npx checkly skills manage` for the full reference.

## Confirmation Protocol

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.

Run `npx checkly skills communicate` for the full protocol details.

<!-- SKILL_COMMANDS -->

Comments 0

Latest | Hot

Please login before commenting.

Loading comments...

checkly

Directory Structure

SKILL.md

Report

Notice