checkly 0.0.0-canary.7166ed8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +117 -0
- package/assets/runtimes/snapshots/20260130/runtimes.json +349 -0
- package/bin/run +8 -0
- package/bin/run.cmd +3 -0
- package/constructs.d.ts +1 -0
- package/constructs.js +2 -0
- package/dist/ai-context/checkly.rules.md +916 -0
- package/dist/ai-context/context.d.ts +150 -0
- package/dist/ai-context/context.js +263 -0
- package/dist/ai-context/context.js.map +1 -0
- package/dist/ai-context/onboarding-boilerplate/__checks__/api.check.ts +22 -0
- package/dist/ai-context/onboarding-boilerplate/__checks__/heartbeat.check.ts +16 -0
- package/dist/ai-context/onboarding-boilerplate/__checks__/homepage.spec.ts +12 -0
- package/dist/ai-context/onboarding-boilerplate/__checks__/url.check.ts +18 -0
- package/dist/ai-context/onboarding-boilerplate/checkly-config-template.ts +50 -0
- package/dist/ai-context/onboarding-prompts/base.md +1 -0
- package/dist/ai-context/onboarding-prompts/playwright.md +1 -0
- package/dist/ai-context/public-skills/checkly/README.md +43 -0
- package/dist/ai-context/public-skills/checkly/SKILL.md +112 -0
- package/dist/ai-context/skills-command/references/communicate-incidents.md +79 -0
- package/dist/ai-context/skills-command/references/communicate.md +33 -0
- package/dist/ai-context/skills-command/references/configure-agentic-checks.md +65 -0
- package/dist/ai-context/skills-command/references/configure-alert-channels.md +54 -0
- package/dist/ai-context/skills-command/references/configure-api-checks.md +73 -0
- package/dist/ai-context/skills-command/references/configure-browser-checks.md +36 -0
- package/dist/ai-context/skills-command/references/configure-check-groups.md +16 -0
- package/dist/ai-context/skills-command/references/configure-dns-monitors.md +39 -0
- package/dist/ai-context/skills-command/references/configure-environment.md +92 -0
- package/dist/ai-context/skills-command/references/configure-heartbeat-monitors.md +28 -0
- package/dist/ai-context/skills-command/references/configure-icmp-monitors.md +42 -0
- package/dist/ai-context/skills-command/references/configure-multistep-checks.md +34 -0
- package/dist/ai-context/skills-command/references/configure-playwright-checks.md +70 -0
- package/dist/ai-context/skills-command/references/configure-supporting-constructs.md +120 -0
- package/dist/ai-context/skills-command/references/configure-tcp-monitors.md +41 -0
- package/dist/ai-context/skills-command/references/configure-url-monitors.md +40 -0
- package/dist/ai-context/skills-command/references/configure.md +152 -0
- package/dist/ai-context/skills-command/references/initialize.md +134 -0
- package/dist/ai-context/skills-command/references/investigate-checks.md +156 -0
- package/dist/ai-context/skills-command/references/investigate-test-sessions.md +165 -0
- package/dist/ai-context/skills-command/references/investigate.md +15 -0
- package/dist/ai-context/skills-command/references/manage-account-members.md +82 -0
- package/dist/ai-context/skills-command/references/manage-plan.md +49 -0
- package/dist/ai-context/skills-command/references/manage.md +53 -0
- package/dist/auth/index.d.ts +15 -0
- package/dist/auth/index.js +226 -0
- package/dist/auth/index.js.map +1 -0
- package/dist/commands/account/plan.d.ts +18 -0
- package/dist/commands/account/plan.js +113 -0
- package/dist/commands/account/plan.js.map +1 -0
- package/dist/commands/alert-channels/get.d.ts +14 -0
- package/dist/commands/alert-channels/get.js +50 -0
- package/dist/commands/alert-channels/get.js.map +1 -0
- package/dist/commands/alert-channels/list.d.ts +13 -0
- package/dist/commands/alert-channels/list.js +64 -0
- package/dist/commands/alert-channels/list.js.map +1 -0
- package/dist/commands/alert-channels/logs.d.ts +19 -0
- package/dist/commands/alert-channels/logs.js +91 -0
- package/dist/commands/alert-channels/logs.js.map +1 -0
- package/dist/commands/api.d.ts +23 -0
- package/dist/commands/api.js +205 -0
- package/dist/commands/api.js.map +1 -0
- package/dist/commands/assets/download.d.ts +19 -0
- package/dist/commands/assets/download.js +170 -0
- package/dist/commands/assets/download.js.map +1 -0
- package/dist/commands/assets/list.d.ts +17 -0
- package/dist/commands/assets/list.js +107 -0
- package/dist/commands/assets/list.js.map +1 -0
- package/dist/commands/authCommand.d.ts +14 -0
- package/dist/commands/authCommand.js +49 -0
- package/dist/commands/authCommand.js.map +1 -0
- package/dist/commands/baseCommand.d.ts +23 -0
- package/dist/commands/baseCommand.js +93 -0
- package/dist/commands/baseCommand.js.map +1 -0
- package/dist/commands/checks/delete.d.ts +15 -0
- package/dist/commands/checks/delete.js +65 -0
- package/dist/commands/checks/delete.js.map +1 -0
- package/dist/commands/checks/get.d.ts +30 -0
- package/dist/commands/checks/get.js +361 -0
- package/dist/commands/checks/get.js.map +1 -0
- package/dist/commands/checks/list.d.ts +18 -0
- package/dist/commands/checks/list.js +124 -0
- package/dist/commands/checks/list.js.map +1 -0
- package/dist/commands/checks/stats.d.ts +22 -0
- package/dist/commands/checks/stats.js +181 -0
- package/dist/commands/checks/stats.js.map +1 -0
- package/dist/commands/debug/parse-file.d.ts +13 -0
- package/dist/commands/debug/parse-file.js +74 -0
- package/dist/commands/debug/parse-file.js.map +1 -0
- package/dist/commands/debug/parse-playwright-config.d.ts +9 -0
- package/dist/commands/debug/parse-playwright-config.js +27 -0
- package/dist/commands/debug/parse-playwright-config.js.map +1 -0
- package/dist/commands/debug/parse-project.d.ts +43 -0
- package/dist/commands/debug/parse-project.js +187 -0
- package/dist/commands/debug/parse-project.js.map +1 -0
- package/dist/commands/deploy.d.ts +20 -0
- package/dist/commands/deploy.js +341 -0
- package/dist/commands/deploy.js.map +1 -0
- package/dist/commands/destroy.d.ts +12 -0
- package/dist/commands/destroy.js +76 -0
- package/dist/commands/destroy.js.map +1 -0
- package/dist/commands/env/add.d.ts +14 -0
- package/dist/commands/env/add.js +54 -0
- package/dist/commands/env/add.js.map +1 -0
- package/dist/commands/env/ls.d.ts +8 -0
- package/dist/commands/env/ls.js +20 -0
- package/dist/commands/env/ls.js.map +1 -0
- package/dist/commands/env/pull.d.ts +14 -0
- package/dist/commands/env/pull.js +72 -0
- package/dist/commands/env/pull.js.map +1 -0
- package/dist/commands/env/rm.d.ts +13 -0
- package/dist/commands/env/rm.js +46 -0
- package/dist/commands/env/rm.js.map +1 -0
- package/dist/commands/env/update.d.ts +15 -0
- package/dist/commands/env/update.js +55 -0
- package/dist/commands/env/update.js.map +1 -0
- package/dist/commands/help.d.ts +6 -0
- package/dist/commands/help.js +11 -0
- package/dist/commands/help.js.map +1 -0
- package/dist/commands/import/apply.d.ts +14 -0
- package/dist/commands/import/apply.js +125 -0
- package/dist/commands/import/apply.js.map +1 -0
- package/dist/commands/import/cancel.d.ts +12 -0
- package/dist/commands/import/cancel.js +91 -0
- package/dist/commands/import/cancel.js.map +1 -0
- package/dist/commands/import/commit.d.ts +14 -0
- package/dist/commands/import/commit.js +109 -0
- package/dist/commands/import/commit.js.map +1 -0
- package/dist/commands/import/plan.d.ts +23 -0
- package/dist/commands/import/plan.js +1273 -0
- package/dist/commands/import/plan.js.map +1 -0
- package/dist/commands/incidents/create.d.ts +17 -0
- package/dist/commands/incidents/create.js +102 -0
- package/dist/commands/incidents/create.js.map +1 -0
- package/dist/commands/incidents/list.d.ts +14 -0
- package/dist/commands/incidents/list.js +80 -0
- package/dist/commands/incidents/list.js.map +1 -0
- package/dist/commands/incidents/resolve.d.ts +16 -0
- package/dist/commands/incidents/resolve.js +78 -0
- package/dist/commands/incidents/resolve.js.map +1 -0
- package/dist/commands/incidents/update.d.ts +18 -0
- package/dist/commands/incidents/update.js +105 -0
- package/dist/commands/incidents/update.js.map +1 -0
- package/dist/commands/init.d.ts +23 -0
- package/dist/commands/init.js +273 -0
- package/dist/commands/init.js.map +1 -0
- package/dist/commands/login.d.ts +14 -0
- package/dist/commands/login.js +96 -0
- package/dist/commands/login.js.map +1 -0
- package/dist/commands/logout.d.ts +10 -0
- package/dist/commands/logout.js +38 -0
- package/dist/commands/logout.js.map +1 -0
- package/dist/commands/members/delete.d.ts +18 -0
- package/dist/commands/members/delete.js +73 -0
- package/dist/commands/members/delete.js.map +1 -0
- package/dist/commands/members/update.d.ts +21 -0
- package/dist/commands/members/update.js +104 -0
- package/dist/commands/members/update.js.map +1 -0
- package/dist/commands/members.d.ts +23 -0
- package/dist/commands/members.js +136 -0
- package/dist/commands/members.js.map +1 -0
- package/dist/commands/pw-test.d.ts +34 -0
- package/dist/commands/pw-test.js +378 -0
- package/dist/commands/pw-test.js.map +1 -0
- package/dist/commands/rca/get.d.ts +15 -0
- package/dist/commands/rca/get.js +69 -0
- package/dist/commands/rca/get.js.map +1 -0
- package/dist/commands/rca/run.d.ts +16 -0
- package/dist/commands/rca/run.js +113 -0
- package/dist/commands/rca/run.js.map +1 -0
- package/dist/commands/rules.d.ts +10 -0
- package/dist/commands/rules.js +127 -0
- package/dist/commands/rules.js.map +1 -0
- package/dist/commands/runtimes.d.ts +8 -0
- package/dist/commands/runtimes.js +25 -0
- package/dist/commands/runtimes.js.map +1 -0
- package/dist/commands/skills/index.d.ts +12 -0
- package/dist/commands/skills/index.js +108 -0
- package/dist/commands/skills/index.js.map +1 -0
- package/dist/commands/skills/install.d.ts +23 -0
- package/dist/commands/skills/install.js +203 -0
- package/dist/commands/skills/install.js.map +1 -0
- package/dist/commands/status-pages/get.d.ts +14 -0
- package/dist/commands/status-pages/get.js +48 -0
- package/dist/commands/status-pages/get.js.map +1 -0
- package/dist/commands/status-pages/list.d.ts +14 -0
- package/dist/commands/status-pages/list.js +82 -0
- package/dist/commands/status-pages/list.js.map +1 -0
- package/dist/commands/switch.d.ts +10 -0
- package/dist/commands/switch.js +53 -0
- package/dist/commands/switch.js.map +1 -0
- package/dist/commands/sync-playwright.d.ts +8 -0
- package/dist/commands/sync-playwright.js +53 -0
- package/dist/commands/sync-playwright.js.map +1 -0
- package/dist/commands/test-sessions/get.d.ts +21 -0
- package/dist/commands/test-sessions/get.js +121 -0
- package/dist/commands/test-sessions/get.js.map +1 -0
- package/dist/commands/test-sessions/list.d.ts +22 -0
- package/dist/commands/test-sessions/list.js +190 -0
- package/dist/commands/test-sessions/list.js.map +1 -0
- package/dist/commands/test.d.ts +37 -0
- package/dist/commands/test.js +390 -0
- package/dist/commands/test.js.map +1 -0
- package/dist/commands/trigger.d.ts +40 -0
- package/dist/commands/trigger.js +241 -0
- package/dist/commands/trigger.js.map +1 -0
- package/dist/commands/validate.d.ts +13 -0
- package/dist/commands/validate.js +81 -0
- package/dist/commands/validate.js.map +1 -0
- package/dist/commands/whoami.d.ts +8 -0
- package/dist/commands/whoami.js +22 -0
- package/dist/commands/whoami.js.map +1 -0
- package/dist/config.d.ts +31 -0
- package/dist/config.js +4 -0
- package/dist/config.js.map +1 -0
- package/dist/constants.d.ts +16 -0
- package/dist/constants.js +25 -0
- package/dist/constants.js.map +1 -0
- package/dist/constructs/agentic-check-codegen.d.ts +22 -0
- package/dist/constructs/agentic-check-codegen.js +58 -0
- package/dist/constructs/agentic-check-codegen.js.map +1 -0
- package/dist/constructs/agentic-check.d.ts +130 -0
- package/dist/constructs/agentic-check.js +100 -0
- package/dist/constructs/agentic-check.js.map +1 -0
- package/dist/constructs/alert-channel-codegen.d.ts +37 -0
- package/dist/constructs/alert-channel-codegen.js +96 -0
- package/dist/constructs/alert-channel-codegen.js.map +1 -0
- package/dist/constructs/alert-channel-subscription-codegen.d.ts +11 -0
- package/dist/constructs/alert-channel-subscription-codegen.js +20 -0
- package/dist/constructs/alert-channel-subscription-codegen.js.map +1 -0
- package/dist/constructs/alert-channel-subscription.d.ts +46 -0
- package/dist/constructs/alert-channel-subscription.js +45 -0
- package/dist/constructs/alert-channel-subscription.js.map +1 -0
- package/dist/constructs/alert-channel.d.ts +130 -0
- package/dist/constructs/alert-channel.js +103 -0
- package/dist/constructs/alert-channel.js.map +1 -0
- package/dist/constructs/alert-escalation-policy-codegen.d.ts +4 -0
- package/dist/constructs/alert-escalation-policy-codegen.js +55 -0
- package/dist/constructs/alert-escalation-policy-codegen.js.map +1 -0
- package/dist/constructs/alert-escalation-policy.d.ts +114 -0
- package/dist/constructs/alert-escalation-policy.js +62 -0
- package/dist/constructs/alert-escalation-policy.js.map +1 -0
- package/dist/constructs/api-assertion-codegen.d.ts +3 -0
- package/dist/constructs/api-assertion-codegen.js +19 -0
- package/dist/constructs/api-assertion-codegen.js.map +1 -0
- package/dist/constructs/api-assertion.d.ts +74 -0
- package/dist/constructs/api-assertion.js +81 -0
- package/dist/constructs/api-assertion.js.map +1 -0
- package/dist/constructs/api-check-bundle.d.ts +58 -0
- package/dist/constructs/api-check-bundle.js +30 -0
- package/dist/constructs/api-check-bundle.js.map +1 -0
- package/dist/constructs/api-check-codegen.d.ts +19 -0
- package/dist/constructs/api-check-codegen.js +83 -0
- package/dist/constructs/api-check-codegen.js.map +1 -0
- package/dist/constructs/api-check.d.ts +193 -0
- package/dist/constructs/api-check.js +219 -0
- package/dist/constructs/api-check.js.map +1 -0
- package/dist/constructs/api-request-codegen.d.ts +4 -0
- package/dist/constructs/api-request-codegen.js +64 -0
- package/dist/constructs/api-request-codegen.js.map +1 -0
- package/dist/constructs/api-request.d.ts +67 -0
- package/dist/constructs/api-request.js +2 -0
- package/dist/constructs/api-request.js.map +1 -0
- package/dist/constructs/browser-check-bundle.d.ts +59 -0
- package/dist/constructs/browser-check-bundle.js +27 -0
- package/dist/constructs/browser-check-bundle.js.map +1 -0
- package/dist/constructs/browser-check-codegen.d.ts +14 -0
- package/dist/constructs/browser-check-codegen.js +44 -0
- package/dist/constructs/browser-check-codegen.js.map +1 -0
- package/dist/constructs/browser-check.d.ts +129 -0
- package/dist/constructs/browser-check.js +169 -0
- package/dist/constructs/browser-check.js.map +1 -0
- package/dist/constructs/check-codegen.d.ts +74 -0
- package/dist/constructs/check-codegen.js +251 -0
- package/dist/constructs/check-codegen.js.map +1 -0
- package/dist/constructs/check-config.d.ts +2 -0
- package/dist/constructs/check-config.js +17 -0
- package/dist/constructs/check-config.js.map +1 -0
- package/dist/constructs/check-group-codegen.d.ts +46 -0
- package/dist/constructs/check-group-codegen.js +268 -0
- package/dist/constructs/check-group-codegen.js.map +1 -0
- package/dist/constructs/check-group-ref.d.ts +20 -0
- package/dist/constructs/check-group-ref.js +46 -0
- package/dist/constructs/check-group-ref.js.map +1 -0
- package/dist/constructs/check-group-v1.d.ts +304 -0
- package/dist/constructs/check-group-v1.js +254 -0
- package/dist/constructs/check-group-v1.js.map +1 -0
- package/dist/constructs/check-group-v2.d.ts +120 -0
- package/dist/constructs/check-group-v2.js +68 -0
- package/dist/constructs/check-group-v2.js.map +1 -0
- package/dist/constructs/check-group.d.ts +4 -0
- package/dist/constructs/check-group.js +5 -0
- package/dist/constructs/check-group.js.map +1 -0
- package/dist/constructs/check.d.ts +336 -0
- package/dist/constructs/check.js +234 -0
- package/dist/constructs/check.js.map +1 -0
- package/dist/constructs/construct-codegen.d.ts +39 -0
- package/dist/constructs/construct-codegen.js +95 -0
- package/dist/constructs/construct-codegen.js.map +1 -0
- package/dist/constructs/construct-diagnostics.d.ts +53 -0
- package/dist/constructs/construct-diagnostics.js +156 -0
- package/dist/constructs/construct-diagnostics.js.map +1 -0
- package/dist/constructs/construct.d.ts +142 -0
- package/dist/constructs/construct.js +120 -0
- package/dist/constructs/construct.js.map +1 -0
- package/dist/constructs/dashboard-bundle.d.ts +11 -0
- package/dist/constructs/dashboard-bundle.js +15 -0
- package/dist/constructs/dashboard-bundle.js.map +1 -0
- package/dist/constructs/dashboard-codegen.d.ts +29 -0
- package/dist/constructs/dashboard-codegen.js +104 -0
- package/dist/constructs/dashboard-codegen.js.map +1 -0
- package/dist/constructs/dashboard.d.ts +226 -0
- package/dist/constructs/dashboard.js +140 -0
- package/dist/constructs/dashboard.js.map +1 -0
- package/dist/constructs/diagnostics.d.ts +59 -0
- package/dist/constructs/diagnostics.js +71 -0
- package/dist/constructs/diagnostics.js.map +1 -0
- package/dist/constructs/dns-assertion-codegen.d.ts +3 -0
- package/dist/constructs/dns-assertion-codegen.js +26 -0
- package/dist/constructs/dns-assertion-codegen.js.map +1 -0
- package/dist/constructs/dns-assertion.d.ts +45 -0
- package/dist/constructs/dns-assertion.js +51 -0
- package/dist/constructs/dns-assertion.js.map +1 -0
- package/dist/constructs/dns-monitor-codegen.d.ts +13 -0
- package/dist/constructs/dns-monitor-codegen.js +34 -0
- package/dist/constructs/dns-monitor-codegen.js.map +1 -0
- package/dist/constructs/dns-monitor.d.ts +87 -0
- package/dist/constructs/dns-monitor.js +55 -0
- package/dist/constructs/dns-monitor.js.map +1 -0
- package/dist/constructs/dns-request-codegen.d.ts +4 -0
- package/dist/constructs/dns-request-codegen.js +28 -0
- package/dist/constructs/dns-request-codegen.js.map +1 -0
- package/dist/constructs/dns-request.d.ts +53 -0
- package/dist/constructs/dns-request.js +2 -0
- package/dist/constructs/dns-request.js.map +1 -0
- package/dist/constructs/email-alert-channel-codegen.d.ts +13 -0
- package/dist/constructs/email-alert-channel-codegen.js +34 -0
- package/dist/constructs/email-alert-channel-codegen.js.map +1 -0
- package/dist/constructs/email-alert-channel.d.ts +27 -0
- package/dist/constructs/email-alert-channel.js +37 -0
- package/dist/constructs/email-alert-channel.js.map +1 -0
- package/dist/constructs/engine.d.ts +40 -0
- package/dist/constructs/engine.js +23 -0
- package/dist/constructs/engine.js.map +1 -0
- package/dist/constructs/environment-variable.d.ts +21 -0
- package/dist/constructs/environment-variable.js +2 -0
- package/dist/constructs/environment-variable.js.map +1 -0
- package/dist/constructs/frequency-codegen.d.ts +8 -0
- package/dist/constructs/frequency-codegen.js +51 -0
- package/dist/constructs/frequency-codegen.js.map +1 -0
- package/dist/constructs/frequency.d.ts +62 -0
- package/dist/constructs/frequency.js +66 -0
- package/dist/constructs/frequency.js.map +1 -0
- package/dist/constructs/heartbeat-monitor-codegen.d.ts +11 -0
- package/dist/constructs/heartbeat-monitor-codegen.js +29 -0
- package/dist/constructs/heartbeat-monitor-codegen.js.map +1 -0
- package/dist/constructs/heartbeat-monitor.d.ts +40 -0
- package/dist/constructs/heartbeat-monitor.js +56 -0
- package/dist/constructs/heartbeat-monitor.js.map +1 -0
- package/dist/constructs/http-header.d.ts +18 -0
- package/dist/constructs/http-header.js +2 -0
- package/dist/constructs/http-header.js.map +1 -0
- package/dist/constructs/http-request.d.ts +2 -0
- package/dist/constructs/http-request.js +2 -0
- package/dist/constructs/http-request.js.map +1 -0
- package/dist/constructs/icmp-assertion-codegen.d.ts +3 -0
- package/dist/constructs/icmp-assertion-codegen.js +18 -0
- package/dist/constructs/icmp-assertion-codegen.js.map +1 -0
- package/dist/constructs/icmp-assertion.d.ts +56 -0
- package/dist/constructs/icmp-assertion.js +57 -0
- package/dist/constructs/icmp-assertion.js.map +1 -0
- package/dist/constructs/icmp-monitor-codegen.d.ts +13 -0
- package/dist/constructs/icmp-monitor-codegen.js +34 -0
- package/dist/constructs/icmp-monitor-codegen.js.map +1 -0
- package/dist/constructs/icmp-monitor.d.ts +83 -0
- package/dist/constructs/icmp-monitor.js +43 -0
- package/dist/constructs/icmp-monitor.js.map +1 -0
- package/dist/constructs/icmp-request-codegen.d.ts +4 -0
- package/dist/constructs/icmp-request-codegen.js +24 -0
- package/dist/constructs/icmp-request-codegen.js.map +1 -0
- package/dist/constructs/icmp-request.d.ts +37 -0
- package/dist/constructs/icmp-request.js +2 -0
- package/dist/constructs/icmp-request.js.map +1 -0
- package/dist/constructs/incident.d.ts +15 -0
- package/dist/constructs/incident.js +2 -0
- package/dist/constructs/incident.js.map +1 -0
- package/dist/constructs/incidentio-alert-channel-codegen.d.ts +13 -0
- package/dist/constructs/incidentio-alert-channel-codegen.js +85 -0
- package/dist/constructs/incidentio-alert-channel-codegen.js.map +1 -0
- package/dist/constructs/incidentio-alert-channel.d.ts +44 -0
- package/dist/constructs/incidentio-alert-channel.js +67 -0
- package/dist/constructs/incidentio-alert-channel.js.map +1 -0
- package/dist/constructs/index.d.ts +54 -0
- package/dist/constructs/index.js +55 -0
- package/dist/constructs/index.js.map +1 -0
- package/dist/constructs/internal/assertion-codegen.d.ts +11 -0
- package/dist/constructs/internal/assertion-codegen.js +144 -0
- package/dist/constructs/internal/assertion-codegen.js.map +1 -0
- package/dist/constructs/internal/assertion.d.ts +40 -0
- package/dist/constructs/internal/assertion.js +93 -0
- package/dist/constructs/internal/assertion.js.map +1 -0
- package/dist/constructs/internal/codegen/codegen.d.ts +9 -0
- package/dist/constructs/internal/codegen/codegen.js +16 -0
- package/dist/constructs/internal/codegen/codegen.js.map +1 -0
- package/dist/constructs/internal/codegen/context.d.ts +62 -0
- package/dist/constructs/internal/codegen/context.js +413 -0
- package/dist/constructs/internal/codegen/context.js.map +1 -0
- package/dist/constructs/internal/codegen/index.d.ts +4 -0
- package/dist/constructs/internal/codegen/index.js +5 -0
- package/dist/constructs/internal/codegen/index.js.map +1 -0
- package/dist/constructs/internal/codegen/safety.d.ts +2 -0
- package/dist/constructs/internal/codegen/safety.js +3 -0
- package/dist/constructs/internal/codegen/safety.js.map +1 -0
- package/dist/constructs/internal/codegen/snippet.d.ts +12 -0
- package/dist/constructs/internal/codegen/snippet.js +39 -0
- package/dist/constructs/internal/codegen/snippet.js.map +1 -0
- package/dist/constructs/internal/common-diagnostics.d.ts +21 -0
- package/dist/constructs/internal/common-diagnostics.js +84 -0
- package/dist/constructs/internal/common-diagnostics.js.map +1 -0
- package/dist/constructs/internal/sanitize.d.ts +15 -0
- package/dist/constructs/internal/sanitize.js +36 -0
- package/dist/constructs/internal/sanitize.js.map +1 -0
- package/dist/constructs/ip.d.ts +2 -0
- package/dist/constructs/ip.js +2 -0
- package/dist/constructs/ip.js.map +1 -0
- package/dist/constructs/key-value-pair-codegen.d.ts +4 -0
- package/dist/constructs/key-value-pair-codegen.js +35 -0
- package/dist/constructs/key-value-pair-codegen.js.map +1 -0
- package/dist/constructs/key-value-pair.d.ts +41 -0
- package/dist/constructs/key-value-pair.js +2 -0
- package/dist/constructs/key-value-pair.js.map +1 -0
- package/dist/constructs/maintenance-window-codegen.d.ts +14 -0
- package/dist/constructs/maintenance-window-codegen.js +53 -0
- package/dist/constructs/maintenance-window-codegen.js.map +1 -0
- package/dist/constructs/maintenance-window.d.ts +62 -0
- package/dist/constructs/maintenance-window.js +53 -0
- package/dist/constructs/maintenance-window.js.map +1 -0
- package/dist/constructs/monitor-codegen.d.ts +1 -0
- package/dist/constructs/monitor-codegen.js +2 -0
- package/dist/constructs/monitor-codegen.js.map +1 -0
- package/dist/constructs/monitor.d.ts +127 -0
- package/dist/constructs/monitor.js +17 -0
- package/dist/constructs/monitor.js.map +1 -0
- package/dist/constructs/msteams-alert-channel-codegen.d.ts +13 -0
- package/dist/constructs/msteams-alert-channel-codegen.js +71 -0
- package/dist/constructs/msteams-alert-channel-codegen.js.map +1 -0
- package/dist/constructs/msteams-alert-channel.d.ts +39 -0
- package/dist/constructs/msteams-alert-channel.js +162 -0
- package/dist/constructs/msteams-alert-channel.js.map +1 -0
- package/dist/constructs/multi-step-check-bundle.d.ts +47 -0
- package/dist/constructs/multi-step-check-bundle.js +21 -0
- package/dist/constructs/multi-step-check-bundle.js.map +1 -0
- package/dist/constructs/multi-step-check-codegen.d.ts +13 -0
- package/dist/constructs/multi-step-check-codegen.js +35 -0
- package/dist/constructs/multi-step-check-codegen.js.map +1 -0
- package/dist/constructs/multi-step-check.d.ts +75 -0
- package/dist/constructs/multi-step-check.js +121 -0
- package/dist/constructs/multi-step-check.js.map +1 -0
- package/dist/constructs/opsgenie-alert-channel-codegen.d.ts +16 -0
- package/dist/constructs/opsgenie-alert-channel-codegen.js +37 -0
- package/dist/constructs/opsgenie-alert-channel-codegen.js.map +1 -0
- package/dist/constructs/opsgenie-alert-channel.d.ts +46 -0
- package/dist/constructs/opsgenie-alert-channel.js +47 -0
- package/dist/constructs/opsgenie-alert-channel.js.map +1 -0
- package/dist/constructs/pagerduty-alert-channel-codegen.d.ts +15 -0
- package/dist/constructs/pagerduty-alert-channel-codegen.js +49 -0
- package/dist/constructs/pagerduty-alert-channel-codegen.js.map +1 -0
- package/dist/constructs/pagerduty-alert-channel.d.ts +40 -0
- package/dist/constructs/pagerduty-alert-channel.js +44 -0
- package/dist/constructs/pagerduty-alert-channel.js.map +1 -0
- package/dist/constructs/phone-call-alert-channel-codegen.d.ts +14 -0
- package/dist/constructs/phone-call-alert-channel-codegen.js +42 -0
- package/dist/constructs/phone-call-alert-channel-codegen.js.map +1 -0
- package/dist/constructs/phone-call-alert-channel.d.ts +34 -0
- package/dist/constructs/phone-call-alert-channel.js +42 -0
- package/dist/constructs/phone-call-alert-channel.js.map +1 -0
- package/dist/constructs/playwright-check-bundle.d.ts +63 -0
- package/dist/constructs/playwright-check-bundle.js +36 -0
- package/dist/constructs/playwright-check-bundle.js.map +1 -0
- package/dist/constructs/playwright-check.d.ts +193 -0
- package/dist/constructs/playwright-check.js +328 -0
- package/dist/constructs/playwright-check.js.map +1 -0
- package/dist/constructs/playwright-config-codegen.d.ts +4 -0
- package/dist/constructs/playwright-config-codegen.js +5 -0
- package/dist/constructs/playwright-config-codegen.js.map +1 -0
- package/dist/constructs/playwright-config.d.ts +52 -0
- package/dist/constructs/playwright-config.js +2 -0
- package/dist/constructs/playwright-config.js.map +1 -0
- package/dist/constructs/private-location-check-assignment-codegen.d.ts +10 -0
- package/dist/constructs/private-location-check-assignment-codegen.js +15 -0
- package/dist/constructs/private-location-check-assignment-codegen.js.map +1 -0
- package/dist/constructs/private-location-check-assignment.d.ts +30 -0
- package/dist/constructs/private-location-check-assignment.js +36 -0
- package/dist/constructs/private-location-check-assignment.js.map +1 -0
- package/dist/constructs/private-location-codegen.d.ts +15 -0
- package/dist/constructs/private-location-codegen.js +46 -0
- package/dist/constructs/private-location-codegen.js.map +1 -0
- package/dist/constructs/private-location-group-assignment-codegen.d.ts +10 -0
- package/dist/constructs/private-location-group-assignment-codegen.js +15 -0
- package/dist/constructs/private-location-group-assignment-codegen.js.map +1 -0
- package/dist/constructs/private-location-group-assignment.d.ts +31 -0
- package/dist/constructs/private-location-group-assignment.js +39 -0
- package/dist/constructs/private-location-group-assignment.js.map +1 -0
- package/dist/constructs/private-location.d.ts +66 -0
- package/dist/constructs/private-location.js +88 -0
- package/dist/constructs/private-location.js.map +1 -0
- package/dist/constructs/project-bundle.d.ts +30 -0
- package/dist/constructs/project-bundle.js +40 -0
- package/dist/constructs/project-bundle.js.map +1 -0
- package/dist/constructs/project.d.ts +61 -0
- package/dist/constructs/project.js +127 -0
- package/dist/constructs/project.js.map +1 -0
- package/dist/constructs/query-param.d.ts +18 -0
- package/dist/constructs/query-param.js +2 -0
- package/dist/constructs/query-param.js.map +1 -0
- package/dist/constructs/ref-codegen.d.ts +3 -0
- package/dist/constructs/ref-codegen.js +11 -0
- package/dist/constructs/ref-codegen.js.map +1 -0
- package/dist/constructs/ref.d.ts +49 -0
- package/dist/constructs/ref.js +54 -0
- package/dist/constructs/ref.js.map +1 -0
- package/dist/constructs/retry-strategy-codegen.d.ts +4 -0
- package/dist/constructs/retry-strategy-codegen.js +104 -0
- package/dist/constructs/retry-strategy-codegen.js.map +1 -0
- package/dist/constructs/retry-strategy.d.ts +196 -0
- package/dist/constructs/retry-strategy.js +110 -0
- package/dist/constructs/retry-strategy.js.map +1 -0
- package/dist/constructs/session.d.ts +67 -0
- package/dist/constructs/session.js +197 -0
- package/dist/constructs/session.js.map +1 -0
- package/dist/constructs/slack-alert-channel-codegen.d.ts +14 -0
- package/dist/constructs/slack-alert-channel-codegen.js +42 -0
- package/dist/constructs/slack-alert-channel-codegen.js.map +1 -0
- package/dist/constructs/slack-alert-channel.d.ts +27 -0
- package/dist/constructs/slack-alert-channel.js +41 -0
- package/dist/constructs/slack-alert-channel.js.map +1 -0
- package/dist/constructs/slack-app-alert-channel-codegen.d.ts +13 -0
- package/dist/constructs/slack-app-alert-channel-codegen.js +39 -0
- package/dist/constructs/slack-app-alert-channel-codegen.js.map +1 -0
- package/dist/constructs/slack-app-alert-channel.d.ts +31 -0
- package/dist/constructs/slack-app-alert-channel.js +38 -0
- package/dist/constructs/slack-app-alert-channel.js.map +1 -0
- package/dist/constructs/sms-alert-channel-codegen.d.ts +14 -0
- package/dist/constructs/sms-alert-channel-codegen.js +42 -0
- package/dist/constructs/sms-alert-channel-codegen.js.map +1 -0
- package/dist/constructs/sms-alert-channel.d.ts +33 -0
- package/dist/constructs/sms-alert-channel.js +41 -0
- package/dist/constructs/sms-alert-channel.js.map +1 -0
- package/dist/constructs/status-page-codegen.d.ts +23 -0
- package/dist/constructs/status-page-codegen.js +67 -0
- package/dist/constructs/status-page-codegen.js.map +1 -0
- package/dist/constructs/status-page-service-codegen.d.ts +12 -0
- package/dist/constructs/status-page-service-codegen.js +39 -0
- package/dist/constructs/status-page-service-codegen.js.map +1 -0
- package/dist/constructs/status-page-service.d.ts +43 -0
- package/dist/constructs/status-page-service.js +61 -0
- package/dist/constructs/status-page-service.js.map +1 -0
- package/dist/constructs/status-page.d.ts +72 -0
- package/dist/constructs/status-page.js +58 -0
- package/dist/constructs/status-page.js.map +1 -0
- package/dist/constructs/tcp-monitor-codegen.d.ts +15 -0
- package/dist/constructs/tcp-monitor-codegen.js +64 -0
- package/dist/constructs/tcp-monitor-codegen.js.map +1 -0
- package/dist/constructs/tcp-monitor.d.ts +155 -0
- package/dist/constructs/tcp-monitor.js +83 -0
- package/dist/constructs/tcp-monitor.js.map +1 -0
- package/dist/constructs/telegram-alert-channel-codegen.d.ts +13 -0
- package/dist/constructs/telegram-alert-channel-codegen.js +98 -0
- package/dist/constructs/telegram-alert-channel-codegen.js.map +1 -0
- package/dist/constructs/telegram-alert-channel.d.ts +44 -0
- package/dist/constructs/telegram-alert-channel.js +60 -0
- package/dist/constructs/telegram-alert-channel.js.map +1 -0
- package/dist/constructs/url-assertion-codegen.d.ts +3 -0
- package/dist/constructs/url-assertion-codegen.js +11 -0
- package/dist/constructs/url-assertion-codegen.js.map +1 -0
- package/dist/constructs/url-assertion.d.ts +60 -0
- package/dist/constructs/url-assertion.js +52 -0
- package/dist/constructs/url-assertion.js.map +1 -0
- package/dist/constructs/url-monitor-codegen.d.ts +13 -0
- package/dist/constructs/url-monitor-codegen.js +34 -0
- package/dist/constructs/url-monitor-codegen.js.map +1 -0
- package/dist/constructs/url-monitor.d.ts +151 -0
- package/dist/constructs/url-monitor.js +109 -0
- package/dist/constructs/url-monitor.js.map +1 -0
- package/dist/constructs/url-request-codegen.d.ts +4 -0
- package/dist/constructs/url-request-codegen.js +27 -0
- package/dist/constructs/url-request-codegen.js.map +1 -0
- package/dist/constructs/url-request.d.ts +65 -0
- package/dist/constructs/url-request.js +2 -0
- package/dist/constructs/url-request.js.map +1 -0
- package/dist/constructs/validator-error.d.ts +2 -0
- package/dist/constructs/validator-error.js +3 -0
- package/dist/constructs/validator-error.js.map +1 -0
- package/dist/constructs/webhook-alert-channel-codegen.d.ts +34 -0
- package/dist/constructs/webhook-alert-channel-codegen.js +147 -0
- package/dist/constructs/webhook-alert-channel-codegen.js.map +1 -0
- package/dist/constructs/webhook-alert-channel.d.ts +68 -0
- package/dist/constructs/webhook-alert-channel.js +59 -0
- package/dist/constructs/webhook-alert-channel.js.map +1 -0
- package/dist/formatters/account-members.d.ts +8 -0
- package/dist/formatters/account-members.js +115 -0
- package/dist/formatters/account-members.js.map +1 -0
- package/dist/formatters/account-plan.d.ts +16 -0
- package/dist/formatters/account-plan.js +320 -0
- package/dist/formatters/account-plan.js.map +1 -0
- package/dist/formatters/alert-channels.d.ts +15 -0
- package/dist/formatters/alert-channels.js +257 -0
- package/dist/formatters/alert-channels.js.map +1 -0
- package/dist/formatters/analytics.d.ts +8 -0
- package/dist/formatters/analytics.js +223 -0
- package/dist/formatters/analytics.js.map +1 -0
- package/dist/formatters/assets.d.ts +22 -0
- package/dist/formatters/assets.js +280 -0
- package/dist/formatters/assets.js.map +1 -0
- package/dist/formatters/batch-stats.d.ts +8 -0
- package/dist/formatters/batch-stats.js +184 -0
- package/dist/formatters/batch-stats.js.map +1 -0
- package/dist/formatters/check-result-detail.d.ts +12 -0
- package/dist/formatters/check-result-detail.js +651 -0
- package/dist/formatters/check-result-detail.js.map +1 -0
- package/dist/formatters/checks.d.ts +29 -0
- package/dist/formatters/checks.js +336 -0
- package/dist/formatters/checks.js.map +1 -0
- package/dist/formatters/incidents.d.ts +7 -0
- package/dist/formatters/incidents.js +172 -0
- package/dist/formatters/incidents.js.map +1 -0
- package/dist/formatters/rca.d.ts +42 -0
- package/dist/formatters/rca.js +156 -0
- package/dist/formatters/rca.js.map +1 -0
- package/dist/formatters/render.d.ts +47 -0
- package/dist/formatters/render.js +261 -0
- package/dist/formatters/render.js.map +1 -0
- package/dist/formatters/status-pages.d.ts +7 -0
- package/dist/formatters/status-pages.js +236 -0
- package/dist/formatters/status-pages.js.map +1 -0
- package/dist/formatters/test-sessions.d.ts +18 -0
- package/dist/formatters/test-sessions.js +341 -0
- package/dist/formatters/test-sessions.js.map +1 -0
- package/dist/help/examples.d.ts +6 -0
- package/dist/help/examples.js +20 -0
- package/dist/help/examples.js.map +1 -0
- package/dist/help/help-extension.d.ts +6 -0
- package/dist/help/help-extension.js +91 -0
- package/dist/help/help-extension.js.map +1 -0
- package/dist/help/skills.d.ts +7 -0
- package/dist/help/skills.js +20 -0
- package/dist/help/skills.js.map +1 -0
- package/dist/helpers/account-member-target.d.ts +14 -0
- package/dist/helpers/account-member-target.js +37 -0
- package/dist/helpers/account-member-target.js.map +1 -0
- package/dist/helpers/api-fields.d.ts +4 -0
- package/dist/helpers/api-fields.js +24 -0
- package/dist/helpers/api-fields.js.map +1 -0
- package/dist/helpers/cli-mode.d.ts +4 -0
- package/dist/helpers/cli-mode.js +62 -0
- package/dist/helpers/cli-mode.js.map +1 -0
- package/dist/helpers/command-preview.d.ts +24 -0
- package/dist/helpers/command-preview.js +50 -0
- package/dist/helpers/command-preview.js.map +1 -0
- package/dist/helpers/command-style.d.ts +21 -0
- package/dist/helpers/command-style.js +108 -0
- package/dist/helpers/command-style.js.map +1 -0
- package/dist/helpers/constants.d.ts +1 -0
- package/dist/helpers/constants.js +2 -0
- package/dist/helpers/constants.js.map +1 -0
- package/dist/helpers/content-range.d.ts +1 -0
- package/dist/helpers/content-range.js +7 -0
- package/dist/helpers/content-range.js.map +1 -0
- package/dist/helpers/flags.d.ts +11 -0
- package/dist/helpers/flags.js +45 -0
- package/dist/helpers/flags.js.map +1 -0
- package/dist/helpers/incidents.d.ts +15 -0
- package/dist/helpers/incidents.js +50 -0
- package/dist/helpers/incidents.js.map +1 -0
- package/dist/helpers/number.d.ts +3 -0
- package/dist/helpers/number.js +20 -0
- package/dist/helpers/number.js.map +1 -0
- package/dist/helpers/onboarding/boilerplate.d.ts +15 -0
- package/dist/helpers/onboarding/boilerplate.js +166 -0
- package/dist/helpers/onboarding/boilerplate.js.map +1 -0
- package/dist/helpers/onboarding/clipboard.d.ts +1 -0
- package/dist/helpers/onboarding/clipboard.js +28 -0
- package/dist/helpers/onboarding/clipboard.js.map +1 -0
- package/dist/helpers/onboarding/detect-project.d.ts +10 -0
- package/dist/helpers/onboarding/detect-project.js +31 -0
- package/dist/helpers/onboarding/detect-project.js.map +1 -0
- package/dist/helpers/onboarding/index.d.ts +7 -0
- package/dist/helpers/onboarding/index.js +8 -0
- package/dist/helpers/onboarding/index.js.map +1 -0
- package/dist/helpers/onboarding/messages.d.ts +5 -0
- package/dist/helpers/onboarding/messages.js +141 -0
- package/dist/helpers/onboarding/messages.js.map +1 -0
- package/dist/helpers/onboarding/prompt-display.d.ts +1 -0
- package/dist/helpers/onboarding/prompt-display.js +76 -0
- package/dist/helpers/onboarding/prompt-display.js.map +1 -0
- package/dist/helpers/onboarding/prompts-helpers.d.ts +2 -0
- package/dist/helpers/onboarding/prompts-helpers.js +11 -0
- package/dist/helpers/onboarding/prompts-helpers.js.map +1 -0
- package/dist/helpers/onboarding/skill-install.d.ts +10 -0
- package/dist/helpers/onboarding/skill-install.js +85 -0
- package/dist/helpers/onboarding/skill-install.js.map +1 -0
- package/dist/helpers/onboarding/template-prompt.d.ts +2 -0
- package/dist/helpers/onboarding/template-prompt.js +14 -0
- package/dist/helpers/onboarding/template-prompt.js.map +1 -0
- package/dist/helpers/recast-acorn-parser.d.ts +2 -0
- package/dist/helpers/recast-acorn-parser.js +22 -0
- package/dist/helpers/recast-acorn-parser.js.map +1 -0
- package/dist/helpers/result-assets.d.ts +54 -0
- package/dist/helpers/result-assets.js +305 -0
- package/dist/helpers/result-assets.js.map +1 -0
- package/dist/helpers/test-helper.d.ts +17 -0
- package/dist/helpers/test-helper.js +75 -0
- package/dist/helpers/test-helper.js.map +1 -0
- package/dist/helpers/wrap.d.ts +6 -0
- package/dist/helpers/wrap.js +49 -0
- package/dist/helpers/wrap.js.map +1 -0
- package/dist/helpers/write-config-helpers.d.ts +5 -0
- package/dist/helpers/write-config-helpers.js +55 -0
- package/dist/helpers/write-config-helpers.js.map +1 -0
- package/dist/hooks/command-not-found.d.ts +3 -0
- package/dist/hooks/command-not-found.js +22 -0
- package/dist/hooks/command-not-found.js.map +1 -0
- package/dist/hooks/parse-error.d.ts +3 -0
- package/dist/hooks/parse-error.js +15 -0
- package/dist/hooks/parse-error.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -0
- package/dist/loader/config.d.ts +3 -0
- package/dist/loader/config.js +8 -0
- package/dist/loader/config.js.map +1 -0
- package/dist/loader/index.d.ts +5 -0
- package/dist/loader/index.js +6 -0
- package/dist/loader/index.js.map +1 -0
- package/dist/loader/jiti.d.ts +28 -0
- package/dist/loader/jiti.js +76 -0
- package/dist/loader/jiti.js.map +1 -0
- package/dist/loader/loader.d.ts +43 -0
- package/dist/loader/loader.js +37 -0
- package/dist/loader/loader.js.map +1 -0
- package/dist/loader/match.d.ts +15 -0
- package/dist/loader/match.js +43 -0
- package/dist/loader/match.js.map +1 -0
- package/dist/loader/mixed.d.ts +7 -0
- package/dist/loader/mixed.js +36 -0
- package/dist/loader/mixed.js.map +1 -0
- package/dist/loader/native.d.ts +10 -0
- package/dist/loader/native.js +30 -0
- package/dist/loader/native.js.map +1 -0
- package/dist/messages/common-messages.d.ts +5 -0
- package/dist/messages/common-messages.js +7 -0
- package/dist/messages/common-messages.js.map +1 -0
- package/dist/playwright/playwright-config-loader.d.ts +1 -0
- package/dist/playwright/playwright-config-loader.js +26 -0
- package/dist/playwright/playwright-config-loader.js.map +1 -0
- package/dist/playwright/playwright-config-template.d.ts +8 -0
- package/dist/playwright/playwright-config-template.js +53 -0
- package/dist/playwright/playwright-config-template.js.map +1 -0
- package/dist/reporters/abstract-list.d.ts +57 -0
- package/dist/reporters/abstract-list.js +283 -0
- package/dist/reporters/abstract-list.js.map +1 -0
- package/dist/reporters/ci.d.ts +12 -0
- package/dist/reporters/ci.js +28 -0
- package/dist/reporters/ci.js.map +1 -0
- package/dist/reporters/dot.d.ts +10 -0
- package/dist/reporters/dot.js +26 -0
- package/dist/reporters/dot.js.map +1 -0
- package/dist/reporters/github.d.ts +32 -0
- package/dist/reporters/github.js +93 -0
- package/dist/reporters/github.js.map +1 -0
- package/dist/reporters/json.d.ts +26 -0
- package/dist/reporters/json.js +74 -0
- package/dist/reporters/json.js.map +1 -0
- package/dist/reporters/list.d.ts +15 -0
- package/dist/reporters/list.js +81 -0
- package/dist/reporters/list.js.map +1 -0
- package/dist/reporters/reporter.d.ts +25 -0
- package/dist/reporters/reporter.js +22 -0
- package/dist/reporters/reporter.js.map +1 -0
- package/dist/reporters/util.d.ts +20 -0
- package/dist/reporters/util.js +596 -0
- package/dist/reporters/util.js.map +1 -0
- package/dist/rest/account-members.d.ts +56 -0
- package/dist/rest/account-members.js +18 -0
- package/dist/rest/account-members.js.map +1 -0
- package/dist/rest/accounts.d.ts +20 -0
- package/dist/rest/accounts.js +14 -0
- package/dist/rest/accounts.js.map +1 -0
- package/dist/rest/alert-channels.d.ts +52 -0
- package/dist/rest/alert-channels.js +23 -0
- package/dist/rest/alert-channels.js.map +1 -0
- package/dist/rest/alert-notifications.d.ts +39 -0
- package/dist/rest/alert-notifications.js +19 -0
- package/dist/rest/alert-notifications.js.map +1 -0
- package/dist/rest/analytics.d.ts +41 -0
- package/dist/rest/analytics.js +60 -0
- package/dist/rest/analytics.js.map +1 -0
- package/dist/rest/api.d.ts +67 -0
- package/dist/rest/api.js +121 -0
- package/dist/rest/api.js.map +1 -0
- package/dist/rest/asset-manifests.d.ts +30 -0
- package/dist/rest/asset-manifests.js +29 -0
- package/dist/rest/asset-manifests.js.map +1 -0
- package/dist/rest/assets.d.ts +64 -0
- package/dist/rest/assets.js +90 -0
- package/dist/rest/assets.js.map +1 -0
- package/dist/rest/batch-analytics.d.ts +25 -0
- package/dist/rest/batch-analytics.js +14 -0
- package/dist/rest/batch-analytics.js.map +1 -0
- package/dist/rest/cancel.d.ts +14 -0
- package/dist/rest/cancel.js +28 -0
- package/dist/rest/cancel.js.map +1 -0
- package/dist/rest/check-groups.d.ts +16 -0
- package/dist/rest/check-groups.js +11 -0
- package/dist/rest/check-groups.js.map +1 -0
- package/dist/rest/check-results.d.ts +183 -0
- package/dist/rest/check-results.js +14 -0
- package/dist/rest/check-results.js.map +1 -0
- package/dist/rest/check-statuses.d.ts +23 -0
- package/dist/rest/check-statuses.js +20 -0
- package/dist/rest/check-statuses.js.map +1 -0
- package/dist/rest/checkly-storage.d.ts +14 -0
- package/dist/rest/checkly-storage.js +17 -0
- package/dist/rest/checkly-storage.js.map +1 -0
- package/dist/rest/checks.d.ts +48 -0
- package/dist/rest/checks.js +43 -0
- package/dist/rest/checks.js.map +1 -0
- package/dist/rest/entitlements.d.ts +47 -0
- package/dist/rest/entitlements.js +11 -0
- package/dist/rest/entitlements.js.map +1 -0
- package/dist/rest/environment-variables.d.ts +43 -0
- package/dist/rest/environment-variables.js +91 -0
- package/dist/rest/environment-variables.js.map +1 -0
- package/dist/rest/error-groups.d.ts +49 -0
- package/dist/rest/error-groups.js +14 -0
- package/dist/rest/error-groups.js.map +1 -0
- package/dist/rest/errors.d.ts +84 -0
- package/dist/rest/errors.js +216 -0
- package/dist/rest/errors.js.map +1 -0
- package/dist/rest/heartbeat-checks.d.ts +11 -0
- package/dist/rest/heartbeat-checks.js +16 -0
- package/dist/rest/heartbeat-checks.js.map +1 -0
- package/dist/rest/incidents.d.ts +60 -0
- package/dist/rest/incidents.js +28 -0
- package/dist/rest/incidents.js.map +1 -0
- package/dist/rest/locations.d.ts +11 -0
- package/dist/rest/locations.js +11 -0
- package/dist/rest/locations.js.map +1 -0
- package/dist/rest/private-locations.d.ts +10 -0
- package/dist/rest/private-locations.js +10 -0
- package/dist/rest/private-locations.js.map +1 -0
- package/dist/rest/projects.d.ts +161 -0
- package/dist/rest/projects.js +205 -0
- package/dist/rest/projects.js.map +1 -0
- package/dist/rest/rca.d.ts +14 -0
- package/dist/rest/rca.js +28 -0
- package/dist/rest/rca.js.map +1 -0
- package/dist/rest/runtimes.d.ts +9 -0
- package/dist/rest/runtimes.js +16 -0
- package/dist/rest/runtimes.js.map +1 -0
- package/dist/rest/status-pages.d.ts +40 -0
- package/dist/rest/status-pages.js +16 -0
- package/dist/rest/status-pages.js.map +1 -0
- package/dist/rest/test-session-error-groups.d.ts +18 -0
- package/dist/rest/test-session-error-groups.js +11 -0
- package/dist/rest/test-session-error-groups.js.map +1 -0
- package/dist/rest/test-sessions.d.ts +167 -0
- package/dist/rest/test-sessions.js +76 -0
- package/dist/rest/test-sessions.js.map +1 -0
- package/dist/rest/users.d.ts +12 -0
- package/dist/rest/users.js +11 -0
- package/dist/rest/users.js.map +1 -0
- package/dist/rest/util.d.ts +3 -0
- package/dist/rest/util.js +10 -0
- package/dist/rest/util.js.map +1 -0
- package/dist/runtimes/index.d.ts +2 -0
- package/dist/runtimes/index.js +2 -0
- package/dist/runtimes/index.js.map +1 -0
- package/dist/runtimes/runtime.d.ts +8 -0
- package/dist/runtimes/runtime.js +2 -0
- package/dist/runtimes/runtime.js.map +1 -0
- package/dist/runtimes/snapshot.d.ts +2 -0
- package/dist/runtimes/snapshot.js +11 -0
- package/dist/runtimes/snapshot.js.map +1 -0
- package/dist/services/abstract-check-runner.d.ts +63 -0
- package/dist/services/abstract-check-runner.js +289 -0
- package/dist/services/abstract-check-runner.js.map +1 -0
- package/dist/services/check-parser/bundler.d.ts +58 -0
- package/dist/services/check-parser/bundler.js +219 -0
- package/dist/services/check-parser/bundler.js.map +1 -0
- package/dist/services/check-parser/cache-hash.d.ts +79 -0
- package/dist/services/check-parser/cache-hash.js +179 -0
- package/dist/services/check-parser/cache-hash.js.map +1 -0
- package/dist/services/check-parser/collector.d.ts +33 -0
- package/dist/services/check-parser/collector.js +46 -0
- package/dist/services/check-parser/collector.js.map +1 -0
- package/dist/services/check-parser/errors.d.ts +8 -0
- package/dist/services/check-parser/errors.js +46 -0
- package/dist/services/check-parser/errors.js.map +1 -0
- package/dist/services/check-parser/faux-package.d.ts +4 -0
- package/dist/services/check-parser/faux-package.js +16 -0
- package/dist/services/check-parser/faux-package.js.map +1 -0
- package/dist/services/check-parser/package-files/extension.d.ts +38 -0
- package/dist/services/check-parser/package-files/extension.js +66 -0
- package/dist/services/check-parser/package-files/extension.js.map +1 -0
- package/dist/services/check-parser/package-files/jsconfig-json-file.d.ts +17 -0
- package/dist/services/check-parser/package-files/jsconfig-json-file.js +23 -0
- package/dist/services/check-parser/package-files/jsconfig-json-file.js.map +1 -0
- package/dist/services/check-parser/package-files/json-source-file.d.ts +11 -0
- package/dist/services/check-parser/package-files/json-source-file.js +32 -0
- package/dist/services/check-parser/package-files/json-source-file.js.map +1 -0
- package/dist/services/check-parser/package-files/json-text-source-file-parser.d.ts +7 -0
- package/dist/services/check-parser/package-files/json-text-source-file-parser.js +47 -0
- package/dist/services/check-parser/package-files/json-text-source-file-parser.js.map +1 -0
- package/dist/services/check-parser/package-files/json-text-source-file.d.ts +7 -0
- package/dist/services/check-parser/package-files/json-text-source-file.js +18 -0
- package/dist/services/check-parser/package-files/json-text-source-file.js.map +1 -0
- package/dist/services/check-parser/package-files/loader.d.ts +7 -0
- package/dist/services/check-parser/package-files/loader.js +24 -0
- package/dist/services/check-parser/package-files/loader.js.map +1 -0
- package/dist/services/check-parser/package-files/lockfile-package-version.d.ts +85 -0
- package/dist/services/check-parser/package-files/lockfile-package-version.js +317 -0
- package/dist/services/check-parser/package-files/lockfile-package-version.js.map +1 -0
- package/dist/services/check-parser/package-files/lookup.d.ts +12 -0
- package/dist/services/check-parser/package-files/lookup.js +52 -0
- package/dist/services/check-parser/package-files/lookup.js.map +1 -0
- package/dist/services/check-parser/package-files/package-json-file.d.ts +59 -0
- package/dist/services/check-parser/package-files/package-json-file.js +248 -0
- package/dist/services/check-parser/package-files/package-json-file.js.map +1 -0
- package/dist/services/check-parser/package-files/package-manager.d.ts +222 -0
- package/dist/services/check-parser/package-files/package-manager.js +785 -0
- package/dist/services/check-parser/package-files/package-manager.js.map +1 -0
- package/dist/services/check-parser/package-files/paths.d.ts +98 -0
- package/dist/services/check-parser/package-files/paths.js +234 -0
- package/dist/services/check-parser/package-files/paths.js.map +1 -0
- package/dist/services/check-parser/package-files/resolver.d.ts +124 -0
- package/dist/services/check-parser/package-files/resolver.js +468 -0
- package/dist/services/check-parser/package-files/resolver.js.map +1 -0
- package/dist/services/check-parser/package-files/result.d.ts +38 -0
- package/dist/services/check-parser/package-files/result.js +53 -0
- package/dist/services/check-parser/package-files/result.js.map +1 -0
- package/dist/services/check-parser/package-files/source-file-parser.d.ts +10 -0
- package/dist/services/check-parser/package-files/source-file-parser.js +13 -0
- package/dist/services/check-parser/package-files/source-file-parser.js.map +1 -0
- package/dist/services/check-parser/package-files/source-file.d.ts +15 -0
- package/dist/services/check-parser/package-files/source-file.js +38 -0
- package/dist/services/check-parser/package-files/source-file.js.map +1 -0
- package/dist/services/check-parser/package-files/tsconfig-json-file.d.ts +66 -0
- package/dist/services/check-parser/package-files/tsconfig-json-file.js +81 -0
- package/dist/services/check-parser/package-files/tsconfig-json-file.js.map +1 -0
- package/dist/services/check-parser/package-files/walk.d.ts +8 -0
- package/dist/services/check-parser/package-files/walk.js +35 -0
- package/dist/services/check-parser/package-files/walk.js.map +1 -0
- package/dist/services/check-parser/package-files/workspace.d.ts +60 -0
- package/dist/services/check-parser/package-files/workspace.js +103 -0
- package/dist/services/check-parser/package-files/workspace.js.map +1 -0
- package/dist/services/check-parser/parser.d.ts +67 -0
- package/dist/services/check-parser/parser.js +491 -0
- package/dist/services/check-parser/parser.js.map +1 -0
- package/dist/services/check-parser/playwright-config-expander.d.ts +7 -0
- package/dist/services/check-parser/playwright-config-expander.js +96 -0
- package/dist/services/check-parser/playwright-config-expander.js.map +1 -0
- package/dist/services/checkly-config-codegen.d.ts +4 -0
- package/dist/services/checkly-config-codegen.js +189 -0
- package/dist/services/checkly-config-codegen.js.map +1 -0
- package/dist/services/checkly-config-loader.d.ts +97 -0
- package/dist/services/checkly-config-loader.js +113 -0
- package/dist/services/checkly-config-loader.js.map +1 -0
- package/dist/services/config.d.ts +28 -0
- package/dist/services/config.js +93 -0
- package/dist/services/config.js.map +1 -0
- package/dist/services/engine-detector.d.ts +6 -0
- package/dist/services/engine-detector.js +141 -0
- package/dist/services/engine-detector.js.map +1 -0
- package/dist/services/engine-resolver.d.ts +6 -0
- package/dist/services/engine-resolver.js +47 -0
- package/dist/services/engine-resolver.js.map +1 -0
- package/dist/services/engine-rules-loader.d.ts +21 -0
- package/dist/services/engine-rules-loader.js +44 -0
- package/dist/services/engine-rules-loader.js.map +1 -0
- package/dist/services/load-dotenv.d.ts +1 -0
- package/dist/services/load-dotenv.js +44 -0
- package/dist/services/load-dotenv.js.map +1 -0
- package/dist/services/playwright-config.d.ts +27 -0
- package/dist/services/playwright-config.js +139 -0
- package/dist/services/playwright-config.js.map +1 -0
- package/dist/services/playwright-project-bundler.d.ts +47 -0
- package/dist/services/playwright-project-bundler.js +380 -0
- package/dist/services/playwright-project-bundler.js.map +1 -0
- package/dist/services/project-parser.d.ts +30 -0
- package/dist/services/project-parser.js +291 -0
- package/dist/services/project-parser.js.map +1 -0
- package/dist/services/proxy.d.ts +2 -0
- package/dist/services/proxy.js +36 -0
- package/dist/services/proxy.js.map +1 -0
- package/dist/services/shell.d.ts +2 -0
- package/dist/services/shell.js +15 -0
- package/dist/services/shell.js.map +1 -0
- package/dist/services/snapshot-service.d.ts +13 -0
- package/dist/services/snapshot-service.js +56 -0
- package/dist/services/snapshot-service.js.map +1 -0
- package/dist/services/socket-client.d.ts +4 -0
- package/dist/services/socket-client.js +58 -0
- package/dist/services/socket-client.js.map +1 -0
- package/dist/services/test-filters.d.ts +3 -0
- package/dist/services/test-filters.js +21 -0
- package/dist/services/test-filters.js.map +1 -0
- package/dist/services/test-runner.d.ts +28 -0
- package/dist/services/test-runner.js +82 -0
- package/dist/services/test-runner.js.map +1 -0
- package/dist/services/trigger-runner.d.ts +29 -0
- package/dist/services/trigger-runner.js +49 -0
- package/dist/services/trigger-runner.js.map +1 -0
- package/dist/services/util.d.ts +34 -0
- package/dist/services/util.js +167 -0
- package/dist/services/util.js.map +1 -0
- package/dist/sourcegen/args.d.ts +7 -0
- package/dist/sourcegen/args.js +22 -0
- package/dist/sourcegen/args.js.map +1 -0
- package/dist/sourcegen/argsbuilder.d.ts +22 -0
- package/dist/sourcegen/argsbuilder.js +106 -0
- package/dist/sourcegen/argsbuilder.js.map +1 -0
- package/dist/sourcegen/array.d.ts +8 -0
- package/dist/sourcegen/array.js +28 -0
- package/dist/sourcegen/array.js.map +1 -0
- package/dist/sourcegen/arraybuilder.d.ts +21 -0
- package/dist/sourcegen/arraybuilder.js +104 -0
- package/dist/sourcegen/arraybuilder.js.map +1 -0
- package/dist/sourcegen/boolean.d.ts +7 -0
- package/dist/sourcegen/boolean.js +18 -0
- package/dist/sourcegen/boolean.js.map +1 -0
- package/dist/sourcegen/case.d.ts +9 -0
- package/dist/sourcegen/case.js +96 -0
- package/dist/sourcegen/case.js.map +1 -0
- package/dist/sourcegen/comment.d.ts +32 -0
- package/dist/sourcegen/comment.js +113 -0
- package/dist/sourcegen/comment.js.map +1 -0
- package/dist/sourcegen/decl.d.ts +43 -0
- package/dist/sourcegen/decl.js +86 -0
- package/dist/sourcegen/decl.js.map +1 -0
- package/dist/sourcegen/declbuilder.d.ts +14 -0
- package/dist/sourcegen/declbuilder.js +34 -0
- package/dist/sourcegen/declbuilder.js.map +1 -0
- package/dist/sourcegen/expr.d.ts +39 -0
- package/dist/sourcegen/expr.js +77 -0
- package/dist/sourcegen/expr.js.map +1 -0
- package/dist/sourcegen/exprbuilder.d.ts +13 -0
- package/dist/sourcegen/exprbuilder.js +49 -0
- package/dist/sourcegen/exprbuilder.js.map +1 -0
- package/dist/sourcegen/identifier.d.ts +12 -0
- package/dist/sourcegen/identifier.js +22 -0
- package/dist/sourcegen/identifier.js.map +1 -0
- package/dist/sourcegen/index.d.ts +22 -0
- package/dist/sourcegen/index.js +23 -0
- package/dist/sourcegen/index.js.map +1 -0
- package/dist/sourcegen/null.d.ts +5 -0
- package/dist/sourcegen/null.js +7 -0
- package/dist/sourcegen/null.js.map +1 -0
- package/dist/sourcegen/number.d.ts +7 -0
- package/dist/sourcegen/number.js +18 -0
- package/dist/sourcegen/number.js.map +1 -0
- package/dist/sourcegen/object.d.ts +28 -0
- package/dist/sourcegen/object.js +80 -0
- package/dist/sourcegen/object.js.map +1 -0
- package/dist/sourcegen/objectbuilder.d.ts +25 -0
- package/dist/sourcegen/objectbuilder.js +122 -0
- package/dist/sourcegen/objectbuilder.js.map +1 -0
- package/dist/sourcegen/output.d.ts +14 -0
- package/dist/sourcegen/output.js +81 -0
- package/dist/sourcegen/output.js.map +1 -0
- package/dist/sourcegen/program.d.ts +53 -0
- package/dist/sourcegen/program.js +254 -0
- package/dist/sourcegen/program.js.map +1 -0
- package/dist/sourcegen/string.d.ts +8 -0
- package/dist/sourcegen/string.js +23 -0
- package/dist/sourcegen/string.js.map +1 -0
- package/dist/sourcegen/undefined.d.ts +5 -0
- package/dist/sourcegen/undefined.js +7 -0
- package/dist/sourcegen/undefined.js.map +1 -0
- package/dist/sourcegen/unknown.d.ts +2 -0
- package/dist/sourcegen/unknown.js +36 -0
- package/dist/sourcegen/unknown.js.map +1 -0
- package/dist/sourcegen/value.d.ts +4 -0
- package/dist/sourcegen/value.js +3 -0
- package/dist/sourcegen/value.js.map +1 -0
- package/dist/testing/fixture-sandbox.d.ts +41 -0
- package/dist/testing/fixture-sandbox.js +122 -0
- package/dist/testing/fixture-sandbox.js.map +1 -0
- package/dist/testing/global-setup.d.ts +2 -0
- package/dist/testing/global-setup.js +14 -0
- package/dist/testing/global-setup.js.map +1 -0
- package/dist/util/index.d.ts +9 -0
- package/dist/util/index.js +23 -0
- package/dist/util/index.js.map +1 -0
- package/oclif.manifest.json +3702 -0
- package/package.json +166 -0
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# ICMP Monitor
|
|
2
|
+
|
|
3
|
+
- Import the `IcmpMonitor` construct from `checkly/constructs`.
|
|
4
|
+
- Reference [the docs for ICMP monitors](https://www.checklyhq.com/docs/constructs/icmp-monitor/) before generating any code.
|
|
5
|
+
- When adding `assertions`, always use `IcmpAssertionBuilder` class.
|
|
6
|
+
- Latency assertions require a property parameter: `'avg'`, `'min'`, `'max'`, or `'stdDev'`.
|
|
7
|
+
- Use `degradedPacketLossThreshold` and `maxPacketLossThreshold` for packet loss thresholds (percentages).
|
|
8
|
+
- **Plan-gated properties:** `retryStrategy`, `runParallel`, and higher frequencies are not available on all plans. Check entitlements matching `UPTIME_CHECKS_*` before using these. Omit any property whose entitlement is disabled. See `npx checkly skills manage` for details.
|
|
9
|
+
|
|
10
|
+
**Reference:** https://www.checklyhq.com/docs/constructs/icmp-monitor/
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AlertEscalationBuilder, Frequency, IcmpAssertionBuilder, IcmpMonitor, RetryStrategyBuilder } from 'checkly/constructs'
|
|
14
|
+
|
|
15
|
+
new IcmpMonitor('example-icmp-monitor', {
|
|
16
|
+
name: 'Example ICMP Monitor',
|
|
17
|
+
request: {
|
|
18
|
+
hostname: 'INSERT_HOSTNAME',
|
|
19
|
+
pingCount: 10,
|
|
20
|
+
assertions: [
|
|
21
|
+
IcmpAssertionBuilder.latency('avg').lessThan(100),
|
|
22
|
+
IcmpAssertionBuilder.latency('max').lessThan(200),
|
|
23
|
+
],
|
|
24
|
+
},
|
|
25
|
+
degradedPacketLossThreshold: 10,
|
|
26
|
+
maxPacketLossThreshold: 20,
|
|
27
|
+
activated: true,
|
|
28
|
+
locations: [
|
|
29
|
+
'eu-central-1',
|
|
30
|
+
'eu-north-1',
|
|
31
|
+
],
|
|
32
|
+
frequency: Frequency.EVERY_10M,
|
|
33
|
+
alertEscalationPolicy: AlertEscalationBuilder.runBasedEscalation(1, {
|
|
34
|
+
amount: 0,
|
|
35
|
+
interval: 5,
|
|
36
|
+
}, {
|
|
37
|
+
enabled: false,
|
|
38
|
+
percentage: 10,
|
|
39
|
+
}),
|
|
40
|
+
retryStrategy: RetryStrategyBuilder.noRetries(),
|
|
41
|
+
})
|
|
42
|
+
```
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# MultiStep Checks
|
|
2
|
+
|
|
3
|
+
- Import the `MultiStepCheck` construct from `checkly/constructs`.
|
|
4
|
+
- Generate a separate `.spec.ts` file for the Playwright code referenced in the `MultiStepCheck` construct.
|
|
5
|
+
- Use the `code.entrypoint` property to specify the path to your Playwright test file.
|
|
6
|
+
- For env vars Checkly exposes at runtime (`CHECK_ID`, `REGION`, `RUNTIME_VERSION`, etc.), see `npx checkly skills configure environment`.
|
|
7
|
+
|
|
8
|
+
**Reference:** https://www.checklyhq.com/docs/constructs/multistep-check/
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
import { AlertEscalationBuilder, Frequency, MultiStepCheck, RetryStrategyBuilder } from 'checkly/constructs'
|
|
12
|
+
|
|
13
|
+
new MultiStepCheck('example-multi-step-check', {
|
|
14
|
+
name: 'Example Multistep Check',
|
|
15
|
+
code: {
|
|
16
|
+
entrypoint: './example-multistep-check.spec.ts',
|
|
17
|
+
},
|
|
18
|
+
activated: true,
|
|
19
|
+
locations: [
|
|
20
|
+
'eu-central-1',
|
|
21
|
+
'eu-west-2',
|
|
22
|
+
],
|
|
23
|
+
frequency: Frequency.EVERY_1H,
|
|
24
|
+
alertEscalationPolicy: AlertEscalationBuilder.runBasedEscalation(1, {
|
|
25
|
+
amount: 0,
|
|
26
|
+
interval: 5,
|
|
27
|
+
}, {
|
|
28
|
+
enabled: false,
|
|
29
|
+
percentage: 10,
|
|
30
|
+
}),
|
|
31
|
+
retryStrategy: RetryStrategyBuilder.noRetries(),
|
|
32
|
+
runParallel: true,
|
|
33
|
+
})
|
|
34
|
+
```
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Playwright Check Suites
|
|
2
|
+
|
|
3
|
+
- Import the `PlaywrightCheck` construct from `checkly/constructs`.
|
|
4
|
+
- Use Playwright Check Suites to run an existing Playwright project. Do not rewrite tests as Browser or Multistep Checks unless the user asks.
|
|
5
|
+
- Set `playwrightConfigPath` relative to the `.check.ts` file that declares the construct, not the project root. If the check is in `monitoring/suites.check.ts` and the config is at the repo root, use `"../playwright.config.ts"`.
|
|
6
|
+
- Use `pwProjects` only when the user wants specific Playwright projects. Values must match the Playwright project `name`, such as `"Cart & Checkout"`, not a folder or slug. Wrong names can deploy but run zero tests.
|
|
7
|
+
- Use `pwTags` only when the user wants tag-based selection.
|
|
8
|
+
|
|
9
|
+
## Dependencies
|
|
10
|
+
|
|
11
|
+
- Use the user's `package.json` and lock file for dependencies. Do not add dependency declarations to check code.
|
|
12
|
+
- For private packages or custom registries, include the registry config file, usually `.npmrc`, with `include`.
|
|
13
|
+
- The `.npmrc` should reference a Checkly environment variable such as `${NPM_TOKEN}`. Tell the user that the token must exist in Checkly before `deploy` or `trigger`.
|
|
14
|
+
- Use `installCommand` only when the default package-manager install command is not enough.
|
|
15
|
+
- In Checkly CLI v8.0.0 and later, `include` patterns resolve relative to the Playwright config directory, not the project root. If `playwrightConfigPath` points to a subdirectory, adjust `include` globs. Example: `playwrightConfigPath: "./e2e/playwright.config.ts"` with root `.npmrc` needs `include: ["../.npmrc"]`.
|
|
16
|
+
|
|
17
|
+
## Install troubleshooting
|
|
18
|
+
|
|
19
|
+
- The execution environment is Linux and non-root, and it does not include a C/C++ compiler. Browsers are pre-installed, so never add `playwright install`, `npx playwright install`, Puppeteer browser downloads, or similar browser installation commands.
|
|
20
|
+
- If `scripts.postinstall`, `scripts.prepare`, or `scripts.install` references missing files, downloads browsers, sets up git hooks, or compiles native code, set `installCommand` to skip project lifecycle scripts and rebuild dependency scripts:
|
|
21
|
+
- npm: `npm install --ignore-scripts && npm rebuild`
|
|
22
|
+
- pnpm: `pnpm install --ignore-scripts && pnpm rebuild`
|
|
23
|
+
- Flag likely dependency problems before suggesting a deploy:
|
|
24
|
+
- `puppeteer` is usually unnecessary because browsers are pre-installed.
|
|
25
|
+
- Native dependencies that require a compiler, such as `sharp` or `better-sqlite3`, may fail.
|
|
26
|
+
- `fsevents` must be optional; a locked non-optional `fsevents` dependency can fail on Linux.
|
|
27
|
+
- `workspace:*` dependencies must be included in the uploaded bundle.
|
|
28
|
+
- Private registries must have auth configured through Checkly environment variables.
|
|
29
|
+
|
|
30
|
+
## Runtime model
|
|
31
|
+
|
|
32
|
+
- Do not use `runtimeId` for Playwright Check Suites. Browser and Multistep Checks use `runtimeId`; Playwright Check Suites use project dependencies plus `engine`.
|
|
33
|
+
- Omit `engine` unless the user explicitly asks to override the JavaScript engine or version.
|
|
34
|
+
- If an engine override is needed, import `Engine` from `checkly/constructs` and use `Engine.node("24")` or `Engine.bun("1.3")`.
|
|
35
|
+
- If no engine is configured or detected, Checkly defaults to Node.js 22. Node.js engine majors map to pinned patch versions: `22` -> `22.14.0`, `24` -> `24.13.1`, and `26` -> `26.2.0`.
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import { PlaywrightCheck } from "checkly/constructs"
|
|
39
|
+
|
|
40
|
+
new PlaywrightCheck("checkout-suite", {
|
|
41
|
+
name: "Checkout suite",
|
|
42
|
+
playwrightConfigPath: "./e2e/playwright.config.ts",
|
|
43
|
+
// Include root .npmrc for private package or registry auth.
|
|
44
|
+
include: ["../.npmrc"],
|
|
45
|
+
})
|
|
46
|
+
```
|
|
47
|
+
- `playwrightConfigPath` is resolved **relative to the `.check.ts` file that declares the construct**, not the project root. If your check lives in `monitoring/suites.check.ts` and your config in `playwright.config.ts` at the repo root, use `'../playwright.config.ts'`.
|
|
48
|
+
- use `pwProjects` if you're tasked to reuse a Playwright project. Values must match the `name` field of each project in your `playwright.config.ts` (e.g. `'Cart & Checkout'`), **not** the directory slug. Mismatched names deploy silently and resolve to zero tests.
|
|
49
|
+
- use `pwTags` if you're tasked to reuse a Playwright tag.
|
|
50
|
+
- Use `include` only for non-code assets that specs read via `fs` at runtime (markdown, JSON fixtures, snapshots). Test files and anything reachable through `import` are already bundled via Playwright's project discovery and the import graph — listing them in `include` is redundant. Globs resolve **relative to the directory of `playwrightConfigPath`**, not the project root and not the `.check.ts`.
|
|
51
|
+
- For env vars Checkly exposes at runtime (e.g. `CHECKLY=1` for "am I running on Checkly?"), see `npx checkly skills configure environment`.
|
|
52
|
+
|
|
53
|
+
**Reference:** https://www.checklyhq.com/docs/constructs/playwright-check/
|
|
54
|
+
|
|
55
|
+
```typescript
|
|
56
|
+
import { PlaywrightCheck } from "checkly/constructs"
|
|
57
|
+
|
|
58
|
+
const playwrightChecks = new PlaywrightCheck("multi-browser-check", {
|
|
59
|
+
name: "Multi-browser check suite",
|
|
60
|
+
playwrightConfigPath: "./playwright.config.ts",
|
|
61
|
+
// Playwright Check Suites support all browsers
|
|
62
|
+
// defined in your `playwright.config`
|
|
63
|
+
pwProjects: ["chromium", "firefox", "webkit"],
|
|
64
|
+
// Bundle non-code assets that specs read via `fs` at runtime.
|
|
65
|
+
// Test files and anything reachable through `import` are already
|
|
66
|
+
// bundled — `include` is only for files outside the import graph.
|
|
67
|
+
// Globs resolve relative to the playwright config's directory.
|
|
68
|
+
include: ["fixtures/**/*.json", "docs/**/*.md"],
|
|
69
|
+
});
|
|
70
|
+
```
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# Supporting Constructs
|
|
2
|
+
|
|
3
|
+
## Status Page
|
|
4
|
+
|
|
5
|
+
- Import the `StatusPage` construct from `checkly/constructs`.
|
|
6
|
+
- Status pages are used to display the status of your services to your users.
|
|
7
|
+
- A Status Page consists of cards which include Status Page Services.
|
|
8
|
+
|
|
9
|
+
**Reference:** https://www.checklyhq.com/docs/constructs/status-page/
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
import { StatusPage } from 'checkly/constructs'
|
|
13
|
+
import { exampleService } from './services/example-service.check'
|
|
14
|
+
|
|
15
|
+
new StatusPage('example-status-page', {
|
|
16
|
+
name: 'Example Status Page',
|
|
17
|
+
url: 'example-status-page',
|
|
18
|
+
cards: [
|
|
19
|
+
{
|
|
20
|
+
name: 'Example service',
|
|
21
|
+
services: [
|
|
22
|
+
exampleService,
|
|
23
|
+
],
|
|
24
|
+
},
|
|
25
|
+
],
|
|
26
|
+
customDomain: 'status.example.com',
|
|
27
|
+
defaultTheme: 'AUTO',
|
|
28
|
+
})
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Status Page Service
|
|
32
|
+
|
|
33
|
+
- Import the `StatusPageService` construct from `checkly/constructs`.
|
|
34
|
+
- Status Page Services are used to represent individual services on a Status Page.
|
|
35
|
+
|
|
36
|
+
**Reference:** https://www.checklyhq.com/docs/constructs/status-page-service/
|
|
37
|
+
|
|
38
|
+
```typescript
|
|
39
|
+
import { StatusPageService } from 'checkly/constructs'
|
|
40
|
+
|
|
41
|
+
export const exampleService = new StatusPageService('example-status-page-service', {
|
|
42
|
+
name: 'Example Service',
|
|
43
|
+
})
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Dashboard
|
|
47
|
+
|
|
48
|
+
- Import the `Dashboard` construct from `checkly/constructs`.
|
|
49
|
+
- Dashboards are used to display the results of your checks on screens external to Checkly.
|
|
50
|
+
- To apply custom styling, set `customCSS` to an entrypoint object so Checkly bundles and hosts the file: `customCSS: { entrypoint: './dashboard.css' }`. Passing a raw string read with `fs.readFileSync` is rejected at deploy time.
|
|
51
|
+
|
|
52
|
+
**Reference:** https://www.checklyhq.com/docs/constructs/dashboard/
|
|
53
|
+
|
|
54
|
+
```typescript
|
|
55
|
+
import { Dashboard } from 'checkly/constructs'
|
|
56
|
+
|
|
57
|
+
new Dashboard('example-dashboard', {
|
|
58
|
+
tags: [
|
|
59
|
+
'app:webshop',
|
|
60
|
+
],
|
|
61
|
+
customUrl: 'example-dashboard',
|
|
62
|
+
customDomain: 'dash.example.com',
|
|
63
|
+
header: 'Example Dashboard',
|
|
64
|
+
description: 'Example dashboard',
|
|
65
|
+
width: 'FULL',
|
|
66
|
+
refreshRate: 60,
|
|
67
|
+
paginate: true,
|
|
68
|
+
paginationRate: 60,
|
|
69
|
+
checksPerPage: 15,
|
|
70
|
+
useTagsAndOperator: false,
|
|
71
|
+
hideTags: false,
|
|
72
|
+
enableIncidents: false,
|
|
73
|
+
expandChecks: false,
|
|
74
|
+
showHeader: true,
|
|
75
|
+
isPrivate: false,
|
|
76
|
+
showP95: true,
|
|
77
|
+
showP99: true,
|
|
78
|
+
})
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Maintenance Window
|
|
82
|
+
|
|
83
|
+
- Import the `MaintenanceWindow` construct from `checkly/constructs`.
|
|
84
|
+
- Maintenance windows are used to pause checks during maintenance periods so no alerts are sent.
|
|
85
|
+
- Checks are referenced by their tags in the `tags` property.
|
|
86
|
+
|
|
87
|
+
**Reference:** https://www.checklyhq.com/docs/constructs/maintenance-window/
|
|
88
|
+
|
|
89
|
+
```typescript
|
|
90
|
+
import { MaintenanceWindow } from 'checkly/constructs'
|
|
91
|
+
|
|
92
|
+
new MaintenanceWindow('example-maintenance-window', {
|
|
93
|
+
name: 'Example Maintenance Window',
|
|
94
|
+
tags: [
|
|
95
|
+
'app:webshop',
|
|
96
|
+
],
|
|
97
|
+
startsAt: new Date('2025-07-01T09:00:00.000Z'),
|
|
98
|
+
endsAt: new Date('2025-07-01T10:00:00.000Z'),
|
|
99
|
+
repeatInterval: 1,
|
|
100
|
+
repeatUnit: 'WEEK',
|
|
101
|
+
repeatEndsAt: new Date('2025-08-01T00:00:00.000Z'),
|
|
102
|
+
})
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## Private Location
|
|
106
|
+
|
|
107
|
+
- Import the `PrivateLocation` construct from `checkly/constructs`.
|
|
108
|
+
- Private locations are used to run checks from your own infrastructure with the Checkly Agent, an OCI compatible container.
|
|
109
|
+
|
|
110
|
+
**Reference:** https://www.checklyhq.com/docs/constructs/private-location/
|
|
111
|
+
|
|
112
|
+
```typescript
|
|
113
|
+
import { PrivateLocation } from 'checkly/constructs'
|
|
114
|
+
|
|
115
|
+
export const examplePrivateLocation = new PrivateLocation('example-private-location', {
|
|
116
|
+
name: 'Example Private Location',
|
|
117
|
+
slugName: 'example-private-location',
|
|
118
|
+
icon: 'location',
|
|
119
|
+
})
|
|
120
|
+
```
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# TCP Monitor
|
|
2
|
+
|
|
3
|
+
- Import the `TcpMonitor` construct from `checkly/constructs`.
|
|
4
|
+
- When adding `assertions`, always use `TcpAssertionBuilder` class for TCP monitors.
|
|
5
|
+
- **Plan-gated properties:** `retryStrategy`, `runParallel`, and higher frequencies are not available on all plans. Check entitlements matching `UPTIME_CHECKS_*` before using these. Omit any property whose entitlement is disabled. See `npx checkly skills manage` for details.
|
|
6
|
+
|
|
7
|
+
**Reference:** https://www.checklyhq.com/docs/constructs/tcp-monitor/
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { AlertEscalationBuilder, Frequency, RetryStrategyBuilder, TcpAssertionBuilder, TcpMonitor } from 'checkly/constructs'
|
|
11
|
+
|
|
12
|
+
new TcpMonitor('example-tcp-monitor', {
|
|
13
|
+
name: 'Example TCP Monitor',
|
|
14
|
+
degradedResponseTime: 5000,
|
|
15
|
+
maxResponseTime: 5000,
|
|
16
|
+
activated: true,
|
|
17
|
+
locations: [
|
|
18
|
+
'eu-central-1',
|
|
19
|
+
'eu-west-2',
|
|
20
|
+
],
|
|
21
|
+
frequency: Frequency.EVERY_1H,
|
|
22
|
+
alertEscalationPolicy: AlertEscalationBuilder.runBasedEscalation(1, {
|
|
23
|
+
amount: 0,
|
|
24
|
+
interval: 5,
|
|
25
|
+
}, {
|
|
26
|
+
enabled: false,
|
|
27
|
+
percentage: 10,
|
|
28
|
+
}),
|
|
29
|
+
retryStrategy: RetryStrategyBuilder.noRetries(),
|
|
30
|
+
runParallel: true,
|
|
31
|
+
request: {
|
|
32
|
+
hostname: 'INSERT_HOSTNAME',
|
|
33
|
+
port: 4242,
|
|
34
|
+
ipFamily: 'IPv4',
|
|
35
|
+
assertions: [
|
|
36
|
+
TcpAssertionBuilder.responseTime().lessThan(200),
|
|
37
|
+
TcpAssertionBuilder.responseData().isEmpty(),
|
|
38
|
+
],
|
|
39
|
+
},
|
|
40
|
+
})
|
|
41
|
+
```
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# URL Monitor
|
|
2
|
+
|
|
3
|
+
- Import the `UrlMonitor` construct from `checkly/constructs`.
|
|
4
|
+
- When adding `assertions`, always use `UrlAssertionBuilder`.
|
|
5
|
+
- **Important:** The target URL must be publicly accessible — checks run on Checkly's cloud, not locally.
|
|
6
|
+
- **Plan-gated properties:** `retryStrategy`, `runParallel`, and higher frequencies are not available on all plans. Check entitlements matching `UPTIME_CHECKS_*` before using these. Omit any property whose entitlement is disabled — Checkly applies safe defaults. See `npx checkly skills manage` for details.
|
|
7
|
+
|
|
8
|
+
**Reference:** https://www.checklyhq.com/docs/constructs/url-monitor/
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
import { AlertEscalationBuilder, Frequency, RetryStrategyBuilder, UrlAssertionBuilder, UrlMonitor } from 'checkly/constructs'
|
|
12
|
+
|
|
13
|
+
new UrlMonitor('example-url-monitor', {
|
|
14
|
+
name: 'Example URL Monitor',
|
|
15
|
+
activated: true,
|
|
16
|
+
locations: [
|
|
17
|
+
'eu-central-1',
|
|
18
|
+
'eu-west-2',
|
|
19
|
+
],
|
|
20
|
+
frequency: Frequency.EVERY_5M,
|
|
21
|
+
alertEscalationPolicy: AlertEscalationBuilder.runBasedEscalation(1, {
|
|
22
|
+
amount: 0,
|
|
23
|
+
interval: 5,
|
|
24
|
+
}, {
|
|
25
|
+
enabled: false,
|
|
26
|
+
percentage: 10,
|
|
27
|
+
}),
|
|
28
|
+
retryStrategy: RetryStrategyBuilder.noRetries(),
|
|
29
|
+
runParallel: true,
|
|
30
|
+
degradedResponseTime: 5000,
|
|
31
|
+
maxResponseTime: 20000,
|
|
32
|
+
request: {
|
|
33
|
+
url: 'INSERT_URL',
|
|
34
|
+
ipFamily: 'IPv4',
|
|
35
|
+
assertions: [
|
|
36
|
+
UrlAssertionBuilder.statusCode().equals(200),
|
|
37
|
+
],
|
|
38
|
+
},
|
|
39
|
+
})
|
|
40
|
+
```
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# Checkly Monitoring
|
|
2
|
+
|
|
3
|
+
- Refer to docs for Checkly CLI v6.0.0 and above.
|
|
4
|
+
- Check the Checkly CLI output to figure out into which folder the setup was generated.
|
|
5
|
+
- Use the [Checkly CLI reference documentation](https://www.checklyhq.com/docs/cli/overview/).
|
|
6
|
+
- Use the [Checkly construct reference documentation](https://www.checklyhq.com/docs/constructs/overview/).
|
|
7
|
+
- Import and / or require any constructs you need in your code, such as `ApiCheck`, `BrowserCheck`, or `PlaywrightCheck` from the `checkly/constructs` package.
|
|
8
|
+
- Always ground generated code and CLI commands against the official documentation and examples in this file.
|
|
9
|
+
- Use `runtimeId` for Browser Checks and MultiStep Checks. Runtimes are managed Checkly execution environments with fixed Checkly-provided dependencies such as Playwright, browser binaries, and runtime libraries.
|
|
10
|
+
- Use `engine` only for Playwright Check Suites. `engine` selects the JavaScript engine version that runs the user's own Playwright project.
|
|
11
|
+
|
|
12
|
+
## Using the Checkly CLI
|
|
13
|
+
|
|
14
|
+
- Use `npx checkly` instead of installing the Checkly CLI globally.
|
|
15
|
+
- NEVER make up commands that do not exist.
|
|
16
|
+
- Use `npx checkly init` to set up Checkly in an existing project.
|
|
17
|
+
|
|
18
|
+
## Project Structure
|
|
19
|
+
|
|
20
|
+
- `checkly.config.ts` - Mandatory global project and CLI configuration. We recommend using TypeScript.
|
|
21
|
+
- `*.check.ts|js` - TS / JS files that define the checks.
|
|
22
|
+
- `*.spec.ts|js` - TS / JS files that contain Playwright code for Browser and MultiStep checks.
|
|
23
|
+
- `src/__checks__` - Default directory where all your checks are stored. Use this directory if it already exists, otherwise create a new directory for your checks.
|
|
24
|
+
- `package.json` - Standard npm project manifest.
|
|
25
|
+
|
|
26
|
+
Here is an example directory tree of what that would look like:
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
.
|
|
30
|
+
|-- checkly.config.ts
|
|
31
|
+
|-- package.json
|
|
32
|
+
`-- src
|
|
33
|
+
`-- __checks__
|
|
34
|
+
|-- alert-channels.ts
|
|
35
|
+
|-- api-check.check.ts
|
|
36
|
+
`-- homepage.spec.ts
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
The `checkly.config.ts` at the root of your project defines a range of defaults for all your checks.
|
|
40
|
+
|
|
41
|
+
**Reference:** https://www.checklyhq.com/docs/constructs/project/
|
|
42
|
+
|
|
43
|
+
```typescript
|
|
44
|
+
import { defineConfig } from 'checkly'
|
|
45
|
+
import { Frequency } from 'checkly/constructs'
|
|
46
|
+
|
|
47
|
+
export default defineConfig({
|
|
48
|
+
projectName: "Production Monitoring Suite",
|
|
49
|
+
logicalId: "prod-monitoring-2025",
|
|
50
|
+
repoUrl: "https://github.com/acme/monitoring",
|
|
51
|
+
checks: {
|
|
52
|
+
activated: true,
|
|
53
|
+
muted: false,
|
|
54
|
+
runtimeId: "2025.04",
|
|
55
|
+
frequency: Frequency.EVERY_10M,
|
|
56
|
+
locations: ["us-east-1", "eu-west-1", "ap-southeast-1"],
|
|
57
|
+
tags: ["production", "critical"],
|
|
58
|
+
checkMatch: "**/__checks__/*.check.ts",
|
|
59
|
+
ignoreDirectoriesMatch: ["node_modules/**", "dist/**"],
|
|
60
|
+
playwrightConfig: {
|
|
61
|
+
use: {
|
|
62
|
+
baseURL: "https://app.example.com",
|
|
63
|
+
},
|
|
64
|
+
},
|
|
65
|
+
browserChecks: {
|
|
66
|
+
frequency: Frequency.EVERY_30M,
|
|
67
|
+
testMatch: "**/__tests__/*.spec.ts",
|
|
68
|
+
},
|
|
69
|
+
},
|
|
70
|
+
cli: {
|
|
71
|
+
runLocation: "eu-west-1",
|
|
72
|
+
privateRunLocation: "private-dc1",
|
|
73
|
+
retries: 2,
|
|
74
|
+
},
|
|
75
|
+
})
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Check and Monitor Constructs
|
|
79
|
+
|
|
80
|
+
Parse and read further reference documentation when tasked with creating or managing any of the following Checkly constructs.
|
|
81
|
+
|
|
82
|
+
If the Checkly CLI is installed (`npx checkly version`), use `npx checkly skills configure [CONSTRUCT]` to access up-to-date information:
|
|
83
|
+
|
|
84
|
+
### `npx checkly skills configure agentic-checks`
|
|
85
|
+
Agentic Check construct (`AgenticCheck`) for AI-powered prompt-driven monitoring with skill and env var allowlists
|
|
86
|
+
|
|
87
|
+
### `npx checkly skills configure api-checks`
|
|
88
|
+
Api Check construct (`ApiCheck`), assertions, and authentication setup scripts
|
|
89
|
+
|
|
90
|
+
### `npx checkly skills configure browser-checks`
|
|
91
|
+
Browser Check construct (`BrowserCheck`) with Playwright test files
|
|
92
|
+
|
|
93
|
+
### `npx checkly skills configure playwright-checks`
|
|
94
|
+
Playwright Check Suite construct (`PlaywrightCheck`) for multi-browser test suites
|
|
95
|
+
|
|
96
|
+
### `npx checkly skills configure multistep-checks`
|
|
97
|
+
Multistep Check construct (`MultiStepCheck`) for complex user flows
|
|
98
|
+
|
|
99
|
+
### `npx checkly skills configure tcp-monitors`
|
|
100
|
+
TCP Monitor construct (`TcpMonitor`) with assertions
|
|
101
|
+
|
|
102
|
+
### `npx checkly skills configure url-monitors`
|
|
103
|
+
URL Monitor construct (`UrlMonitor`) with assertions
|
|
104
|
+
|
|
105
|
+
### `npx checkly skills configure dns-monitors`
|
|
106
|
+
DNS Monitor construct (`DnsMonitor`) with assertions
|
|
107
|
+
|
|
108
|
+
### `npx checkly skills configure icmp-monitors`
|
|
109
|
+
ICMP Monitor construct (`IcmpMonitor`) with latency and packet loss assertions
|
|
110
|
+
|
|
111
|
+
### `npx checkly skills configure heartbeat-monitors`
|
|
112
|
+
Heartbeat Monitor construct (`HeartbeatMonitor`)
|
|
113
|
+
|
|
114
|
+
### `npx checkly skills configure check-groups`
|
|
115
|
+
CheckGroupV2 construct (`CheckGroupV2`) for organizing checks
|
|
116
|
+
|
|
117
|
+
### `npx checkly skills configure alert-channels`
|
|
118
|
+
Email (`EmailAlertChannel`), Phone (`PhoneCallAlertChannel`), Slack App (`SlackAppAlertChannel`), and other alert channels
|
|
119
|
+
|
|
120
|
+
### `npx checkly skills configure supporting-constructs`
|
|
121
|
+
Status pages (`StatusPage`), dashboards (`Dashboard`), maintenance windows (`MaintenanceWindow`), and private locations (`PrivateLocation`)
|
|
122
|
+
|
|
123
|
+
### `npx checkly skills configure environment`
|
|
124
|
+
Environment variables: built-in vars Checkly injects at runtime (`CHECK_ID`, `CHECK_NAME`, `REGION`, `CHECKLY_*`), user-defined variables and secrets at global/group/check scope, reference syntax (`process.env` vs `{{handlebars}}`), and the `checkly env` CLI for managing global vars.
|
|
125
|
+
|
|
126
|
+
## Important: Public URL Requirement
|
|
127
|
+
|
|
128
|
+
All checks (API, Browser, URL monitors) run on **Checkly's cloud infrastructure**, not on the user's local machine. Target URLs must be publicly accessible from the internet.
|
|
129
|
+
|
|
130
|
+
- `localhost` and private network URLs will **not work** with `npx checkly test` or `npx checkly deploy`
|
|
131
|
+
- For local development, suggest: tunneling tools (ngrok, cloudflare tunnel), preview/staging deployments, or CI preview URLs
|
|
132
|
+
- Always confirm with the user that their target URLs are publicly reachable before creating checks
|
|
133
|
+
|
|
134
|
+
## Check Locations and Plan Entitlements
|
|
135
|
+
|
|
136
|
+
Not all features and locations are available on all plans. **Before configuring checks, run:**
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
npx checkly account plan --output json
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
This returns your exact entitlements and available locations. Use only locations where `available` is `true` in the `locations.all` array. If a feature is disabled, the response includes an `upgradeUrl` to share with the user.
|
|
143
|
+
|
|
144
|
+
Run `npx checkly skills manage plan` for the full reference.
|
|
145
|
+
|
|
146
|
+
## Testing and Debugging
|
|
147
|
+
|
|
148
|
+
- Test checks using the `npx checkly test` command. Pass environment variables with the `-e` flag, results are recorded by default (use `--no-record` to skip), and use `--verbose` to see all errors.
|
|
149
|
+
|
|
150
|
+
## Deploying
|
|
151
|
+
|
|
152
|
+
- Deploy checks using the `npx checkly deploy` command. Use `--output` to see the created, updated, and deleted resources. Use `--verbose` to also include each resource's name and physical ID (UUID), which is useful for programmatically referencing deployed resources (e.g. `npx checkly checks get <id>`).
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# Checkly Project Setup
|
|
2
|
+
|
|
3
|
+
Follow these steps in order to set up a new Checkly monitoring project.
|
|
4
|
+
|
|
5
|
+
## Step 0 — Pre-flight checks
|
|
6
|
+
|
|
7
|
+
Before starting, verify:
|
|
8
|
+
|
|
9
|
+
1. **Node.js** is installed (`node --version`). Checkly CLI requires Node.js 18 or later.
|
|
10
|
+
2. **npm** is available (`npm --version`).
|
|
11
|
+
3. The current working directory is the right location for the project (or create/navigate to it).
|
|
12
|
+
|
|
13
|
+
If any pre-flight check fails, help the user fix it before proceeding.
|
|
14
|
+
|
|
15
|
+
## Step 1 — Choose a setup method
|
|
16
|
+
|
|
17
|
+
Ask the user which setup method they prefer:
|
|
18
|
+
|
|
19
|
+
- **Option A: Initialize with CLI** — Run `npx checkly init` to set up Checkly in the project. The CLI handles skill installation, dependencies, configuration, and optionally creates demo checks. This is the fastest way to get started.
|
|
20
|
+
- **Option B: AI-first** — Generate the project structure and checks from scratch using this skill. Best when the user already knows what they want to monitor and prefers a tailored setup.
|
|
21
|
+
|
|
22
|
+
### Option A: Initialize with CLI
|
|
23
|
+
|
|
24
|
+
Run the following command:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npx checkly init
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
The CLI will guide you through skill installation, configuration, and dependency setup. Once finished, setup is complete.
|
|
31
|
+
|
|
32
|
+
### Option B: AI-first
|
|
33
|
+
|
|
34
|
+
Continue with the following steps:
|
|
35
|
+
|
|
36
|
+
#### Step 1: Install dependencies
|
|
37
|
+
|
|
38
|
+
1. **Install the Checkly dependency**
|
|
39
|
+
|
|
40
|
+
Check if `npx checkly --version` works. If not, run `npm install --save-dev checkly`.
|
|
41
|
+
|
|
42
|
+
2. **Do you want to use TypeScript? (recommended)**
|
|
43
|
+
- If **yes** → install `jiti`:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npm i --save-dev jiti
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
- If **no** → there's nothing to do
|
|
50
|
+
|
|
51
|
+
#### Step 2: Gather the project requirements
|
|
52
|
+
|
|
53
|
+
Ask the user the following questions to determine the setup:
|
|
54
|
+
|
|
55
|
+
1. **What do you want to monitor?** (multiple selections allowed)
|
|
56
|
+
- **Uptime monitoring** — Monitor URLs for availability and response times
|
|
57
|
+
- **API checks** — Validate API endpoints with custom assertions
|
|
58
|
+
- **Browser checks** — Run Playwright scripts to test user flows
|
|
59
|
+
- **Multistep API checks** — Chain multiple API requests into a single check
|
|
60
|
+
- **Playwright Check Suites** — Reuse your existing Playwright project for synthetic monitoring
|
|
61
|
+
|
|
62
|
+
Remember the selection for later steps when creating checks.
|
|
63
|
+
|
|
64
|
+
2. **How do you want to get alerted?** (multiple selections allowed)
|
|
65
|
+
|
|
66
|
+
Run `npx checkly skills configure alert-channels` to access up-to-date information on alert channel options and setup.
|
|
67
|
+
|
|
68
|
+
3. **Where do you want to store your monitoring configuration?**
|
|
69
|
+
- **__checks__** — create all resources and `check.ts` files in a separate `__checks__` directory
|
|
70
|
+
- **next to the resource** — place the `check.ts` files next to page routes, api endpoints etc.
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
#### Step 3 — Check your account plan
|
|
74
|
+
|
|
75
|
+
Before writing checks, verify what your account can do:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
npx checkly account plan --output json
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
This shows your entitlements, limits, and available locations. Use this data when creating the config:
|
|
82
|
+
|
|
83
|
+
- **Only use locations** from `locations.all` where `available` is `true`. Using unavailable locations will cause deploy failures.
|
|
84
|
+
- **Check feature availability** before configuring constructs like private locations, advanced alert channels, or higher-frequency schedules.
|
|
85
|
+
- **Respect metered limits** — the `quantity` field shows maximums for each metered feature.
|
|
86
|
+
|
|
87
|
+
If a feature the user wants is disabled, the response includes an `upgradeUrl` — share it so they can upgrade their plan.
|
|
88
|
+
|
|
89
|
+
Run `npx checkly skills manage plan` for the full reference.
|
|
90
|
+
|
|
91
|
+
#### Step 4 — Create the config file
|
|
92
|
+
|
|
93
|
+
Run the following command to retrieve the configure skill reference:
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
npx checkly skills configure
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Use the output to create a `checkly.config.ts` (or `checkly.config.js` if the user chose JavaScript) in the project root.
|
|
100
|
+
|
|
101
|
+
Adjust the `checkMatch` property according to previous selection. Use only locations verified as available in the previous step.
|
|
102
|
+
|
|
103
|
+
Present the generated configuration to the user and ask if it looks correct. Allow the user to make changes.
|
|
104
|
+
|
|
105
|
+
Congratulate the user on completing the config. Now it's time to test the configuration and turn everything into monitoring!
|
|
106
|
+
|
|
107
|
+
#### Step 5: Log in to Checkly CLI
|
|
108
|
+
|
|
109
|
+
To use the Checkly CLI the user needs to be logged in. Run the following command:
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
npx checkly whoami
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
If the user is logged in, verify the information and if it's the correct account.
|
|
116
|
+
|
|
117
|
+
If the user is NOT logged in, present two options (lead with env vars — they work for agents, CI, and interactive use):
|
|
118
|
+
|
|
119
|
+
- **Option A: Environment variables (recommended)** — The user sets `CHECKLY_API_KEY` and `CHECKLY_ACCOUNT_ID` as environment variables. They can create an API key at https://app.checklyhq.com/accounts/settings/user/api-keys. This is the recommended approach as it works in all contexts (agentic, CI/CD, and interactive). Once both variables are set, re-run `npx checkly whoami` to verify.
|
|
120
|
+
- **Option B: Interactive login** — The user runs `npx checkly login` themselves. This command opens a browser for OAuth authentication and **cannot be completed by an AI agent**. Tell the user to run the command, complete the browser flow, and let you know when they're done so you can re-run `npx checkly whoami` to verify.
|
|
121
|
+
|
|
122
|
+
#### Step 6: Summarize and test the new monitoring configuration
|
|
123
|
+
|
|
124
|
+
Read the generated `checkly.config.ts` (or `checkly.config.js`) and summarize the configured checks, locations, and frequencies.
|
|
125
|
+
|
|
126
|
+
Run the following command to test the new monitoring setup:
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
npx checkly test
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
If the command passed, congratulate the user and ask them what they want to do next!
|
|
133
|
+
|
|
134
|
+
Share more Checkly CLI options and ask if they want to deploy their new monitoring setup using `npx checkly deploy`.
|