Command Reference: rdctl

rdctl is a command-line tool, included in Rancher Desktop that enables command-line access to GUI features. rdctl is developed to help users with tasks such as scripting (for automation, CI/CD), troubleshooting, remote management, etc. The current version of rdctl supports the below commands (with support for more commands to be added in upcoming releases):

Command Reference: rdctl - 图1info

As the current version of rdctl is experimental, all subcommand names, their arguments, and their output are still subject to change.

Command Reference: rdctl - 图2warning

The Rancher Desktop application must be running for the following commands:

Details

Command List

  • rdctl list-settings
  • rdctl set
  • rdctl shutdown

Command Reference: rdctl - 图3note

For many rdctl commands, there are corresponding API calls that can be applied. Listed below are the available commands shown in both formats. The api examples will assume curl as the tool being used to talk to the API.

rdctl or rdctl help

Run rdctl or rdctl help to see the list of available commands.

Details

Example Output

  1. > rdctl help
  2. The eventual goal of this CLI is to enable any UI-based operation to be done from the command-line as well.
  4. Usage:
  5.   rdctl [command]
  7. Available Commands:
  8.   api           Run API endpoints directly
  9.   completion    Generate the autocompletion script for the specified shell
  10.   factory-reset Clear all the Rancher Desktop state and shut it down.
  11.   help          Help about any command
  12.   list-settings Lists the current settings.
  13.   set           Update selected fields in the Rancher Desktop UI and restart the backend.
  14.   shell         Run an interactive shell or a command in a Rancher Desktop-managed VM
  15.   shutdown      Shuts down the running Rancher Desktop application
  16.   start         Start up Rancher Desktop, or update its settings.
  17.   version       Shows the CLI version.
  19. Flags:
  20.       --config-path string   config file (default /Users/jan/Library/Application Support/rancher-desktop/rd-engine.json)
  21.   -h, --help                 help for rdctl
  22.       --host string          default is localhost; most useful for WSL
  23.       --password string      overrides the password setting in the config file
  24.       --port string          overrides the port setting in the config file
  25.       --user string          overrides the user setting in the config file
  27. Use "rdctl [command] --help" for more information about a command.

rdctl api

Run rdctl api / to list all endpoints globally.

Details

Example Output

  1. $ rdctl api / | jq -r .[]
  2. GET /
  3. GET /v0
  4. GET /v1
  5. GET /v1/about
  6. GET /v1/diagnostic_categories
  7. GET /v1/diagnostic_checks
  8. POST /v1/diagnostic_checks
  9. GET /v1/diagnostic_ids
  10. PUT /v1/factory_reset
  11. PUT /v1/propose_settings
  12. GET /v1/settings
  13. PUT /v1/settings
  14. PUT /v1/shutdown
  15. GET /v1/transient_settings
  16. PUT /v1/transient_settings

rdctl api /vX

Run rdctl api /v1 to list all endpoints in version 1.

Details

Example Output

  1. $ rdctl api /v1 | jq -r .[]
  2. GET /v1
  3. GET /v1/about
  4. GET /v1/diagnostic_categories
  5. GET /v1/diagnostic_checks
  6. POST /v1/diagnostic_checks
  7. GET /v1/diagnostic_ids
  8. PUT /v1/factory_reset
  9. PUT /v1/propose_settings
  10. GET /v1/settings
  11. PUT /v1/settings
  12. PUT /v1/shutdown
  13. GET /v1/transient_settings
  14. PUT /v1/transient_settings

rdctl api /v0/settings

rdctl api [endpoints] are commands that are most useful for users working directly with the API itself, and therefore they would not be for everyday use, such as rdctl set might be. For example,

a command such as

  1. rdctl api /v0/settings --method PUT --body '{"kubernetes": {"enabled": false}}'

is the same as

  1. rdctl set --kubernetes-enabled=false

but less concise and user-friendly.

rdctl create-profile

Generates a deployment profile for Rancher Desktop settings in either macOS .plist or Windows .reg format.

  1. rdctl create-profile <options> <options-input>

Details

Options & Example Command

Options

  1. --input [FILE]              File containing a JSON document.
  2. --body [JSON]               Command-line option containing a JSON document
  3. --from-settings             Use current settings.
  4. --output [plist, reg]       An output of .plist files for macOS and .reg files for Windows.
  6. Additional options for --output reg:
  7. --type [locked, defaults]   The locked field is set as default, otherwise the default type can be specified.
  8. --hive [hklm, hkcu]         The hklm field is set as default, otherwise hkcu can be specified.

Example

  1. rdctl create-profile --output reg --hive=Hkcu --from-settings

rdctl extension install

Installs a Rancher Desktop extension.

  1. rdctl extension install <image-id>

Details

Options & Example Output

Options

  1. --force               Avoids any interactivity.
  2. <image-id>:<tag>      The <tag> is optional, e.g. splatform/epinio-docker-desktop:latest.

