Install & update

Install the Urlbox CLI with npm, Homebrew, Scoop or the install script, verify it with urlbox doctor, and keep it current with urlbox upgrade.

Install with whichever package manager you already use.

npm (any platform)

npm install -g @urlbox/cli

The npm package is a thin wrapper: on install it downloads the pre-built native binary for your platform and architecture (macOS, Linux or Windows; amd64 or arm64) from the GitHub release, then runs that binary with your arguments.

Homebrew (macOS / Linux)

brew install urlbox/tap/urlbox

Scoop (Windows)

scoop bucket add urlbox https://github.com/urlbox/homebrew-tap
scoop install urlbox

Note: the Scoop manifest is co-located inside the homebrew-tap repo, so you add that repo as the bucket.

Install script (macOS / Linux)

curl -fsSL https://cli.urlbox.com/install.sh | sh

Use this on machines without npm or Homebrew, such as servers, containers and CI runners. The script downloads the latest release for your platform from GitHub, checks it against the release's SHA-256 checksums, and installs the urlbox binary to /usr/local/bin, asking for sudo if that folder isn't writable. If cosign is installed, it also verifies the checksums' Sigstore signature.

On shared CI runners, set GITHUB_TOKEN so the script's release lookup isn't rate-limited by GitHub. curl -fsSL https://cli.urlbox.com/install.sh | sh -s -- --help lists the other options.

Verify the install

urlbox doctor

urlbox doctor checks your install, config, network and credentials, and tells you exactly what's missing rather than failing cryptically later. Run it any time something isn't working.

You can also check the exact build:

urlbox version              # human-readable summary
urlbox --version            # plain "vX.Y.Z" for scripts
urlbox version --output-format quiet

Keeping it up to date

urlbox upgrade

upgrade detects how you installed urlbox (Homebrew, Scoop, npm, or a raw Go binary) and runs the matching update command. If it can't detect the method, it prints all the available upgrade commands so you can pick the right one.

If you used the install script, run it again to update: it always installs the latest release.

Once it's installed, sign in and take your first render.