Every serverrf command below can be run from a Linux terminal as serverrf <command> or inside the interactive server@remoterf: console without the serverrf prefix. When the server is running, shell commands communicate with the live server process and automatically reload devices or restart the server as needed.
Server Lifecycle & Config (serverrf)
| Command |
Description |
serverrf -s / serverrf --serve |
Start the RemoteRF server inside its tmux session (or attach to a running instance) and open the server@remoterf: console. |
serverrf -s --daemon |
Start the server detached in the background without attaching your terminal. |
serverrf -s --foreground (--headless) |
Run the server directly in the current terminal without tmux. |
serverrf / serverrf status |
Print live server status, uptime, port bindings, and summary counts. |
detach (or Ctrl-C) |
Detach from the server@remoterf: console while leaving the server running in the background. |
restart |
Restart the running server process cleanly (can also be run from bash as serverrf restart). |
quit / stop / exit / q |
Stop the running server process (can also be run from bash as serverrf stop). |
help [topic] / h / ? |
Print the command summary or detailed help for a topic (server, devices, users, reservations, groups, enrollment, hosts, certificates, config, global, schemas, clusters, database, remote). |
clear / cls |
Clear the terminal screen and redraw the console banner. |
config list |
Show the configured gRPC and TLS certificate ports in ~/.config/remoterf/server.env. |
config ports <grpc> [cert] |
Set the main gRPC port and TLS certificate distribution port (defaults to grpc + 1 if omitted). |
config wipe [-y] |
Delete ~/.config/remoterf/server.env. |
certs list [-v] |
Show the server TLS CA and leaf certificate subjects, SANs, validity windows, and SHA-256 fingerprints. |
certs reset [ip] [--dns <name>] |
Generate self-signed TLS certificates (10-year root CA and 1-year server leaf certificate) for the server IP and optional DNS hostnames. |
certs wipe [-y] |
Delete all generated TLS certificate and key files in ~/.config/remoterf/certs/. |
Devices, Diagnostics & Schemas (serverrf)
| Command |
Description |
devices list |
List all configured devices, their handles (Name@deployment), host routing, and live connection status. |
devices add [type] [--id N] [-y] |
Launch the interactive guided wizard to discover and add an SDR or sensor to ~/.config/remoterf/devices.yml. |
devices add <type> "<name>" --serial <S> [--id N] [-y] |
Add a USB/serial device non-interactively (pluto, pluto-mimo, rtl-sdr, hackrf, ti-mmwave, usrp-2901, usrp-b205-mini). |
devices add usrp-n210 "<name>" --addr <ip> [--id N] [-y] |
Add a Gigabit Ethernet USRP N210 using inventory type usrp and an address-bound usrp2 profile. |
devices add usrp-profile "<name>" --profile <P> --selector <S> [--id N] [-y] |
Add a UHD USRP device using an explicit UHD profile and selector string. |
devices rename <id> "<New Name>" |
Rename a configured device in devices.yml. |
devices remove <id> / devices wipe [-y] |
Remove a single device or clear all devices from devices.yml. |
diag [--force] [--copy] |
Run automated hardware self-tests across all local and host-attached SDRs (--force tests devices with active reservations; --copy copies the report to clipboard). |
schema browse [text] |
Search the RemoteRF Global approved driver schema registry. |
schema download <name|hash> [-y] |
Download an approved interface JSON specification from the Global schema registry into ~/.config/remoterf/drivers/registry/. |
hosts status |
Show connected hostrf edge hosts, tunnel health, and host-attached devices. |
hosts token <host_id> [--force] |
Generate an authentication token for a RemoteRF host (use --force to rotate an existing host's token). |
hosts tokens [--secrets] | wipe |
List configured host tokens (or wipe all host tokens). |
hosts forget <host_id> |
Delete a single host's token and remove it from the host directory. |
hosts wipe [-y] |
Clear persisted host registry and live host tunnel state. |
Users, Groups & Reservations (serverrf)
| Command |
Description |
groups list |
List all user groups, device whitelists, reservation limits, and Global/public visibility flags. |
groups create / groups edit / groups remove |
Create, modify, or remove a user group interactively (groups delete is an alias). |
groups public |
Toggle whether a user group's devices are publicly bookable on RemoteRF Global. |
groups share |
Share or unshare a user group with a deployment cluster. |
groups csv |
Export the user groups table to a CSV file in ~/Downloads. |
codes list |
List active enrollment codes, remaining uses, expiration windows, and attached groups. |
codes create / codes remove |
Generate a batch of enrollment codes or remove codes by name/group (codes delete is an alias). |
codes csv |
Export all enrollment codes to a CSV file in ~/Downloads. |
users list |
List registered user accounts, permission tiers, emails, and creation timestamps. |
users manage |
Interactively manage a user account, change permissions, delete the user, or view/cancel their reservations. |
users perms |
Display default permission tier tables. |
users prune-proxies [-y] |
Delete stale partner-deployment proxy user accounts (rfg_*) with no active reservations. |
reservations list |
List all active and upcoming reservations with IDs, usernames, device IDs, and start/end times. |
reservations cancel <id> |
Cancel a specific reservation by ID. |
Global, Clusters & Remote Admin (serverrf)
| Command |
Description |
global status |
Show RemoteRF Global registration status, assigned hostname, and outbound relay tunnel health (run inside serverrf -s to see live tunnel state up; from bash it shows assigned). |
global join |
Enroll this deployment in RemoteRF Global. |
global verify <code> |
Redeem the administrator email verification code to activate Global participation. |
global leave |
Disconnect from RemoteRF Global and stop the outbound relay tunnel immediately. |
cluster list / cluster info <cluster> |
List joined clusters or inspect a cluster's members and shared groups. |
cluster create <name> |
Create a new multi-institution deployment cluster. |
cluster invite <cluster> / cluster join <token> |
Generate a single-use cluster invite token or join a cluster using an invite token. |
cluster cap <cluster> <n> / cluster peers |
Set the concurrent peer-reservation cap, or list peer deployments across your clusters and their cached trust/endpoint state. |
cluster kick <cluster> <peer> [-y] / cluster remove <cluster> [-y] |
Remove a peer deployment from a cluster, or leave/dissolve a cluster. |
admins list / admins add <user> [--read-only] |
List remote administrators or authorize a user account for remote administration (optionally read-only). |
admins code / admins remove <user> [-y] |
Generate a one-time pairing code for remote admin enrollment, or remove a remote administrator. |
admins devices [user] / admins revoke <user> <fingerprint|all> |
List enrolled administrator Ed25519 device keys or revoke a specific key (or all keys) for a user. |
admins log [n] / admins hostkey [rotate] |
View recent remote administration audit log entries, or show/rotate the server's Ed25519 host key. |
admins policy [relay on|off] [new-device email|console] / admins kick [<user>] |
View or set remote admin relay and new-device approval policies, or terminate active remote admin sessions. |
Backups & Reset (serverrf)
| Command |
Description |
db export [dir] |
Create a hot SQLite snapshot archive (~/Downloads/remoterf-export-<timestamp>.tgz) while the server is running. |
reservations purge |
Delete all active and upcoming reservation records. |
stats purge [-y] |
Delete completed reservation history used for usage analytics. |
users purge |
Delete all registered user accounts. |
db purge |
Delete all database-backed accounts, groups, codes, and reservations, then exit the server. |
wipe [-y] |
Factory-reset the entire ~/.config/remoterf/ directory (databases, certificates, ports, devices, and Global config). |
Host CLI (hostrf)
Run these commands on a RemoteRF edge host in the remoterf-host environment:
| Command |
Description |
hostrf --help |
Print all command-line options for the host CLI. |
hostrf -s / hostrf --serve |
Start the host process, connect to the central server, and open the host shell. |
hostrf --config --addr <server_ip:main_port> [--ca-sha256 <sha256>] |
Point the host at the central server's main gRPC port and fetch (or pin) its TLS CA certificate. |
hostrf --config --show / --config --wipe [-y] |
Display or clear the saved server address configuration. |
hostrf --host --set <host_id> "<token>" |
Save the host identifier and authentication token generated on the server with serverrf hosts token. |
hostrf --host --show / --host --wipe [-y] |
Display or clear the saved host identifier and authentication token. |
hostrf --device --add --<type> "<id:name:selector>" |
Add a host-attached SDR to ~/.config/remoterf/host/devices.yml. |
hostrf --device --remove <id> / --device --wipe [-y] |
Remove a single device or clear all devices from ~/.config/remoterf/host/devices.yml. |
hostrf --device --show |
List devices configured in ~/.config/remoterf/host/devices.yml. |