upstream/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2026-06-10 17:32:29 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

website: help command is now path-help

Browse source
This commit is contained in:
Armon Dadgar 2015-07-13 20:03:29 +10:00
parent 29f2e510c5
commit e6cf9dcb63
2 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
website/source/docs/commands/help.html.md
View file

@ -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 <mount point>`.
To discover what paths are supported, use `vault path-help <mount point>`.
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 <path>` where "path" is a path that matches one of the
using `vault path-help <path>` 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: ^.*$

4
website/source/layouts/docs.erb
View file

@ -79,8 +79,8 @@
<li<%= sidebar_current("docs-commands") %>>
<a href="/docs/commands/index.html">Commands (CLI)</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-help") %>>
<a href="/docs/commands/help.html">Help</a>
<li<%= sidebar_current("docs-commands-path-help") %>>
<a href="/docs/commands/help.html">Path Help</a>
</li>
<li<%= sidebar_current("docs-commands-readwrite") %>>