⚠️ The new ZFordDev Documentation Portal is currently under active development. Search is not yet enabled and some pages are still missing. Please bear with us while we transition to the new system.
Getting Started with KeyPlus
KeyPlus is a lightweight, local‑first password manager built to be simple, fast, and fully offline. This guide walks you through installing the current pre‑release, creating your first vault, and getting comfortable with the workspace.
Installation
KeyPlus ships as both a desktop app and a command‑line tool. Choose your platform below:
Linux
Available through the Snap Store testing channels. The app runs fully sandboxed using native confinement.
sudo snap install --candidate keyplus
Candidate Channel Live
Windows
Windows support is fully implemented. The installer is currently going through final QA before public release.
Coming SoonmacOS
KeyPlus is designed for local, decoupled environments and does not currently support macOS.
Not AvailableFirst Launch
When you start KeyPlus for the first time, it opens in an interactive console workspace. This gives you a fast, keyboard‑driven way to manage your vault right from your terminal.
If KeyPlus doesn’t detect an existing vault, it will guide you through creating your master password. The prompt is intentionally simple and friendly:
╭──────────────────────────────────╮
│ 🔑 KeyPlus — Secure Vault Client │
╰──────────── Runtime Mode Active ─╯
╭──────────────────────────────────────────────────────────────────────╮
│ ⚠️ No Master Password detected. Let's secure your vault. │
╰──────────────────────────────────────────────────────────────────────╯
New password:
Confirm password:
✨ Password created successfully. KeyPlus unlocked, Welcome!
Important: KeyPlus is completely offline. There are no cloud backups, recovery emails, or admin overrides. If you lose your master password, your vault cannot be recovered.
⚙️ Interactive Shell Commands
Once your vault is set up, you’ll see the persistent prompt (KeyPlus ❯). Here are the core commands you’ll use day‑to‑day:
help— Shows all available commands.list— Displays every entry stored in your vault.add <name> <domain> <password>— Creates a new credential entry.view <name>— Shows the full details for a specific entry.edit <name>— Updates an existing entry.history <name>— Shows the change history for an entry.exit/quit— Safely closes your session.
KeyPlus ❯ add mygithub www.github.com 123456
➕ Added entry: mygithub
KeyPlus ❯ list
Vault Entries
┏━━━━━━━━┳━━━━━━━━━━━━━━┓
┃ Index ┃ Account Name ┃
┡━━━━━━━━╇━━━━━━━━━━━━━━┩
│ 1 │ mygithub │
└────────┴──────────────┘
🖥️ Using the GUI
Prefer a visual interface? KeyPlus includes a clean PySide6 (Qt for Python) GUI. Launch it with:
keyplus --gui
The Idea Behind KeyPlus
KeyPlus exists because password managers have drifted away from what users actually need. Many modern tools rely on cloud sync, subscriptions, or heavy feature stacks that introduce more risk than benefit.
KeyPlus goes the opposite direction: local‑first, offline, minimal, and built on proven cryptographic foundations. Your data stays on your machine, under your control, with no external dependencies.