CLI installation
You can install the CLI in any of the following ways:
- Interactive CLI installation using a script
- Non-interactive CLI installation using a script
- Installation without using a script
Interactive CLI installation using a script
This section provides a guide for interactive CLI installation using a script that:
- Identifies your OS and architecture.
- Downloads the executable with the latest stable CLI version for your environment.
- Performs a health check.
- Adds the CLI to the
PATHenvironment variable. - Generates autocompletion settings.
-
Run this command:
curl -sSL https://storage.yandexcloud.net/yandexcloud-yc/install.sh | bashThe script will install the CLI and add the executable file path to the
PATHenvironment variable.Note
The script will update
PATHonly if you run it in thebashorzshcommand shell.If you run the script in a different shell, add the CLI path to the
PATHvariable yourself.Warning
For autocompletion to work correctly when using
zsh, you need the shell version 5.1 or higher. If usingbashon CentOS and derivative distributions, install thebash-completionpackage. -
After installation is complete, restart your terminal.
-
Run this command:
curl -sSL https://storage.yandexcloud.net/yandexcloud-yc/install.sh | bashThe script will install the CLI and add the executable file path to the
PATHenvironment variable. -
Restart your terminal for the changes to take effect.
The CLI supports command autocompletion for the bash and zsh command shells. To enable autocompletion:
-
Install the Homebrew
package manager. -
Install the
zsh-completionpackage:Warning
If you installed bash instead of zsh or have macOS Mojave 10.14 or earlier with bash as the default shell, use the
bash-completionpackage instead ofzsh-completionand the~/.bash_profileconfiguration file instead of~/.zshrcat the current and next step.brew install zsh-completionThe installation script will update the
~/.zshrcconfiguration file:# The next line updates PATH for Yandex Cloud CLI. if [ -f '/Users/<username>/yandex-cloud/path.bash.inc' ]; then source '/Users/<username>/yandex-cloud/path.bash.inc'; fi # The next line enables shell command completion for yc. if [ -f '/Users/<username>/yandex-cloud/completion.zsh.inc' ]; then source '/Users/<username>/yandex-cloud/completion.zsh.inc'; fi -
After the installation is complete, add the following lines to the
~/.zshrcconfiguration file. Insert them above the lines automatically added by the installation script.if [ -f $(brew --prefix)/etc/zsh_completion ]; then . $(brew --prefix)/etc/zsh_completion fi -
Restart your terminal.
For Windows, you can install the CLI using PowerShell or command line:
-
To install using PowerShell:
-
Run this command:
iex (New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-yc/install.ps1') -
The installation script will ask whether to add the path to
ycto the PATH variable:Add yc installation dir to your PATH? [Y/n] -
Enter
Y. After this, you can use the Yandex Cloud CLI without restarting the command shell.
-
-
To install using the command line:
-
Run this command:
@"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-yc/install.ps1'))" && SET "PATH=%PATH%;%USERPROFILE%\yandex-cloud\bin" -
The installation script will ask whether to add the path to
ycto the PATH variable:Add yc installation dir to your PATH? [Y/n] -
Enter
Y. -
Restart your terminal for the changes to take effect.
-
If you get an error during CLI installation, see CLI troubleshooting.
To use the CLI, create a profile.
Non-interactive CLI installation using a script
To use the CLI in scripts, you can use flags for a non-interactive installation:
Run this command:
curl https://storage.yandexcloud.net/yandexcloud-yc/install.sh | bash -s -- -h
Usage: install [options...]
Options:
-i [INSTALL_DIR] Installs to specified dir.
-r [RC_FILE] Automatically modify RC_FILE with PATH modification and shell completion.
-n Don't modify rc file and don't ask about it.
-a Automatically modify default rc file with PATH modification and shell completion.
-h Prints help.
Examples of use:
-
Installing the CLI to
/opt/ycwithout changing the.bashrcfile:curl https://storage.yandexcloud.net/yandexcloud-yc/install.sh | \ bash -s -- -i /opt/yc -n -
Installing the CLI to the default directory with
completionandPATHadded to.bashrc:curl https://storage.yandexcloud.net/yandexcloud-yc/install.sh | \ bash -s -- -a
To use the CLI, create a profile.
Installation without using a script
If running scripts is not possible on the target system, you can manually download and install the executable with the latest stable CLI version.
Select instructions based on your OS and processor architecture:
-
Navigate to the directory you want to download the CLI to:
cd <path_to_directory> -
Download and unpack the yc_linux_amd64.tar.gz
file:curl -O https://storage.yandexcloud.net/yandexcloud-yc/release/yc_linux_amd64.tar.gz tar -xzf yc_linux_amd64.tar.gz -
Grant permissions to run the executable:
chmod +x yc -
Add the path to the directory containing the executable to
PATH:export PATH=$PATH:$PWD
-
Navigate to the directory you want to download the CLI to:
cd <path_to_directory> -
Download and unpack the yc_linux_386.tar.gz
file:curl -O https://storage.yandexcloud.net/yandexcloud-yc/release/yc_linux_386.tar.gz tar -xzf yc_linux_386.tar.gz -
Grant permissions to run the executable:
chmod +x yc -
Add the path to the directory containing the executable to
PATH:export PATH=$PATH:$PWD
-
Navigate to the directory you want to download the CLI to:
cd <path_to_directory> -
Download and unpack the yc_linux_arm64.tar.gz
file:curl -O https://storage.yandexcloud.net/yandexcloud-yc/release/yc_linux_arm64.tar.gz tar -xzf yc_linux_arm64.tar.gz -
Grant permissions to run the executable:
chmod +x yc -
Add the path to the directory containing the executable to
PATH:export PATH=$PATH:$PWD
-
Navigate to the directory you want to download the CLI to:
cd <path_to_directory> -
Download and unpack the yc_darwin_amd64.tar.gz
file:curl -O https://storage.yandexcloud.net/yandexcloud-yc/release/yc_darwin_amd64.tar.gz tar -xzf yc_darwin_amd64.tar.gz -
Grant permissions to run the executable:
chmod +x yc -
Add the path to the directory containing the executable to
PATH:export PATH=$PATH:$PWD
-
Navigate to the directory you want to download the CLI to:
cd <path_to_directory> -
Download and unpack the yc_darwin_arm64.tar.gz
file:curl -O https://storage.yandexcloud.net/yandexcloud-yc/release/yc_darwin_arm64.tar.gz tar -xzf yc_darwin_arm64.tar.gz -
Grant permissions to run the executable:
chmod +x yc -
Add the path to the directory containing the executable to
PATH:export PATH=$PATH:$PWD
-
Navigate to the directory you want to download the CLI to:
cd <path_to_directory> -
Download and unpack the yc_windows_amd64.zip
file:curl.exe -O https://storage.yandexcloud.net/yandexcloud-yc/release/yc_windows_amd64.zip Expand-Archive yc_windows_amd64.zip -DestinationPath . -
Add the path to the directory containing the executable to
PATH:[System.Environment]::SetEnvironmentVariable("PATH", "$env:PATH;$PWD", "User") -
Restart PowerShell.
-
Navigate to the directory you want to download the CLI to:
cd <path_to_directory> -
Download and unpack the yc_windows_386.zip
file:curl.exe -O https://storage.yandexcloud.net/yandexcloud-yc/release/yc_windows_386.zip Expand-Archive yc_windows_386.zip -DestinationPath . -
Add the path to the directory containing the executable to
PATH:[System.Environment]::SetEnvironmentVariable("PATH", "$env:PATH;$PWD", "User") -
Restart PowerShell.
To use the CLI, create a profile.