81 lines
2.6 KiB
Markdown
81 lines
2.6 KiB
Markdown
# Lprs
|
|
|
|
Lprs is a local password manager designed to securely store and manage your passwords.
|
|
|
|
## Installation
|
|
|
|
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:
|
|
```bash
|
|
cargo install --locked --git https://github.com/theawiteb/lprs.git
|
|
```
|
|
|
|
2. Run Lprs:
|
|
```bash
|
|
lprs --help
|
|
```
|
|
|
|
## Uninstallation
|
|
```bash
|
|
cargo uninstall lprs
|
|
```
|
|
|
|
## Usage
|
|
|
|
Lprs provides a command-line interface for managing your passwords. The following commands are available:
|
|
|
|
```
|
|
Local CLI password manager
|
|
|
|
Usage: lprs [OPTIONS] <COMMAND>
|
|
|
|
Commands:
|
|
add Add new password
|
|
remove Remove password
|
|
list List your password and search
|
|
clean Clean the password file
|
|
edit Edit the password content
|
|
gen Generate password
|
|
help Print this message or the help of the given subcommand(s)
|
|
|
|
Options:
|
|
-p, --passwords-file <PASSWORDS_FILE>
|
|
The passwords json file, default: $HOME/.local/share/lprs/passwords.json
|
|
-h, --help
|
|
Print help
|
|
-V, --version
|
|
Print version
|
|
```
|
|
|
|
### Example
|
|
```bash
|
|
lprs add -n "Gmail" -u "some@gmail.com" -p $(lprs gen 19 -u -l -s) -s "https://mail.google.com"
|
|
```
|
|
|
|
#### Result
|
|
This is the result when search for it
|
|
```
|
|
$ lprs list -e "mail" -p -s
|
|
Master Password: ***************
|
|
+-------+-------+----------------+---------------------+-------------------------+
|
|
| Index | Name | Username | Password | Service |
|
|
+================================================================================+
|
|
| 31 | Gmail | some@gmail.com | >NC`q$%+Nno<y&<y]VB | https://mail.google.com |
|
|
+-------+-------+----------------+---------------------+-------------------------+
|
|
```
|
|
|
|
|
|
<!--
|
|
### 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. -->
|
|
|
|
|
|
## Contributing
|
|
|
|
Contributions to Lprs are welcome! If you would like to contribute, please follow the guidelines outlined in the [CONTRIBUTING](CONTRIBUTING.md) file.
|
|
|
|
## License
|
|
|
|
Lprs is licensed under the GPL-3.0 License. This means that you are free to use, modify, and distribute the software under the terms of this license. Please refer to the [LICENSE](LICENSE) file for more details.
|