diff --git a/website/source/docs/commands/help.html.md b/website/source/docs/commands/help.html.md index c21be6dfc0..48f596b463 100644 --- a/website/source/docs/commands/help.html.md +++ b/website/source/docs/commands/help.html.md @@ -1,7 +1,7 @@ --- layout: "docs" -page_title: "Help" -sidebar_current: "docs-commands-help" +page_title: "Path Help" +sidebar_current: "docs-commands-path-help" description: |- The Vault CLI has a built-in help system that can be used to get help for not only the CLI itself, but also any paths that the CLI can be used with within Vault. --- @@ -9,7 +9,7 @@ description: |- # Help In addition to standard CLI help using the `-h` or `-help` flag for -commands, Vault has a built-in `help` command that can be used to get +commands, Vault has a built-in `path-help` command that can be used to get help for specific paths within Vault. These paths are used with the API or `read, write, delete` commands in order to interact with Vault. @@ -20,29 +20,29 @@ in Vault, and also allows you to discover new paths. use of Vault. As a beginner or experienced user of Vault, you'll be using the help command a lot to remember how to use different components of Vault. Note that the Vault Server must be running and the client configured -properly to execute this command to look up paths. +properly to execute this command to look up paths. ## Discovering Paths -Before using `help`, it is important to understand "paths" within Vault. +Before using `path-help`, it is important to understand "paths" within Vault. Paths are the parameters used for `vault read`, `vault write`, etc. An example path is `secret/foo`, or `aws/config/root`. The paths available depend on the mounted secret backends. Because of this, the interactive help is an indispensable tool to finding what paths are supported. -To discover what paths are supported, use `vault help `. +To discover what paths are supported, use `vault path-help `. For example, if you mounted the AWS secret backend, you can use -`vault help aws` to find the paths supported by that backend. The paths +`vault path-help aws` to find the paths supported by that backend. The paths will be shown with regular expressions, which can make them hard to parse, but they're also extremely exact. -You can try it right away with any Vault with `vault help secret`, since +You can try it right away with any Vault with `vault path-help secret`, since `secret` is always mounted initially. The output from this command is shown below and contains both a description of what that backend is for, along with the paths it supports. ``` -$ vault help secret +$ vault path-help secret ## DESCRIPTION The generic backend reads and writes arbitrary secrets to the backend. @@ -69,11 +69,11 @@ you may or may not be able to access certain paths. ## Single Path Once you've found a path you like, you can learn more about it by -using `vault help ` where "path" is a path that matches one of the +using `vault path-help ` where "path" is a path that matches one of the regular expressions from the backend help. Or, if you saw an example online with `vault write` or some similar -command, you can plug that directly into `vault help` to learn about it +command, you can plug that directly into `vault path-help` to learn about it (assuming you have the proper backends mounted!). For example, below we get the help for a single secret in the `secret/` @@ -81,7 +81,7 @@ mount point. The help shows the operations that that path supports, the parameters it takes (for write), and a description of that specific path. ``` -$ vault help secret/password +$ vault path-help secret/password Request: password Matching Route: ^.*$ diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index b87373f6ba..a1236cd4f7 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -79,8 +79,8 @@ > Commands (CLI)