Armada KVCLI Reference
Armada ships three CLIs:
armada— the server binary used to start and run ArmadaKV nodes.arctl— the control-plane and maintenance CLI used for backup, restore, and table administration.arq— the data-plane CLI used to query and modify key-value data.
armada Commands
| Command | Description |
|---|---|
| armada | Root command |
| armada leader | Start Armada in leader mode |
| armada follower | Start Armada in follower mode |
| armada version | Print current version |
arctl Commands
| Command | Description |
|---|---|
| arctl | Control-plane and maintenance CLI |
| arctl backup | Backup Armada to local files |
| arctl restore | Restore Armada from local files |
| arctl tables | Create, list, and delete tables |
arq Commands
| Command | Description |
|---|---|
| arq | Query and data-plane CLI |
| arq get | Get a key or range of keys |
| arq put | Put a key-value pair |
| arq delete | Delete a key or range of keys |
| arq txn | Execute an atomic transaction |