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 01:11:20 -05:00
parent fd4a010dbf
commit e1fece9ef7
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -15,16 +15,16 @@ A fast, secure, and lightweight password manager CLI built entirely in Rust. No
2. Extract the folder 2. Extract the folder
3. Run the installer (this also works when updating to a newer downloaded version): 3. Run the installer (this also works when updating to a newer downloaded version):
- **Linux/Mac:** Open a terminal in the extracted folder and run: '''chmod +x linux-mac-install.sh && ./linux-mac-install.sh''' - **Linux/Mac:** Open a terminal in the extracted folder and run: `chmod +x linux-mac-install.sh && ./linux-mac-install.sh`
- **Windows:** Right-click windows-install.ps1 and select '''Run with PowerShell''' - **Windows:** Right-click windows-install.ps1 and select `Run with PowerShell`
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.
**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:
- **Linux/Mac:** Open a terminal in the extracted folder and run: '''chmod +x linux-mac-uninstall.sh && ./linux-mac-uninstall.sh''' - **Linux/Mac:** Open a terminal in the extracted folder and run: `chmod +x linux-mac-uninstall.sh && ./linux-mac-uninstall.sh`
- **Windows:** Right-click windows-uninstall.ps1 and select '''Run with PowerShell''' - **Windows:** Right-click windows-uninstall.ps1 and select `Run with PowerShell`
> [!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**
@ -35,17 +35,17 @@ The first time you run any command you'll be prompted to set a master password.
Enter any of the following commands into a terminal of your choice. Enter any of the following commands into a terminal of your choice.
- **Add a password:** '''pm add github'' (Or any name you want instead of github) after this you will be prompted to enter and confirm a password. - **Add a password:** `pm add github` (Or any name you want instead of github) after this you will be prompted to enter and confirm a password.
- **Get a password:** '''pm get github''' (Or any name you want instead of github) this will print the name and password to the terminal, just a reminder Ctrl+Alt+C is how you copy from the terminal. - **Get a password:** `pm get github` (Or any name you want instead of github) this will print the name and password to the terminal, just a reminder Ctrl+Alt+C is how you copy from the terminal.
- **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:
- **Linux/Mac:** '''~/.my_pass_manager''' - **Linux/Mac:** `~/.my_pass_manager`
- **Windows:** '''%USERPROFILE%\.my_pass_manager\''' - **Windows:** `%USERPROFILE%\.my_pass_manager\`
This tool uses Argon2id to derive your encryption key from your master password making brute-force attacks computationally expensive. So even if someone stole your passwords.enc file from your computer, they would not be able to read it without your master password. So if someone happens to steal your passwords.enc file from your computer you have bigger problems than them figuring out your passwords. This tool uses Argon2id to derive your encryption key from your master password making brute-force attacks computationally expensive. So even if someone stole your passwords.enc file from your computer, they would not be able to read it without your master password. So if someone happens to steal your passwords.enc file from your computer you have bigger problems than them figuring out your passwords.
**Future Plans** **Future Plans**