checkly-cli-skills_skill

Overview

This skill runs Checkly checks locally using the npx checkly test command to validate checks in the same runtime as production without deploying them. It supports filtering, reporters, retries, location testing, and verbose debugging to reproduce and fix failures before deployment. Use it to speed up local iteration, integrate checks into CI/CD, and verify runtime dependencies.

How this skill works

The skill invokes npx checkly test to execute checks inside Checkly’s runtime environment, mirroring production behavior while avoiding scheduling or deployment. You can target specific files, name patterns, or datacenters, enable verbose logs, select reporters (list, dot, ci, github, json), and configure retries and env files. It can also validate runtime dependencies and produce machine-readable results for CI pipelines.

When to use it

• Validate checks locally before deploying to production
• Debug failing or flaky checks with verbose logs and screenshots
• Run automated tests in CI/CD workflows and produce CI/GitHub annotations
• Filter and run a subset of checks during development
• Verify behavior from different Checkly locations or private locations

Best practices

• Run npx checkly test --verbose for detailed failure information before debugging
• Use --env-file to load environment-specific variables and avoid secrets in CLI
• Start with Playwright locally for fast iteration, then validate in Checkly runtime
• Use --verify-runtime-dependencies to catch unsupported or missing packages early
• Pipe --reporter=json results into CI tooling for automated analysis

Example use cases

• Run a single failing check: npx checkly test __checks__/failing.spec.ts --verbose
• CI job that validates all checks and annotates GitHub: npx checkly test --reporter=github
• Reproduce regional issues: npx checkly test --location=eu-west-1
• Reduce flakiness by rerunning failed checks: npx checkly test --retries=1
• Export test results for dashboards: npx checkly test --reporter=json > results.json