Once the RemoteRF client is installed, use the interactive command-line interface (remoterf --login) to check available radios, book exclusive time slots, and connect from your Python scripts.
Interactive CLI (Simulated)
Use the simulated RemoteRF CLI below to familiarize yourself with its commands. Click any command chip in the toolbar or type directly in the prompt:
CLI Command Reference
Run remoterf --login from your terminal to enter the interactive shell:
| Command | Description |
|---|---|
getdev |
Lists connected SDRs grouped by deployment (@deployment) and their online/offline state. |
resdev |
Searches free time slots on an online device and reserves a block. |
myres |
Displays active and upcoming reservations held by you. |
cancelres |
Cancels a reservation you currently hold. |
getres |
Views all active and upcoming reservations across visible devices. |
enroll |
Enrolls your account with an enrollment code (e.g., enroll ucla/CODE). |
status |
Shows the connected home and the network path device calls use. |
direct on|off |
Enables or disables a direct network path for device streaming calls. |
perms |
Displays your user group membership and per-device reservation limits. |
logout |
Logs out and forgets the stored session on this machine. |
clear |
Clears the terminal screen and reprints the session banner. |
help / h |
Shows the boxed command menu. |
exit / quit |
Exits the RemoteRF interactive session (keeping your saved login). |
Launching & Logging In
Open your terminal, activate your Python environment (e.g., conda activate remoterf), and launch the client:
remoterf --loginAfter you log in once, RemoteRF saves your session locally. Subsequent runs of remoterf --login automatically resume your session without asking for your password again:
By default, remoterf --login connects to RemoteRF Global (user@global>), where you can see and reserve devices across all deployments you have enrolled in. Once you enroll in a deployment (such as ucla), RemoteRF also saves it as a local “deployment home” so you can log in to that server directly if desired:
remoterf --login global # Log in to RemoteRF Global (default)
remoterf --login ucla # Log in directly to an enrolled deployment
remoterf homes # List saved deployments you have enrolled inChecking Available Devices
Type getdev to list all radios visible to your account, grouped by deployment (@deployment):
online: The device is connected and operational.offline: The device is currently disconnected or unavailable; it will be omitted when runningresdev.
Reserving a Device
A reservation grants your account exclusive access to the device during your booked time slot. To reserve a device:
- Type
resdevto list online devices along with their slot durations (e.g.,30 min slots). - Enter the 0-based device index you want to reserve (e.g.,
0). - Enter the number of days ahead to check for open slots (e.g.,
1for today). - Select an available time slot by index from the
AVAILABLE SLOTSpanel. - Confirm with
yat theRESERVEpanel.
Device Handle vs. Reservation Token:
- Device Handle (e.g.,
Pluto_00@ucla): Names a specific device and deployment (<device-name>@<deployment-tag>). Works on any machine where you are logged in, and automatically reserves the current time slot if the device is free. - Reservation Token (e.g.,
k3v9qlw2mxb7): A one-time secret code for a single reservation slot. Works on any machine, even without a saved login on that machine.
Viewing Reservations
Use myres to view your own active and upcoming bookings (or getres to view all reservations across visible devices):
Canceling a Reservation
If you finish your experiments early, run cancelres, select the 0-based reservation index, and confirm with y:
Connecting in Python
Initialize the device driver in Python using the lines printed in the USAGE panel, passing either your device handle (Name@deployment) or your reservation token. If you pass a device handle while logged in and do not yet hold an active reservation on that device, remoterf automatically books the current time slot if the device is online and the current slot is free:
from remoterf.drivers.adalm_pluto import adi
# Connect using the device handle (with a saved login) or your reservation token
pluto = adi.Pluto(token="Pluto_00@ucla")
# Configure radio parameters as normal
pluto.rx_lo = int(915e6)
pluto.sample_rate = int(1e6)
# Receive complex baseband samples into a NumPy array
samples = pluto.rx()RemoteRF automatically manages and updates device drivers behind the scenes whenever you make a reservation. If you are running a script on a machine for the first time or want to be certain your local driver is current, you can optionally call ensure_driver before importing the device class:
from remoterf.drivers import ensure_driver
ensure_driver(token="RTLSDR_0@ucla")
from remoterf.drivers.rtlsdr import RtlSdr
sdr = RtlSdr(token="RTLSDR_0@ucla")Non-Interactive CLI & Starter Scripts
In addition to the interactive remoterf --login shell, you can check device status, inspect live device APIs, and generate starter Python scripts directly from your system shell:
remoterf auth status # Check the active saved login
remoterf devices [--deployment ucla] [--all] # List devices and their status
remoterf reservations # View reservations
remoterf api Pluto_00@ucla # Print the live Python API for a device
remoterf example Pluto_00@ucla --recipe rx_once -o rx_once.pyAvailable starter script recipes for remoterf example HANDLE --recipe <name> are connect, rx_once, and rx_spectrum. For programmatic slot discovery, CLI-based reservation commands (remoterf slots, remoterf reserve), and AI assistant automation, see AI Agents & MCP.
Next Steps
Configure frequencies, sample rates, and transmit/receive complex samples with Pluto.
Start a two-channel RX/TX experiment with the Pluto MIMO driver.
Tune a HackRF and collect a block of complex baseband samples.
Build a receive-only experiment with an RTL-SDR dongle.
Open a remote UHD session and stream with the USRP 2901.
Connect to the compact USB UHD radio and prepare a stream.
Open an Ethernet UHD session and check N210 capabilities.