Documentation

Browse the guides below to get the most out of Keyguard.

Get started

  • Getting started — Install Keyguard and connect your first vault.
  • Locking & unlocking — The app password vs. your account password, biometric and YubiKey unlock, auto-lock settings, and what to do if you forget a password.
  • Migrating to Keyguard — How to bring your passwords into Keyguard — and how to take them with you if you leave.
  • Premium — What's free, what needs a premium license, and how purchasing works.

Accounts & sync

  • Multiple accounts — Connect several Bitwarden and KeePass vaults side by side — one merged view, with per-account identity and control.
  • Bitwarden
    • Supported servers — Connect Keyguard to bitwarden.com, bitwarden.eu, or your own server — including Vaultwarden, per-endpoint URLs, and custom HTTP headers.
    • Two-factor login — The second-factor methods Keyguard supports when signing in to a Bitwarden account, and how each one works.
  • KeePass (KDBX) — Open, edit, and create KeePass databases in Keyguard — what maps to what, and what to watch out for.
  • Sync & conflict resolution — How offline edits sync back, and how Keyguard merges conflicting edits field by field.
  • Backups — How Keyguard's automatic backups work — what's saved, where, encryption, retention, and how to recover.

Guides

  • Items, fields & organizing — Item types, custom fields, folders, favorites, archive, trash, and the per-item re-prompt.
  • Autofill & passkeys on Android — Set up the Android autofill service and the Android 14+ credential provider for passkeys.
  • One-time passwords (TOTP) — Store authenticator keys in your login items — QR scanning, supported code types, and auto-copy.
  • Watchtower — The thirteen security checks Keyguard runs on your vault, how each one works, and how the checks respect your privacy.
  • SSH agent setup — Use SSH keys stored in your vault to authenticate — socket paths, SSH_AUTH_SOCK, and the Android helper.
  • Email relays — Generate masked email addresses through SimpleLogin, addy.io, Firefox Relay, and other forwarder services.
  • Generator & wordlists — Generate passwords, passphrases, usernames, email aliases, and SSH keys — with your own wordlists.
  • Keyguard on Wear OS — Put your vault on your wrist — setup, what works on the watch, and current limitations.

Reference

  • Search — Find any item fast with Keyguard's search — terms, exact phrases, exclusion, and field qualifiers.
  • Placeholders — Dynamic tokens that expand into an item's data — fields, URL parts, transformations, and timestamps.
  • URL overrides — Rewrite or extend an item's URLs with regex-matched commands and placeholders.
  • URL matching — How Keyguard decides which items to suggest for a website or app — match detection modes and equivalent domains.
  • Keyboard shortcuts — Global and contextual keyboard shortcuts for the desktop app.
  • Item types & extras — Custom-field conventions that unlock extra UI — WiFi credentials with QR codes, and tags.
  • Passkeys — What passkeys are, how WebAuthn registration and sign-in work under the hood, and why passkeys resist phishing and breaches that defeat passwords.

Help