lprs/README.md

94 lines
3.5 KiB
Markdown
Raw Permalink Normal View History

2023-12-26 18:53:07 +01:00
# Lprs
2023-12-23 21:28:14 +01:00
2023-12-26 18:53:07 +01:00
Lprs is a local password manager designed to securely store and manage your passwords.
2023-12-23 21:28:14 +01:00
## Installation
2023-12-26 18:53:07 +01:00
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`.
2023-12-23 21:28:14 +01:00
2023-12-29 06:47:29 +01:00
1. Install using [cargo-install](https://doc.rust-lang.org/cargo/commands/cargo-install.html):
2024-01-03 13:46:36 +01:00
```bash
cargo install lprs --locked
```
This will enable the update notifications for Lprs. If you don't want to enable update notifications, you can install Lprs using:
```bash
cargo install lprs --locked --no-default-features
```
2023-12-23 21:28:14 +01:00
2023-12-26 18:53:07 +01:00
2. Run Lprs:
2024-01-03 13:46:36 +01:00
```bash
lprs --help
```
2023-12-23 21:28:14 +01:00
## Uninstallation
```bash
2023-12-26 18:53:07 +01:00
cargo uninstall lprs
2023-12-23 21:28:14 +01:00
```
## Usage
2023-12-26 18:53:07 +01:00
Lprs provides a command-line interface for managing your passwords. The following commands are available:
2023-12-23 21:28:14 +01:00
```
2023-12-29 06:53:05 +01:00
A local CLI password manager
2023-12-23 21:28:14 +01:00
2023-12-26 18:53:07 +01:00
Usage: lprs [OPTIONS] <COMMAND>
2023-12-23 21:28:14 +01:00
Commands:
2023-12-29 06:47:29 +01:00
add Add new password
2023-12-25 02:41:25 +01:00
remove Remove password
2023-12-29 06:47:29 +01:00
list List your password and search
clean Clean the password file
edit Edit the password content
gen Generate password
export Export the passwords
2023-12-29 09:38:45 +01:00
import Import passwords
2023-12-29 06:47:29 +01:00
help Print this message or the help of the given subcommand(s)
2023-12-23 21:28:14 +01:00
Options:
-p, --passwords-file <PASSWORDS_FILE>
2023-12-26 18:53:07 +01:00
The passwords json file, default: $HOME/.local/share/lprs/passwords.json
2023-12-23 21:28:14 +01:00
-h, --help
Print help
-V, --version
Print version
```
2023-12-24 18:28:03 +01:00
### Example
```bash
2023-12-26 18:53:07 +01:00
lprs add -n "Gmail" -u "some@gmail.com" -p $(lprs gen 19 -u -l -s) -s "https://mail.google.com"
2023-12-24 18:28:03 +01:00
```
#### Result
This is the result when search for it
```
2023-12-26 18:53:07 +01:00
$ lprs list -e "mail" -p -s
2023-12-24 18:28:03 +01:00
Master Password: ***************
+-------+-------+----------------+---------------------+-------------------------+
| Index | Name | Username | Password | Service |
+================================================================================+
| 31 | Gmail | some@gmail.com | >NC`q$%+Nno<y&<y]VB | https://mail.google.com |
+-------+-------+----------------+---------------------+-------------------------+
```
2023-12-23 21:28:14 +01:00
### Backup
2023-12-29 06:47:29 +01:00
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.
2023-12-23 21:28:14 +01:00
## Contributing
2023-12-26 18:53:07 +01:00
Contributions to Lprs are welcome! If you would like to contribute, please follow the guidelines outlined in the [CONTRIBUTING](CONTRIBUTING.md) file.
2023-12-23 21:28:14 +01:00
## License
2023-12-26 18:53:07 +01:00
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.