Rediacc CLI Reference (Cloud / Experimental)
Overview
These commands require the **cloud adapter** (experimental) — activated when a config contains `apiUrl` and `token` fields. For the main CLI reference, see [CLI Application](/en/docs/cli-application).
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 <name> | Save credentials to a named config | 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 config. Use `--save-as` to store credentials under a named config for multiple environments.
2. Organization Management
Organization management commands
2.1 list
List organizations
rdc organization list
2.2 info
Get organization information
rdc organization info
2.3 dashboard
Get organization dashboard data
rdc organization dashboard
2.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 | - |
2.5 export
Export organization data
rdc organization export [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--path <path> | Path to save output file | No | - |
2.6 import
Import organization data
rdc organization import <path> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--mode <mode> | Import mode (merge or replace) | No | merge |
2.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.
3. User Management
User management commands
3.1 list
List all users
rdc user list
3.2 create
Create a new user
rdc user create <email> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-p, --password <password> | Password for the new user | No | - |
3.3 activate
Activate a user account
rdc user activate <email> <activationCode>
3.4 deactivate
Deactivate a user account
rdc user deactivate <email> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-f, --force | Skip confirmation prompts | No | - |
3.5 reactivate
Reactivate a deactivated user account
rdc user reactivate <email>
3.6 update-email
Change a user's email address
rdc user update-email <currentEmail> <newEmail>
3.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 | - |
3.8 update-language
Set current user's preferred language
rdc user update-language <language>
3.9 exists
Check if a user exists
rdc user exists <email>
3.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 | - |
3.11 permission
User permission management
assign
Assign a permission group to a user
rdc user permission assign <userEmail> <groupName>
4. Team Management
Team management
4.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 | - |
4.2 create
Create a team
rdc team create <name>
4.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>
5. Permission Management
Permission management commands
5.1 list
List permissions
rdc permission list
5.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>
5.3 add
Add a permission to a group
rdc permission add <groupName> <permission>
5.4 remove
Remove a permission from a group
rdc permission remove <groupName> <permission>
6. Region Management
Region management
6.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 | - |
7. Bridge Management
Bridge management
7.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 | - |
7.2 reset-auth
Reset bridge authorization token
rdc bridge reset-auth <name> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-r, --region <name> | Region name | No | - |
8. Repository Management
Repository management commands
8.1 list
List repositories
rdc repository list [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-t, --team <name> | Team name | No | - |
8.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 | - |
8.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 |
8.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 | - |
8.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.
8.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 | - |
9. 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.
9.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 |
9.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 | - |
9.3 cancel
Cancel a queue item
rdc queue cancel <taskId>
9.4 retry
Retry a failed queue item
rdc queue retry <taskId>
9.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.
9.6 delete
Delete a queue item
rdc queue delete <taskId> [options]
| Flag | Description | Required | Default |
|---|---|---|---|
-f, --force | Skip confirmation prompts | No | - |
10. Ceph Storage Management
Ceph distributed storage management
10.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 | - |
10.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 | - |
10.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 | - |
10.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 | - |
10.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 | - |
11. Audit and Compliance
Audit log commands
11.1 list
List audit log entries
rdc audit list
11.2 log
View audit logs
rdc audit log [options]
| Flag | Description | Required | Default |
|---|---|---|---|
--limit <n> | Maximum number of results | No | 100 |
11.3 trace
Trace audit history for an entity
rdc audit trace <entityType> <entityId>
11.4 history
View entity history
rdc audit history <entityType> <entityId>