lprs/README.md

82 lines
2.7 KiB
Markdown
Raw Normal View History

2023-12-23 21:28:14 +01:00
# Passrs
Passrs is a local password manager designed to securely store and manage your passwords.
## Installation
To install Passrs, 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 Passrs is `1.70.0`.
1. Clone the Passrs repository:
```bash
cargo install --locked --git https://github.com/theawiteb/passrs.git
```
2. Run Passrs:
```bash
passrs --help
```
## Uninstallation
```bash
cargo uninstall passrs
```
## Usage
Passrs provides a command-line interface for managing your passwords. The following commands are available:
```
Local CLI password manager
Usage: passrs [OPTIONS] <COMMAND>
Commands:
add Add new password
2023-12-25 02:41:25 +01:00
remove Remove password
2023-12-23 21:28:14 +01:00
list List your password and search
clean Clean the password file
edit Edit the password content
2023-12-24 18:28:03 +01:00
gen Generate password
2023-12-23 21:28:14 +01:00
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/passrs/passwords.json
-h, --help
Print help
-V, --version
Print version
```
2023-12-24 18:28:03 +01:00
### Example
```bash
passrs add -n "Gmail" -u "some@gmail.com" -p $(passrs gen 19 -u -l -s) -s "https://mail.google.com"
```
#### Result
This is the result when search for it
```
$ passrs 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 |
+-------+-------+----------------+---------------------+-------------------------+
```
2023-12-23 21:28:14 +01:00
<!--
### Backup
It is important to regularly backup your passwords to prevent data loss. Passrs does not provide an automatic backup feature. To backup your passwords, you can use the export command provided by Passrs. 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 Passrs are welcome! If you would like to contribute, please follow the guidelines outlined in the [CONTRIBUTING](CONTRIBUTING.md) file.
## License
Passrs 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.