Skip to content

Commit

Permalink
docs: update plugins install command documentation
Browse files Browse the repository at this point in the history
Since the plugins install subcommand can install both remotely and
locally sourced plugins, we update the documentation for it on the
web-docs to reflect this change.
  • Loading branch information
lbajolet-hashicorp committed May 14, 2024
1 parent c7f2508 commit d8a95a7
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions website/content/docs/commands/plugins/install.mdx
Original file line number Diff line number Diff line change
@@ -1,22 +1,36 @@
---
description: |
The "plugins install" command can install a plugin at a version constraint.
The "plugins install" command installs a Packer plugin.
page_title: plugins Command
---

# `plugins install`

The `plugins install` subcommand installs a Packer plugin at a version constraint
The `plugins install` subcommand installs a Packer plugin.

The requested plugin will be remotely installed by default at its latest version, unless a version
constraint is specified.
The command also supports installing plugins from a locally-sourced binary, along with its
expected source location.

```shell-session
$ packer plugins install -h
Usage: packer plugins install <plugin> [<version constraint>]
Usage: packer plugins install [OPTIONS...] <plugin> [<version constraint>]
This command will install the most recent compatible Packer plugin matching
version constraint. When the version constraint is omitted, the most recent
version will be installed.
Ex: packer plugins install github.com/hashicorp/happycloud v1.2.3
packer plugins install --path ./packer-plugin-happycloud "github.com/hashicorp/happycloud"
Options:
-path <path> Install the plugin from a locally-sourced plugin binary.
This installs the plugin where a normal invocation would, but will
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 reinstallation of plugins, even if already installed.
```

## Related
Expand Down

0 comments on commit d8a95a7

Please sign in to comment.