{"id":20390479,"url":"https://github.com/checkly/checkly-advanced-cli-project-js","last_synced_at":"2025-08-24T08:14:47.035Z","repository":{"id":188303498,"uuid":"646244194","full_name":"checkly/checkly-advanced-cli-project-js","owner":"checkly","description":null,"archived":false,"fork":false,"pushed_at":"2023-06-08T15:01:37.000Z","size":60,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-25T10:56:18.571Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/checkly.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-05-27T18:47:17.000Z","updated_at":"2023-06-09T15:27:38.000Z","dependencies_parsed_at":"2023-08-14T20:55:04.672Z","dependency_job_id":null,"html_url":"https://github.com/checkly/checkly-advanced-cli-project-js","commit_stats":null,"previous_names":["checkly/checkly-advanced-cli-project-js"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-advanced-cli-project-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-advanced-cli-project-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-advanced-cli-project-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-advanced-cli-project-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/checkly","download_url":"https://codeload.github.com/checkly/checkly-advanced-cli-project-js/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241940579,"owners_count":20045883,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T03:25:10.722Z","updated_at":"2025-03-05T00:12:12.644Z","avatar_url":"https://github.com/checkly.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Checkly Monitoring-as-code: Advanced Project\n\nThis example project shows how you can use the Checkly CLI in a monitoring as code (MaC) workflow. We are using the\nhttps://checklyhq.com website as a monitoring target.\n\n1. Write API Checks and Playwright-powered Browser Checks.\n2. Add Alert Channels, and dry-run your Checks on 20+ global locations.\n3. Test -\u003e Deploy: now you have your app monitored around the clock. All from your code base.\n\n```\nnpm create checkly -- --template advanced-project\n```\n\n## Project Structure\n\nThis project mimics a typical app where you organize code with top-level defaults and per page, service or component checks.\n\n```\n.\n├── .github\n│   └── workflow.yml\n├── README.md\n├── checkly.config.js\n├── package.json\n└── src\n    ├── __checks__\n    │   ├── api.check.js\n    │   ├── home.check.js\n    │   ├── homepage.spec.js\n    │   ├── login.spec.js\n    │   ├── utils\n    │   │   ├── auth-client.js\n    │   │   └── setup.js\n    │   └── website-group.check.js\n    ├── alert-channels.js\n    ├── defaults.js\n    └── services\n        ├── api\n        │   └── __checks__\n        │       └── api.check.js\n        └── top-sellers\n            └── __checks__\n                └── top-sellers.spec.js\n```\n\n- Running `npx checkly test` will look for `.check.js` files and `.spec.js` in `__checks__` directories and execute them in a dry run.\n\n- Running `npx check deploy` will deploy your checks to Checkly, attach alert channels, and run them on a 10m schedule in the \nregion `us-east-1` and `eu-west-1`\n\n- An example GitHub Actions workflow is in the `.github/workflow.yml` file. It triggers all the checks in the project and deploys\nthem if they pass.\n\n## CLI Commands\n\nRun the core CLI commands with `npx checkly \u003ccommand\u003e` \n\n| Command              | Action                                           |\n|:---------------------|:-------------------------------------------------|\n| `npx checkly test`   | Dry run all the checks in your project           |\n| `npx checkly deploy` | Deploy your checks to the Checkly cloud          |\n| `npx checkly login`  | Log in to your Checkly account                   |\n| `npx checkly --help` | Show help for each command.                      |\n\n[Check the docs for the full CLI reference](https://www.checklyhq.com/docs/cli/command-line-reference/).\n\n## Adding and running `@playwright/test`\n\nYou can add `@playwright/test` to this project to get full code completion and run `.spec.js` files for local debugging.\nIt's best to install the Playwright npm package version that matches your [Checkly runtime](https://www.checklyhq.com/docs/cli/npm-packages/).\n\n```bash\nnpm install --save-dev @playwright/test@1.28.0\n```\n\n## Questions?\n\nCheck [our CLI docs](https://www.checklyhq.com/docs/cli/), the [main Checkly docs](https://checklyhq.com/docs) or \njoin our [Slack community](https://checklyhq.com/slack).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckly%2Fcheckly-advanced-cli-project-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheckly%2Fcheckly-advanced-cli-project-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckly%2Fcheckly-advanced-cli-project-js/lists"}