Основные возможности CLI

Интерфейс командной строки OpenTofu — это команда tofu, которая принимает различные подкоманды, например tofu init или tofu plan.

Чтобы просмотреть список команд, доступных в вашей текущей версии OpenTofu, запустите tofu без дополнительных аргументов:

Usage: tofu [global options] <subcommand> [args]

The available commands for execution are listed below.
The primary workflow commands are given first, followed by
less common or more advanced commands.

Main commands:
  init          Prepare your working directory for other commands
  validate      Check whether the configuration is valid
  plan          Show changes required by the current configuration
  apply         Create or update infrastructure
  destroy       Destroy previously-created infrastructure

All other commands:
  console       Try OpenTofu expressions at an interactive command prompt
  fmt           Reformat your configuration in the standard style
  force-unlock  Release a stuck lock on the current workspace
  get           Install or upgrade remote OpenTofu modules
  graph         Generate a Graphviz graph of the steps in an operation
  import        Associate existing infrastructure with a OpenTofu resource
  login         Obtain and save credentials for a remote host
  logout        Remove locally-stored credentials for a remote host
  metadata      Metadata related commands
  output        Show output values from your root module
  providers     Show the providers required for this configuration
  refresh       Update the state to match remote systems
  show          Show the current state or a saved plan
  state         Advanced state management
  taint         Mark a resource instance as not fully functional
  untaint       Remove the 'tainted' state from a resource instance
  version       Show the current OpenTofu version
  workspace     Workspace management

Global options (use these before the subcommand, if any):
  -chdir=DIR    Switch to a different working directory before executing the
                given subcommand.
  -help         Show this help output, or the help for a specified subcommand.
  -version      An alias for the "version" subcommand.

(Вывод вашей текущей версии OpenTofu может отличаться от приведённого выше примера.)

Чтобы получить справку по конкретной команде, используйте параметр -help с соответствующей подкомандой. Например, чтобы просмотреть справку по подкоманде "validate", можно запустить tofu validate -help.

Встроенная справка CLI OpenTofu описывает наиболее важные характеристики каждой команды. Более подробную информацию см. на странице соответствующей команды.

Смена рабочего каталога с помощью -chdir​

Обычно OpenTofu запускают, предварительно перейдя в каталог, содержащий файлы .tf или .tofu корневого модуля (например, с помощью команды cd), чтобы OpenTofu автоматически находил эти файлы без дополнительных аргументов.

Однако в некоторых случаях — особенно при использовании OpenTofu в сценариях автоматизации — может быть удобно запускать OpenTofu из каталога, отличного от каталога корневого модуля. Для этого OpenTofu поддерживает глобальный параметр -chdir=..., который можно указать перед именем запускаемой подкоманды:

tofu -chdir=environments/production apply

Параметр chdir указывает OpenTofu сменить рабочий каталог на заданный перед запуском указанной подкоманды. Это означает, что все файлы, которые OpenTofu обычно читает или записывает в текущем рабочем каталоге, будут читаться или записываться в указанном каталоге.

Есть два исключения: в следующих случаях OpenTofu будет использовать исходный рабочий каталог, даже если вы укажете -chdir=...:

• Настройки в конфигурации CLI не относятся к конкретной подкоманде, и OpenTofu обрабатывает их до применения параметра -chdir.

• Если вам нужно использовать файлы из исходного рабочего каталога в конфигурации, ссылка на path.cwd в конфигурации укажет на исходный рабочий каталог, а не на переопределённый. Используйте path.root, чтобы получить каталог корневого модуля.

Автодополнение команд в оболочке​

Если в качестве командной оболочки вы используете bash или zsh, OpenTofu может обеспечить автодополнение имён всех команд и некоторых аргументов команд.

Чтобы добавить необходимые команды в профиль оболочки, выполните следующую команду:

tofu -install-autocomplete

После установки необходимо перезапустить оболочку или перечитать её сценарий профиля, чтобы автодополнение заработало.

Чтобы удалить подключение автодополнения (если оно не было изменено вручную в профиле оболочки), выполните следующую команду:

tofu -uninstall-autocomplete