Keepr 1.0.0.post1

Secure Command-Line Password Manager

Keepr 🗝️

A lightweight, end-to-end encrypted password manager for developers - built for the terminal.

Keepr is a secure, cross-platform command-line password manager designed for software developers.
It stores your credentials in a fully encrypted SQLCipher database that lives entirely on your local machine, ensuring complete control over your data. No servers, no cloud syncing — just strong, local encryption.

The vault is protected by a Master Password derived into a strong encryption key using industry-standard PBKDF2-HMAC (SHA256, 1.2M iterations). Your data remains safe even if the database or key files are compromised.

---

🧠 Why Keepr?

As a developer, you constantly handle sensitive data — API keys, repository tokens, SSH passwords, and configuration secrets. Keepr was built to simplify that workflow by letting you store, search, and retrieve secrets directly from the terminal, without switching tools or exposing plaintext data.

---

⚡ Quick Start

Install Keepr from PyPI:

pip install keepr

keepr login # Set or unlock the master password

keepr add github # Add a credential

keepr view github # Retrieve entry securely

That’s it — your credentials are stored locally, fully encrypted, and accessible only through your master key.

---

🧩 Features at a Glance

• 🔒 End-to-End Encryption — AES-256 via SQLCipher and Fernet.
• 🔑 Master Password — Derives a Key Encryption Key (KEK) with PBKDF2-HMAC.
• 🕒 Timed Sessions — Stay logged in for convenience, auto-lock after expiry.
• 🧭 Vault Management — Add, update, list, search, or delete credentials.
• 🧰 Password Generator — Cryptographically secure, configurable length.
• 🧼 Clipboard Copy — Copy credentials without displaying them in plaintext.
• 🎨 Custom Color Scheme — Clear, high-contrast terminal output.

---

📦 Installation

You can install Keepr either via PyPI (recommended) or as a standalone binary if you can’t install Python.

---

🐍 Option 1: Install from PyPI (Recommended)

Keepr supports macOS, Linux, and Windows.

pip install keepr

Once installed, verify your installation:

keepr --help

💻 Option 2: Download a Prebuilt Binary

If you prefer not to install Python, Keepr provides precompiled binaries built with PyInstaller, which bundle Python and all dependencies.

👉 Download the latest binary for your OS from the GitHub Releases page.

Steps

1. Download the correct archive for your OS.
2. Extract the contents to a permanent folder (e.g. ~/tools/keepr on macOS/Linux, or C:\Tools\Keepr on Windows).
3. Add that folder to your system’s PATH so keepr can be run from anywhere.

macOS & Linux Setup

On macOS and Linux, you'll update your shell's configuration file (usually .zshrc or .bashrc).

1. Move the Directory: Move the extracted keepr folder (containing the executable) to a clean, permanent location, like a new tools directory in your home folder:

   # Example: Move the extracted 'keepr' folder into a 'tools' directory
   mv /path/to/downloaded/keepr ~/tools/
   

2. Edit Shell Configuration: Open the configuration file for your shell (.zshrc for modern macOS, .bashrc for most Linux systems) using a text editor like vim:

   # For modern macOS (Zsh):
   vim ~/.zshrc
   
   # For most Linux systems (Bash):
   vim ~/.bashrc
   

3. Add to PATH: Add the following line to the very end of the file, replacing the path with your chosen directory:

   export PATH="$HOME/tools/keepr:$PATH"
   

4. Apply Changes: Save the file and apply the new configuration by running:

   source ~/.zshrc  # or source ~/.bashrc
   

5. Verify: Open a new terminal window and run keepr --help.

Windows (PowerShell) Setup

On Windows, you need to update your systems environment variables. This can be done through the GUI, but below I've posted instructions for doing this through the command line. Please ensure you're running Powershell in Administrator Mode.

1. Ensure you have moved the extracted keepr folder to a permanent, simple location, for example: C:\Tools\Keepr.

2. Define the Path: Open a new Windows Terminal window running PowerShell. First, set the path to your keepr folder as a variable for easier use.

   # Set the variable to the exact path where the 'keepr' executable is located
   $KeeprPath = "C:\Tools\Keepr"
   

3. Add the Path Permanently: Use the built-in .NET class method to append the new directory to your User-level PATH variable. The third argument "User" ensures the change is permanent.

   [System.Environment]::SetEnvironmentVariable(
   "Path",
   "$env:Path;$KeeprPath",
   "User"
   )
   

4. Exclude the Dir From Windows Defender: Windows defender massively hampers performance of this executable as it scans the directory everytime which can take minutes. To avoid this, please exclude it from defender scans:

   Add-MpPreference -ExclusionPath $KeeprPath
   

5. Verify: Close and reopen any active Command Prompt or PowerShell windows, and then run keepr --help.

---

🧠 Usage Overview

