diff --git a/docs/app/references/error-messages.mdx b/docs/app/references/error-messages.mdx index f2615a4bfd..8413c31b1d 100644 --- a/docs/app/references/error-messages.mdx +++ b/docs/app/references/error-messages.mdx @@ -610,6 +610,9 @@ if you've exhausted all other possibilities. ## CLI Errors +Errors in this section may occur when using the [Cypress command line (CLI)](/app/references/command-line). +They may also apply to running Cypress programmatically through the [Cypress Module API](/app/references/module-api). + ### You passed the `--record` flag but did not provide us your Record Key. You may receive this error when trying to run Cypress tests in @@ -659,12 +662,18 @@ We will automatically apply the record key environment variable. ### A Cached Cypress Binary Could not be found -This error occurs in CI when using `cypress run` without a valid Cypress binary -cache installed on the system (on linux that's `~/.cache/Cypress`). +This error occurs in CI when attempting to use `cypress run` or `cypress verify` CLI commands +without having a valid Cypress binary cache installed on the system. + +The Cypress binary is downloaded and installed into a [global cache folder](/app/references/advanced-installation#Binary-cache) +with a package manager install command (such as `npm ci`, `npm install`, `yarn install` or `pnpm install`). +The Cypress cache can also be loaded from a CI cache that was saved from a previous CI run. + +If you are using pnpm, ensure you are following the [pnpm configuration](/app/get-started/install-cypress#pnpm-Configuration) +instructions, otherwise pnpm may skip the Cypress binary installation. -To fix this error, follow instructions on -[caching the cypress binary in CI](/app/continuous-integration/overview#Caching), -then bump the version of your CI cache to ensure a clean build. +If you are using CI caches, then review also the recommendations for +[caching the Cypress binary in CI](/app/continuous-integration/overview#Caching). ### Incorrect usage of `--ci-build-id` flag