Skip to main content

3.16.1 rdkstudio

rdkstudio is RDK Studio’s command-line entry point. After enabling it you can list devices, run short commands, browse remote files, or hand a question to Moss from the terminal.

rdkstudio cheat sheet: interactive mode, one-shot prompt, devices, exec, files

When to use it

GoalTypical command
Verify installrdkstudio --version
List known devicesrdkstudio device list
Ask Moss somethingrdkstudio "Check current device status"
Run one remote commandrdkstudio exec "uname -a"
List a remote pathrdkstudio file list /userdata

Device commands need working SSH; Moss commands need a valid model profile.

Enable the CLI

  1. Open the RDK Studio desktop app.
  2. Go to Settings center → Apps & updates.
  3. Find “CLI tool rdkstudio”.
  4. Click Enable CLI (or Re-enable if already done).

On Windows, close and reopen terminals after enabling. On macOS (Apple Silicon) the current shell often works immediately; if you see command not found, open a new terminal or run hash -r.

First check

rdkstudio --version
rdkstudio device list

--version proves the binary is on PATH. device list empty means CLI works but no devices are registered yet.

For full help:

rdkstudio --help
rdkstudio device --help

Add and use devices

Provide host/IP; the CLI prompts for SSH password (hidden echo).

rdkstudio device add <device-ip>
rdkstudio device list

Then run quick commands or list paths:

rdkstudio exec "uname -a"
rdkstudio file list /userdata

exec suits short commands. For installs, builds, or long jobs, return to AI Dock or the in-app terminal for clearer progress and errors.

Moss from the shell

If model config is ready:

rdkstudio "Check current device status"
cat error.log | rdkstudio --pipe

Model/API/URL/key errors → fix under Settings center → AI engine in the desktop app.

Config sources and safety

SourceGood for
Desktop clientDaily use, least friction
CLI flagsOne-off overrides
Environment variablesAutomation or disposable shells
rdkstudio configNon-secret local preferences

Prefer storing API keys in the desktop AI engine or env vars—never paste real secrets into docs, scripts, screenshots, or chat.

Temporary model override example:

rdkstudio --provider openai-compatible --model qwen3.6-plus "Summarize this directory"

rdkstudio config is for ordinary prefs, not long-term secret storage.

Common subcommands

CommandRole
device listList devices
device add <host> [user] [port]Add device
device connect <id>Reconnect
device remove <id>Remove local record
exec <command> --device <device>Remote exec
file list <remote-path>Remote listing
file read <remote-path>Print remote file
file write <remote-path> <content>Write small text blob
skill listSkills visible in workspace
config list / set / get / deleteLocal config keys

See rdkstudio --help and each subcommand’s --help for the full flag set.

Prerequisites

CommandNeeds
rdkstudio --version, rdkstudio --helpNothing
device list, config list, skill listLocal config / cwd only
device add <host>SSH reachable host
exec, fileDevice added + SSH ok
rdkstudio, rdkstudio "...", rdkstudio --pipeWorking model profile

If devices are missing, run rdkstudio device list; if SSH fails, verify host/IP, user, password, and network.

Interactive slash commands

Inside rdkstudio interactive mode:

CommandAction
/helpHelp
/clearClear session reference context
/resetReset Moss state
/historyThis session history
/sessionsList sessions
/modelTemporarily switch model
/quit (or Ctrl + D)Exit