Skip to content

Commit

Permalink
docs: add exerpt on packer plugins install --path
Browse files Browse the repository at this point in the history
  • Loading branch information
lbajolet-hashicorp committed Dec 4, 2023
1 parent 47e35bd commit af2a439
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
2 changes: 1 addition & 1 deletion command/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Options:
version, if there is a new higher one. Note that
this still takes into consideration the version
constraint of the config.
-force Forces installation of plugins, even if already
-force Forces reinstallation of plugins, even if already
installed.
`

Expand Down
2 changes: 1 addition & 1 deletion command/plugins_install.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Options:
not try to download it from a remote location, and instead
install the binary in the Packer plugins path.
This option cannot be specified with a version constraint.
- force: forces installation of a plugin, even if it is already there.
- force: forces reinstallation of plugins, even if already installed.
`

return strings.TrimSpace(helpText)
Expand Down
10 changes: 10 additions & 0 deletions website/content/docs/plugins/install-plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -227,5 +227,15 @@ If you have a `required_plugins` for the plugin you're manually installing, make
it respects the constraints described in the [Plugin loading workflow](#plugin-loading-workflow)
section, otherwise Packer will not be able to load it.

Starting with v1.10.0 of Packer, you can also use `packer plugins install` with the
`--path` flag to install a plugin from a binary, following the layout that is required to
work with `required_plugins` block.

```shell
packer plugins install --path <path-to-plugin-binary> github.com/hashicorp/vagrant
```

-> packer plugins install --path only works with release versions of plugins.

</Tab>
</Tabs>

0 comments on commit af2a439

Please sign in to comment.