Installing the Yandex Cloud CLI

1. 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.

   This command runs the installation script using bash. The script detects the user's command shell via the SHELL variable and adds the configurations for zsh to ~/.zshrc.

2. Restart your terminal for the changes to take effect.

For Windows, you can install the CLI using PowerShell or cmd.exe. In both cases, the installation script runs in PowerShell.

• Installation using PowerShell:

  1. Run this command:

     Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-yc/install.ps1')
     

  2. 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]
     

  3. Enter Y. After this, you can use the Yandex Cloud CLI without restarting the command shell.

• Installation from cmd.exe:

  1. Run this command:

     @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -Command "Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-yc/install.ps1'))" && SET "PATH=%PATH%;%USERPROFILE%\yandex-cloud\bin"
     

  2. When prompted by the installation script, confirm whether to add the yc path to the PATH variable:

     Add yc installation dir to your PATH? [Y/n]
     

  3. Enter Y.

  4. Restart your terminal for the changes to take effect.

For more information, see Working with the Yandex Cloud CLI and API in Microsoft Windows.

To enable autocompletion:

1. Open ~/.zshrc and add the following lines to the beginning of the file:

   autoload -Uz compinit
   compinit
   

   The yc installation script adds CLI initialization and autocompletion lines to the end of ~/.zshrc. Place the autoload and compinit calls above these lines; otherwise, you will get the command not found: compdef error when you start the terminal.

   The final ~/.zshrc should look as follows:

   autoload -Uz compinit
   compinit
   
   # The lines below were added automatically by the yc installation script.
   if [ -f "$HOME/yandex-cloud/path.bash.inc" ]; then source "$HOME/yandex-cloud/path.bash.inc"; fi
   if [ -f "$HOME/yandex-cloud/completion.zsh.inc" ]; then source "$HOME/yandex-cloud/completion.zsh.inc"; fi
   
   Installing extended autocompletions

   The zsh-completions package extends the system's basic autocompletions. It is not required for the yc autocompletion.

   To install the package:

   1. Install Homebrew.

   2. Install the zsh-completions package:

      brew install zsh-completions
      

      Tip

      If using bash, install the bash-completion package instead of zsh-completions.

   3. Add a section with FPATH before the autoload and compinit lines. The final ~/.zshrc should look as follows:

      if type brew &>/dev/null; then
        FPATH=$(brew --prefix)/share/zsh-completions:$FPATH
      fi
      autoload -Uz compinit
      compinit
      
      # The lines below were added automatically by the yc installation script.
      if [ -f "$HOME/yandex-cloud/path.bash.inc" ]; then source "$HOME/yandex-cloud/path.bash.inc"; fi
      if [ -f "$HOME/yandex-cloud/completion.zsh.inc" ]; then source "$HOME/yandex-cloud/completion.zsh.inc"; fi
      

2. Restart the command shell or run the exec -l $SHELL command.

3. Check that autocompletion works: type yc and press Tab twice. A list of available commands should appear.

winget install Microsoft.PowerShell

To enable autocompletion in PowerShell:

1. If you do not have a PowerShell profile, create one and open it in a text editor:

   New-Item -Path $PROFILE -Type File -Force
   notepad $PROFILE
   

   Instead of notepad, you can use any editor you prefer. For example, for VS Code, use the code $PROFILE command.

2. Add the following code to the file and save it:

   Register-ArgumentCompleter -Native -CommandName yc -ScriptBlock {
       param($wordToComplete, $commandAst, $cursorPosition)
   
       $elements = $commandAst.CommandElements
       $allTokens = $elements | Select-Object -Skip 1 | ForEach-Object { $_.ToString() }
       $allTokens = $allTokens | Where-Object { $_ -match '^[\x20-\x7E]+$' }
   
       if ($wordToComplete -ne '') {
           $completedTokens = $allTokens | Select-Object -SkipLast 1
           $queryTokens = @($completedTokens) + @("")
       } else {
           $queryTokens = @($allTokens) + @("")
       }
   
       $result = yc __completeNoDesc @queryTokens 2>$null
   
       $completions = $result | Where-Object {
           $_ -notmatch '^\:' -and $_ -notmatch '^Completion'
       } | Where-Object {
           $_.StartsWith($wordToComplete)
       }
   
       if ($completions.Count -eq 0 -and $wordToComplete -ne '') {
           $queryTokensFallback = @($completedTokens) + @($wordToComplete)
           $resultFallback = yc __completeNoDesc @queryTokensFallback 2>$null
   
           $completions = $resultFallback | Where-Object {
               $_ -notmatch '^\:' -and $_ -notmatch '^Completion'
           } | Where-Object {
               $_.StartsWith($wordToComplete)
           }
       }
   
       $completions | ForEach-Object {
           $parts = $_ -split '\t'
           [System.Management.Automation.CompletionResult]::new(
               $parts[0], $parts[0], 'ParameterValue', $parts[0]
           )
       }
   }
   

   Note

   By default, pressing Tab in PowerShell suggests the options one by one. To open a menu with all options and tooltips instead, add the following lines to the top of the file:

   Set-PSReadLineOption -ShowToolTips
   Set-PSReadLineKeyHandler -Key Tab -Function MenuComplete
   

   These lines change the Tab behavior in all PowerShell commands, not just yc.

3. Restart PowerShell. Check that autocompletion works: type yc and press Tab. A list of available commands should appear.

1. Navigate to the directory you want to download the CLI to:

   cd <path_to_directory>
   

2. 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
   

3. Grant permissions to run the executable:

   chmod +x yc
   

4. Add the path to the directory containing the executable to PATH:

   export PATH=$PATH:$PWD
   

1. Navigate to the directory you want to download the CLI to:

   cd <path_to_directory>
   

2. 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
   

3. Grant permissions to run the executable:

   chmod +x yc
   

4. Add the path to the directory containing the executable to PATH:

   export PATH=$PATH:$PWD
   

1. Navigate to the directory you want to download the CLI to:

   cd <path_to_directory>
   

2. 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
   

3. Grant permissions to run the executable:

   chmod +x yc
   

4. Add the path to the directory containing the executable to PATH:

   export PATH=$PATH:$PWD
   

1. Navigate to the directory you want to download the CLI to:

   cd <path_to_directory>
   

2. 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
   

3. Grant permissions to run the executable:

   chmod +x yc
   

4. Add the path to the directory containing the executable to PATH:

   export PATH=$PATH:$PWD
   

1. Navigate to the directory you want to download the CLI to:

   cd <path_to_directory>
   

2. 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 .
   

3. Add the path to the directory containing the executable to PATH:

   [System.Environment]::SetEnvironmentVariable("PATH", "$env:PATH;$PWD", "User")
   

4. Restart PowerShell.

1. Navigate to the directory you want to download the CLI to:

   cd <path_to_directory>
   

2. 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 .
   

3. Add the path to the directory containing the executable to PATH:

   [System.Environment]::SetEnvironmentVariable("PATH", "$env:PATH;$PWD", "User")
   

4. Restart PowerShell.