keyplus documentation
Choose a version
Version 0.3.x
KeyPlus documentation #
KeyPlus is a local-first encrypted password vault for Windows and Linux. It has an interactive terminal interface and a PySide6 desktop interface over the same vault and application services.
Status: 0.3.1 development source. These pages do not describe the previous 0.2.9 release or the 0.3.0 pre-release snapshot. Confirm the version of an installed package before relying on the workflows and storage guidance here.
KeyPlus has not received an independent security audit. The documentation describes its implementation and boundaries; it does not guarantee protection against every attack or implementation defect.
Getting started
Install the 0.3 development source, create a vault, or migrate 0.2 data.
Desktop guide
Unlock the GUI and manage entries and backups.
CLI reference
Use the interactive KeyPlus command workspace.
Vaults, migration, and backups
Understand data locations, backup restoration, and 0.2 migration.
Security design
Cryptographic design, application behaviour, and limitations.
Technical overview
Application layers, persistence, sessions, and internal vault format.
Packaging and platforms
Source, Debian, Snap, and Windows build behaviour.
Troubleshooting
Resolve unlock, migration, locking, and vault-file problems safely.
KeyPlus has no supported public Python API or stable public vault-format specification. Contributor-facing internals are documented only to explain the current implementation.