rtz CLI overview
rtz reads what the agent last synced, so it needs no kubeconfig and no network path to the
cluster. That makes it usable from a laptop, a bastion, or a CI runner with nothing but a
token.
Install
Section titled “Install”brew install runtimez-com/tap/rtzcurl -fsSL https://raw.githubusercontent.com/runtimez-com/runtimez-cli/main/install.sh | shOn Windows:
scoop bucket add runtimez https://github.com/runtimez-com/scoop-bucket && scoop install rtzBinaries cover macOS, Linux and Windows on amd64 and arm64. .deb, .rpm and .apk
packages are attached to each release. The install script verifies the checksum before
installing; set RTZ_VERSION to pin a release and INSTALL_DIR to choose where the binary
lands.
Quick start
Section titled “Quick start”rtz login # browser sign-inrtz login --token rk_... # or an API key with the api:read scope, for CIrtz cluster lsrtz use prodrtz doctorInteractive UI
Section titled “Interactive UI”Run rtz with no arguments for the full-screen UI.
| Key | Action |
|---|---|
: |
command bar — :pods, :deploy, :sts, :ds, :svc, :ing, :nodes, :all, :risk, :signals, :changes, :logs, :traces, :ns <name>, :q |
/ |
filter the visible rows as you type |
enter / d |
describe the selected workload |
p |
pause or resume auto-refresh |
ctrl+r |
refresh now |
? |
keys and commands |
q, ctrl+c |
quit |
Auto-refresh runs every 10s (--refresh) and holds while a pane or prompt is open, so rows
never move under the cursor. --view picks the opening screen. Every screen has an exact
flag equivalent — :deploy is rtz get deploy, d is rtz describe.
On a terminal that cannot host the UI (a pipe, a CI log, TERM=dumb) rtz prints help
instead. On Windows use Windows Terminal or PowerShell 7.
