awiteb/lprs
1
Fork 0
Code Issues 2 Pull requests Releases 3 Activity Actions

docs: Update remove command docs
All checks were successful
Write changelog / write-changelog (push) Successful in 3s
Details
Rust CI / Rust CI (push) Successful in 1m56s
Details

Browse source 
Signed-off-by: Awiteb <a@4rs.nl>
This commit is contained in:
Awiteb 2024-08-20 17:46:12 +00:00
parent 78513b3694
commit f364f5bb4b
Signed by: awiteb
GPG key ID: 3F6B55640AA6682F
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/commands/remove.md
View file

@ -3,17 +3,17 @@
## Usage ## Usage
``` ```
Usage: lprs remove [OPTIONS] <INDEX-or-NAME> Usage: lprs remove [OPTIONS] [INDEX-or-NAME]...
Arguments: Arguments:
<INDEX-or-NAME> The vault to remove, index or name [INDEX-or-NAME]... The vaults to remove, index or name
Options: Options:
-f, --force Force remove, will not return error if there is no vault with the given index or name -f, --force Force remove, will not return error if there is no vault with the given index or name
-h, --help Print help -h, --help Print help
``` ```
To remove a vault you need to provide the index or the name of the vault. If you To remove a vaults you need to provide the index or the name of each vault. If you
provide the index, the vault will be removed by its index, if you provide the provide the index, the vault will be removed by its index, if you provide the
name, the vault will be removed the first vault with the given name. name, the vault will be removed the first vault with the given name.
@ -22,17 +22,17 @@ unless you provide the `--force` option, in which case the command will not
return an error if there is no vault with the given index or name. return an error if there is no vault with the given index or name.
## Examples ## Examples
Remove a vault by its index: Remove a vaults by its index:
```sh ```sh
lprs remove 1 lprs remove 1 10 14
``` ```
Remove a vault by its name: Remove a vault by its name:
```sh ```sh
lprs remove my-vault lprs remove my-vault 'another vault' "third vault"
``` ```
Force remove a vault by its index: Force remove a vault by its index (will not return an error if there is no vault with the given index):
```sh ```sh
lprs remove 234 --force lprs remove 234 --force
``` ```