docs: Update the docs
All checks were successful
Rust CI / Rust CI (pull_request) Successful in 1m56s
All checks were successful
Rust CI / Rust CI (pull_request) Successful in 1m56s
- Remove the version option
- Update it with the changes of this commit 4028607cb5
(current patch)
Signed-off-by: Awiteb <a@4rs.nl>
This commit is contained in:
parent
4028607cb5
commit
4133b0fe1e
8 changed files with 14 additions and 26 deletions
|
@ -35,9 +35,11 @@ Options:
|
|||
-t, --totp-secret [<TOTP_SECRET>]
|
||||
The TOTP secret, if there is no value you will prompt it
|
||||
|
||||
-c, --custom <KEY=VALUE>
|
||||
-c, --custom <KEY(=VALUE)?>
|
||||
Add a custom field to the vault
|
||||
|
||||
If there is no value, you will enter it through a prompt
|
||||
|
||||
-f, --force
|
||||
Force add, will not return error if there is a problem with the args.
|
||||
|
||||
|
@ -45,9 +47,6 @@ Options:
|
|||
|
||||
-h, --help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
-V, --version
|
||||
Print version
|
||||
```
|
||||
|
||||
So, to add a vault you need to provide a name for the vault, and you can provide
|
||||
|
|
|
@ -4,10 +4,6 @@
|
|||
|
||||
```
|
||||
Usage: lprs clean
|
||||
|
||||
Options:
|
||||
-h, --help Print help
|
||||
-V, --version Print version
|
||||
```
|
||||
|
||||
Is simple, just run `lprs clean` and the vaults file will be cleaned, removing
|
||||
|
|
|
@ -14,24 +14,28 @@ Options:
|
|||
The new vault name
|
||||
|
||||
-u, --username <USERNAME>
|
||||
The new vault username
|
||||
The new vault username, make it empty string to delete it
|
||||
|
||||
-p, --password [<PASSWORD>]
|
||||
The new password, if there is no value for it you will prompt it
|
||||
The new password, make it empty string to delete it
|
||||
|
||||
If there is no value for it you will prompt it
|
||||
|
||||
-s, --service <SERVICE>
|
||||
The new vault service
|
||||
The new vault service, make it empty string to delete it
|
||||
|
||||
-o, --note <NOTE>
|
||||
The new vault note
|
||||
|
||||
-t, --totp-secret [<TOTP_SECRET>]
|
||||
The TOTP secret, if there is no value you will prompt it
|
||||
The TOTP secret, make it empty string to delete it
|
||||
|
||||
If there is no value you will prompt it
|
||||
|
||||
-c, --custom <KEY=VALUE>
|
||||
The custom field, make its value empty to delete it
|
||||
The custom field, make it empty string to delete it
|
||||
|
||||
If the custom field not exist will created it, if it's will update it
|
||||
If the custom field not exist will created it, if it's will update it, if there is no value, you will enter it through a prompt (e.g `-c key`)
|
||||
|
||||
-f, --force
|
||||
Force edit, will not return error if there is a problem with the args.
|
||||
|
@ -40,9 +44,6 @@ Options:
|
|||
|
||||
-h, --help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
-V, --version
|
||||
Print version
|
||||
```
|
||||
|
||||
To edit a vault you need to provide the index or the name of the vault. If you
|
||||
|
|
|
@ -14,7 +14,6 @@ Options:
|
|||
-n, --numbers With numbers (0-9)
|
||||
-s, --symbols With symbols (!,# ...)
|
||||
-h, --help Print help
|
||||
-V, --version Print version
|
||||
```
|
||||
|
||||
Generate a password with the specified length, by default the length is `18`,
|
||||
|
|
|
@ -19,9 +19,6 @@ Arguments:
|
|||
Options:
|
||||
-h, --help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
-V, --version
|
||||
Print version
|
||||
```
|
||||
|
||||
Get a single field from a vault, if the field is not provided, the whole vault
|
||||
|
|
|
@ -24,9 +24,6 @@ Options:
|
|||
|
||||
-h, --help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
-V, --version
|
||||
Print version
|
||||
```
|
||||
|
||||
## Export usage
|
||||
|
|
|
@ -10,7 +10,6 @@ Options:
|
|||
-r, --regex Enable regex when use `--filter` option
|
||||
--json Returns the output as `json` list of vaults
|
||||
-h, --help Print help
|
||||
-V, --version Print version
|
||||
```
|
||||
|
||||
Lprs `list` command is used to list all vaults in the vaults file, you can also
|
||||
|
@ -21,4 +20,5 @@ 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>
|
||||
|
|
|
@ -11,7 +11,6 @@ Arguments:
|
|||
Options:
|
||||
-f, --force Force remove, will not return error if there is no vault with the given index or name
|
||||
-h, --help Print help
|
||||
-V, --version Print version
|
||||
```
|
||||
|
||||
To remove a vault you need to provide the index or the name of the vault. If you
|
||||
|
|
Loading…
Reference in a new issue