This repository contains a Checkly Monitoring-as-Code project that is ready to be cloned and deployed to a checkly account. Getting started is as simple as:
- Cloning this repository
- Installing all dependencies with
npm i - Connecting to your checkly account with
npx checkly login - Start adding your Playwright Tests!
Running npx checkly test will look for any .spec.ts in src/__checks__ directories and execute them in a dry run. We have added a playwright-tests/ sub directory along with example tests to get you started.
Running npx checkly deploy will deploy your checks to Checkly, and run them on a 12 hour schedule.
Note: This scheduled time for tests along with other default configurations can be changed in the
checkly.config.tsfile. For more information on core settings and defaults please refer to the Checkly documentation on the topic here
We have added a Github Actions workflow which automatically runs your checks and deploys to Checkly whenever you run the command git push.
To allow Github Actions to authenticate your Checkly account, make sure to set the CHECKLY_API_KEY and CHECKLY_ACCOUNT_ID parameters as environment variables. You can find your Account ID in your Checkly dashboard by selecting your profile on the top right and going to your account settings. You can create an API Key by following these steps.
Be sure to add these as secrets to your Github Action settings.
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.
Check our CLI docs, the main Checkly docs or join our Slack community.