Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
246 changes: 185 additions & 61 deletions index.mdx
Original file line number Diff line number Diff line change
@@ -1,98 +1,222 @@
---
title: 'Checkly Documentation'
sidebarTitle: 'Home'
description: 'The AI Native Application Reliability Platform built for modern engineering teams.'
mode: "wide"
mode: "frame"
canonical: 'https://www.checklyhq.com/docs/'

---


## Ready to get started?

Checkly combines **testing**, **monitoring**, and **incident communication** <br />into a single platform to help you catch issues before your users do.

<Columns cols={2}>
<Card title="What is Checkly?" icon="rocket" href="/what-is-checkly">
Learn more about how Checkly works for modern teams.
</Card>

<Card title="Quick Start" icon="bolt" href="/quickstart">
Get up and running with tests and monitors deployed in 5 minutes.
</Card>
</Columns>

---

## Product Documentation
<Visibility for="agents">
> **For AI agents:** Start with [llms.txt](https://www.checklyhq.com/docs/llms.txt) for the full documentation index. Append `.md` to any docs URL to get its Markdown. To set Checkly up in a project, follow the [Quickstart](https://www.checklyhq.com/docs/quickstart.md).

# Checkly Documentation

Checkly is the Application Reliability Platform for engineering teams: Playwright-powered monitors defined in TypeScript, run from global locations, with traces for every failure.

## Onboard your agent

Run this in your project directory. It installs the Checkly CLI and [Checkly Skills](/ai/skills), creates a `checkly.config.ts`, and copies a starter prompt for your coding agent:

```bash
npx checkly init
```

## Installation

**Checkly CLI**

```bash
npm install --save-dev checkly
```

**Checkly Skills** for Claude Code, Cursor, Codex, and other agents

```bash
npx checkly skills install
```

## Explore the platform

- [Detect](/detect/overview): synthetic monitoring, uptime monitoring, and testing
- [Communicate](/communicate/overview): alerts, status pages, and dashboards
- [Resolve](/resolve/overview): traces, Rocky AI root cause analysis, and debugging

## Developer resources

- [Constructs reference](/constructs/overview)
- [CLI reference](/cli/overview)
- [API reference](/api-reference/overview)
- [Guides](/guides/)
- [Checkly for AI agents](/ai/overview)
</Visibility>

<Visibility for="humans">
<div className="home">

<div className="home-hero">
<img className="home-hero-mark" src="/images/racoon_logo.svg" alt="Checkly logo" noZoom />
<h1 className="home-title">Detect, Communicate, and Resolve.<br />All as code.</h1>
<p className="home-subtitle">Checkly is the Application Reliability Platform for engineering teams. Define Playwright-powered monitors in TypeScript, run them from locations around the globe, and trace every failure back to the root cause.</p>
<div className="home-hero-actions">
<a className="home-button" href="/quickstart">Start in 5 minutes</a>
<a className="home-button home-button-secondary" href="/what-is-checkly">What is Checkly?</a>
</div>
</div>

<div className="home-section home-section-lead">
<p className="home-eyebrow">Agent-first setup</p>
<h2 className="home-heading">Let your AI agent set up Checkly</h2>
<p className="home-lead">Run this in a project you already have. It installs the Checkly CLI and [Checkly Skills](/ai/skills), scaffolds a `checkly.config.ts`, and copies a starter prompt for Claude Code, Cursor, Codex, or any agent that supports skills. Your agent scans the project, writes monitors, tests them, and deploys after you confirm.</p>

```bash Terminal
npx checkly init
```

<p className="home-footnote">Prefer to do it by hand? Every step is in the [Quickstart](/quickstart).</p>
</div>

<div className="home-section">
<p className="home-eyebrow">Monitoring as Code</p>
<h2 className="home-heading">Monitors are code. Write one.</h2>
<p className="home-lead">A check is a TypeScript file in your repo, versioned and reviewed like the rest of your code. Browser Checks are plain `@playwright/test` specs, so the tests you already have can become production monitors.</p>

<Tabs>
<Tab title="Browser Check" icon="window">
```ts __checks__/homepage.spec.ts
import { test, expect } from '@playwright/test'

test('homepage loads', async ({ page }) => {
const response = await page.goto('https://www.checklyhq.com')
expect(response?.status()).toBeLessThan(400)
await expect(page).toHaveTitle(/Checkly/)
})
```
</Tab>
<Tab title="API Check" icon="code">
```ts __checks__/runtimes-api.check.ts
import { ApiCheck, AssertionBuilder } from 'checkly/constructs'

new ApiCheck('runtimes-api', {
name: 'Runtimes API',
request: {
method: 'GET',
url: 'https://api.checklyhq.com/v1/runtimes',
assertions: [AssertionBuilder.statusCode().equals(200)],
},
})
```
</Tab>
<Tab title="URL Monitor" icon="globe">
```ts __checks__/homepage.check.ts
import { Frequency, UrlAssertionBuilder, UrlMonitor } from 'checkly/constructs'

new UrlMonitor('homepage-uptime', {
name: 'Homepage uptime',
frequency: Frequency.EVERY_1M,
request: {
url: 'https://www.checklyhq.com',
assertions: [UrlAssertionBuilder.statusCode().equals(200)],
},
})
```
</Tab>
<Tab title="Heartbeat Monitor" icon="heart-pulse">
```ts __checks__/nightly-backup.check.ts
import { HeartbeatMonitor } from 'checkly/constructs'

new HeartbeatMonitor('nightly-backup', {
name: 'Nightly backup job',
period: 1,
periodUnit: 'days',
grace: 2,
graceUnit: 'hours',
})
```
</Tab>
</Tabs>

<p className="home-lead home-lead-spaced">Then run it from Checkly's global infrastructure, and ship it when it passes.</p>
<div className="home-install">
<div>
<p className="home-install-label"><Icon icon="flask" size={16} /> Test from the terminal or CI</p>

```bash Terminal
npx checkly test
```

</div>
<div>
<p className="home-install-label"><Icon icon="rocket" size={16} /> Deploy as always-on monitors</p>

```bash Terminal
npx checkly deploy
```

</div>
</div>
</div>

<div className="home-section">
<p className="home-eyebrow">The platform</p>
<h2 className="home-heading">Detect. Communicate. Resolve.</h2>
<p className="home-lead">The full reliability loop, from catching an issue before your users do to knowing why it happened.</p>

<Columns cols={3}>
<Card title="Detect" href="/detect/overview" img="/images/Detect.svg">
Detect issues before they happen with multiple layers of detection from around the globe.
Playwright Browser Checks, API Checks, and uptime monitors that run from locations around the globe.
</Card>

<Card title="Communicate" href="/communicate/overview" img="/images/Communicate.svg">
Get notified when issues happen with smart alerting, status pages, and dashboards.
Alerts with retries and escalation, plus status pages and dashboards for your team and your users.
</Card>

<Card title="Resolve" href="/resolve/overview" img="/images/Resolve.svg">
Debug issues with distributed OTel tracing, AI-powered insights, and performance analysis.
OpenTelemetry traces linked to every failed run, and Rocky AI to pinpoint the root cause.
</Card>
</Columns>
</div>

---

## Developer Tools Documentation
<div className="home-section">
<p className="home-eyebrow">Reference</p>
<h2 className="home-heading">Developer resources</h2>

<Columns cols={3}>
<Card title="Constructs" icon="building-columns" href="/constructs/overview">
Build and deploy monitoring infrastructure with reusable code constructs.
Every check, alert channel, and status page you can define in code.
</Card>

<Card title="CLI" icon="terminal" href="/cli/overview">
Get everything you need to monitor and test your applications continuously with the Checkly CLI.
Test, deploy, and manage your monitoring from the terminal or CI.
</Card>

<Card title="API" icon="code" href="/api-reference/overview">
Extend the Checkly platform with our powerful REST API and SDKs.
Extend the Checkly platform with the REST API.
</Card>
</Columns>

---

## Learn More

<Columns cols={3}>
<Card title="Learn" icon="graduation-cap" href="/learn/overview">
Learn the fundamentals of reliability and how to build a reliable application.
<Card title="Guides" icon="book-open" href="/guides/">
Tutorials that turn a real codebase into a monitored one.
</Card>

<Card title="Guides" icon="book-open" href="/guides/">
Implementation tutorials, best practices, and real-world examples.
<Card title="AI" icon="sparkles" href="/ai/overview">
Skills, the MCP server, and Rocky AI for agent-driven monitoring.
</Card>

<Card title="Community" icon="slack" href="https://www.checklyhq.com/slack/">
Ask questions and get help from the Checkly team and other users.
</Card>
</Columns>

---

## Quick Links

<Columns cols={4}>
<Card title="What is Checkly?" icon="circle-info" href="/what-is-checkly">
Platform overview
</Card>

<Card title="Structure a Checkly project" icon="folder-tree" href="/guides/structuring-a-checkly-project">
Organize monitoring for a real codebase
</Card>

<Card title="Set up Alerts" icon="bell" href="/communicate/overview">
Get notified
</Card>

<Card title="Turn Playwright tests into monitors" icon="masks-theater" href="/guides/playwright-testing-to-monitoring">
Reuse your existing Playwright tests
</Card>
</Columns>
</div>

<div className="home-section">
<div className="sign-up-cta">
<div className="sign-up-cta-title">
Bugs don't stop at CI/CD. Why would Playwright? <img src="/images/icons/playwright.svg" alt="Playwright logo" noZoom />
</div>
<div className="sign-up-cta-body">
<a href="https://app.checklyhq.com/signup" target="_blank">Sign up</a> and start using Playwright for end-to-end monitoring with Checkly.
</div>
</div>
</div>

</div>
</Visibility>
Loading
Loading