open-vault/website/source/docs/commands/plugin/info.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.1 KiB

layout page_title sidebar_current description
docs plugin info - Command docs-commands-plugin-info The "plugin info" command displays information about a plugin in the catalog.

plugin info

The plugin info displays information about a plugin in the catalog.

Examples

Display information about a plugin

$ vault plugin info my-custom-plugin

Key        Value
---        -----
args       []
builtin    false
command    my-custom-plugin
name       my-custom-plugin
sha256     d3f0a8be02f6c074cf38c9c99d4d04c9c6466249

Usage

The following flags are available in addition to the standard set of flags included on all commands.

Output Options

  • -field (string: "") - Print only the field with the given name. Specifying this option will take precedence over other formatting directives. The result will not have a trailing newline making it ideal for piping to other processes.

  • -format (string: "table") - Print the output in the given format. Valid formats are "table", "json", or "yaml". This can also be specified via the VAULT_FORMAT environment variable.