checkly/Checkly
Run Checkly CLI checks from GitHub Actions.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 10, 2026
- License
- MIT
Pinned Snippet
uses: checkly/checkly-action@b4bca0f32b1da7c2b758e6525f128890bab3734f # v0.0.2tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| command | CLI command to run. Use "test" for local constructs or "trigger" for deployed checks. | no | test |
| cli-version | Checkly CLI npm version. Projects that install checkly run their local CLI; exact stable pins must match it. Requires 8.15.0 or newer. | no | latest |
| working-directory | Directory where the Checkly CLI command should run. | no | . |
| install-command | Optional dependency installation command to run before the Checkly CLI command. | no | — |
| tags | Tags selector. Use one line per --tags filter, e.g. "production,webapp". | no | — |
| grep | Only for command=test. Run checks whose name matches this regular expression. | no | — |
| check-id | Only for command=trigger. Comma-separated deployed check IDs to trigger. | no | — |
| files | Only for command=test. File-name patterns passed as positional arguments, one per line. | no | — |
| config | Checkly CLI config file path. | no | — |
| location | Public location to run checks from. | no | — |
| private-location | Private location slug to run checks from. | no | — |
| env | Environment variables for the Checkly run, one KEY=VALUE per line. | no | — |
| env-file | Dotenv file path to pass to the Checkly CLI. | no | — |
| test-session-name | Name to use when storing results as a Checkly test session. | no | — |
| timeout | Timeout in seconds to wait for checks to complete. Mostly useful when reporting through GitHub Actions. | no | — |
| retries | Number of times to retry a failing run. | no | — |
| refresh-cache | Force a fresh dependency install and update the cached version. | no | false |
| update-snapshots | Only for command=test. Update snapshots using the actual result of this run. | no | false |
| verify-runtime-dependencies | Only for command=test. Set to false to pass --no-verify-runtime-dependencies. | no | — |
| fail-on-no-matching | Only for command=trigger. Set to false to pass --no-fail-on-no-matching. | no | — |
| verbose | Set to true or false to pass --verbose or --no-verbose. | no | — |
| reporting | Where to report the Checkly result. Use "auto", "github-check", or "github-actions". | no | auto |
| github-check-name | GitHub Check name to create when reporting through the Checkly GitHub App. Defaults to "Checkly". | no | — |
| github-sha | Commit SHA that receives the GitHub Check. Overrides the SHA inferred from the GitHub event. | no | — |
Outputs
| name | description |
|---|---|
| test-session-id | The Checkly test session ID, when detected from CLI output. |
| test-session-url | The Checkly test session URL, when detected from CLI output. |