Install runtz CLI

The runtz CLI is a single static Go binary. The install script detects your OS and architecture, downloads the binary and installs it to /usr/local/bin:

curl -fsSL https://get.runtz.dev | bash

Verify the installation:

runtz version

runtz 1.0.0-rc1 (linux/amd64)

Linux and macOS are supported on amd64 and arm64.

Script options

The script accepts environment overrides:

# Install a specific release
RUNTZ_VERSION=v1.0.0-rc1 curl -fsSL https://get.runtz.dev | bash

# Install to a custom directory (no sudo needed if writable)
RUNTZ_INSTALL_DIR=$HOME/.local/bin curl -fsSL https://get.runtz.dev | bash

Manual install

Download the binary for your platform from the GitHub releases page, then:

chmod +x runtz_linux_amd64
sudo mv runtz_linux_amd64 /usr/local/bin/runtz
runtz version

Docker image

The CLI is also published as a container image — the entrypoint is the runtz binary:

docker run --rm runtzdev/runtz-cli:latest version

This is the recommended way to run runtz in pipelines — see the CI/CD guides for ready-to-use pipeline examples (GitHub Actions, GitLab, Jenkins, Azure DevOps, Bitbucket and CircleCI).

Commands

Authentication

Every scan command requires --endpoint and --token. For the runtz SaaS engine, use:

https://engine.runtz.dev

The token is generated in the platform (rtz_live_...) and resolves your workspace automatically. Both values can also come from the environment:

export RUNTZ_ENDPOINT=https://engine.runtz.dev
export RUNTZ_TOKEN=rtz_live_...

runtz sca ./

First scan

From the root of any repository:

runtz sca ./ \
  --endpoint https://engine.runtz.dev \
  --token rtz_live_...

Expected output:

Parsed package.json (npm): 42 dependencies
Checking 42 dependencies against the GitHub Advisory Database...
Sending SCA scan to Runtz...
SCA scan completed and sent to Runtz Platform.
Project: frontend
Manifests: 1
Dependencies: 42
Vulnerabilities: 3

See the Scans section for what each scan type covers and every available flag.