Начало работы с интерфейсом командной строки

1. Выполните команду:

   curl -sSL https://storage.yandexcloud.net/yandexcloud-yc/install.sh | bash
   

   Скрипт установит CLI и добавит путь до исполняемого файла в переменную окружения PATH.

2. Перезапустите командную оболочку, чтобы перезагрузить переменные окружения.

Для Windows CLI можно установить с помощью PowerShell или командной строки:

• Для установки с помощью PowerShell:

  1. Выполните команду:

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

  2. Скрипт установки спросит, нужно ли добавить путь до yc в переменную PATH:

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

  3. Введите Y. После этого Yandex Cloud CLI можно пользоваться, командную оболочку перезапускать не нужно.

• Для установки с помощью командной строки:

  1. Выполните команду:

     @"%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"
     

  2. Скрипт установки спросит, нужно ли добавить путь до yc в переменную PATH:

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

  3. Введите Y.

  4. Перезапустите командную оболочку, чтобы перезагрузить переменные окружения.

Чтобы включить автодополнение:

1. Откройте ~/.zshrc и добавьте в начало файла следующие строки:

   autoload -Uz compinit
   compinit
   

   Скрипт установки yc добавляет строки инициализации CLI и автодополнения в конец ~/.zshrc. Разместите вызовы autoload и compinit выше этих строк, иначе при запуске терминала появится ошибка command not found: compdef.

   Итоговый ~/.zshrc должен выглядеть так:

   autoload -Uz compinit
   compinit
   
   # Строки ниже добавлены скриптом установки yc автоматически.
   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
   
   Установка расширенных автодополнений

   Пакет zsh-completions расширяет базовые автодополнения системы. Для автодополнения yc он не обязателен.

   Чтобы установить пакет:

   1. Установите Homebrew.

   2. Установите пакет zsh-completions:

      brew install zsh-completions
      

      Совет

      Если вы используете bash, вместо zsh-completions установите пакет bash-completion.

   3. Добавьте блок с FPATH перед строками autoload и compinit. Итоговый ~/.zshrc должен выглядеть так:

      if type brew &>/dev/null; then
        FPATH=$(brew --prefix)/share/zsh-completions:$FPATH
      fi
      autoload -Uz compinit
      compinit
      
      # Строки ниже добавлены скриптом установки yc автоматически.
      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. Перезапустите командную оболочку или выполните команду exec -l $SHELL.

3. Проверьте, что автодополнение работает: введите yc и нажмите Tab дважды. Должен появиться список доступных команд.

winget install Microsoft.PowerShell

Чтобы включить автодополнение в PowerShell:

1. Если у вас нет профиля PowerShell, создайте его и откройте в текстовом редакторе:

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

   Вместо notepad можно использовать любой удобный редактор. Например, для VS Code используйте команду code $PROFILE.

2. Добавьте в файл следующий код и сохраните:

   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]
           )
       }
   }
   

   Примечание

   По умолчанию при нажатии Tab в PowerShell варианты подставляются по очереди. Чтобы вместо этого открывалось меню со всеми вариантами и всплывающими подсказками, добавьте в начало файла следующие строки:

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

   Эти строки меняют поведение Tab во всех командах PowerShell, не только в yc.

3. Перезапустите PowerShell. Проверьте, что автодополнение работает: введите yc и нажмите Tab. Должны появиться варианты доступных команд.

Чтобы аутентифицироваться с помощью SAML-совместимой федерации удостоверений:

1. Узнайте идентификатор федерации у вашего администратора.

2. Запустите интерактивное создание профиля:

   yc init --federation-id=<идентификатор_федерации>
   

3. Выберите профиль, для которого вы хотите настроить аутентификацию, или создайте новый.

   Welcome! This command will take you through the configuration process.
   Pick desired action:
   [1] Re-initialize this profile 'default' with new settings
   [2] Create a new profile
   

4. CLI выведет сообщение о продолжении аутентификации в браузере. Для продолжения нажмите клавишу Enter.

   You are going to be authenticated via federation-id 'aje1f0hsgds3a********'.
   Your federation authentication web site will be opened.
   After your successful authentication, you will be redirected to 'https://console.yandex.cloud'.
   
   Press 'enter' to continue...
   

   После успешной аутентификации в профиле сохранится IAM-токен. При каждой операции аутентификация будет происходить с помощью этого IAM-токена, пока не истечет время его жизни (не более 12 часов). После этого CLI снова выведет сообщение о необходимости пройти аутентификацию в браузере.

   Чтобы продлить срок, в течение которого не нужно аутентифицироваться в браузере, используйте refresh-токены, позволяющие перевыпускать IAM-токены без перехода в браузер. Для этого разрешите использовать refresh-токены на уровне организации и инициализируйте DPoP-защиту в CLI.

5. Вернитесь в интерфейс командной строки, чтобы завершить создание профиля.

