# Checkly Docs - [Docs (209 pages)](https://www.checklyhq.com/docs/_llms/docs.txt): Documentation for Docs. ## Constructs ### Getting Started - [Using Checkly CLI Constructs](https://www.checklyhq.com/docs/constructs/overview.md): Build monitoring infrastructure using JavaScript/TypeScript and the Checkly CLI - [Create Checks Automatically from Files](https://www.checklyhq.com/docs/constructs/including-checks.md): Learn how to automatically include checks in your project - [Dynamic monitor creation](https://www.checklyhq.com/docs/constructs/dynamic-monitor-creation.md): Create monitors dynamically with the Checkly CLI by looping over lists of targets in TypeScript or JavaScript, managing checks at scale without duplication. ### DETECT - [UrlMonitor Construct](https://www.checklyhq.com/docs/constructs/url-monitor.md): Learn how to configure URL monitors with the Checkly CLI. - [DnsMonitor Construct](https://www.checklyhq.com/docs/constructs/dns-monitor.md): Learn how to configure DNS monitors with the Checkly CLI. - [TcpMonitor Construct](https://www.checklyhq.com/docs/constructs/tcp-monitor.md): Learn how to configure TCP monitors with the Checkly CLI. - [IcmpMonitor Construct](https://www.checklyhq.com/docs/constructs/icmp-monitor.md): Learn how to configure ICMP monitors with the Checkly CLI. - [TracerouteMonitor Construct](https://www.checklyhq.com/docs/constructs/traceroute-monitor.md): Learn how to configure Traceroute monitors with the Checkly CLI. - [GrpcMonitor Construct](https://www.checklyhq.com/docs/constructs/grpc-monitor.md): Learn how to configure gRPC monitors with the Checkly CLI. - [SslMonitor Construct](https://www.checklyhq.com/docs/constructs/ssl-monitor.md): Learn how to configure SSL monitors with the Checkly CLI. - [Heartbeat Monitor Construct](https://www.checklyhq.com/docs/constructs/heartbeat-monitor.md): Learn how to configure heartbeat monitors with the Checkly CLI. - [API Check Construct](https://www.checklyhq.com/docs/constructs/api-check.md): Learn how to configure API Checks with the Checkly CLI. - [Multistep Check Construct](https://www.checklyhq.com/docs/constructs/multistep-check.md): Learn how to configure multistep checks with the Checkly CLI. - [Browser Check Construct](https://www.checklyhq.com/docs/constructs/browser-check.md): Learn how to configure browser checks with the Checkly CLI. - [Playwright Check Suite](https://www.checklyhq.com/docs/constructs/playwright-check.md): Learn how to configure Playwright check suites with the Checkly CLI. ### COMMUNICATE - [Alert Escalation Policy Construct](https://www.checklyhq.com/docs/constructs/alert-escalation-policy.md): Learn how to configure alert escalation policies with the Checkly CLI. - [RetryStrategyBuilder Construct](https://www.checklyhq.com/docs/constructs/retry-strategy.md): Learn how to configure retry strategies with the Checkly CLI. - [Dashboard Construct](https://www.checklyhq.com/docs/constructs/dashboard.md): Learn how to configure dashboards with the Checkly CLI. - [MaintenanceWindow Construct](https://www.checklyhq.com/docs/constructs/maintenance-window.md): Learn how to configure maintenance windows with the Checkly CLI. #### Alert Channels - [Alert Channel Overview](https://www.checklyhq.com/docs/constructs/alert-channel.md): Learn how to configure alert channels with the Checkly CLI. - [EmailAlertChannel Construct](https://www.checklyhq.com/docs/constructs/email-alert-channel.md): Learn how to configure email alert channels with the Checkly CLI. - [SmsAlertChannel Construct](https://www.checklyhq.com/docs/constructs/sms-alert-channel.md): Learn how to configure SMS alert channels with the Checkly CLI. - [PhoneCallAlertChannel Construct](https://www.checklyhq.com/docs/constructs/phone-call-alert-channel.md): Learn how to configure phone call alert channels with the Checkly CLI. - [SlackAppAlertChannel Construct](https://www.checklyhq.com/docs/constructs/slack-app-alert-channel.md): Learn how to configure Slack alert channels with the Checkly CLI. - [SlackAlertChannel Construct](https://www.checklyhq.com/docs/constructs/slack-alert-channel.md): Learn how to configure Slack alert channels with the Checkly CLI. - [WebhookAlertChannel Construct](https://www.checklyhq.com/docs/constructs/webhook-alert-channel.md): Learn how to configure webhook alert channels with the Checkly CLI. - [OpsgenieAlertChannel Construct](https://www.checklyhq.com/docs/constructs/opsgenie-alert-channel.md): Learn how to configure Opsgenie alert channels with the Checkly CLI. - [PagerdutyAlertChannel Construct](https://www.checklyhq.com/docs/constructs/pagerduty-alert-channel.md): Learn how to configure Pagerduty alert channels with the Checkly CLI. - [IncidentioAlertChannel Construct](https://www.checklyhq.com/docs/constructs/incidentio-alert-channel.md): Learn how to configure Incident.io alert channels with the Checkly CLI. - [MSTeamsAlertChannel Construct](https://www.checklyhq.com/docs/constructs/msteams-alert-channel.md): Learn how to configure Microsoft Teams alert channels with the Checkly CLI. - [TelegramAlertChannel Construct](https://www.checklyhq.com/docs/constructs/telegram-alert-channel.md): Learn how to configure Telegram alert channels and forum topics with the Checkly CLI. #### Status Pages - [StatusPageV3 Construct](https://www.checklyhq.com/docs/constructs/status-page-v3.md): Learn how to configure status pages with the Checkly CLI. - [StatusPageV3Component Construct](https://www.checklyhq.com/docs/constructs/status-page-v3-component.md): Learn how to configure status page components with the Checkly CLI. - [StatusPageV3AutomationRule Construct](https://www.checklyhq.com/docs/constructs/status-page-v3-automation-rule.md): Learn how to automate status page incidents with the Checkly CLI. - [StatusPage Construct](https://www.checklyhq.com/docs/constructs/status-page.md): Learn how to configure status pages with the Checkly CLI. - [StatusPageService Construct](https://www.checklyhq.com/docs/constructs/status-page-service.md): Learn how to configure status page services with the Checkly CLI. - [IncidentTrigger Configuration](https://www.checklyhq.com/docs/constructs/incident-trigger.md): Learn how to configure status page incident automation with the Checkly CLI. ### Project & Configuration - [Project Construct](https://www.checklyhq.com/docs/constructs/project.md): Learn how to configure projects with the Checkly CLI. - [CheckGroupV2 Construct](https://www.checklyhq.com/docs/constructs/check-group-v2.md): Learn how to configure check groups with the Checkly CLI. - [CheckGroup Construct](https://www.checklyhq.com/docs/constructs/check-group.md): Learn how to configure check groups with the Checkly CLI. ### Platform - [PrivateLocation Construct](https://www.checklyhq.com/docs/constructs/private-location.md): Learn how to configure private locations with the Checkly CLI. ## CLI Reference ### Getting Started - [Checkly CLI](https://www.checklyhq.com/docs/cli/overview.md): Code, test, and deploy synthetic monitoring at scale with the Checkly CLI. - [Intallation](https://www.checklyhq.com/docs/cli/installation.md): Creating a CLI project from scratch - [Authentication](https://www.checklyhq.com/docs/cli/authentication.md): How to authenticate with the Checkly CLI - [Environment Variables](https://www.checklyhq.com/docs/cli/environment-variables.md): Learn how to use environment variables in your Checkly project - [Using npm packages and local dependencies](https://www.checklyhq.com/docs/cli/dependencies.md): Use npm packages and local JavaScript or TypeScript files in your checks, and see how dependencies differ between Checkly runtimes and Playwright Check Suites. - [Attaching Git metadata](https://www.checklyhq.com/docs/cli/attaching-git-metadata.md): Attach git metadata like branch, commit SHA, and owner to your Checkly test sessions and deployments so you can cross-reference monitoring with code changes. - [Importing existing Checks into your CLI project](https://www.checklyhq.com/docs/cli/importing.md): Learn how to import checks from the UI into the CLI - [Manage monitoring through pull requests](https://www.checklyhq.com/docs/cli/monitoring-pull-requests.md): Export monitoring from the UI, review and test a GitHub pull request, then deploy the merged code with the Checkly CLI. - [CLI vs. Terraform & Pulumi](https://www.checklyhq.com/docs/cli/cli-vs-terraform-pulumi.md): Comparing your options for Monitoring as Code ### CLI Commands - [checkly account](https://www.checklyhq.com/docs/cli/checkly-account.md): View your Checkly account plan, entitlements, feature limits, and available locations. - [checkly alert-channels](https://www.checklyhq.com/docs/cli/checkly-alert-channels.md): List and inspect alert channels and their notification logs from the Checkly CLI. - [checkly api](https://www.checklyhq.com/docs/cli/checkly-api.md): Make authenticated HTTP requests to the Checkly API from the command line. - [checkly assets](https://www.checklyhq.com/docs/cli/checkly-assets.md): List and download result assets such as logs, traces, videos, and screenshots. - [checkly checks](https://www.checklyhq.com/docs/cli/checkly-checks.md): List, inspect, run, and analyze checks in your Checkly account. - [checkly deploy](https://www.checklyhq.com/docs/cli/checkly-deploy.md): Deploy checks and resources to your Checkly account. - [checkly destroy](https://www.checklyhq.com/docs/cli/checkly-destroy.md): Destroy all project resources from your Checkly account. - [checkly env](https://www.checklyhq.com/docs/cli/checkly-env.md): Manage the global variables of a Checkly account. - [checkly import](https://www.checklyhq.com/docs/cli/checkly-import.md): Import existing resources into your CLI-managed project. - [checkly incidents](https://www.checklyhq.com/docs/cli/checkly-incidents.md): Create, update, and resolve incidents on your status pages from the CLI. - [checkly init](https://www.checklyhq.com/docs/cli/checkly-init.md): Initialize Checkly in your project with interactive or AI-assisted onboarding. - [checkly login](https://www.checklyhq.com/docs/cli/checkly-login.md): Sign up for a new Checkly account or log in to your existing account. - [checkly logout](https://www.checklyhq.com/docs/cli/checkly-logout.md): Log out of your Checkly account. - [checkly members](https://www.checklyhq.com/docs/cli/checkly-members.md): List, update, and delete members in your Checkly account. - [checkly pw-test](https://www.checklyhq.com/docs/cli/checkly-pw-test.md): Run Playwright tests with Checkly monitoring features - [checkly rca](https://www.checklyhq.com/docs/cli/checkly-rca.md): Trigger and retrieve AI-powered root cause analyses for error groups. - [checkly runtimes](https://www.checklyhq.com/docs/cli/checkly-runtimes.md): List all available runtimes and their dependencies. - [checkly skills](https://www.checklyhq.com/docs/cli/checkly-skills.md): Print Checkly project, CLI and workflow context as Markdown for AI agents and LLMs. - [checkly status-pages](https://www.checklyhq.com/docs/cli/checkly-status-pages.md): List and inspect status pages in your Checkly account. - [checkly switch](https://www.checklyhq.com/docs/cli/checkly-switch.md): Switch between multiple Checkly accounts. - [checkly sync-playwright](https://www.checklyhq.com/docs/cli/checkly-sync-playwright.md): Synchronize Playwright configuration with Checkly settings. - [checkly test](https://www.checklyhq.com/docs/cli/checkly-test.md): Run checks in your project using the Checkly CLI. - [checkly test-sessions](https://www.checklyhq.com/docs/cli/checkly-test-sessions.md): Inspect recorded test sessions and their error groups. - [checkly trigger](https://www.checklyhq.com/docs/cli/checkly-trigger.md): Trigger checks already in your Checkly account. - [checkly whoami](https://www.checklyhq.com/docs/cli/checkly-whoami.md): Display current account and user information. - [API Reference (234 pages)](https://www.checklyhq.com/docs/_llms/api-reference.txt): Documentation for API Reference. ## Guides ### Getting Started - [Checkly guides](https://www.checklyhq.com/docs/guides/overview.md): Hands-on guides that take you from a first Checkly project to monitoring that detects failures, tells the right people, and helps you fix them. - [Structure a Checkly project for a real codebase](https://www.checklyhq.com/docs/guides/structuring-a-checkly-project.md): Organize checks by service with groups, keep shared settings in one config, and deploy monitoring from CI on every merge to main. - [Turn your Playwright tests into monitors](https://www.checklyhq.com/docs/guides/playwright-testing-to-monitoring.md): Run the Playwright tests you already have as scheduled production monitors with a Playwright Check Suite, without rewriting them. - [Control and Configure your Monitoring Infrastructure with AI](https://www.checklyhq.com/docs/guides/agentic-workflows.md): Thanks to Checkly's Monitoring as Code approach, LLMs and AI agents can set up, configure and control your entire monitoring setup. - [Why monitoring from around the globe is critical for modern organizations](https://www.checklyhq.com/docs/guides/global-monitoring.md): A monitor next to your servers sees your servers. Your users see DNS, CDN edges, transit routes, and regions. Run the same checks from where they are, in parallel, and let the regions vote before you get paged. ### Detect - [Cover every endpoint with uptime monitors](https://www.checklyhq.com/docs/guides/uptime-monitoring.md): Turn a list of public pages into URL monitors, tell slow from down, and watch the certificate every one of them depends on, all from a few lines of code. - [Monitor your API end to end](https://www.checklyhq.com/docs/guides/api-monitoring.md): Turn every endpoint into an API check that asserts on status, headers, and body, tells slow from down, authenticates in a setup script, and cleans up in a teardown. - [Monitor the content your customers need to see](https://www.checklyhq.com/docs/guides/keyword-monitoring.md): Assert that your best seller, offer banner, and call to action are on the page, in the right place, exactly once, and that error copy never is, with one Playwright test that runs every five minutes. - [Run checks on every deploy](https://www.checklyhq.com/docs/guides/sdlc-monitoring.md): Test pull request previews before merging, trigger deployed checks after production deployments, and record the commit, branch, and environment. - [How to Use Setup and Teardown Scripts for Better API Monitoring](https://www.checklyhq.com/docs/guides/setup-scripts-for-apis.md): Setup and teardown scripts are fundamental tools to tailor API checks to your target endpoints. This guide presents real-world examples to help you master these tools. ### Communicate - [Alerting that doesn't wake you up for nothing](https://www.checklyhq.com/docs/guides/alerting.md): Send failures to the right people, retry blips in place, escalate on consecutive runs, let regions vote, and mute planned deploys, all defined in code with the Checkly CLI. - [A status page backed by real monitors](https://www.checklyhq.com/docs/guides/communicate-availability.md): Build a public status page in code whose components go red when the checks that test them fail, and read and update its incidents from your coding agent with the Checkly MCP server. ### Resolve - [Debug a failed check](https://www.checklyhq.com/docs/guides/reading-traces.md): Go from a failing Playwright check to its root cause with the Checkly CLI, the Playwright trace in your terminal, and Rocky AI, then confirm the fix with a test run before you deploy. - [Send failed checks to a coding agent](https://www.checklyhq.com/docs/guides/agent-driven-repair.md): Start a Claude Code routine from a Checkly webhook alert channel when a check fails. The agent follows a runbook skill, investigates with the Checkly CLI, and opens a pull request for you to review. ### Examples - [In-Depth Monitoring With Checkly and Claude Code](https://www.checklyhq.com/docs/guides/claude-code-monitoring.md): By integrating AI into your development workflow, you can generate valid Checkly constructs—including URL monitors and Playwright-based browser checks—with minimal effort. - [Monitor a checkout flow](https://www.checklyhq.com/docs/guides/monitoring-ecommerce-apps-using-playwright.md): Cover browse, search, add to cart, and checkout on a shop with a Playwright Check Suite that asserts the order confirmation, uses safe test data, and runs against a per-environment base URL. - [Monitor a shop with Terraform](https://www.checklyhq.com/docs/guides/monitoring-ecommerce-apps-using-terraform.md): Declare a shop's whole monitoring stack in Terraform with the Checkly provider, from the alert channel and check group to Browser Checks loaded from spec files and an API check with body assertions. - [How to monitor the Stripe customer API with Checkly | API Monitoring Examples](https://www.checklyhq.com/docs/guides/monitoring-the-stripe-api.md): Application Programming Interfaces (APIs) are used throughout software to define interactions between different software applications. In this article we focus on web APIs specifically, taking a look at how they fit in the Jamstack architecture and how we can set up API monitoring in order to make s… - [How to Create an API Monitor using an OpenAPI (Swagger) Spec](https://www.checklyhq.com/docs/guides/monitoring-an-openapi-spec.md): OpenAPI and Swagger help users design and document APIs in a way that is readable from both humans and machines. As a consequence, they can also be used to generate the code that will run the specified API - both on the provider and consumer side. Can we leverage this same principle to simplify API… - [Learn (101 pages)](https://www.checklyhq.com/docs/_llms/learn.txt): Documentation for Learn. ## Comparisons ### Playwright Comparisons - [Playwright vs Cypress - Detailed comparison [2024]](https://www.checklyhq.com/docs/comparisons/frameworks/playwright-vs-cypress.md): Discover the differences between Playwright and Cypress. Explore key features, pros and cons, and how to pick the right framework. - [Playwright vs Selenium - Detailed Comparison for 2026](https://www.checklyhq.com/docs/comparisons/frameworks/playwright-vs-selenium.md): Compare Playwright and Selenium by language and browser support, waiting, test tooling, debugging, and mobile testing, with side-by-side examples. - [Playwright vs Puppeteer](https://www.checklyhq.com/docs/comparisons/frameworks/playwright-vs-puppeteer.md): Compare Playwright and Puppeteer by browser support, testing features, language support, and common use cases. ### Migrations - [The Complete Guide to Migrating from Puppeteer to Playwright](https://www.checklyhq.com/docs/comparisons/frameworks/moving-from-puppeteer-to-playwright.md): The switch from Puppeteer to Playwright is easy. But is it worth it? And how exactly does one migrate existing scripts from one tool to another? What are the required code-level changes, and what new features and approaches does the switch enable? ## OpenAPI Specs - [openapi](/docs/api-reference/openapi.json) - [openapi](/docs/samples/guides/api-monitoring/openapi.yaml) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Docs (209 pages)](https://www.checklyhq.com/docs/_llms/docs.txt): Documentation for Docs. - [API Reference (234 pages)](https://www.checklyhq.com/docs/_llms/api-reference.txt): Documentation for API Reference. - [Learn (101 pages)](https://www.checklyhq.com/docs/_llms/learn.txt): Documentation for Learn. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.