Skip to content
Documentation

Docs / Installation

Installation

Pick the install path that fits your environment, then run onboard once per repo.

Install the CLI

Install the CLI, then run boringcache onboard in your repository. Follow the quick start to connect a workspace and make the first cache save.

macOS and Linux

Install the latest BoringCache CLI with the install script.

curl -sSL https://install.boringcache.com/install.sh | sh

Supported platforms

The install script supports Linux AMD64 and ARM64, and macOS on Intel and Apple Silicon. On macOS, it installs the Xcode CAS adapter beside the CLI. Windows AMD64 and ARM64 binaries are available from the release downloads.

Verify the download

The installer checks each downloaded binary against SHA256SUMS. When cosign 3.1.3 or newer is available, it also verifies the signed checksum bundle. An older or unrecognized installed version of cosign stops installation until you upgrade it or explicitly opt out of signature verification.

To require signature verification, install cosign 3.1.3 or newer and run:

Require signature verification
curl -sSL https://install.boringcache.com/install.sh | BORINGCACHE_VERIFY_SIGNATURE=1 sh

This command stops if the verifier or a valid signature is unavailable. BORINGCACHE_VERIFY_SIGNATURE=0 explicitly selects checksum-only verification.

Check the installation and connect a repository

The installer prints the installation directory and any required PATH change. Open a new terminal after changing PATH, check the version, then run onboarding from your project directory:

Check installation and onboard
boringcache --version
cd your-project
boringcache onboard

Onboarding connects a workspace and writes .boringcache.toml. Follow the quick start for the first cache save, or use the troubleshooting guide if installation or authentication fails.

Need help or found something unclear? Open an issue or browse the CLI repo.