Installing ROCm CLI#
ROCm CLI ships as a single prebuilt binary. Platform support:
Platform |
Prebuilt binary |
Notes |
|---|---|---|
Linux (x86_64) |
Yes |
Ubuntu 24.04 or newer; full support, including the live dashboard and both inference engines |
Windows (x86_64) |
Yes |
CLI and Lemonade serving; no live dashboard or vLLM |
WSL2 (x86_64) |
Yes (Linux binary) |
Ubuntu 24.04 or newer; full support, including the live dashboard; see docs/wsl.md for setup |
macOS |
No |
No official installer, release, CI, or QA coverage |
Live dashboard telemetry requires Linux or WSL2 (see
Interactive interfaces). vLLM
serving is Linux or WSL2 only (see docs/vllm.md).
The installer downloads a prebuilt bundle, verifies its SHA-256 checksum,
installs the rocm and rocmd binaries into ~/.local/bin, and adds that
directory to your shell PATH. Rerun it any time to upgrade.
Linux and WSL (x86_64)#
curl -fsSL https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.sh | sh
This tracks the default release channel. For nightly builds, pass the
nightly channel instead:
curl -fsSL https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.sh | sh -s -- nightly
Windows (x86_64, PowerShell)#
irm https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.ps1 | iex
This tracks the default release channel. For nightly builds, set
ROCM_CLI_CHANNEL to nightly first:
$env:ROCM_CLI_CHANNEL = "nightly"
irm https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.ps1 | iex
Build from source#
Building requires Rust; the pinned toolchain in
rust-toolchain.toml (currently 1.96.0) installs automatically via rustup.
git clone https://github.com/ROCm/rocm-cli
cd rocm-cli
cargo build --release
This produces the two binaries under target/release/:
rocm— the CLI and interactive interfacesrocmd— the background telemetry daemon used by the dashboard
Run without installing:
cargo run --release --bin rocm -- examine
Or copy the release binaries onto your PATH:
install -m 0755 target/release/rocm target/release/rocmd ~/.local/bin/
See Contributing for the full development setup, test commands, and commit-signing requirements.