Skip to content

docs(cli): explain hand-off from other checkly installs [RED-757] #593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sorccu merged 4 commits into from
Oct 24, 2026
Merged

docs(cli): explain hand-off from other checkly installs [RED-757] #593

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7cb53f8
docs(cli): explain how other checkly installs hand off to the project…
sorccu Oct 23, 2026
235d79d
docs(cli): the hand-off applies to every command [RED-757]
sorccu Oct 24, 2026
e37a935
docs(cli): name package-manager equivalents of npx checkly [RED-757]
sorccu Oct 24, 2026
21a0b0d
docs(cli): the hand-off searches from the --config directory [RED-757]
sorccu Oct 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions cli/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,14 @@ before hand or just sign up for a new account straight from the terminal.
npx checkly login
```

## Global installs and `npx checkly@<version>`

Run the CLI through `npx checkly` from your project (or your package manager's equivalent, such as `pnpm exec checkly` or `yarn checkly`), so the CLI version is the one in your `package.json`.

Your checks only load with the `checkly` package your project installs, because they register with that copy. Since CLI version 10.0.0, when you run `checkly` from any other installation, for example a global `npm i -g checkly`, `pnpm dlx checkly` or `npx checkly@<version>`, inside a project that has its own `checkly` package, the CLI hands the command to your project's installation, as `npx checkly` or its equivalent would. This applies to every command. The CLI looks for your project's installation from the directory of the `--config` file if you pass one, and from the current directory otherwise. If the two versions differ, the CLI says which version runs. To use another version, install that version in your project.

Set `CHECKLY_NO_DELEGATION=1` to turn off the hand-off. Older global installs, and any install with the hand-off turned off, fail on projects that have their own `checkly` package with `Unable to create a construct ... outside a Checkly CLI project`.

## Direct download

If you cannot access the npm registry directly, you can also download the Checkly CLI via our CDN.
Expand Down
Loading