Skip to content

Installation

Download and install the Pipemason CLI on your machine.

The Pipemason CLI is a single, code-signed and notarized binary. There is no Node, npm, or runtime to install alongside it — the runner ships everything it needs in one executable. Builds are published for macOS (Apple Silicon and Intel), Linux (x64 and arm64), and Windows (x64).

Note

You need a Pipemason account before the CLI is useful. Sign up at pipemason.com and start the 14-day free trial first, then come back here to install.

Homebrew (macOS / Linux)

The recommended install path on macOS and Linux is Homebrew:

brew install crashbytes/tap/pipemason

Homebrew puts pipemason on your PATH automatically and upgrades it with brew upgrade like any other formula.

Scoop (Windows)

On Windows, install with Scoop. Add the bucket once, then install:

scoop bucket add crashbytes https://github.com/CrashBytes/scoop-bucket
scoop install pipemason

Future releases upgrade with scoop update pipemason.

Single-use install script

On CI runners and locked-down boxes where you cannot tap a package manager, use the single-use install command shown on the onboarding page. Open pipemason.com/onboarding and copy the command verbatim — it embeds a token scoped to your account and plan:

curl -fsSL https://api.pipemason.com/install/<your-token> | bash

The script detects your platform, downloads the matching binary, and drops it at ~/.local/bin/pipemason. If ~/.local/bin is not already on your PATH, the script reminds you to add it.

Heads-up

The install token is single-use and expires 15 minutes after the onboarding page renders. If it expires before you run it, reload /onboarding and a fresh token mints automatically.

Verify the install

Confirm the binary is installed and on your path:

pipemason --version

command not found

If your shell reports pipemason: command not found after the script install, the install directory is not on your PATH. Add ~/.local/bin to your shell profile and reopen the terminal:

export PATH="$HOME/.local/bin:$PATH"

Supported platforms

The runner ships as a signed binary for these targets:

  • macOS — Apple Silicon (arm64) and Intel (x64)
  • Linux — x64 and arm64
  • Windows — x64

Next step

With the CLI installed, pair it to your account so it can register runs and stream them to your dashboard. Continue to Pairing the runner.