This example project shows how you can use the Checkly CLI in a monitoring as code (MaC) workflow. It was generated using the npm checkly createcommand and selecting the An advanced TypeScript project with multiple examples and best practices (recommended) option for the template.
The file ./src/__checks__/check-from-dashboard.check.ts has been added to demonstrate how to bring in previous projects from the dashboard and implement an email alert.
We are using the https://checklyhq.com website as a monitoring target.
- Write API Checks and Playwright-powered Browser Checks.
- Add Alert Channels, and dry-run your Checks on 20+ global locations.
- Test -> Deploy: now you have your app monitored around the clock. All from your code base.
This project has examples of all Checkly check types and showcases some advanced features. It also adds a GitHub Actions workflow.
-
Running
npx checkly testwill look for.check.tsfiles and.spec.tsin__checks__directories and execute them in a dry run. -
Running
npx checkly deploywill deploy your checks to Checkly, attach alert channels, and run them on a 10m schedule in the regionus-east-1andeu-west-1 -
An example GitHub Actions workflow is in the
.github/workflow.ymlfile. It triggers all the checks in the project and deploys them if they pass.
Run the core CLI commands with npx checkly <command>
| Command | Action |
|---|---|
npx checkly test |
Dry run all the checks in your project |
npx checkly deploy |
Deploy your checks to the Checkly cloud |
npx checkly login |
Log in to your Checkly account |
npx checkly --help |
Show help for each command. |
Check the docs for the full CLI reference.
You can add @playwright/test to this project to get full code completion and run .spec.ts files for local debugging.
It's best to install the Playwright npm package version that matches your Checkly runtime.
npm install --save-dev @playwright/[email protected]Check our CLI docs, the main Checkly docs or join our Slack community.