See the general quickstart guide if you want to start creating your monitoring in the Checkly app first.
The Checkly CLI enables monitoring as code, allowing you to create, test, and deploy synthetic monitoring checks directly from your codebase. Write checks in JavaScript/TypeScript, test them locally, and deploy them to Checkly’s global monitoring infrastructure.

Installing

Recommended approach: Create a new project with the CLI:
Terminal
npm create checkly@latest
Alternative: Install as a dev dependency in existing projects:
Terminal
npm install --save-dev checkly
Recommended: Install jiti to use TypeScript for your Checkly monitoring setup.
Terminal
npm i --save-dev jiti
Then, discover all available commands using:
Terminal
npx checkly --help

Checking the Version

Terminal
npx checkly --version

Command Reference

Authentication & Account Management

Development & Testing

Deployment & Management

Environment & Import

Next Steps

  1. Authenticate - Get started with the CLI
  2. Create your first test - Write and test a check locally
  3. Deploy your monitoring - Push checks to Checkly