Getting started with ROCm CLI#
Launch ROCm CLI with no arguments:
rocm
With no arguments on an interactive terminal, rocm opens the launcher, a
small front-door menu that gets you to the common tasks:
Set up this system: install or update ROCm
Serve a model: run a model on your GPU
Diagnose & fix: check GPU, driver, and ROCm
Chat: talk to a local or API-backed model
Open full dashboard →: escalate into the live dashboard (
rocm dash)
Pick a row with the arrow keys and Enter. Press q or Ctrl-C to quit.
Ctrl-C quits from the launcher and the dashboard alike and restores your
terminal.
The one exception is the dashboard’s console for a running job, where
Ctrl-C keeps its existing meaning of “cancel this job” and does not quit. Once
that job finishes, Ctrl-C quits there too.
On a non-interactive terminal (or piped output), rocm prints a one-shot status
summary instead of opening the launcher.
Configure ROCm and serve a model#
Before serving a model, check whether a managed ROCm runtime is already configured:
rocm examine
When active_runtime_status reports ready, you can serve a model now. A
machine can also have an existing ROCm install that rocm examine reports as
legacy_rocm_status: detected_unmanaged, alongside the managed runtime. To
install a runtime, or to get a different version or configuration, run:
rocm install sdk
This downloads TheRock ROCm wheels and a matching PyTorch stack into a managed
environment. Running rocm install sdk creates a managed runtime alongside any
legacy install.
ROCm CLI supports ROCm 7.14, 10.0, and 10.1. Without --version,
rocm install sdk currently installs ROCm 7.14. To install ROCm 10.0 or 10.1,
add --version. If ROCm CLI can’t tell which exact GPU arch this computer has,
or you want a different one, also add --family with the raw gfx code from
rocm examine. For example: --version 10.1.0 --family gfx1200.
Running rocm install sdk when a managed runtime is already the active default
asks first, because the new install takes over as the active default; see
ROCm installation for that gate, the flags
that approve it without a prompt, and the ROCm 10 and newer requirements.
After the install finishes, serve a model:
rocm serve qwen
qwen is a built-in alias for a small assistant model that serves out of the
box.
You can also serve any compatible Hugging Face model directly. See Model serving for the GGUF versus safetensors rule, because which form works depends on the engine your GPU selects.
Quick reference#
Command |
Description |
|---|---|
|
Open the launcher menu (setup, serve, diagnose, chat, dashboard) |
|
Check GPU, ROCm install, engines, and managed folders |
|
Match this machine against known ROCm, PyTorch, and llama.cpp failure modes |
|
Say whether a model will run here, before downloading it |
|
Show what this machine would contribute to a problem report, and send nothing |
|
Apply a fix reported by |
|
Install TheRock ROCm wheels into a managed Python environment |
|
Install the AMD kernel driver on Linux |
|
Start a local OpenAI-compatible model server |
|
Serve a model on another GPU machine over your private network |
|
Open the full-screen telemetry dashboard |
|
Load-test a local OpenAI-compatible endpoint |
|
Show first-time setup state |
|
Print the ROCm CLI version, release tag or branch, and commit hash, plus the ROCm SDK and GPU driver in use |
|
Print a shell completion script (bash, zsh, fish, elvish, powershell) |
Interactive interfaces#
rocm ships two terminal UIs built on ratatui:
The launcher (rocm)#
The lightweight hub described above. It runs the guided Set up, Serve, Diagnose, and Chat flows in place, and hands off to the full dashboard when you need live instruments. This is the default surface for everyday use; the legacy full-screen setup assistant has been retired.
The dashboard (rocm dash)#
The full-screen telemetry dashboard shows every instrument and action on one screen.
It auto-starts an embedded rocmd daemon when none is running, then presents
five tabs (switch with Tab/Shift+Tab or number keys 1–5):
Tab |
What it shows |
|---|---|
Home |
At-a-glance status: GPU, active runtime, running servers |
ROCm |
Guided ROCm and runtime actions with inline details |
Serving |
Start, inspect, and manage model servers |
Observe |
Live GPU utilization, instances, and benchmark telemetry |
Chat |
Assistant chat backed by a local server or configured provider |
Live mode reads telemetry over a Unix domain socket, so it requires Linux or
WSL2. Use rocm dash --demo for a synthetic session that runs anywhere without a
GPU or daemon.