Packer
init command reference
The packer init command initializes Packer according to an HCL template configuration. Refer to Installing Plugins for additional information about installing plugins.
Description
Use the packer init command to download and install plugins according to the required_plugins block in Packer templates written in HCL. Refer to Specifying plugin requirements in the template configuration reference for additional information about configuring the required_plugins block.
Legacy JSON templates are not supported. You can convert your JSON template files to HCL using the hcl2_upgrade command.
We recommend running the packer init command as the first step when working with a new or existing template. You can run the command multiple times. Subsequent runs may produce errors, but the command never deletes already-installed plugins.
Third-party plugin verification
We recommend that you vet and verify any third-party plugins you want to install.
Installation location
By default, Packer installs plugins into the plugins directory at $HOME/.config/packer/plugins on Unix and %APPDATA%\packer.d\plugins on Windows, but you can specify a different directory using the PACKER_PLUGIN_PATH environment variable. Refer to the Packer configuration reference for additional information.
Usage
Use the following syntax to run the packer init command:
$ packer init <path-to-template>
The command will process any template file that ends with pkr.hcl.
The template must contain all dependencies when running the command on a single template file. The command fails if the template is intended to be built as a bundle of partials.
For variable definitions, it is recommended to use the extensions .pkrvars.hcl or .auto.pkrvars.hcl. When you run packer init in the directory, these variable definition files will be automatically excluded from processing.
Examples
The following example installs the plugins specified in a template from the current directory:
$ packer init .
The following example installs the plugins specified in a template named template.pkr.hcl from the current directory:
$ packer init template.pkr.hcl
The following example installs the plugins specified in the builds/foo/ directory:
$ packer init builds/foo/.
The following example installs the plugins specified in a template from the builds/foo/template.pkr.hcl path:
$ packer init builds/foo/template.pkr.hcl
Arguments
You can pass the following arguments:
- Packer template: Specify the path to either an HCL2 template or a directory containing at least one valid HCL2 template and related dependencies.