Table of contents

Getting Started

The Checkly CLI (now in beta) gives you a JavaScript/TypeScript-native workflow for coding, testing and deploying synthetic monitoring at scale, from your code base. We call this workflow monitoring as code (MaC).

• Unite E2E testing & monitoring in one workflow. No more silos between Dev, QA and Ops.
• Programmable, testable, reviewable. Works with your dev pipeline. From your IDE, via PR to CI.
• Native @playwright/test support. No lock-in, just write standard *.spec.ts files.
• Alerting baked in. Set alerts for Slack, SMS and many more channels.
• Typescript-first. Fully typed for a stellar developer experience with code completion.
• Run in the cloud or on-prem. Run on the Checkly cloud or in your network using the Private Locations

First, make sure you sign up for a free Checkly account.

Then, 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.

npm create @checkly/cli

Now, login to your Checkly account.

npx checkly login

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

npx checkly test

This should report the following output to your terminal

Running 5 checks in eu-west-1.

src/__checks__/group.check.ts
  ✔ Homepage - fetch stats (43ms)
src/__checks__/home.check.ts
  ✔ 404 page (7s)
  ✔ Homepage (7s)
src/services/api/api.check.ts
  ✔ Homepage - fetch stats (50ms)
src/services/docs/__checks__/docs-search.spec.ts
  ✔ docs-search.spec.ts (11s)

5 passed, 5 total

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

npx checkly deploy

✨Et voilà, you have just created your entire synthetic monitoring setup with API and Playwright-based Browser Checks from your code base! Open up your Checkly dashboard and you should see your Check, ready to start monitoring around the clock. ✨

For a custom installation check out our installation docs

You can contribute to this documentation by editing this page on Github