lprs/docs/commands/list.md
Awiteb 4133b0fe1e
All checks were successful
Rust CI / Rust CI (pull_request) Successful in 1m56s
docs: Update the docs
- Remove the version option
- Update it with the changes of this commit 4028607cb5
(current patch)

Signed-off-by: Awiteb <a@4rs.nl>
2024-08-17 18:20:04 +03:00

24 lines
797 B
Markdown

# Listing all vaults
## Usage
```
Usage: lprs list [OPTIONS]
Options:
-f, --filter <TEXT> Filter the select list
-r, --regex Enable regex when use `--filter` option
--json Returns the output as `json` list of vaults
-h, --help Print help
```
Lprs `list` command is used to list all vaults in the vaults file, you can also
filter the list by using the `--filter` option, and you can enable regex by
using the `--regex` flag. Also you can get the output as `json` by using the
`--json` flag (this is useful when you want to use the output in a script and
work with it with `jq`).
### Examples
<script src="https://asciinema.org/a/eEVkDi0NroBjKNILg7KW3hSKY.js" id="asciicast-eEVkDi0NroBjKNILg7KW3hSKY" async="true" data-cols=48 data-rows=10></script>