checkly

The Checkly CLI 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.
• Codeable, 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 easy refactoring and code completion.
• Run in the cloud or on-prem. Run on the Checkly cloud or in your network using the Private Locations

Installation

First, make sure you sign up for a free Checkly account or signup via the terminal using npx checkly login.

Then, the easiest way to get started is to install the CLI using the following command:

npm create checkly

This command will guide you through some simple steps and set up a fully working example project for you. Should take ~1 minute.

You can also set up the CLI from scratch by running:

npm install --save-dev checkly

Docs

Official docs are over at checklyhq.com/docs/cli

Need help?

• Check out our Getting Started Guide
• Join our Slack Community. The devs who built this hang out there.
• Found a bug? File an issue on this repo

Local Development

Use CHECKLY_CLI_VERSION environment variable to set the latest version you want to test.

To get started with local development check CONTRIBUTING.MD