> ## Documentation Index
> Fetch the complete documentation index at: https://checklyhq.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Checkly CLI

> Code, test, and deploy synthetic monitoring at scale with the Checkly CLI.

The Checkly CLI gives you a JavaScript/TypeScript-native workflow for coding, testing and deploying synthetic
monitoring at scale, from your code base. The Checkly CLI comes with **native `@playwright/test` support.** No lock-in,
just write standard `*.spec.ts` files.

## Starting your first project

Get started by installing the CLI using the following command which will guide you through the required steps to
set up a fully working example.

```bash Terminal theme={null}
npx checkly init
```

Now, login to your Checkly account or sign up for a new account right from the terminal.

```bash Terminal theme={null}
npx checkly login
```

After this, let's dry run the Checks in your new project against the global Checkly infrastructure.

```bash Terminal theme={null}
npx checkly test
```

This should report the following output to your terminal

```
Running 4 checks in eu-west-1.

src/__checks__/api.check.ts
  ✔ Books API (222ms)
src/__checks__/home.check.ts
  ✔ Home page (24s)
  ✔ Login Check (5s)
src/__checks__/multi-step-spacex.check.ts
  ✔ SpaceX MS (4s)

4 passed, 4 total
```

Lastly, you deploy your Checks and related alert channels to Checkly, so we run your checks around the clock.

```bash Terminal theme={null}
npx checkly deploy
```

You just created your entire synthetic monitoring setup with API and Playwright-based Browser Checks from your code base!
Open up [your Checkly dashboard](https://app.checklyhq.com) and you should see your check, ready to start monitoring around the clock.

For a custom installation check out [our installation docs](/cli/installation/).

## Using Agents, AI IDEs and Copilots

Checkly is designed to work with Agents, AI IDEs, and Copilots. You can use your preferred provider to generate code for API
Checks, Browser Checks and all other constructs.

<Columns cols={2}>
  <Card title="Checkly Skills" href="/ai/skills">
    Install Checkly Skills and let AI agents generate Checkly monitoring code for you.
  </Card>

  <Card title="Checkly Rules" href="/ai/rules">
    Include the Checkly Rules in your conversations to generate Checkly monitoring code for you.
  </Card>
</Columns>

## Integrating with CI/CD

After kicking the tires, you should delegate the testing and deploying of your checks to your CI/CD pipeline. Check our
docs on [setting up the Checkly CLI with your favourite CI/CD platform](/integrations/ci-cd/overview).

<Columns cols={3}>
  <Card title="GitHub Actions" icon="https://mintcdn.com/checkly-422f444a/oKreJ12T0nCfIDb_/images/github-icon-dark.svg?fit=max&auto=format&n=oKreJ12T0nCfIDb_&q=85&s=0bc77a059e229683529c21f9b82802eb" href="/integrations/ci-cd/github/actions" width="24" height="24" data-path="images/github-icon-dark.svg">
    Run the Checkly CLI from GitHub Actions, export summary reports and integrate with mono repos
  </Card>

  <Card title="GitLab CI" icon="https://mintcdn.com/checkly-422f444a/oKreJ12T0nCfIDb_/images/gitlab-logo.svg?fit=max&auto=format&n=oKreJ12T0nCfIDb_&q=85&s=96c98815fc48031fa17179d32b410a0b" href="/integrations/ci-cd/gitlab/overview" width="128" height="128" data-path="images/gitlab-logo.svg">
    Run the Checkly CLI from GitLab CI pipelines, using separate e2e-test and deploy jobs.
  </Card>

  <Card title="Jenkins" icon="https://mintcdn.com/checkly-422f444a/Vk5L_RINdMXmLv3a/images/jenkins-logo.svg?fit=max&auto=format&n=Vk5L_RINdMXmLv3a&q=85&s=121115e043f8b4bc749a4b14dba54f66" href="/integrations/ci-cd/jenkins/overview" width="180" height="180" data-path="images/jenkins-logo.svg">
    Run the Checkly CLI from a Jenkins pipeline using a Jenkinsfile.
  </Card>
</Columns>
