Awiteb
3cec690a4b
Reviewed-on: #16 Co-authored-by: Awiteb <a@4rs.nl> Co-committed-by: Awiteb <a@4rs.nl> |
||
---|---|---|
.forgejo | ||
.github/workflows | ||
src | ||
.gitignore | ||
Cargo.lock | ||
Cargo.toml | ||
CHANGELOG.md | ||
cliff.toml | ||
CONTRIBUTING.md | ||
Justfile | ||
LICENSE | ||
README.md | ||
sumi.toml |
Lprs
Lprs is a local vault manager designed to securely store and manage your vaults.
MSRV
The Minimum Supported Rust Version (MSRV) is 1.70.0
.
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.
- Install using cargo-install:
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:
cargo install lprs --locked --no-default-features
- Run Lprs:
lprs --help
Uninstallation
cargo uninstall lprs
Usage
Lprs provides a command-line interface for managing your vaults. The following commands are available:
A local CLI password manager
Usage: lprs [OPTIONS] <COMMAND>
Commands:
add Add new vault
remove Remove vault
list List your vaults and search
clean Clean the vaults file
edit Edit the vault content
gen Generate a password
export Export the vaults
import Import vaults
help Print this message or the help of the given subcommand(s)
Options:
-v, --vaults-file <VAULTS_FILE> The vaults json file
-h, --help Print help
-V, --version Print version
Example
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 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
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 theimport
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. 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
Contributions to Lprs are welcome! If you would like to contribute, please follow the guidelines outlined in the [CONTRIBUTING] (CONTRIBUTING.md) file.
Mirrors
This repository is mirrored on the following platforms:
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 file for more details.