[sorccu]

Linear: RED-1310

Adds Private Packages and Internal Registries (detect/synthetic-monitoring/playwright-checks/internal-registries), next to Custom Dependencies in the Playwright Check Suites nav. It documents CLI options for projects whose private packages come from a registry Checkly runners can't reach. None of these options were documented before:

• bundle.packages.embed: ship private package tarballs inside the code bundle
• Automatic lockfile pruning, plus CHECKLY_LOCKFILE_PRUNE and CHECKLY_LOCKFILE_PRUNE_TIMEOUT
• bundle.packages.prune: remove dependencies from the bundled package.json files, including member-scoped remove/keep entries
• runner.registries: route the runner's install to registries it can reach

The page also covers using pruning to speed up dependency installs in any project, for example by pruning linters and Storybook from the bundled package.json. It explains how each option treats dependencies of dependencies. Every config snippet is followed by what it does, and an Examples section walks through two complete setups: a pnpm monorepo with an internal registry, and a private scope behind a VPN-only mirror.

Custom Dependencies is updated to match current CLI behaviour:

• .npmrc files are bundled automatically, so the checks.include step is removed.
• bun is listed as a supported package manager.
• The dependency cache section lists the current invalidation inputs and documents runner.cache.install.version and --refresh-cache for forcing a reinstall.

It also links to the new page, including from the caching section and the installation timeout and memory troubleshooting entries. The checkly.config.ts reference in constructs/project.mdx has bundle and runner rows pointing to the relevant sections.

Affected Components

• Content & Marketing
• Pricing
• Test
• Docs
• Learn
• Other

Notes for the Reviewer

• The content follows the CLI's own config documentation (checkly-config-loader.ts JSDoc). The pages describe the latest CLI only, without version notes.
• Every checkly.config.ts example type-checks against checkly@10.0.0.
• The embed and prune behaviour was run against pnpm workspaces with checkly@10.0.0, including one built like the monorepo example with public stand-in packages. Results:
  • A transitive-only package can be embedded, and embedding a package doesn't embed its dependencies.
  • Pruning a dependency drops its own dependencies from the bundled lockfile and from embedding.
  • Out-of-bundle members' dependencies are not embedded.
  • A pattern that also matches a depended-on workspace member warns on every run, and a ! exclusion silences the warning.
• Install-speed effect: in a single-package pnpm project, removing eslint and typescript from devDependencies cut the regenerated lockfile from 496 to 380 packages. The docs don't quote a number, since it depends on the project.
• Embedded packages are installed from the code bundle, so they need no registry credentials in Checkly. npm 10 and pnpm 10 also install cleanly when the bundled .npmrc references a token variable that isn't set.
• The Yarn Berry note ("looks them up in your registry's package metadata each time it bundles your checks") describes current CLI behaviour. RED-1311 tracks caching that lookup, after which the note can go.
• The "Yarn workspaces remain unsupported" sentence in Custom Dependencies is unchanged. The CLI discovers Yarn workspaces, but I couldn't confirm runner support.
• The pages render under mint dev. The frontmatter check, the regenerated sitemap and the broken-links check all pass.

🤖 Generated with Claude Code

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated
checkly-422f444a	🟢 Ready	View Preview	Oct 29, 2026, 7:07 AM