open-vault/website/source/docs/commands/plugin.html.md
Seth Vargo 1259ee6743 Add plugin CLI for interacting with the plugin catalog (#4911)
* Add 'plugin list' command

* Add 'plugin register' command

* Add 'plugin deregister' command

* Use a shared plugin helper

* Add 'plugin read' command

* Rename to plugin info

* Add base plugin for help text

* Fix arg ordering

* Add docs

* Rearrange to alphabetize

* Fix arg ordering in example

* Don't use "sudo" in command description
2018-07-13 10:35:08 -07:00

1.3 KiB

layout page_title sidebar_current description
docs plugin - Command docs-commands-plugin The "plugin" command groups subcommands for interacting with Vault's plugins and the plugin catalog.

plugin

The plugin command groups subcommands for interacting with Vault's plugins and the plugin catalog

Examples

List all available plugins in the catalog:

$ vault plugin list

Plugins
-------
my-custom-plugin
# ...

Register a new plugin to the catalog:

$ vault plugin register \
  -sha256=d3f0a8be02f6c074cf38c9c99d4d04c9c6466249 \
  my-custom-plugin
Success! Registered plugin: my-custom-plugin

Get information about a plugin in the catalog:

$ vault plugin info my-custom-plugin
Key        Value
---        -----
command    my-custom-plugin
name       my-custom-plugin
sha256     d3f0a8be02f6c074cf38c9c99d4d04c9c6466249

Usage

Usage: vault plugin <subcommand> [options] [args]

  # ...

Subcommands:
    deregister    Deregister an existing plugin in the catalog
    list          Lists available plugins
    read          Read information about a plugin in the catalog
    register      Registers a new plugin in the catalog

For more information, examples, and usage about a subcommand, click on the name of the subcommand in the sidebar.