This section explains the procedure for installing and configuring the researcher Command Line Interface.
Note
This section refers to CLI v2 only. You can find installation instructions for the CLI v1 here . CLI v1 was deprecated in v2.20.
Ensure the Improved command line interface toggle is enabled, under General settings → Workloads
Only clusters that are version 2.18 or above are supported.
Click the Help (?) icon in the top right corner
Select Researcher Command Line Interface
Select the cluster you want the CLI to communicate with
Select your computer’s operating system
Copy the installer command and run it in the terminal or download the binary file for Windows OS
Follow the installation process instructions
Click Enter
to use the default values (recommended)
To verify the CLI client was installed properly
Run the command runai version
Follow the steps below to configure the CLI.
Setting the Control Plane URLThe following step is required for Windows users only. Linux and Mac clients are configured via the installation script automatically
Run the command runai config set --cp-url <CONTROL_PLANE_URL>
. This will also create the config.json
file in the default path.
After installation, sign in to the NVIDIA Run:ai platform to authenticate the CLI.
Open the terminal on your local machine
Enter your username and password in the NVIDIA Run:ai platform's sign-in page
Return to the terminal window to use the CLI
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:
Open the terminal on your local machine
Run runai cluster
and select the desired cluster from the interactive menu.
Alternatively:
Open the terminal on your local machine.
Run runai cluster list
to find the desired cluster name.
Run the following command runai cluster set <CLUSTER_NAME>
.
Set a default working project, to easily submit workloads without mentioning the project name in every command.
Open the terminal on your local machine.
Run runai project
and select the desired cluster from the interactive menu.
Alternatively:
Open the terminal on your local machine.
Run runai cluster list
to find the desired project name.
Run the following command runai project set <PROJECT_NAME>
If successful, the following message is returned project <PROJECT_NAME> configured successfully.
To view the current configuration run runai config generate --json
Auto-completion assists with completing the command syntax automatically for ease-of-use. Auto-completion is installed automatically. The interfaces below require manual installation:
Installation instructions for ZSHAdd the following code:
autoload -U compinit; compinit -i
source <(runai completion zsh)
Install the bash-completion package
Choose your operating system: Mac: brew install bash-completion
Ubuntu/Debian: sudo apt-get install bash-completion
Fedora/Centos: sudo yum install bash-completion
Edit the file ~/.bashrc
and add the following lines:
[[ -r “/usr/local/etc/profile.d/bash_completion.sh” ]] && . “/usr/local/etc/profile.d/bash_completion.sh”
source <(runai completion bash)
Add the following code in the powershell profile:
runai.exe completion powershell | Out-String | Invoke-Expression
Set-PSReadLineKeyHandler -Key Tab -Function MenuComplete
For more completion modes options, see Powershell completions .
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4