CLI installation
You can install the CLI in different modes:
Interactive CLI installation
-
Run this command:
curl -sSL https://storage.yandexcloud.net/yandexcloud-yc/install.sh | bash
The script will install the CLI and add the executable file path to the
PATH
environment variable.Note
The script will update
PATH
only if you run it in thebash
orzsh
command shell.If you run the script in a different shell, add the CLI path to the
PATH
variable yourself.Warning
For correct operation of the autocompletion feature when using
zsh
, you need the shell version 5.1 or higher. If usingbash
on CentOS and derivative distributions, install thebash-completion
package. -
After installation is complete, restart your terminal.
-
Run this command:
curl -sSL https://storage.yandexcloud.net/yandexcloud-yc/install.sh | bash
The script will install the CLI and add the executable file path to the
PATH
environment variable. -
Restart your terminal for the changes to take effect.
The CLI supports command autocompletion for the bash
and zsh
command shells. To enable command autocompletion:
-
Install the Homebrew
package manager. -
Install the
zsh-completion
package: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-completion
package instead ofzsh-completion
and the~/.bash_profile
configuration file instead of~/.zshrc
at the current and next step.brew install zsh-completion
The installation script will update the
~/.zshrc
configuration 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
~/.zshrc
configuration 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
yc
to 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
yc
to 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
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.
Example of use:
-
Installing the CLI to
/opt/yc
without changing the.bashrc
file:curl https://storage.yandexcloud.net/yandexcloud-yc/install.sh | \ bash -s -- -i /opt/yc -n
-
Installing the CLI to the default directory with
completion
andPATH
added to.bashrc
:curl https://storage.yandexcloud.net/yandexcloud-yc/install.sh | \ bash -s -- -a