Skip to main content Skip to navigation Skip to footer

CLI Application

Complete guide to using the Rediacc command-line interface for platform management

Rediacc CLI Reference

Overview

The **Rediacc CLI** (`rdc`) is a command-line interface for managing all aspects of the Rediacc platform — authentication, infrastructure, repositories, queues, storage, and more.

Installation

Download the latest binary for your platform from the [Rediacc releases page](https://www.rediacc.com) or install via your package manager:

# macOS / Linux
curl -fsSL https://get.rediacc.com | sh

# Or use the packaged binary directly
./rdc --help

Global Options

Every command supports these global flags:

FlagDescription
--outputOutput format (table|json|yaml|csv)
--contextUse specific context for this command
--langLanguage override ({{languages}})
--forceSkip confirmation prompts

1. Authentication

Authentication commands

1.1 login

Authenticate with Rediacc

rdc auth login [options]
FlagDescriptionRequiredDefault
-e, --email <email>Email addressNo-
-p, --password <password>Password (for non-interactive login)No-
-m, --master-password <password>Master password for vault encryptionNo-
-n, --name <name>Session nameNo-
--endpoint <url>API endpoint URLNo-
--save-as <context>Save credentials to a named contextNo-

1.2 logout

Clear stored credentials

rdc auth logout

1.3 status

Check current authentication status

rdc auth status

1.4 register

Register a new organization and user account

After registration, check your email for the activation code.

rdc auth register [options]
FlagDescriptionRequiredDefault
--organization <name>Organization nameYes-
-e, --email <email>Email addressYes-
-p, --password <password>Password (for non-interactive login)Yes-
-m, --master-password <password>Master password for vault encryptionNo-
--endpoint <url>API endpoint URLNo-
--plan <plan>Subscription plan (COMMUNITY, PROFESSIONAL, BUSINESS, ENTERPRISE)NoCOMMUNITY

1.5 activate

Activate account with verification code

rdc auth activate [options]
FlagDescriptionRequiredDefault
-e, --email <email>Email addressYes-
-p, --password <password>Password (for non-interactive login)Yes-
--code <code>Activation code from emailYes-
--endpoint <url>API endpoint URLNo-

1.6 tfa

Two-factor authentication management

disable

Disable two-factor authentication

rdc auth tfa disable [options]
FlagDescriptionRequiredDefault
--code <code>Current TFA code for verificationNo-
-y, --yesSkip confirmation promptNo-

enable

Enable two-factor authentication

rdc auth tfa enable

status

Check TFA status

rdc auth tfa status

1.7 token

Token management

fork

Create a forked token for another application

rdc auth token fork [options]
FlagDescriptionRequiredDefault
-n, --name <name>Token nameNoCLI Fork
-e, --expires <hours>Expiration in hours (1-720)No24

list

List active tokens/sessions

rdc auth token list

revoke

Revoke a specific token

rdc auth token revoke <requestId>

Tip: Your authentication token is stored locally in your context. Use `--save-as` to store credentials under a named context for multiple environments.


2. Context Management

Manage CLI contexts

Contexts store connection details (API URL, credentials, default team/region/machine) so you can switch between environments quickly.

2.1 list

List all contexts

rdc context list

2.2 show

Show current context details

rdc context show

2.3 use

Switch to a different context

rdc context use

2.4 create

Create a new context

rdc context create <name> [options]
FlagDescriptionRequiredDefault
-u, --api-url <url>API URLNo-

2.5 delete

Delete a context

rdc context delete <name>

2.6 rename

Rename a context

rdc context rename <oldName> <newName>

2.7 current

Show current context name

rdc context current

2.8 set

Set a default value (team, region, bridge, machine)

rdc context set <key> <value>

Tip: Setting defaults means you don't need to pass `--team`, `--region`, or `--machine` with every command.

2.9 unset

Remove a context default value

rdc context unset

2.10 clear

Clear defaults (all or specific key)

rdc context clear [key]

2.11 set-language

Set preferred language

rdc context set-language

2.12 create-local

Create a new local context for middleware-less operation

In local mode you can add machines directly:

rdc context create-local <name> [options]
FlagDescriptionRequiredDefault
--ssh-key <path>Path to SSH private key (e.g., ~/.ssh/id_rsa)Yes-
--renet-path <path>Path to renet binary (default: renet in PATH)No-

2.13 add-machine

Add a machine to the current local context

rdc context add-machine <name> [options]
FlagDescriptionRequiredDefault
--ip <address>Machine IP address or hostnameYes-
--user <username>SSH usernameYes-
--port <port>SSH portNo22
--datastore <path>Datastore path on machineNo/mnt/rediacc

2.14 remove-machine

Remove a machine from the current local context

rdc context remove-machine <name>

2.15 machines

List machines in the current local context

rdc context machines

2.16 set-ssh

Update SSH configuration for the current local context

rdc context set-ssh [options]
FlagDescriptionRequiredDefault
--private-key <path>Path to SSH private keyYes-
--public-key <path>Path to SSH public keyNo-

2.17 create-s3

Create a new S3/R2 context for remote state with local execution

rdc context create-s3 <name> [options]
FlagDescriptionRequiredDefault
--endpoint <url>S3 endpoint URLYes-
--bucket <name>S3 bucket nameYes-
--access-key-id <key>S3 access key IDYes-
--ssh-key <path>Path to SSH private keyYes-
--secret-access-key <key>S3 secret access key (prompts if not given)No-
--region <region>S3 regionNoauto
--prefix <prefix>Key prefix/namespace in bucketNo-
--renet-path <path>Path to renet binaryNo-
--master-password <password>Master password for encryption (optional, leave empty to skip)No-

2.18 set-renet

Set the path to renet binary for local mode

rdc context set-renet <path>

3. Organization Management

Organization management commands

3.1 list

List organizations

rdc organization list

3.2 info

Get organization information

rdc organization info

3.3 dashboard

Get organization dashboard data

rdc organization dashboard

3.4 vault

Organization vault management

get

Get organization vault data

rdc organization vault get

list

List all vault types

rdc organization vault list

update

Update organization vault data

rdc organization vault update [options]
FlagDescriptionRequiredDefault
--vault <json>Vault content as JSON stringNo-
--vault-version <n>Current vault version for optimistic lockingNo-

3.5 export

Export organization data

rdc organization export [options]
FlagDescriptionRequiredDefault
--path <path>Path to save output fileNo-

3.6 import

Import organization data

rdc organization import <path> [options]
FlagDescriptionRequiredDefault
--mode <mode>Import mode (merge or replace)Nomerge

3.7 maintenance

Enable or disable maintenance mode (blocks non-admin logins)

rdc organization maintenance <action>

Warning: When maintenance mode is enabled, non-admin users cannot log in.


4. User Management

User management commands

4.1 list

List all users

rdc user list

4.2 create

Create a new user

rdc user create <email> [options]
FlagDescriptionRequiredDefault
-p, --password <password>Password for the new userNo-

4.3 activate

Activate a user account

rdc user activate <email> <activationCode>

4.4 deactivate

Deactivate a user account

rdc user deactivate <email> [options]
FlagDescriptionRequiredDefault
-f, --forceSkip confirmation promptsNo-

4.5 reactivate

Reactivate a deactivated user account

rdc user reactivate <email>

4.6 update-email

Change a user's email address

rdc user update-email <currentEmail> <newEmail>

4.7 update-password

Change your password

rdc user update-password [options]
FlagDescriptionRequiredDefault
--password <password>New password (non-interactive mode)No-
--confirm <confirm>Confirm password (non-interactive mode)No-

4.8 update-language

Set current user's preferred language

rdc user update-language <language>

4.9 exists

Check if a user exists

rdc user exists <email>

4.10 vault

User vault management

get

Get current user vault data

rdc user vault get

update

Update current user vault data

rdc user vault update [options]
FlagDescriptionRequiredDefault
--vault <json>Vault content as JSON stringNo-
--vault-version <n>Current vault version for optimistic lockingNo-

4.11 permission

User permission management

assign

Assign a permission group to a user

rdc user permission assign <userEmail> <groupName>

5. Team Management

Team management

5.1 list

List teams

rdc team list [options]
FlagDescriptionRequiredDefault
--search <text>Search in {{field}}No-
--sort <field>Sort by fieldNo-
--descSort in descending orderNo-

5.2 create

Create a team

rdc team create <name>

5.3 member

Team membership management

list

List team members

rdc team member list <teamName>

add

Add a user to a team

rdc team member add <teamName> <userEmail>

remove

Remove a user from a team

rdc team member remove <teamName> <userEmail>

6. Permission Management

Permission management commands

6.1 list

List permissions

rdc permission list

6.2 group

Permission group management

list

List all permission groups

rdc permission group list

create

Create a new permission group

rdc permission group create <name>

delete

Delete a permission group

rdc permission group delete <name> [options]
FlagDescriptionRequiredDefault
-f, --forceSkip confirmation promptsNo-

show

Show permission group details

rdc permission group show <name>

6.3 add

Add a permission to a group

rdc permission add <groupName> <permission>

6.4 remove

Remove a permission from a group

rdc permission remove <groupName> <permission>

7. Region Management

Region management

7.1 list

List regions

rdc region list [options]
FlagDescriptionRequiredDefault
--search <text>Search in {{field}}No-
--sort <field>Sort by fieldNo-
--descSort in descending orderNo-

8. Bridge Management

Bridge management

8.1 list

List bridges

rdc bridge list [options]
FlagDescriptionRequiredDefault
-r, --region <name>Region nameNo-
--search <text>Search in {{field}}No-
--sort <field>Sort by fieldNo-
--descSort in descending orderNo-

8.2 reset-auth

Reset bridge authorization token

rdc bridge reset-auth <name> [options]
FlagDescriptionRequiredDefault
-r, --region <name>Region nameNo-

9. Machine Management

Machine management

9.1 list

List machines

rdc machine list [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
--search <text>Search in {{field}}No-
--sort <field>Sort by fieldNo-
--descSort in descending orderNo-

9.2 create

Create a new machine

rdc machine create <name> [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
-b, --bridge <name>Bridge nameNo-
--vault <json>Machine vault data as JSON stringNo-

9.3 delete

Delete a machine

rdc machine delete <name> [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
-f, --forceSkip confirmation promptsNo-

9.4 update

Update machine configuration

rdc machine update

9.5 health

Check machine health for CI/CD pipelines

The health command outputs system metrics, container status, service stability, and storage information — useful for CI/CD pipeline checks.

rdc machine health <name> [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-

9.6 containers

List Docker containers on a machine

rdc machine containers <name> [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
--health-checkHealth check mode - exits with code 2 if any unhealthyNo-

9.7 services

List systemd services on a machine

rdc machine services <name> [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
--stability-checkStability check mode - exits with code 2 if any failed/restartingNo-

9.8 vault-status

Show parsed vault status for a machine

rdc machine vault-status <name> [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-

9.9 repos

List deployed repositories on a machine

rdc machine repos <name> [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
--search <text>Filter repositories by nameNo-

9.10 test-connection

Test SSH connection to a machine and capture host key

rdc machine test-connection [options]
FlagDescriptionRequiredDefault
--ip <address>Machine IP address or hostnameYes-
--user <name>SSH usernameYes-
-t, --team <name>Team nameNo-
-b, --bridge <name>Bridge nameNo-
--port <number>SSH portNo22
--password <pwd>SSH password for initial authenticationNo-
--datastore <path>Datastore path on machineNo/mnt/rediacc
-m, --machine <name>Machine name (for updating vault after test)No-
--saveSave known_hosts to machine vault after successful testNo-

Tip: Use `--save-known-hosts` to automatically persist the host key to the machine vault after a successful test.


10. Repository Management

Repository management commands

10.1 list

List repositories

rdc repository list [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-

10.2 create

Create a new repository

rdc repository create <name> [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
--tag <tag>Repository tagNolatest
--parent <name>Parent repository (for forks)No-
--parent-tag <tag>Parent repository tagNo-

10.3 rename

Rename a repository

rdc repository rename <oldName> <newName> [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
--tag <tag>Repository tagNolatest

10.4 delete

Delete a repository

rdc repository delete <name> [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
--tag <tag>Repository tagNolatest
-f, --forceSkip confirmation promptsNo-

10.5 promote

Promote a fork to grand status

rdc repository promote <name> [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
--tag <tag>Repository tagNolatest
-f, --forceSkip confirmation promptsNo-

Note: Promoting a fork separates it from its grand (parent) repository, making it independent.

10.6 vault

Repository vault management

get

Get repository vault data

rdc repository vault get <repositoryName> [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
--tag <tag>Repository tagNolatest

update

Update repository vault data

rdc repository vault update <repositoryName> [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
--tag <tag>Repository tagNolatest
--vault <json>Vault content as JSON stringNo-
--vault-version <n>Current vault version for optimistic lockingNo-

11. Storage Management

Storage management

11.1 list

List storage providers

rdc storage list [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
--search <text>Search in {{field}}No-
--sort <field>Sort by fieldNo-
--descSort in descending orderNo-

12. Queue Operations

Queue management

The queue system is at the heart of Rediacc's task execution. Every operation (deploy, backup, script execution) runs through the queue.

12.1 list

List queue items

rdc queue list [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
--status <status>Filter by statusNo-
--priority-min <n>Minimum priority (1-5)No-
--priority-max <n>Maximum priority (1-5)No-
--search <text>Search in task ID, team, machine, bridgeNo-
--sort <field>Sort by fieldNo-
--descSort in descending orderNo-
--limit <n>Maximum number of resultsNo50

12.2 create

Create a queue item

rdc queue create [options]
FlagDescriptionRequiredDefault
-f, --function <name>Function name to executeYes-
-t, --team <name>Team nameNo-
-m, --machine <name>Machine nameNo-
-b, --bridge <name>Bridge nameNo-
-p, --priority <1-5>Priority (1=highest)No3
--param <key=value>Function parametersNo-
--vault <json>Raw vault JSON (for scripts/CI)No-

12.3 cancel

Cancel a queue item

rdc queue cancel <taskId>

12.4 retry

Retry a failed queue item

rdc queue retry <taskId>

12.5 trace

Trace queue item execution

rdc queue trace <taskId> [options]
FlagDescriptionRequiredDefault
-w, --watchWatch for updatesNo-
--interval <ms>Poll interval in millisecondsNo2000

Tip: Use `--watch` to follow the task in real-time until it completes.

12.6 delete

Delete a queue item

rdc queue delete <taskId> [options]
FlagDescriptionRequiredDefault
-f, --forceSkip confirmation promptsNo-

13. File Synchronization

File synchronization with repositories using rsync

13.1 upload

Upload files to a repository

rdc sync upload [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
-m, --machine <name>Machine nameNo-
-r, --repository <name>Repository name (connects to repository environment)No-
-l, --local <path>Local directory path (default: current directory)No-
--remote <path>Remote subdirectory path within repositoryNo-
--mirrorMirror mode - delete remote files not present locallyNo-
--verifyVerify files using checksums after syncNo-
--confirmPreview changes and ask for confirmation before syncingNo-
--exclude <patterns...>Patterns to exclude from syncNo-
--dry-runShow what would be transferred without actually syncingNo-

13.2 download

Download files from a repository

rdc sync download [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
-m, --machine <name>Machine nameNo-
-r, --repository <name>Repository name (connects to repository environment)No-
-l, --local <path>Local directory path (default: current directory)No-
--remote <path>Remote subdirectory path within repositoryNo-
--mirrorMirror mode - delete local files not present on remoteNo-
--verifyVerify files using checksums after syncNo-
--confirmPreview changes and ask for confirmation before syncingNo-
--exclude <patterns...>Patterns to exclude from syncNo-
--dry-runShow what would be transferred without actually syncingNo-

13.3 status

Check sync status and compare local/remote files

rdc sync status [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
-m, --machine <name>Machine nameNo-
-r, --repository <name>Repository name (connects to repository environment)No-
-l, --local <path>Local directory path (default: current directory)No-
--remote <path>Remote subdirectory path within repositoryNo-

14. VS Code Integration

VS Code Remote SSH integration

14.1 connect

Connect to a machine or repository in VS Code

rdc vscode connect [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
-m, --machine <name>Machine nameNo-
-r, --repository <name>Repository name (connects to repository environment)No-
-f, --folder <path>Remote folder path to openNo-
--url-onlyPrint the VS Code URI instead of launchingNo-
-n, --new-windowOpen in new VS Code windowNo-
--skip-env-setupSkip remote environment setupNo-
--insidersUse VS Code Insiders settingsNo-

14.2 list

List configured VS Code SSH connections

rdc vscode list

14.3 cleanup

Remove VS Code SSH configurations

rdc vscode cleanup [options]
FlagDescriptionRequiredDefault
--allRemove all rediacc SSH configurationsNo-
-c, --connection <name>Remove specific connectionNo-

14.4 check

Check VS Code installation and configuration

rdc vscode check [options]
FlagDescriptionRequiredDefault
--insidersUse VS Code Insiders settingsNo-

15. SSH Terminal Access

SSH terminal access to machines and repositories

15.1 connect

Connect to a machine or repository via SSH

rdc term connect [options]
FlagDescriptionRequiredDefault
-t, --team <name>Team nameNo-
-m, --machine <name>Machine nameNo-
-r, --repository <name>Repository name (connects to repository environment)No-
-c, --command <cmd>Execute a command instead of interactive shellNo-
--container <id>Connect to a specific Docker containerNo-
--container-action <action>Container action: terminal, logs, stats, execNo-
--log-lines <lines>Number of log lines to show (default: 50)No-
--followFollow logs outputNo-
--externalForce launching in external terminal windowNo-

16. Ceph Storage Management

Ceph distributed storage management

16.1 cluster

Ceph cluster management

list

List Ceph clusters

rdc ceph cluster list

create

Create a new Ceph cluster

rdc ceph cluster create <name> [options]
FlagDescriptionRequiredDefault
--vault <content>Vault content as JSON stringNo-

delete

Delete a Ceph cluster

rdc ceph cluster delete <name> [options]
FlagDescriptionRequiredDefault
-f, --forceSkip confirmation promptsNo-

machines

List machines in a Ceph cluster

rdc ceph cluster machines <name>

vault

Ceph cluster vault management

get:

Get cluster vault data

rdc ceph cluster vault get <name>

update:

Update cluster vault data

rdc ceph cluster vault update <name> [options]
FlagDescriptionRequiredDefault
--vault <content>Vault content as JSON stringYes-

16.2 pool

Ceph pool management

list

List Ceph pools

rdc ceph pool list [options]
FlagDescriptionRequiredDefault
--team <name>Team nameNo-
--cluster <name>Ceph cluster nameNo-

create

Create a new Ceph pool

rdc ceph pool create <name> [options]
FlagDescriptionRequiredDefault
--cluster <name>Ceph cluster nameYes-
--team <name>Team nameYes-
--vault <content>Vault content as JSON stringNo-

delete

Delete a Ceph pool

rdc ceph pool delete <name> [options]
FlagDescriptionRequiredDefault
--team <name>Team nameYes-
-f, --forceSkip confirmation promptsNo-

vault

Ceph pool vault management

get:

Get pool vault data

rdc ceph pool vault get <name> [options]
FlagDescriptionRequiredDefault
--team <name>Team nameYes-

update:

Update pool vault data

rdc ceph pool vault update <name> [options]
FlagDescriptionRequiredDefault
--team <name>Team nameYes-
--vault <content>Vault content as JSON stringYes-

16.3 image

Ceph RBD image management

list

List RBD images

rdc ceph image list [options]
FlagDescriptionRequiredDefault
--pool <name>Ceph pool nameNo-
--team <name>Team nameNo-

create

Create a new RBD image

rdc ceph image create <name> [options]
FlagDescriptionRequiredDefault
--pool <name>Ceph pool nameYes-
--team <name>Team nameYes-
--machine <name>Machine nameYes-
--vault <content>Vault content as JSON stringNo-

delete

Delete an RBD image

rdc ceph image delete <name> [options]
FlagDescriptionRequiredDefault
--pool <name>Ceph pool nameYes-
--team <name>Team nameYes-
-f, --forceSkip confirmation promptsNo-

16.4 snapshot

Ceph RBD snapshot management

list

List RBD snapshots

rdc ceph snapshot list [options]
FlagDescriptionRequiredDefault
--image <name>RBD image nameNo-
--pool <name>Ceph pool nameNo-
--team <name>Team nameNo-

create

Create a new RBD snapshot

rdc ceph snapshot create <name> [options]
FlagDescriptionRequiredDefault
--image <name>RBD image nameYes-
--pool <name>Ceph pool nameYes-
--team <name>Team nameYes-
--vault <content>Vault content as JSON stringNo-

delete

Delete an RBD snapshot

rdc ceph snapshot delete <name> [options]
FlagDescriptionRequiredDefault
--image <name>RBD image nameYes-
--pool <name>Ceph pool nameYes-
--team <name>Team nameYes-
-f, --forceSkip confirmation promptsNo-

16.5 clone

Ceph RBD clone management

list

List RBD clones

rdc ceph clone list [options]
FlagDescriptionRequiredDefault
--snapshot <name>RBD snapshot nameNo-
--image <name>RBD image nameNo-
--pool <name>Ceph pool nameNo-
--team <name>Team nameNo-

create

Create a new RBD clone from snapshot

rdc ceph clone create <name> [options]
FlagDescriptionRequiredDefault
--snapshot <name>RBD snapshot nameYes-
--image <name>RBD image nameYes-
--pool <name>Ceph pool nameYes-
--team <name>Team nameYes-
--vault <content>Vault content as JSON stringNo-

delete

Delete an RBD clone

rdc ceph clone delete <name> [options]
FlagDescriptionRequiredDefault
--snapshot <name>RBD snapshot nameYes-
--image <name>RBD image nameYes-
--pool <name>Ceph pool nameYes-
--team <name>Team nameYes-
-f, --forceSkip confirmation promptsNo-

machines

List machines assigned to a clone

rdc ceph clone machines <name> [options]
FlagDescriptionRequiredDefault
--snapshot <name>RBD snapshot nameYes-
--image <name>RBD image nameYes-
--pool <name>Ceph pool nameYes-
--team <name>Team nameYes-

assign

Assign machines to a clone

rdc ceph clone assign <name> [options]
FlagDescriptionRequiredDefault
--snapshot <name>RBD snapshot nameYes-
--image <name>RBD image nameYes-
--pool <name>Ceph pool nameYes-
--team <name>Team nameYes-
--machines <names>Machine names (comma-separated)Yes-

unassign

Remove machines from a clone

rdc ceph clone unassign <name> [options]
FlagDescriptionRequiredDefault
--snapshot <name>RBD snapshot nameYes-
--image <name>RBD image nameYes-
--pool <name>Ceph pool nameYes-
--team <name>Team nameYes-
--machines <names>Machine names (comma-separated)Yes-

17. Audit and Compliance

Audit log commands

17.1 list

List audit log entries

rdc audit list

17.2 log

View audit logs

rdc audit log [options]
FlagDescriptionRequiredDefault
--limit <n>Maximum number of resultsNo100

17.3 trace

Trace audit history for an entity

rdc audit trace <entityType> <entityId>

17.4 history

View entity history

rdc audit history <entityType> <entityId>

18. Protocol Handler

Manage {{scheme}}:// protocol handler registration and URL handling

18.1 register

Register the protocol handler on the system

rdc protocol register [options]
FlagDescriptionRequiredDefault
--systemRegister system-wide (requires admin privileges)No-
--forceForce re-registration even if already registeredNo-

18.2 unregister

Unregister the protocol handler from the system

rdc protocol unregister [options]
FlagDescriptionRequiredDefault
--systemUnregister system-wide registration (requires admin privileges)No-

18.3 status

Show protocol handler registration status

rdc protocol status

18.4 open

Open a {{scheme}}:// URL and execute the action

rdc protocol open <url>

18.5 build

Build a {{scheme}}:// URL from components

rdc protocol build [options]
FlagDescriptionRequiredDefault
--token <token>Authentication tokenYes-
-t, --team <name>Team nameYes-
-m, --machine <name>Machine nameYes-
-r, --repository <name>Repository name (connects to repository environment)No-
-a, --action <action>Action ({{actions}})Nodesktop
-p, --params <key=value...>Additional parametersNo-

18.6 parse

Parse a {{scheme}}:// URL and show components

rdc protocol parse <url>

19. Quick Commands (Shortcuts)

19.1 run

Run a function (shortcut for: queue create)

rdc run

19.2 trace

Trace a task (shortcut for: queue trace)

rdc trace

19.3 cancel

Cancel a task (shortcut for: queue cancel)

rdc cancel

19.4 retry

Retry a failed task (shortcut for: queue retry)

rdc retry

20. CLI Updates

Check for and apply CLI updates

rdc update [options]
FlagDescriptionRequiredDefault
--forceForce update even if already up-to-dateNo-
--check-onlyOnly check for updates without downloadingNo-

21. System Diagnostics

Diagnose CLI environment and renet integration

rdc doctor

Common Error Messages

When something goes wrong, the CLI provides clear error messages:

ErrorMeaning
Authentication required. Run: rdc loginYou need to log in first
No active context. Create or select a context first.No context is selected — create or switch to one
Permission deniedYour account lacks the required permissions
Machine name required. Use --machine or set context.Specify a machine with `--machine` or set a context default
Team name required. Use --team or set context.Specify a team with `--team` or set a context default
Region name required. Use --region or set context.Specify a region with `--region` or set a context default

Output Formats

All list/get commands support multiple output formats via `--output`:

rdc machine list --output json
rdc machine list --output yaml
rdc machine list --output csv
rdc machine list --output table   # default

This makes it easy to integrate Rediacc CLI into scripts, CI/CD pipelines, and automation workflows.