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

Update README.md

Browse source
This commit is contained in:
TheAwiteb 2023-12-29 08:47:29 +03:00
parent 5df67e772c
commit 0f78b13cb8
No known key found for this signature in database
GPG key ID: ABF818BD15DC2D34
1 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -6,7 +6,7 @@ Lprs is a local password manager designed to securely store and manage your pass
To install Lprs, you will need to have the Cargo package manager installed. If you do not have Cargo installed, you can install it by following the instructions [here](https://doc.rust-lang.org/cargo/getting-started/installation.html). Note the Minimum Supported Rust Version (MSRV) for Lprs is `1.70.0`. To install Lprs, you will need to have the Cargo package manager installed. If you do not have Cargo installed, you can install it by following the instructions [here](https://doc.rust-lang.org/cargo/getting-started/installation.html). Note the Minimum Supported Rust Version (MSRV) for Lprs is `1.70.0`.
1. Clone the Lprs repository: 1. Install using [cargo-install](https://doc.rust-lang.org/cargo/commands/cargo-install.html):
```bash ```bash
cargo install --locked --git https://github.com/theawiteb/lprs.git cargo install --locked --git https://github.com/theawiteb/lprs.git
``` ```
@ -31,13 +31,14 @@ Local CLI password manager
Usage: lprs [OPTIONS] <COMMAND> Usage: lprs [OPTIONS] <COMMAND>
Commands: Commands:
add Add new password add Add new password
remove Remove password remove Remove password
list List your password and search list List your password and search
clean Clean the password file clean Clean the password file
edit Edit the password content edit Edit the password content
gen Generate password gen Generate password
help Print this message or the help of the given subcommand(s) export Export the passwords
help Print this message or the help of the given subcommand(s)
Options: Options:
-p, --passwords-file <PASSWORDS_FILE> -p, --passwords-file <PASSWORDS_FILE>
@ -66,10 +67,16 @@ 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 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.
#### Formats
The format of the exported file can be specified using the `--format` option. The following formats are supported:
- `lprs`: The default format used by Lprs. This format is encrypted and can be imported back into Lprs using the `import` command. This is the recommended format to use for backups as it is encrypted and can be imported back into Lprs.
- `bit-warden`: The format used by [Bitwarden](https://bitwarden.com/). This format is not encrypted and can be imported into Bitwarden. This format is useful if you want to switch to Bitwarden or another password manager that supports this format.
## Contributing ## Contributing