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:
| Flag | Description |
|---|---|
--output | Output format (table|json|yaml|csv) |
--context | Use specific context for this command |
--lang | Language override ({{languages}}) |
--force | Skip confirmation prompts |
1. Authentication
Authentication commands
1.1 login
Authenticate with Rediacc
rdc auth login [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-e, --email <email> | Email address | No | - |
-p, --password <password> | Password (for non-interactive login) | No | - |
-m, --master-password <password> | Master password for vault encryption | No | - |
-n, --name <name> | Session name | No | - |
--endpoint <url> | API endpoint URL | No | - |
--save-as <context> | Save credentials to a named context | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
--organization <name> | Organization name | Yes | - |
-e, --email <email> | Email address | Yes | - |
-p, --password <password> | Password (for non-interactive login) | Yes | - |
-m, --master-password <password> | Master password for vault encryption | No | - |
--endpoint <url> | API endpoint URL | No | - |
--plan <plan> | Subscription plan (COMMUNITY, PROFESSIONAL, BUSINESS, ENTERPRISE) | No | COMMUNITY |
1.5 activate
Activate account with verification code
rdc auth activate [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-e, --email <email> | Email address | Yes | - |
-p, --password <password> | Password (for non-interactive login) | Yes | - |
--code <code> | Activation code from email | Yes | - |
--endpoint <url> | API endpoint URL | No | - |
1.6 tfa
Two-factor authentication management
disable
Disable two-factor authentication
rdc auth tfa disable [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--code <code> | Current TFA code for verification | No | - |
-y, --yes | Skip confirmation prompt | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
-n, --name <name> | Token name | No | CLI Fork |
-e, --expires <hours> | Expiration in hours (1-720) | No | 24 |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
-u, --api-url <url> | API URL | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
--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]
| Flag | Description | Required | Default |
|---|---|---|---|
--ip <address> | Machine IP address or hostname | Yes | - |
--user <username> | SSH username | Yes | - |
--port <port> | SSH port | No | 22 |
--datastore <path> | Datastore path on machine | No | /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]
| Flag | Description | Required | Default |
|---|---|---|---|
--private-key <path> | Path to SSH private key | Yes | - |
--public-key <path> | Path to SSH public key | No | - |
2.17 create-s3
Create a new S3/R2 context for remote state with local execution
rdc context create-s3 <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--endpoint <url> | S3 endpoint URL | Yes | - |
--bucket <name> | S3 bucket name | Yes | - |
--access-key-id <key> | S3 access key ID | Yes | - |
--ssh-key <path> | Path to SSH private key | Yes | - |
--secret-access-key <key> | S3 secret access key (prompts if not given) | No | - |
--region <region> | S3 region | No | auto |
--prefix <prefix> | Key prefix/namespace in bucket | No | - |
--renet-path <path> | Path to renet binary | No | - |
--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]
| Flag | Description | Required | Default |
|---|---|---|---|
--vault <json> | Vault content as JSON string | No | - |
--vault-version <n> | Current vault version for optimistic locking | No | - |
3.5 export
Export organization data
rdc organization export [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--path <path> | Path to save output file | No | - |
3.6 import
Import organization data
rdc organization import <path> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--mode <mode> | Import mode (merge or replace) | No | merge |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
-p, --password <password> | Password for the new user | No | - |
4.3 activate
Activate a user account
rdc user activate <email> <activationCode>
4.4 deactivate
Deactivate a user account
rdc user deactivate <email> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-f, --force | Skip confirmation prompts | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
--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]
| Flag | Description | Required | Default |
|---|---|---|---|
--vault <json> | Vault content as JSON string | No | - |
--vault-version <n> | Current vault version for optimistic locking | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
--search <text> | Search in {{field}} | No | - |
--sort <field> | Sort by field | No | - |
--desc | Sort in descending order | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
-f, --force | Skip confirmation prompts | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
--search <text> | Search in {{field}} | No | - |
--sort <field> | Sort by field | No | - |
--desc | Sort in descending order | No | - |
8. Bridge Management
Bridge management
8.1 list
List bridges
rdc bridge list [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-r, --region <name> | Region name | No | - |
--search <text> | Search in {{field}} | No | - |
--sort <field> | Sort by field | No | - |
--desc | Sort in descending order | No | - |
8.2 reset-auth
Reset bridge authorization token
rdc bridge reset-auth <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-r, --region <name> | Region name | No | - |
9. Machine Management
Machine management
9.1 list
List machines
rdc machine list [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
--search <text> | Search in {{field}} | No | - |
--sort <field> | Sort by field | No | - |
--desc | Sort in descending order | No | - |
9.2 create
Create a new machine
rdc machine create <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
-b, --bridge <name> | Bridge name | No | - |
--vault <json> | Machine vault data as JSON string | No | - |
9.3 delete
Delete a machine
rdc machine delete <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
-f, --force | Skip confirmation prompts | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
9.6 containers
List Docker containers on a machine
rdc machine containers <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
--health-check | Health check mode - exits with code 2 if any unhealthy | No | - |
9.7 services
List systemd services on a machine
rdc machine services <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
--stability-check | Stability check mode - exits with code 2 if any failed/restarting | No | - |
9.8 vault-status
Show parsed vault status for a machine
rdc machine vault-status <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
9.9 repos
List deployed repositories on a machine
rdc machine repos <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
--search <text> | Filter repositories by name | No | - |
9.10 test-connection
Test SSH connection to a machine and capture host key
rdc machine test-connection [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--ip <address> | Machine IP address or hostname | Yes | - |
--user <name> | SSH username | Yes | - |
-t, --team <name> | Team name | No | - |
-b, --bridge <name> | Bridge name | No | - |
--port <number> | SSH port | No | 22 |
--password <pwd> | SSH password for initial authentication | No | - |
--datastore <path> | Datastore path on machine | No | /mnt/rediacc |
-m, --machine <name> | Machine name (for updating vault after test) | No | - |
--save | Save known_hosts to machine vault after successful test | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
10.2 create
Create a new repository
rdc repository create <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
--tag <tag> | Repository tag | No | latest |
--parent <name> | Parent repository (for forks) | No | - |
--parent-tag <tag> | Parent repository tag | No | - |
10.3 rename
Rename a repository
rdc repository rename <oldName> <newName> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
--tag <tag> | Repository tag | No | latest |
10.4 delete
Delete a repository
rdc repository delete <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
--tag <tag> | Repository tag | No | latest |
-f, --force | Skip confirmation prompts | No | - |
10.5 promote
Promote a fork to grand status
rdc repository promote <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
--tag <tag> | Repository tag | No | latest |
-f, --force | Skip confirmation prompts | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
--tag <tag> | Repository tag | No | latest |
update
Update repository vault data
rdc repository vault update <repositoryName> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
--tag <tag> | Repository tag | No | latest |
--vault <json> | Vault content as JSON string | No | - |
--vault-version <n> | Current vault version for optimistic locking | No | - |
11. Storage Management
Storage management
11.1 list
List storage providers
rdc storage list [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
--search <text> | Search in {{field}} | No | - |
--sort <field> | Sort by field | No | - |
--desc | Sort in descending order | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
--status <status> | Filter by status | No | - |
--priority-min <n> | Minimum priority (1-5) | No | - |
--priority-max <n> | Maximum priority (1-5) | No | - |
--search <text> | Search in task ID, team, machine, bridge | No | - |
--sort <field> | Sort by field | No | - |
--desc | Sort in descending order | No | - |
--limit <n> | Maximum number of results | No | 50 |
12.2 create
Create a queue item
rdc queue create [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-f, --function <name> | Function name to execute | Yes | - |
-t, --team <name> | Team name | No | - |
-m, --machine <name> | Machine name | No | - |
-b, --bridge <name> | Bridge name | No | - |
-p, --priority <1-5> | Priority (1=highest) | No | 3 |
--param <key=value> | Function parameters | No | - |
--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]
| Flag | Description | Required | Default |
|---|---|---|---|
-w, --watch | Watch for updates | No | - |
--interval <ms> | Poll interval in milliseconds | No | 2000 |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
-f, --force | Skip confirmation prompts | No | - |
13. File Synchronization
File synchronization with repositories using rsync
13.1 upload
Upload files to a repository
rdc sync upload [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
-m, --machine <name> | Machine name | No | - |
-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 repository | No | - |
--mirror | Mirror mode - delete remote files not present locally | No | - |
--verify | Verify files using checksums after sync | No | - |
--confirm | Preview changes and ask for confirmation before syncing | No | - |
--exclude <patterns...> | Patterns to exclude from sync | No | - |
--dry-run | Show what would be transferred without actually syncing | No | - |
13.2 download
Download files from a repository
rdc sync download [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
-m, --machine <name> | Machine name | No | - |
-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 repository | No | - |
--mirror | Mirror mode - delete local files not present on remote | No | - |
--verify | Verify files using checksums after sync | No | - |
--confirm | Preview changes and ask for confirmation before syncing | No | - |
--exclude <patterns...> | Patterns to exclude from sync | No | - |
--dry-run | Show what would be transferred without actually syncing | No | - |
13.3 status
Check sync status and compare local/remote files
rdc sync status [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
-m, --machine <name> | Machine name | No | - |
-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 repository | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
-m, --machine <name> | Machine name | No | - |
-r, --repository <name> | Repository name (connects to repository environment) | No | - |
-f, --folder <path> | Remote folder path to open | No | - |
--url-only | Print the VS Code URI instead of launching | No | - |
-n, --new-window | Open in new VS Code window | No | - |
--skip-env-setup | Skip remote environment setup | No | - |
--insiders | Use VS Code Insiders settings | No | - |
14.2 list
List configured VS Code SSH connections
rdc vscode list
14.3 cleanup
Remove VS Code SSH configurations
rdc vscode cleanup [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--all | Remove all rediacc SSH configurations | No | - |
-c, --connection <name> | Remove specific connection | No | - |
14.4 check
Check VS Code installation and configuration
rdc vscode check [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--insiders | Use VS Code Insiders settings | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
-m, --machine <name> | Machine name | No | - |
-r, --repository <name> | Repository name (connects to repository environment) | No | - |
-c, --command <cmd> | Execute a command instead of interactive shell | No | - |
--container <id> | Connect to a specific Docker container | No | - |
--container-action <action> | Container action: terminal, logs, stats, exec | No | - |
--log-lines <lines> | Number of log lines to show (default: 50) | No | - |
--follow | Follow logs output | No | - |
--external | Force launching in external terminal window | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
--vault <content> | Vault content as JSON string | No | - |
delete
Delete a Ceph cluster
rdc ceph cluster delete <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-f, --force | Skip confirmation prompts | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
--vault <content> | Vault content as JSON string | Yes | - |
16.2 pool
Ceph pool management
list
List Ceph pools
rdc ceph pool list [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--team <name> | Team name | No | - |
--cluster <name> | Ceph cluster name | No | - |
create
Create a new Ceph pool
rdc ceph pool create <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--cluster <name> | Ceph cluster name | Yes | - |
--team <name> | Team name | Yes | - |
--vault <content> | Vault content as JSON string | No | - |
delete
Delete a Ceph pool
rdc ceph pool delete <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--team <name> | Team name | Yes | - |
-f, --force | Skip confirmation prompts | No | - |
vault
Ceph pool vault management
get:
Get pool vault data
rdc ceph pool vault get <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--team <name> | Team name | Yes | - |
update:
Update pool vault data
rdc ceph pool vault update <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--team <name> | Team name | Yes | - |
--vault <content> | Vault content as JSON string | Yes | - |
16.3 image
Ceph RBD image management
list
List RBD images
rdc ceph image list [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--pool <name> | Ceph pool name | No | - |
--team <name> | Team name | No | - |
create
Create a new RBD image
rdc ceph image create <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--pool <name> | Ceph pool name | Yes | - |
--team <name> | Team name | Yes | - |
--machine <name> | Machine name | Yes | - |
--vault <content> | Vault content as JSON string | No | - |
delete
Delete an RBD image
rdc ceph image delete <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--pool <name> | Ceph pool name | Yes | - |
--team <name> | Team name | Yes | - |
-f, --force | Skip confirmation prompts | No | - |
16.4 snapshot
Ceph RBD snapshot management
list
List RBD snapshots
rdc ceph snapshot list [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--image <name> | RBD image name | No | - |
--pool <name> | Ceph pool name | No | - |
--team <name> | Team name | No | - |
create
Create a new RBD snapshot
rdc ceph snapshot create <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--image <name> | RBD image name | Yes | - |
--pool <name> | Ceph pool name | Yes | - |
--team <name> | Team name | Yes | - |
--vault <content> | Vault content as JSON string | No | - |
delete
Delete an RBD snapshot
rdc ceph snapshot delete <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--image <name> | RBD image name | Yes | - |
--pool <name> | Ceph pool name | Yes | - |
--team <name> | Team name | Yes | - |
-f, --force | Skip confirmation prompts | No | - |
16.5 clone
Ceph RBD clone management
list
List RBD clones
rdc ceph clone list [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--snapshot <name> | RBD snapshot name | No | - |
--image <name> | RBD image name | No | - |
--pool <name> | Ceph pool name | No | - |
--team <name> | Team name | No | - |
create
Create a new RBD clone from snapshot
rdc ceph clone create <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--snapshot <name> | RBD snapshot name | Yes | - |
--image <name> | RBD image name | Yes | - |
--pool <name> | Ceph pool name | Yes | - |
--team <name> | Team name | Yes | - |
--vault <content> | Vault content as JSON string | No | - |
delete
Delete an RBD clone
rdc ceph clone delete <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--snapshot <name> | RBD snapshot name | Yes | - |
--image <name> | RBD image name | Yes | - |
--pool <name> | Ceph pool name | Yes | - |
--team <name> | Team name | Yes | - |
-f, --force | Skip confirmation prompts | No | - |
machines
List machines assigned to a clone
rdc ceph clone machines <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--snapshot <name> | RBD snapshot name | Yes | - |
--image <name> | RBD image name | Yes | - |
--pool <name> | Ceph pool name | Yes | - |
--team <name> | Team name | Yes | - |
assign
Assign machines to a clone
rdc ceph clone assign <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--snapshot <name> | RBD snapshot name | Yes | - |
--image <name> | RBD image name | Yes | - |
--pool <name> | Ceph pool name | Yes | - |
--team <name> | Team name | Yes | - |
--machines <names> | Machine names (comma-separated) | Yes | - |
unassign
Remove machines from a clone
rdc ceph clone unassign <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--snapshot <name> | RBD snapshot name | Yes | - |
--image <name> | RBD image name | Yes | - |
--pool <name> | Ceph pool name | Yes | - |
--team <name> | Team name | Yes | - |
--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]
| Flag | Description | Required | Default |
|---|---|---|---|
--limit <n> | Maximum number of results | No | 100 |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
--system | Register system-wide (requires admin privileges) | No | - |
--force | Force re-registration even if already registered | No | - |
18.2 unregister
Unregister the protocol handler from the system
rdc protocol unregister [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--system | Unregister 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]
| Flag | Description | Required | Default |
|---|---|---|---|
--token <token> | Authentication token | Yes | - |
-t, --team <name> | Team name | Yes | - |
-m, --machine <name> | Machine name | Yes | - |
-r, --repository <name> | Repository name (connects to repository environment) | No | - |
-a, --action <action> | Action ({{actions}}) | No | desktop |
-p, --params <key=value...> | Additional parameters | No | - |
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]
| Flag | Description | Required | Default |
|---|---|---|---|
--force | Force update even if already up-to-date | No | - |
--check-only | Only check for updates without downloading | No | - |
21. System Diagnostics
Diagnose CLI environment and renet integration
rdc doctor
Common Error Messages
When something goes wrong, the CLI provides clear error messages:
| Error | Meaning |
|---|---|
| Authentication required. Run: rdc login | You need to log in first |
| No active context. Create or select a context first. | No context is selected — create or switch to one |
| Permission denied | Your 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.