Keepr is designed to feel natural for developers — everything happens directly in your terminal.

Note: You may have to resize your terminal so the outputs from keepr can be displayed without breaking up.

All commands follow the format:

keepr <command> [arguments]

If you ever get lost, use:

keepr --help

🔐 First-Time Setup

Before using keepr, you must create your master password. This password is the only way to unlock your vault — it cannot be recovered if lost. To do this run:

keepr login

Keepr will guide you through the initial setup, generating encryption keys and a secure vault on your local machine. Once logged in, your vault remains unlocked for a timed session of 1 hour to support a smooth workflow.

⚙️ Core Commands

All commands follow the structure: $ keepr <command> [arguments]

Command	Description	Example
login	Logs in and unlocks your vault (creates or renews your session).	$ keepr login
logout	Instantly locks the vault and clears any active session.	$ keepr logout
change-master	Safely change your Master Password.	$ keepr change-master

🔑 Vault Management

You can only run the vault management commands once you've logged in and created an active session.

Command	Description	Example
add	Creates a new entry in the vault, prompting for details.	$ keepr add github
view	Displays a specific entry's details, including the password.	$ keepr view example_site
list	Shows all entries in a clean table (passwords hidden).	$ keepr list
search	Finds entries matching a given keyword.	$ keepr search work
update	Updates the password for an existing entry.	$ keepr update old_site
delete	Permanently deletes an entry after confirmation.	$ keepr delete test_account

🧩 Session Management

Keepr uses a temporary session file to keep your vault unlocked during your work session. Sessions last 1 hour. You can logout manually anytime using keepr logout. After expiration, Keepr requires your Master Password again.

---

🛡️ Security Model

Keepr follows a two-tier encryption model for maximum protection of your secrets.

1. 🔑 Master Key Derivation (KEK)

• Input: Master Password + random Salt
• Algorithm: PBKDF2-HMAC (SHA256, 1,200,000 iterations)
• Output: Key Encryption Key (KEK)
• The KEK is never stored — it’s derived at runtime from your Master Password.

---

2. 🧠 Primary Encryption Key (PEK)

• The PEK is the actual key that encrypts your vault (keepr.db) using SQLCipher.
• It’s stored encrypted on disk (.keepr/.security/keepr.key) — wrapped with your KEK via cryptography.Fernet.

---

3. 🧭 Unlocking Flow

1. You enter your Master Password.
2. Keepr derives the KEK from it.
3. The KEK decrypts your encrypted PEK.
4. The PEK opens your SQLCipher database.
5. A temporary session file keeps the vault open until timeout or logout.

Even if an attacker steals both your vault and key files, your data remains secure — without your Master Password, decryption is computationally infeasible.

---

🏰 Local-Only Security

Keepr is 100% offline — no network requests, telemetry, or remote storage. Everything (database, keys, and session) resides in your home directory under:

~/.keepr/

This ensures full data ownership and an extremely small attack surface.

---

💡 Pro Tips

• Use short, memorable entry names (e.g., aws, github, prod-db).
• Rotate your Master Password occasionally with keepr change-master.
• Always lock the vault when leaving your machine:

keepr logout 

---

🤝 Contributing

Contributions are welcome — whether it's bug reports, new ideas, or pull requests.

If you're planning a substantial change, please open an issue first so we can discuss the approach.

How to Contribute

1. Fork the repository
2. Create a branch for your feature or fix
3. Commit your changes with clear messages
4. Open a Pull Request
5. Wait for review and feedback

---

🛠 Support

If you run into problems, the best way to get help is through the GitHub issue tracker.

• 🐛 Bug Reports:
  Tag the issue with the bug label and include steps to reproduce.

• 💡 Feature Requests:
  Use the enhancement label and describe what you’d like to see added or improved.

• ❓ General Questions:
  Feel free to open an issue or reach out directly to the maintainers.

---

🗺 Roadmap

Planned future features and improvements:

• ⚙️ Customizable CLI configuration (color themes, session duration, default password generator length).
• ⌨️ Shell autocompletion for Keepr commands and arguments.
• 🧪 Password strength checks.
• 🧵 Bulk import/export of entries.
• 🔄 A copy command, which copies a password for an entry to the clipboard, without displaying any info on screen.
• 🧩 A generate command, which just generates a password and displays it on screen (separate to the -g option for the add command).
• 🛡️ Optional Two-factor authentication.

If you want to help shape the roadmap, feel free to open an issue or submit proposals.

---

👤 Authors

• Ben Samarji — Active Maintainer
  📧 [e-mail]

---

📜 License

Keepr is offered under the MIT License. See LICENSE.md for full details.

You are free to use, modify, and distribute the software as long as the license terms are respected.

---

🚀 Project Status

Active development

New features, performance improvements, and security enhancements are added regularly. Community feedback is always appreciated, and contributions are welcome!