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

chore: Update README.md
Some checks failed
Check PR title / check_pr_title (pull_request) Failing after 11s
Details
Rust CI / Rust CI (pull_request) Successful in 3m51s
Details

Browse source
This commit is contained in:
Awiteb 2024-03-19 10:12:55 +03:00
parent 078b047e04
commit f4bf05ea71
Signed by: awiteb
GPG key ID: 3F6B55640AA6682F
1 changed files with 15 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -1,6 +1,6 @@
# Lprs # Lprs
Lprs is a local password manager designed to securely store and manage your passwords. Lprs is a local vault manager designed to securely store and manage your vaults.
### MSRV ### MSRV
The Minimum Supported Rust Version (MSRV) is `1.70.0`. The Minimum Supported Rust Version (MSRV) is `1.70.0`.
@ -31,7 +31,7 @@ cargo uninstall lprs
## Usage ## Usage
Lprs provides a command-line interface for managing your passwords. The following commands are available: Lprs provides a command-line interface for managing your vaults. The following commands are available:
``` ```
A local CLI password manager A local CLI password manager
@ -39,23 +39,20 @@ A local CLI password manager
Usage: lprs [OPTIONS] <COMMAND> Usage: lprs [OPTIONS] <COMMAND>
Commands: Commands:
add Add new password add Add new vault
remove Remove password remove Remove vault
list List your password and search list List your vaults and search
clean Clean the password file clean Clean the vaults file
edit Edit the password content edit Edit the vault content
gen Generate password gen Generate a password
export Export the passwords export Export the vaults
import Import passwords import Import vaults
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
Options: Options:
-p, --passwords-file <PASSWORDS_FILE> -v, --vaults-file <VAULTS_FILE> The vaults json file
The passwords json file, default: $HOME/.local/share/lprs/passwords.json -h, --help Print help
-h, --help -V, --version Print version
Print help
-V, --version
Print version
``` ```
### Example ### Example
@ -78,7 +75,7 @@ Master Password: ***************
### Backup ### Backup
It is important to regularly backup your passwords to prevent data loss. Lprs does not provide an automatic backup feature. To backup your passwords, you can use the `export` command provided by Lprs. This command allows you to export your encrypted passwords to a json file, which you can then manually backup to a secure location. It is important to regularly backup your vaults to prevent data loss. Lprs does not provide an automatic backup feature. To backup your vaults, you can use the `export` command provided by Lprs. This command allows you to export your encrypted vaults to a json file, which you can then manually backup to a secure location.
#### Formats #### Formats
The format of the exported file can be specified using the `--format` option. The following formats are supported: The format of the exported file can be specified using the `--format` option. The following formats are supported:
@ -104,4 +101,4 @@ Lprs is licensed under the GPL-3.0 License. This means that you are free to use,
--- ---
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/awiteb) [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/awiteb)