lprs/docs/commands
Awiteb d68ab92a6a
All checks were successful
Rust CI / Rust CI (pull_request) Successful in 1m53s
chore: Add change-master-password command doc
2024-05-17 00:25:19 +03:00
..
add.md feat: Initialize Lprs book 2024-05-16 23:43:17 +03:00
auto-completion.md feat: Initialize Lprs book 2024-05-16 23:43:17 +03:00
change-master-password.md chore: Add change-master-password command doc 2024-05-17 00:25:19 +03:00
clean.md feat: Initialize Lprs book 2024-05-16 23:43:17 +03:00
edit.md feat: Initialize Lprs book 2024-05-16 23:43:17 +03:00
gen.md feat: Initialize Lprs book 2024-05-16 23:43:17 +03:00
get.md feat: Initialize Lprs book 2024-05-16 23:43:17 +03:00
import-export.md feat: Initialize Lprs book 2024-05-16 23:43:17 +03:00
list.md feat: Initialize Lprs book 2024-05-16 23:43:17 +03:00
README.md feat: Initialize Lprs book 2024-05-16 23:43:17 +03:00
remove.md feat: Initialize Lprs book 2024-05-16 23:43:17 +03:00

Command line usage

This section provides a reference for the various commands and options that are available in the lprs command line tool, and how to use them.

But before we dive into the commands, let's take a look at the lprs main options, which are available for all commands.

Options:
  -f, --vaults-file <VAULTS_FILE>          The vaults json file
  -v, --verbose                            Show the logs in the stdout
  -m, --master-password <MASTER_PASSWORD>  The master password, or you will prompt it
  -h, --help                               Print help
  -V, --version                            Print version

As you can see, the lprs command line tool has a few options that are available for all commands, which are:

  • -f, --vaults-file <VAULTS_FILE>: The vaults json file, this is the file where the vaults are stored. By default, the vaults are stored in the program's directory, in a directory called lprs and the file called vaults.lprs.
  • -v, --verbose: Show the logs in the stdout, this option is useful for debugging purposes.
  • -m, --master-password <MASTER_PASSWORD>: The master password, this is the password that is used to encrypt and decrypt the vaults, usful for scripting purposes, otherwise you will be prompted for the master password (which is better for security reasons)

Now let's take a look at the available commands and how to use them.

Donations

You can support the development of my projects by donating me, check out my profile at git.4rs.nl