Skip to main content

Imports and existing KeePass db with REF fields into Bitwarden

Project description

KP2BW - KeePass 2.x to Bitwarden Converter

Fork of jampe/kp2bw, modernized.

Migrates KeePass databases to Bitwarden via the bw CLI, with advantages over the built-in Bitwarden importer:

  • Encrypted in-memory transfer -- data never hits disk unencrypted (except attachments, which are cleaned up after upload)
  • KeePass REF resolution -- username/password references are resolved: matching credentials merge URLs into one entry; differing ones create new entries
  • Passkey migration -- KeePassXC FIDO2/passkey credentials (KPEX_PASSKEY_*) are converted to Bitwarden fido2Credentials
  • Custom properties & attachments -- imported as Bitwarden custom fields or attachments (values > 10k chars auto-upload as files)
  • Long notes handling -- notes exceeding 10k chars are uploaded as notes.txt attachments
  • Idempotent -- safe to run multiple times without duplicating entries
  • Nested folders -- KeePass folder hierarchy is recreated in Bitwarden
  • Recycle Bin filtering -- deleted entries are automatically excluded
  • Expiry awareness -- expired entries are marked [EXPIRED] in notes; optionally skip them entirely with --skip-expired
  • Metadata preservation -- KeePass tags, expiry dates, and created/modified timestamps are stored as Bitwarden custom fields
  • Tag filtering -- import only entries matching specific tags
  • Organization & collection support -- upload into a Bitwarden organization with automatic or manual collection assignment
  • Full UTF-8 & cross-platform -- works on Windows, macOS, and Linux

Installation

# install with:
uv tool install kp2bw
kp2bw passwords.kdbx

# or run directly without installing:
uvx kp2bw

or from a GitHub URL:

# install with:
uv tool install git+https://github.com/kjanat/kp2bw
kp2bw passwords.kdbx

# run directly without installing:
uvx --from git+https://github.com/kjanat/kp2bw kp2bw passwords.kdbx

Prerequisites

Install the Bitwarden CLI and log in once before using kp2bw:

# optional: point to a self-hosted instance
bw config server https://your-domain.com/

# log in (only needed once; kp2bw uses `bw unlock` afterwards)
bw login <user>

Usage

kp2bw [-h] [-k KEEPASS_PASSWORD] [-K KEEPASS_KEYFILE] [-b BITWARDEN_PASSWORD]
       [-o BITWARDEN_ORG] [-c BITWARDEN_COLLECTION] [-t TAG [TAG ...]]
       [--path-to-name | --no-path-to-name] [--path-to-name-skip N]
       [--skip-expired | --no-skip-expired]
       [--include-recycle-bin | --no-include-recycle-bin]
       [--metadata | --no-metadata] [-y] [-v] [-V | --version] keepass_file
Flag Description Env var
keepass_file Path to your KeePass 2.x database -
-k, --keepass-password KeePass password (prompted if omitted) KP2BW_KEEPASS_PASSWORD
-K, --keepass-keyfile KeePass key file KP2BW_KEEPASS_KEYFILE
-b, --bitwarden-password Bitwarden password (prompted if omitted) KP2BW_BITWARDEN_PASSWORD
-o, --bitwarden-org Bitwarden Organization ID KP2BW_BITWARDEN_ORG
-c, --bitwarden-collection Collection ID, or auto to derive from top-level folder names KP2BW_BITWARDEN_COLLECTION
-t, --import-tags Only import entries with these tags KP2BW_IMPORT_TAGS (comma-separated)
--path-to-name / --no-path-to-name Prepend folder path to entry names (default: off) KP2BW_PATH_TO_NAME
--path-to-name-skip Skip first N folders in path prefix (default: 1) KP2BW_PATH_TO_NAME_SKIP
--skip-expired Skip entries that have expired in KeePass KP2BW_SKIP_EXPIRED
--include-recycle-bin Include Recycle Bin entries (excluded by default) KP2BW_INCLUDE_RECYCLE_BIN
--metadata / --no-metadata Toggle KeePass metadata as custom fields (default: on) KP2BW_MIGRATE_METADATA
-y, --yes Skip the Bitwarden CLI setup confirmation prompt KP2BW_YES
-v, --verbose Verbose output KP2BW_VERBOSE
-V, --version Print the installed kp2bw version and exit -

Configuration precedence is always: CLI flag > environment variable > built-in default.

Troubleshooting

"Invalid master password" on bw unlock

If your password contains special shell characters (?, >, &, etc.), wrap it in double quotes when prompted. See jampe/kp2bw#10 and libkeepass/pykeepass#254 for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kp2bw-3.0.0a1.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kp2bw-3.0.0a1-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file kp2bw-3.0.0a1.tar.gz.

File metadata

  • Download URL: kp2bw-3.0.0a1.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for kp2bw-3.0.0a1.tar.gz
Algorithm Hash digest
SHA256 0885597e7e721c7bbaf0753a4fdb55cb776d7baea2344c8e3f224c0719e55897
MD5 fa3e40a2d2cbe28661243dc3f15ac582
BLAKE2b-256 db71923ce076b69c5e6f0459a1a56a1bc458e6c7b908922665597b3898d76223

See more details on using hashes here.

File details

Details for the file kp2bw-3.0.0a1-py3-none-any.whl.

File metadata

  • Download URL: kp2bw-3.0.0a1-py3-none-any.whl
  • Upload date:
  • Size: 26.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for kp2bw-3.0.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 32d2b24025d1c8c3858b133e202b6de5f5457b886ac09546d7d589cdde3d2652
MD5 01e86e79a37077abc07281f18c4413d9
BLAKE2b-256 3baaa67486bdfb78f8a34eb455dec4e9e7df12398fc4dfc6fa437ef3ab31ffc5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page