README.md

Checkly Monitoring-as-code Workshop

This project is part of the "Monitoring as Code with Checkly" workshop. Run the examples as follows:

git clone https://github.com/checkly/mac-workshop.git
cd mac-workshop
npm install

Make sure you are logged into your checkly account:

npx checkly login

Run the first example:

npx checkly test _1

Project Structure

This project has the following file structure

.
├── README.md
├── __checks__
│   ├── api.check.ts
│   └── homepage.spec.ts
├── checkly.config.ts
└── package.json

• Running npx checkly test will look for .check.ts files and .spec.ts in __checks__ directories and execute them in a dry run.

• Running npx checkly deploy will deploy your checks to Checkly, attach alert channels, and run them on a 10m schedule in the region us-east-1 and eu-west-1

CLI Commands

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.

Adding and running @playwright/test

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/test@1.38.1

Questions?

Check our CLI docs, the main Checkly docs or join our Slack community.