Example

  1. $ rdctl extension install docker/logs-explorer-extension:0.2.2
  2. Installing image docker/logs-explorer-extension:0.2.2

rdctl extension ls

Lists currently installed images.

  1. rdctl extension ls

Details

Example Output

Example

  1. $ rdctl extension ls
  2. Extension IDs
  4. docker/logs-explorer-extension:0.2.2

rdctl extension uninstall

Uninstalls a Rancher Desktop extension.

  1. rdctl extension uninstall <image-id>

Details

Options & Example Output

Options

  1. <image-id>:<tag>      The <tag> is optional, e.g. splatform/epinio-docker-desktop:latest.

Example

  1. $ rdctl extension uninstall docker/logs-explorer-extension:0.2.2
  2. Uninstalling image docker/logs-explorer-extension:0.2.2: Deleted docker/logs-explorer-extension:0.2.2

rdctl list-settings

  • CLI
  • API

Run rdctl list-settings to see the current active configuration.

Details

Options & Example Output

Options

  1. > rdctl list-settings --help 
  2. Lists the current settings in JSON format.
  4. Usage:
  5.   rdctl list-settings [flags]
  7. Flags:
  8.   -h, --help   help for list-settings
  10. Global Flags:
  11.       --config-path string   config file (default /Users/{username}/Library/Application Support/rancher-desktop/rd-engine.json)
  12.       --host string          default is localhost; most useful for WSL
  13.       --password string      overrides the password setting in the config file
  14.       --port string          overrides the port setting in the config file
  15.       --user string          overrides the user setting in the config file

Example

  1. > rdctl list-settings
  2. {
  3.   "version": 6,
  4.   "application": {
  5.     "adminAccess": false,
  6.     "pathManagementStrategy": "rcfiles",
  7.     "updater": {
  8.       "enabled": false
  9.     },
  10.     "debug": false,
  11.     "telemetry": {
  12.       "enabled": true
  13.     },
  14.     "autoStart": false,
  15.     "startInBackground": false,
  16.     "hideNotificationIcon": false,
  17.     "window": {
  18.       "quitOnClose": false
  19.     }
  20.   },
  21.   "virtualMachine": {
  22.     "memoryInGB": 6,
  23.     "numberCPUs": 2,
  24.     "hostResolver": true
  25.   },
  26.   "WSL": {
  27.     "integrations": {}
  28.   },
  29.   "containerEngine": {
  30.     "allowedImages": {
  31.       "enabled": false,
  32.       "patterns": [
  33.         "docker.io"
  34.       ]
  35.     },
  36.     "name": "moby"
  37.   },
  38.   "kubernetes": {
  39.     "version": "",
  40.     "port": 6443,
  41.     "enabled": false,
  42.     "options": {
  43.       "traefik": true,
  44.       "flannel": true
  45.     },
  46.     "ingress": {
  47.       "localhostOnly": false
  48.     }
  49.   },
  50.   "portForwarding": {
  51.     "includeKubernetesServices": false
  52.   },
  53.   "images": {
  54.     "showAll": true,
  55.     "namespace": "k8s.io"
  56.   },
  57.   "diagnostics": {
  58.     "showMuted": false,
  59.     "mutedChecks": {}
  60.   },
  61.   "experimental": {
  62.     "virtualMachine": {
  63.       "type": "qemu",
  64.       "useRosetta": false,
  65.       "socketVMNet": false,
  66.       "mount": {
  67.         "type": "reverse-sshfs",
  68.         "9p": {
  69.           "securityModel": "none",
  70.           "protocolVersion": "9p2000.L",
  71.           "msizeInKB": 128,
  72.           "cacheMode": "mmap"
  73.         }
  74.       },
  75.       "networkingTunnel": false
  76.     }
  77.   },
  78.   "extensions": {
  79.     "docker/logs-explorer-extension:0.2.2": true
  80.   }
  81. }

Run the following API call to see the current active configuration:

Details

Example Output

  1. curl -s -H "Authorization: Basic $AUTH" http://localhost:6107/v0/settings -X GET

Note: Using -X GET is optional. You could also just use the preceding command by itself.

rdctl set

  • CLI
  • API

Run rdctl set [flags] to set properties. In most of the cases, Kubernetes would be reset on running the set command. You can set multiple properties by chaining in a single command. See some examples below.

Details

Example Output

  1. > rdctl set --kubernetes-enabled=false
  2. > rdctl set --container-engine docker --kubernetes-version 1.21.2

Run the following API call to set properties:

Details

Example Output

  1. curl -s -H "Authorization: Basic $AUTH" http://localhost:6107/v0/settings -d '{ "kubernetes": { "containerEngine": "docker", "enabled": false, "version":"1.23.5" }}' -X PUT

rdctl shutdown

  • CLI
  • API

Run rdctl shutdown to gracefully shut down Rancher Desktop.

Details

Example Output

  1. > rdctl shutdown
  2. Shutting down.

Run the following API call to shut down Rancher Desktop:

Details

