# Keyguard

> Keyguard is a client for the Bitwarden platform and KeePass (KDBX) files. It autofills your logins, supports passkeys, works offline, and runs a Watchtower that finds leaked and reused passwords and other issues.

These documentation pages describe setup, feature availability, limitations, and troubleshooting.
Each Markdown page includes its canonical website URL, supported platforms, Premium requirement, and release stage when applicable.

## Get started

- [Get started with Keyguard](https://keyguard.dev/docs/getting-started/index.md): Install Keyguard, create its local vault, and add your first Bitwarden or KeePass account.
- [Premium](https://keyguard.dev/docs/premium/index.md): What Keyguard Premium unlocks, and how to buy a subscription or lifetime license.
- [License keys](https://keyguard.dev/docs/license-keys/index.md): Activate Keyguard Premium with a lifetime license bought on the web or a key from an existing purchase.

## Accounts and sync

- [Connect to a Bitwarden server](https://keyguard.dev/docs/bitwarden/self-hosted/index.md): Connect Keyguard to bitwarden.com, bitwarden.eu, Vaultwarden or another self-hosted Bitwarden server.
- [Two-factor authentication](https://keyguard.dev/docs/bitwarden/two-factor-login/index.md): The two-factor methods Keyguard supports when you sign in to a Bitwarden account.
- [Sends](https://keyguard.dev/docs/bitwarden/sends/index.md): Share text or a file through a Bitwarden link that deletes itself, with an optional password or access limit.
- [KeePass databases](https://keyguard.dev/docs/keepass/index.md): Open, create and edit KeePass (KDBX) databases in Keyguard, and how their entries map to items.
- [Multiple accounts](https://keyguard.dev/docs/multi-account/index.md): Connect several Bitwarden and KeePass accounts and see their items in one merged vault.
- [Sync and conflict resolution](https://keyguard.dev/docs/sync-and-conflicts/index.md): How offline edits sync back to the server, and how Keyguard merges conflicting edits field by field.

## Vault

- [Items and fields](https://keyguard.dev/docs/items/index.md): What an item holds: item types, custom field types, and the folders, tags, archive and trash that organize them.
- [Search](https://keyguard.dev/docs/search/index.md): Search your vault with terms, phrases, exclusions and field qualifiers, and sort the results.
- [Filters](https://keyguard.dev/docs/filters/index.md): Narrow the vault list by account, type, folder, tag and more, and save the filters you use as custom filters.
- [One-time passwords](https://keyguard.dev/docs/totp/index.md): Store authenticator keys in login items and use TOTP, HOTP, Steam and mOTP codes.
- [Generator](https://keyguard.dev/docs/generator/index.md): Generate passwords, passphrases, PIN codes, usernames, email aliases, and SSH and GPG keys.
- [Email forwarders](https://keyguard.dev/docs/email-relays/index.md): Generate masked email addresses through SimpleLogin, addy.io, Firefox Relay and other forwarders.
- [Attachments](https://keyguard.dev/docs/attachments/index.md): Attach files to vault items, download them, and preview images, text, GPG keys and ZIP archives without saving them to disk.
- [Bulk actions](https://keyguard.dev/docs/bulk-actions/index.md): Select several vault items, then move, rename, tag, merge, archive, trash or export them in one step.

## Autofill and passkeys

- [Autofill](https://keyguard.dev/docs/autofill/index.md): Fill logins in other apps and browsers with Keyguard: turn it on, allow it in browsers, and adjust its options.
- [Passkeys](https://keyguard.dev/docs/passkeys/index.md): How passkeys work, why they resist phishing, and how Keyguard stores and signs with them.
- [Use Keyguard as a passkey provider](https://keyguard.dev/docs/passkey-provider/index.md): Register Keyguard as the system's passkey provider to create and sign in with passkeys stored in your vault.
- [URL matching](https://keyguard.dev/docs/url-matching/index.md): How Keyguard picks the items to suggest for a website or app: match detection and equivalent domains.
- [Blocked URIs](https://keyguard.dev/docs/blocked-uris/index.md): Stop Keyguard from offering autofill in the apps and on the websites you list.
- [Quick search](https://keyguard.dev/docs/quick-search/index.md): Find an item from any desktop app with a global shortcut, then copy its values or auto-type a login.
- [Troubleshoot autofill and passkeys](https://keyguard.dev/docs/troubleshoot-autofill/index.md): Fix missing or wrong autofill suggestions, and problems with Keyguard as a passkey provider.

## Security

- [Lock and unlock](https://keyguard.dev/docs/lock-and-unlock/index.md): The app password, biometric, YubiKey and security key unlock, auto-lock, and what to do if you forget a password.
- [Watchtower](https://keyguard.dev/docs/watchtower/index.md): The security checks Keyguard runs on your vault, how each one works, and how they protect your privacy.
- [Security model](https://keyguard.dev/docs/security/index.md): How Keyguard protects the local copy of your vault, what it can't protect against, and its known limitations.

## Developer tools

- [SSH agent](https://keyguard.dev/docs/ssh-agent/index.md): Sign SSH requests with keys from your vault, from desktop tools, Termux and Android apps.
- [GPG agent](https://keyguard.dev/docs/gpg-agent/index.md): Sign and decrypt with GPG keys from your vault, from GnuPG on desktop and in Termux, and from OpenPGP apps on Android.
- [Agent approvals](https://keyguard.dev/docs/agent-approvals/index.md): How long Keyguard remembers an approval for the SSH and GPG agents, the command line and MCP, and who can reuse it.
- [Sign Git commits](https://keyguard.dev/docs/git-signing/index.md): Sign Git commits with a GPG or SSH key from your vault, through Keyguard's GPG or SSH agent.
- [GPG keys](https://keyguard.dev/docs/gpg-keys/index.md): The GPG Key item: identifiers, algorithms, edits, import and export, GPG tools and keyservers.
- [GPG tools](https://keyguard.dev/docs/gpg-tools/index.md): Encrypt, decrypt, sign and verify text or files with the GPG keys in your vault, without GnuPG.
- [Environments](https://keyguard.dev/docs/environments/index.md): Keep environment variables in your vault and pass them to local tools through local .env files, keyguard run or MCP.
- [Connect a coding agent](https://keyguard.dev/docs/coding-agents/index.md): Let a coding agent create and edit your environments through MCP, and run its commands with their variables, without seeing values.
- [Command line](https://keyguard.dev/docs/cli/index.md): The keyguard command-line tool, with its commands, flags, endpoints, exit codes, error messages and MCP tools.

## Backup and transfer

- [Import from another password manager](https://keyguard.dev/docs/migrating/index.md): Move your passwords into Keyguard through a Bitwarden account, a KeePass database or Credential Exchange.
- [Export your vault](https://keyguard.dev/docs/export/index.md): Export items from Keyguard as an encrypted ZIP archive or a KeePass database, with or without attachments.
- [Credential Exchange](https://keyguard.dev/docs/credential-exchange/index.md): Move passwords, passkeys and other items between Keyguard and another app on the same device.
- [Automatic backups](https://keyguard.dev/docs/backups/index.md): Save versioned snapshots of your vault to a folder, a WebDAV server or S3-compatible storage after each change.

## Platforms

- [Platform support](https://keyguard.dev/docs/platform-support/index.md): Which pages and features each platform supports, built from the docs themselves.
- [Wear OS](https://keyguard.dev/docs/wear-os/index.md): Use your vault on a Wear OS watch: setup, what works on the watch, and its limits.

## Reference

- [Placeholders](https://keyguard.dev/docs/placeholders/index.md): Tokens that expand into an item's data: fields, URL parts, text transformations, dates and times.
- [URL overrides](https://keyguard.dev/docs/url-overrides/index.md): Rewrite or extend an item's URLs with regex-matched commands and placeholders.
- [Keyboard shortcuts](https://keyguard.dev/docs/shortcuts/index.md): Global, Quick search and in-app keyboard shortcuts for the desktop app.
- [Custom field conventions](https://keyguard.dev/docs/item-extras/index.md): Custom-field names that Keyguard reads as Wi-Fi credentials, tags, item links, GPG keys, SSH certificates and environments.
- [Appearance settings](https://keyguard.dev/docs/appearance/index.md): Language, theme, color, font, navigation, icon, behavior and layout settings that change how Keyguard looks.
- [Security settings](https://keyguard.dev/docs/security-settings/index.md): Every setting on the Security screen: locking, the clipboard, screen privacy, unlock methods and the app password.

## Help

- [Troubleshooting](https://keyguard.dev/docs/troubleshooting/index.md): Every troubleshooting page in the docs, with the problems each one covers.
- [Send feedback](https://keyguard.dev/docs/feedback/index.md): Suggest a feature, report a bug, ask a question or start a discussion about Keyguard.
- [Report a vulnerability](https://keyguard.dev/docs/report-vulnerability/index.md): Report a security vulnerability in Keyguard privately by email, optionally encrypted with PGP.
- [Architecture](https://keyguard.dev/docs/architecture/index.md): How Keyguard is built: the shared code, the app for each platform, the core technologies and the local-first design.