mirror of
https://github.com/hashicorp/packer.git
synced 2026-09-22 07:51:39 -04:00
d75975821f
* IPE-727 first commit, adds release notes * content for the 1.11 release notes * updates to init CLI reference * updates to install plugins CLI reference * updates to source information on the packer block configuration reference * updated Packer configuration page * updated plugins installation overview page * updated plugins installation usage page * added Upgrades section * added outline for an upgrade page for this version * added comments for upgrade page outline * renamed install plugins mdx and added redirects * Apply suggestions from code review Co-authored-by: Lucas Bajolet <[email protected]> * fix nav * fix bad links * applying additional feedback * Apply suggestions from code review Co-authored-by: Lucas Bajolet <[email protected]> * integrated rationale into release notes * removed 'upgrade from older version' section in the upgrade instructions * docs: fill-in the upgrade/1.11 document * Apply suggestions from code review Co-authored-by: Wilken Rivera <[email protected]> * edits to upgrade 1.11 and release note * Apply suggestions from code review Co-authored-by: Lucas Bajolet <[email protected]> * Apply suggestions from code review Co-authored-by: Lucas Bajolet <[email protected]> --------- Co-authored-by: Lucas Bajolet <[email protected]> Co-authored-by: Lucas Bajolet <[email protected]> Co-authored-by: Wilken Rivera <[email protected]>
55 lines
2.7 KiB
Plaintext
55 lines
2.7 KiB
Plaintext
---
|
|
description: |
|
|
Reference information about the `packer plugins install` command which downloads and installs Packer plugin binaries without a Packer template
|
|
page_title: packer plugins install command reference
|
|
---
|
|
|
|
# `packer plugins install` command reference
|
|
|
|
The `packer plugins install` command downloads and installs the most recent version of a plugin binary. Refer to [Installing Plugins](/packer/docs/plugins/install) for additional information about installing plugins.
|
|
|
|
## Description
|
|
|
|
Use the `packer plugins install` command to manually install plugins instead of specifying plugins in a template and initializing Packer. Refer to the [`packer init` command documentation](/packer/docs/commands/init) for information about installing plugins specified in a Packer template during initialization.
|
|
|
|
### Third-party plugin verification
|
|
|
|
HashiCorp only verifies plugins from GitHub under the`hashicorp/*` namespace. We recommend that you vet and verify any third-party plugins you want to install.
|
|
|
|
### Installation directory
|
|
|
|
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](/packer/docs/configure) for additional information.
|
|
|
|
## Usage
|
|
|
|
Use the following syntax to run the `packer plugins install` command:
|
|
|
|
## Examples
|
|
|
|
Specify a version number to install a specific version of the plugin. The following example installs the version `1.0.1` of `my-plugin` from a remote source:
|
|
|
|
```shell-session
|
|
$ packer plugins install github.com/hashicorp/my-plugin 1.0.1
|
|
```
|
|
|
|
Use the `--path` option to specify a local plugin binary. The following example installs `my-plugin` from a local binary:
|
|
|
|
```shell-session
|
|
$ packer plugins install --path my-plugin github.com/hashicorp/my-plugin
|
|
```
|
|
|
|
## Arguments
|
|
|
|
You can pass the following arguments:
|
|
|
|
- `<plugin-binary-source>`: A remote source where the plugin binary is available. To remotely download from a source, the plugin must be hosted on GitHub. For locally-sourced binaries, you must also include the `--path` option. Refer to [Installing Plugins](/packer/docs/plugins/install) for additional information about installing plugins.
|
|
- `<plugin version>`: A specific version of the plugin to download and install. Packer accepts semantic version numbers that follow the `<major>.<minor>.<patch>` format. If omitted, the command installs the latest plugin version.
|
|
|
|
## Options
|
|
|
|
You can use the following options:
|
|
|
|
`--path`: Use this option to specify a local plugin binary. You must use this option to install plugins from a local source.
|
|
`--force`: Use this option to force Packer to reinstall the plugin.
|
|
|