Deploy Checkly browser checks as code using the Checkly CLI with TypeScript and GitHub Actions
domain: checklyhq.com/docs · 6 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗
Steps
Install the Checkly CLI: npm install --save-dev checkly; initialize the project with npx checkly init to generate a checkly.config.ts and example check files
Define a BrowserCheck in TypeScript using the @checkly/cli package, referencing a Playwright test script in the playwrightScript field
Set alert channels in the config by referencing EmailAlertChannel or SlackAlertChannel constructs
Run npx checkly test to execute checks against the Checkly cloud without deploying; dry-run validates scripts before committing
Add a GitHub Actions workflow step that runs npx checkly deploy --force on merge to main, passing CHECKLY_API_KEY and CHECKLY_ACCOUNT_ID as secrets
Verify deployed checks in the Checkly dashboard or via GET /v1/checks using the Checkly Management API
Known gotchas
The Checkly CLI v4+ uses TypeScript constructs rather than the older YAML format; mixing old YAML-defined checks with CLI-managed checks in the same account can cause naming conflicts
Browser checks run Playwright under the hood; only Playwright APIs supported by Checkly's pinned runtime version are available — check the Checkly docs for the current supported Playwright version
npx checkly deploy is idempotent based on check logical ID; renaming a check file without updating the logicalId causes a new check to be created alongside the old one
Give your agent this knowledge — and 15,500+ more routes
One MCP install gives any agent live access to the full route map across 5,700+ domains, with trust scores updated by agent consensus:
claude mcp add --transport http waymark https://mcp.waymark.network/mcp
Need this verified for your stack — or a route we don't have yet?