henry/rust-password-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated README

Browse source
This commit is contained in:
ManOfGoldForever 2026-02-01 12:00:12 -05:00
parent 57c4e27b26
commit 42b8c2cdcd
1 changed files with 22 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -1,15 +1,26 @@
**pm 🦀** # pm 🦀
A fast, secure, and lightweight password manager CLI built entirely in Rust. No cloud, no tracking, just local encryption. A fast, secure, and lightweight password manager CLI built entirely in Rust. No cloud, no tracking, just local encryption.
**Why use this?** ## Table of Contents
- [Why use this?](#why-use-this?)
- [Installation](#installation)
- [Build from Source](#build-from-source)
- [Uninstallation](#uninstallation)
- [Usage](#usage)
- [Security and Data](#security-and-data)
- [Future Plans](#future-plans)
- [License](#license)
### Why use this?
- **Privacy First:** Your passwords never leave your machine. - **Privacy First:** Your passwords never leave your machine.
- **Modern Encryption:** Uses XChaCha20-Poly1305 and Argon2id. - **Modern Encryption:** Uses XChaCha20-Poly1305 and Argon2id.
- **Memory Safe:** Sensitive data is wiped from RAM immediately after use. - **Memory Safe:** Sensitive data is wiped from RAM immediately after use.
- **Lightweight:** Tiny binary with an instant startup and no gui bloat. - **Lightweight:** Tiny binary with an instant startup and no gui bloat.
**Installation and Removal** ### Installation
1. Download the latest compressed folder for your OS (.tar.gz for linux/Mac or .zip for Windows) from the [releases](https://github.com/ManOfGoldForever/Rust-Password-Manager/releases/tag/first-release) tab. 1. Download the latest compressed folder for your OS (.tar.gz for linux/Mac or .zip for Windows) from the [releases](https://github.com/ManOfGoldForever/Rust-Password-Manager/releases/tag/first-release) tab.
2. Extract the folder 2. Extract the folder
@ -20,7 +31,7 @@ A fast, secure, and lightweight password manager CLI built entirely in Rust. No
This script moves the pm binary to your "PATH" so you can use it anywhere by typing pm in a terminal. This script moves the pm binary to your "PATH" so you can use it anywhere by typing pm in a terminal.
**Build from Source** ### Build from Source
If you would rather compile the binary yourself rather than using pre-built releases, follow these steps: If you would rather compile the binary yourself rather than using pre-built releases, follow these steps:
@ -45,7 +56,7 @@ After the build finishes your executable will be located at:
- **Linux/Mac:** `target/release/pm` - **Linux/Mac:** `target/release/pm`
- **Windows:** `target/release/pm.exe` - **Windows:** `target/release/pm.exe`
**Uninstallation** ### Uninstallation
If for whatever reason you want to remove this perfect and amazing tool along with permanently deleting your encrypted vault: If for whatever reason you want to remove this perfect and amazing tool along with permanently deleting your encrypted vault:
@ -54,7 +65,7 @@ If for whatever reason you want to remove this perfect and amazing tool along wi
> **WARNING!** This will delete all saved passwords, your master password, and everything else along with the tool! > **WARNING!** This will delete all saved passwords, your master password, and everything else along with the tool!
**Usage** ### Usage
The first time you run any command you'll be prompted to set a master password. The first time you run any command you'll be prompted to set a master password.
@ -67,7 +78,7 @@ Enter any of the following commands into a terminal of your choice.
- **List names of saved passwords:** `pm list` this will list only the names of all passwords you have saved. - **List names of saved passwords:** `pm list` this will list only the names of all passwords you have saved.
- **Delete an entry:** `pm delete github` (Or any name you want instead of github) this will permanently delete the entry with the name you type. - **Delete an entry:** `pm delete github` (Or any name you want instead of github) this will permanently delete the entry with the name you type.
**Security and Data** ### Security and Data
All data lives in a hidden folder in your home directory if you ever need to start from scratch you could delete it: All data lives in a hidden folder in your home directory if you ever need to start from scratch you could delete it:
@ -76,12 +87,12 @@ All data lives in a hidden folder in your home directory if you ever need to sta
This tool uses Argon2id to perform some black magic. So even if someone stole your passwords.enc file from your computer, they would not be able to read it without your master password. Basically, if someone manages to steal your passwords.enc file from your computer you have bigger problems than them figuring out your passwords. This tool uses Argon2id to perform some black magic. So even if someone stole your passwords.enc file from your computer, they would not be able to read it without your master password. Basically, if someone manages to steal your passwords.enc file from your computer you have bigger problems than them figuring out your passwords.
**Future Plans** ### Future Plans
I plan to add more to this eventually like maybe a secure password generator or a TUI or something, but I don't have a list of things to add yet. Maybe after using it some I will come up with some stuff we'll see what happens. I plan to add more to this eventually like maybe a secure password generator or a TUI or something, but I don't have a list of things to add yet. Maybe after using it some I will come up with some stuff we'll see what happens.
**License** ### License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/ManOfGoldForever/Rust-Password-Manager/blob/main/LICENSE) file for details. This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
**Enjoy :)** # Enjoy :)