Installing the V2 Command-line interface¶

This article explains the procedure for installing and configuring the new researcher Command Line Interface (CLI).

Enabling the V2 CLI¶

Under Tools & Settings → General settings → Workloads, enable the flag Improved command line interface

Installing the CLI¶

1. Click the Help (?) icon in the top right corner
2. Select Researcher Command Line Interface
3. Select the cluster you want the CLI to communicate with
4. Select your computer’s operating system
5. Copy the installer command and run it in the terminal
6. Follow the installation process instructions
7. Click Enter to use the default values (recommended)

Testing the installation¶

To verify the CLI client was installed properly

1. Open the terminal
2. Run the command runai version

Configuring the CLI¶

Follow the steps below to configure the CLI.

Authenticating the CLI¶

After installation, sign in to the Run:ai platform to authenticate the CLI:

1. Open the terminal on your local machine.
2. Run runai login.
3. Enter your username and password on the Run:ai platform's sign-in page.
4. Return to the terminal window to use the CLI.

Setting the default cluster¶

If only one cluster is connected to the account, it is set as the default cluster when you first sign in.
If there are multiple clusters, you must follow the steps below to set your preferred cluster for workload submission:

1. Open the terminal on your local machine.
2. Run runai cluster list to find the required cluster name.
3. Run the following command runai cluster set <CLUSTER_NAME>

Setting a default project¶

Set a default working project, to easily submit workloads without mentioning the project name in every command.

1. Run the following command on the terminal:
   runai project set <PROJECT_NAME>
2. If successful, the following message is returned:
   project <PROJECT_NAME> configured successfully
3. To see the current configuration run:
   runai config generate --json

Installing command auto-completion¶

Auto-completion assists with completing the command syntax automatically for ease of use. Auto-completion is installed automatically.
The interfaces below require manual installation:

autoload -U compinit; compinit -i
source <(runai completion zsh)

[[ $PS1 && -f /usr/share/bash-completion/bash_completion ]] && . /usr/share/bash-completion/bash_completion
source <(runai completion bash)