6. Выберите одно из предложенных облаков, в которых у вас есть права доступа:

   Please select cloud to use:
    [1] cloud1 (id = aoe2bmdcvata********)
    [2] cloud2 (id = dcvatao4faoe********)
   Please enter your numeric choice: 2
   

   Если вам доступно только одно облако, оно будет выбрано автоматически.

7. Выберите каталог по умолчанию:

   Please choose a folder to use:
    [1] folder1 (id = cvatao4faoe2********)
    [2] folder2 (id = tao4faoe2cva********)
    [3] Create a new folder
   Please enter your numeric choice: 1
   

8. Чтобы выбрать зону доступности по умолчанию для сервиса Compute Cloud, введите Y. Чтобы пропустить настройку, введите n.

   Do you want to configure a default Yandex Compute Cloud availability zone? [Y/n] Y
   

   Если вы ввели Y, выберите зону доступности:

   Which zone do you want to use as a profile default?
    [1] ru-central1-a
    [2] ru-central1-b
    [3] ru-central1-d
    [4] Do not set default zone
   Please enter your numeric choice: 2
   

9. Проверьте настройки вашего профиля CLI:

   yc config list
   

   Результат:

   federation-id: aje1f0hs6oja********
   subject-id: ajea53egl28l********
   cloud-id: b1g159pa15cd********
   folder-id: b1g8o9jbt58********
   compute-default-zone: ru-central1-b
   

Чтобы аутентифицироваться с помощью аккаунта локального пользователя:

1. Запустите интерактивное создание профиля:

   Пул пользователей

   Электронная почта

   1. Узнайте идентификатор пула пользователей у вашего администратора.

   2. Запустите интерактивное создание профиля:

      yc init --userpool-id=<идентификатор_пула_пользователей>
      

   1. Получите адрес электронной почты:

      1. Перейдите в портал Мой аккаунт.
      2. На панели слева выберите Профиль.
      3. В блоке Контакты скопируйте адрес электронной почты.

   2. Запустите интерактивное создание профиля:

      yc init --username=<электронная_почта>
      

2. Выберите профиль, для которого вы хотите настроить аутентификацию, или создайте новый.

   Welcome! This command will take you through the configuration process.
   Pick desired action:
   [1] Re-initialize this profile 'default' with new settings
   [2] Create a new profile
   

3. CLI выведет сообщение о продолжении аутентификации в браузере. Для продолжения нажмите клавишу Enter.

   You are going to be authenticated via userpool-id 'ek0auknfc0mh********'.
   Your userpool authentication web site will be opened.
   After your successful authentication, you will be redirected to cloud console.
   
   Press 'enter' to continue...
   

   После успешной аутентификации в профиле сохранится IAM-токен. При каждой операции аутентификация будет происходить с помощью этого IAM-токена, пока не истечет время его жизни (не более 12 часов). После этого CLI снова выведет сообщение о необходимости пройти аутентификацию в браузере.

   Чтобы продлить срок, в течение которого не нужно аутентифицироваться в браузере, используйте refresh-токены, позволяющие перевыпускать IAM-токены без перехода в браузер. Для этого разрешите использовать refresh-токены на уровне организации и инициализируйте DPoP-защиту в CLI.

4. Вернитесь в интерфейс командной строки, чтобы завершить создание профиля.

5. Выберите одно из предложенных облаков, в которых у вас есть права доступа:

   Please select cloud to use:
    [1] cloud1 (id = aoe2bmdcvata********)
    [2] cloud2 (id = dcvatao4faoe********)
   Please enter your numeric choice: 2
   

   Если вам доступно только одно облако, оно будет выбрано автоматически.

6. Выберите каталог по умолчанию:

   Please choose a folder to use:
    [1] folder1 (id = cvatao4faoe2********)
    [2] folder2 (id = tao4faoe2cva********)
    [3] Create a new folder
   Please enter your numeric choice: 1
   

7. Чтобы выбрать зону доступности по умолчанию для сервиса Compute Cloud, введите Y. Чтобы пропустить настройку, введите n.

   Do you want to configure a default Yandex Compute Cloud availability zone? [Y/n] Y
   

   Если вы ввели Y, выберите зону доступности:

   Which zone do you want to use as a profile default?
    [1] ru-central1-a
    [2] ru-central1-b
    [3] ru-central1-d
    [4] Do not set default zone
   Please enter your numeric choice: 2
   

8. Проверьте настройки вашего профиля CLI:

   yc config list
   

   Результат:

   Пул пользователей

   Электронная почта

   userpool-id: ek0auknfc0mh********
   subject-id: ek00cd1m8hdd8********
   cloud-id: b1g159pa15cd********
   folder-id: b1g8o9jbt58********
   compute-default-zone: ru-central1-b
   

   subject-id: b1g159pa15cd********
   username: <электронная_почта>
   folder-id: b1g8o9jbt58********
   compute-default-zone: ru-central1-b