Skip to main content

CLI

CLI (Command line interface) is a simple way to execute commands on the running rostore service, that include:

  • creation and deletion of containers
  • creation and deletion of key/value-pairs
  • bulk operations like copying containers / storages
  • administrative operations like pinging the service or shutting it down.

How it works​

CLI is implemented as a java application that uses the rostore-client API to access remote service. Any operation available as a CLI operation is also available as a Java class/function and also available over the swagger API.

In fact, CLI has reduced functionality as Java/Swagger and meant to be used for CI/CD scripting or administrative operations like copying the data.

Profiles​

CLI works with the properly installed rostore service and is part of the standard rostore service distribution. CLI can also be downloaded as a separate bundle and can be used to access a remote rostore service. If CLI is aimed to be used as a administrative tool for a rostore distribution it must be executed from the home directory of the service, in any other use case a profile should be used to point the proper service.

General points​

Every CLI operation can be executed in a silent or verbose mode (-v option), in the later case a more detailed information is provided. The drawback of the verbose mode is politing of the output with meaningful, still very detailed information.