Example Output

  1. shutdown: curl -s -H "Authorization: Basic $AUTH" http://localhost:6107/v0/shutdown -X PUT

rdctl snapshot

Run rdctl snapshot to store the current configuration of your virtual machine and all associated settings as a snapshot.

Details

Options & Example Commands

Options

  1. Usage:
  2.   rdctl snapshot [command]
  4. Available Commands:
  5.   create      Create a snapshot
  6.   delete      Delete a snapshot
  7.   list        List snapshots
  8.   restore     Restore a snapshot
  9.   unlock      Remove snapshot lock
  11. Flags:
  12.   -h, --help   help for snapshot
  14. Global Flags:
  15.       --config-path string   config file (default /Users/[username]/Library/Application Support/rancher-desktop/rd-engine.json)
  16.       --host string          default is 127.0.0.1; most useful for WSL
  17.       --password string      overrides the password setting in the config file
  18.       --port string          overrides the port setting in the config file
  19.       --user string          overrides the user setting in the config file
  21. Use "rdctl snapshot [command] --help" for more information about a command.

Example

  1. $ rdctl snapshot create example_snapshot
  2. $ rdctl snapshot delete example_snapshot
  3. $ rdctl snapshot list --json

rdctl start

  • CLI
  • API

Run rdctl start to ensure that Rancher Desktop is running and configured as requested.

Details

Options & Example Command

Options:

  1. Usage:
  2.   rdctl start [flags]
  4. Flags:
  5.       --application.admin-access                                        enable privileged operations
  6.       --application.auto-start                                          start app when logging in
  7.       --application.debug                                               generate more verbose logging
  8.       --application.hide-notification-icon                              don't show notification icon
  9.       --application.path-management-strategy string                     update PATH to include ~/.rd/bin (allowed values: [manual, rcfiles])
  10.       --application.start-in-background                                 start app without window
  11.       --application.telemetry.enabled                                   allow collection of anonymous statistics
  12.       --application.updater.enabled                                     automatically update to the latest release
  13.       --application.window.quit-on-close                                terminate app when the main window is closed
  14.       --container-engine.allowed-images.enabled                         only allow images to be pulled that match the allowed patterns
  15.       --container-engine.name string                                    set engine (allowed values: [containerd, docker, moby])
  16.       --diagnostics.show-muted                                          unhide muted diagnostics
  17.       --experimental.virtual-machine.mount.9p.cache-mode string         (allowed values: [none, loose, fscache, mmap])
  18.       --experimental.virtual-machine.mount.9p.msize-in-kib int          maximum packet size
  19.       --experimental.virtual-machine.mount.9p.protocol-version string   (allowed values: [9p2000, 9p2000.u, 9p2000.L])
  20.       --experimental.virtual-machine.mount.9p.security-model string     (allowed values: [passthrough, mapped-xattr, mapped-file, none])
  21.       --experimental.virtual-machine.mount.type string                  how directories are shared (allowed values: [reverse-sshfs, 9p, virtiofs])
  22.       --experimental.virtual-machine.socket-vmnet                       use socket-vmnet instead of vde-vmnet
  23.       --experimental.virtual-machine.type string                        (allowed values: [qemu, vz])
  24.       --experimental.virtual-machine.use-rosetta                        
  25.       -h, --help                                                        help for start
  26.       --images.namespace string                                         select only images from this namespace (containerd only)
  27.       --images.show-all                                                 show system images on Images page
  28.       --kubernetes.enabled                                              run Kubernetes
  29.       --kubernetes.options.flannel                                      use flannel networking; disable to install your own CNI
  30.       --kubernetes.options.traefik                                      install and run traefik
  31.       --kubernetes.port int                                             apiserver port
  32.       --kubernetes.version string                                       choose which version of Kubernetes to run
  33.       --no-modal-dialogs                                                avoid displaying dialog boxes
  34.       -p, --path string                                                 path to main executable
  35.       --port-forwarding.include-kubernetes-services                     show Kubernetes system services on Port Forwarding page
  36.       --virtual-machine.memory-in-gb int                                reserved RAM size
  37.       --virtual-machine.number-cpus int                                 reserved number of CPUs
  39. Global Flags:
  40.       --config-path string   config file (default /Users/{username}/Library/Application Support/rancher-desktop/rd-engine.json)
  41.       --host string          default is localhost; most useful for WSL
  42.       --password string      overrides the password setting in the config file
  43.       --port string          overrides the port setting in the config file
  44.       --user string          overrides the user setting in the config file

Example:

  1. > rdctl start --container-runtime dockerd -- kubernetes-version 1.19.3

Run the following API call to ensure Rancher Desktop is running and configured, making sure to fill in your respective user and password values:

Details

Example Output

  1. curl -s -H "Authorization: Basic $(echo -n "user:PASSWORD" | base64)"

rdctl version

Run rdctl version to see the current rdctl CLI version.

Details

Example Output

  1. > rdctl version
  2. rdctl client version: 1.1.0, targeting server version: v1