Requirements
- Target platform
- OpenClaw
- Install method
- Manual import
- Extraction
- Extract archive
- Prerequisites
- OpenClaw
- Primary doc
- SKILL.md
Comprehensive Checkly CLI command reference and Monitoring as Code workflows. Use when user mentions Checkly CLI, monitoring as code, synthetic monitoring, A...
Comprehensive Checkly CLI command reference and Monitoring as Code workflows. Use when user mentions Checkly CLI, monitoring as code, synthetic monitoring, A...
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Then review README.md for any prerequisites, environment setup, or post-install checks. Tell me what you changed and call out any manual steps you could not complete.
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Then review README.md for any prerequisites, environment setup, or post-install checks. Summarize what changed and any follow-up checks I should run.
Comprehensive Checkly CLI command reference and Monitoring as Code (MaC) workflows.
# Create new Checkly project npm create checkly@latest # Test checks locally npx checkly test # Deploy to Checkly cloud npx checkly deploy
The Checkly CLI provides a TypeScript/JavaScript-native workflow for coding, testing, and deploying synthetic monitoring at scale. Define your monitoring checks as code, test them locally, version control them with Git, and deploy through CI/CD pipelines. Key benefits: Codeable - Define checks in TypeScript/JavaScript Testable - Run checks locally before deployment Reviewable - Code review your monitoring in PRs Native Playwright - Use standard @playwright/test specs CI/CD Native - Integrate with your deployment pipeline
This skill routes to specialized sub-skills by Checkly domain: Getting Started: checkly-auth - Authentication setup and login checkly-config - Configuration files (checkly.config.ts) and project structure Core Workflows: checkly-test - Local testing workflow with npx checkly test checkly-deploy - Deployment to Checkly cloud checkly-import - Import existing checks from Checkly to code Check Types: checkly-checks - API checks, browser checks, multi-step checks checkly-monitors - Heartbeat, TCP, DNS, URL monitors checkly-groups - Check groups for organization and shared config Advanced: checkly-constructs - Constructs system and resource management checkly-playwright - Playwright test suites and configuration checkly-advanced - Retry strategies, reporters, environment variables, bundling
Use Checkly CLI when: Defining monitoring as part of your codebase Automating check creation/updates in CI/CD Testing checks locally during development Version controlling monitoring configuration Managing multiple checks efficiently Integrating monitoring with application deployments Use Web UI when: Exploring Checkly for the first time Viewing dashboards and historical results Analyzing check failures and incidents Managing account-level settings Configuring alert channels (email, Slack, PagerDuty) Setting up private locations
# Initialize project npm create checkly@latest cd my-checkly-project # Authenticate npx checkly login # Test locally npx checkly test # Deploy to cloud npx checkly deploy
# Create new API check cat > __checks__/api-status.check.ts <<'EOF' import { ApiCheck, AssertionBuilder } from 'checkly/constructs' new ApiCheck('api-status-check', { name: 'API Status Check', request: { url: 'https://api.example.com/status', method: 'GET', assertions: [ AssertionBuilder.statusCode().equals(200), AssertionBuilder.responseTime().lessThan(500), ], }, }) EOF # Test locally npx checkly test # Deploy when ready npx checkly deploy
# Create browser check cat > __checks__/homepage.spec.ts <<'EOF' import { test, expect } from '@playwright/test' test('homepage loads', async ({ page }) => { const response = await page.goto('https://example.com') expect(response?.status()).toBeLessThan(400) await expect(page).toHaveTitle(/Example/) await page.screenshot({ path: 'homepage.jpg' }) }) EOF # Test with Playwright locally (faster) npx playwright test __checks__/homepage.spec.ts # Test via Checkly runtime npx checkly test __checks__/homepage.spec.ts # Deploy npx checkly deploy
# Import all checks from Checkly account npx checkly import plan # Review generated code git diff # Commit imported checks git add . git commit -m "Import existing monitoring checks"
What are you monitoring? โโ REST API / HTTP endpoint โ โโ Simple availability โ API Check (request + status assertion) โ โโ Complex validation โ API Check (request + multiple assertions + scripts) โ โโ Just uptime/ping โ URL Monitor (simpler, faster) โ โโ Web application / User flow โ โโ Single page โ Browser Check (one .spec.ts file) โ โโ Multiple steps โ Browser Check or Multi-Step Check โ โโ Full test suite โ Playwright Check Suite (playwright.config.ts) โ โโ Service health / Infrastructure โโ Periodic heartbeat โ Heartbeat Monitor โโ TCP port โ TCP Monitor โโ DNS record โ DNS Monitor โโ Simple HTTP โ URL Monitor Quick reference: API Check: HTTP requests with assertions (status, headers, body, response time) Browser Check: Single Playwright spec file for web testing Multi-Step Check: Complex browser workflows (legacy, use Browser Check instead) Playwright Check Suite: Multiple Playwright tests with projects/parallelization Monitors: Simple health checks without code execution
What stage are you at? โโ Developing new check โ โโ Browser check โ npx playwright test (fastest iteration) โ โโ API check โ npx checkly test (includes assertions) โ โโ Ready to validate โ โโ npx checkly test (runs in Checkly runtime, catches issues) โ โโ Ready for production โโ npx checkly deploy (schedule checks to run continuously) Testing hierarchy: npx playwright test - Fastest, local Playwright execution (browser checks only) npx checkly test - Validates in Checkly runtime, catches compatibility issues npx checkly deploy - Deploys for continuous scheduled monitoring
How do you want to define checks? โโ Auto-discovery (convention over configuration) โ โโ Browser checks โ *.spec.ts files matching testMatch pattern โ โโ Multi-step โ *.check.ts files with MultiStepCheck construct โ โโ API checks โ *.check.ts files with ApiCheck construct โ โโ Explicit definition โโ Programmatic โ Construct instances in .check.ts files โโ Full control โ Playwright Check Suite with playwright.config.ts Patterns: Auto-discovery: Configure checks.browserChecks.testMatch in checkly.config.ts Explicit constructs: Import from checkly/constructs and instantiate Playwright projects: Define multiple test suites with different configs
What are you configuring? โโ Project-level (all checks) โ โโ checkly.config.ts โ defaults, locations, frequency, runtime โ โโ Group-level (related checks) โ โโ CheckGroup construct โ shared settings for subset of checks โ โโ Check-level (individual) โโ Check constructor โ override defaults for specific check Configuration hierarchy (specific overrides general): Check-level properties (highest priority) CheckGroup properties checkly.config.ts defaults Checkly account defaults (lowest priority)
Typical Checkly CLI project: my-monitoring-project/ โโโ checkly.config.ts # Project configuration โโโ __checks__/ # Check definitions โ โโโ api.check.ts # API check construct โ โโโ homepage.spec.ts # Browser check (auto-discovered) โ โโโ login.spec.ts # Another browser check โ โโโ utils/ โ โโโ alert-channels.ts # Shared alert channel definitions โ โโโ helpers.ts # Shared helper functions โโโ playwright.config.ts # Playwright configuration (optional) โโโ package.json โโโ node_modules/ โโโ checkly/ # CLI package with constructs
npm create checkly@latest Creates scaffolded project with: checkly.config.ts with sensible defaults Example checks in __checks__/ directory package.json with checkly dependency .gitignore configured
# Install as dev dependency npm install --save-dev checkly # Create configuration file npx checkly init
npm install -g checkly checkly test Note: Use npx checkly instead for project-specific CLI version.
Getting started: See checkly-auth for authentication setup See checkly-config for project configuration See checkly-test for local testing workflow Creating checks: See checkly-checks for API and browser checks See checkly-monitors for simpler health checks See checkly-playwright for full test suite setup Advanced workflows: See checkly-deploy for deployment strategies See checkly-constructs for understanding the object model See checkly-advanced for retry strategies and reporters Import existing: See checkly-import to migrate from web UI to code
Code helpers, APIs, CLIs, browser automation, testing, and developer operations.
Largest current source with strong distribution and engagement signals.