Skip to main content

Using the CLI

The S1 system provides a powerful command line interface (CLI) tool that can help you get more done. It supports auto-completion and interactive help, so you can quickly find the commands you need and get the information you need. By learning how to use the CLI effectively, you can save time and improve your productivity.

Before you begin

The StorONE CLI is a standalone client application. You can download the CLI client for your operating system (Windows or Linux) by navigating in your browser to the name or IP address of one of the StorONE controller nodes.

On the web page, click to download the CLI version for your operating system:

S1 web page with CLI downloadS1 web page with CLI download

Running the CLI client

Navigate to the directory where you downloaded the CLI, and run the application by double-clicking on it (for Windows) or running the binary at the terminal (for Linux).

When prompted, enter the name or IP address of your relay server, and then your username and password.

In cases where it is not the first time you have connected to a system you should be able to use the arrow keys to select your system and hit enter to start the login process

Interactive help

StorONE CLI supports auto-completion. You can type part of the command and use the TAB key to auto-complete. To get help on any command, use the -h or help command modifier ([command-name] -h or [command-name] help).

Using interactive help

  • The ls or help command provides a short description for all of the initial commands.

  • You can add help or -h to any command to view specific help for that command. For example:

    • To get help on the applications command and all its subcommands, run: 
      applications -h
    • To get help on the applications command and a specific sub-command, such as create, run: 
      applications create -h

  • To produce a PDF reference guide for all commands, run documentation save. The file is downloaded to the directory containing the CLI binary or executable.

  • To see for a usage example for any command, use the examples generate command. For example, to generate an example for the applications create command run:
    examples generate --command "applications create" --count 3

    • The --command modifier is followed by the name of the command
    • The --count modifier is followed by a number that specifies the number of usage examples to display.
    • To specify two examples for every command run:
      examples generate --all --count 2
    • To specify all usage examples for every command, run:
      examples generate --all

  • To view information about the versions of the S1 system components, run
    version

  • The search command allows you to look for a command by running a text search. The search command takes one argument (the text search string) and has two optional modifiers:

    • The --beforeContext modifier is followed by a number that specifies the number of characters before the match (the default value is 10)
    • The --afterContext modifier is followed by a number that specifies the number of characters after the match (the default value is 10)

    For example, to look for commands that contain the word pool, with 18 characters of context before and after, run search pool --afterContext 18 --beforeContext 18.

Back to top