diff --git a/cli/installation.mdx b/cli/installation.mdx index 1c3cad67..147a99d7 100644 --- a/cli/installation.mdx +++ b/cli/installation.mdx @@ -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@` + +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@`, 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.