Skip to main content

Export Bitwarden vault

Project description

Bitwarden Exporter

Python Wrapper for Password Manager CLI for exporting bitwarden vaults to KeePass.

Features

  • Comprehensive data mapping
    • Credentials
    • URIs (Compatible with keepass URL)
    • Notes (Compatible with keepass note)
    • TOTP codes (Compatible with keepass totp)
    • Custom Fields (Compatible with additional attributes)
    • Identity/Cards (Backup only, not supported by Keepass yet)
    • Attachments (Compatible with keepass attachment)
    • SSH keys (Compatible with keepass ssh and attachments)
    • Fido U2F Keys (Backup only, not supported by Keepass yet)
  • Preserves vault structure
    • Collection and Folder hierarchy is preserved as Keepass groups.
  • Built-in JSON snapshot of vault data for auditing.
  • Configurable CLI with options for duplicates handling, custom temp directory, debug logging, and Bitwarden CLI path.

Prerequisites

(Recommended) Run with uvx

BW_SESSION=<session token> uvx bitwarden-exporter==VERSION --help

or

BW_SESSION=<session token> uvx bitwarden-exporter --help

Install with pipx

BW_SESSION=<session token> pipx install bitwarden-exporter

Options

bitwarden-exporter --help

Export Location (-l, --export-location)

Bitwarden Export Location, Default: bitwarden_dump_<timestamp>.kdbx,

This is a dynamic value, Just in case if it exists, it will be overwritten.

Export Password (-p, --export-password)

  • Required

Bitwarden Export Password or Path to Password File.

File paths can be prefixed with 'file:' to reference a file, e.g. file:secret.txt.

Environment variables can be used to reference a file, e.g. env:SECRET_PASSWORD.

From vault, jmespath expression on bw list items,

e.g. jmespath:[?id=='xx-xx-xx-xxx-xxx'].fields[] | [?name=='export-password'].value.

Allow Duplicates (-d, --allow-duplicates)

Allow Duplicates entries in Export, In bitwarden each item can be in multiple collections.

Default: --no-allow-duplicates

Temporary Directory (-t, --tmp-dir)

Temporary Directory to store temporary sensitive files, Make sure to delete it after the export.

Default: ./bitwarden_dump_attachments

Bitwarden CLI Executable (-e, --bw-executable)

Path to the Bitwarden CLI executable.

Default: bw

Debug (-d, --debug)

Enable Verbose Logging.

This will print debug logs, THAT MAY CONTAIN SENSITIVE INFORMATION.

This will not delete the temporary directory after the export.

Default: --no-debug

Roadmap

  • Make a cloud-ready option for bitwarden zero-touch backup, Upload to cloud storage.
  • Restore back to bitwarden.

Credits

@ckabalan for bitwarden-attachment-exporter

License

MIT

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

bitwarden_exporter-1.7.0.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

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

bitwarden_exporter-1.7.0-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file bitwarden_exporter-1.7.0.tar.gz.

File metadata

  • Download URL: bitwarden_exporter-1.7.0.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.3

File hashes

Hashes for bitwarden_exporter-1.7.0.tar.gz
Algorithm Hash digest
SHA256 f349b300f29239202d37fcd504f1ec77b06c3769414221512458c8e8567a7df8
MD5 d395d44b58545ecea478c9feb1a6adb5
BLAKE2b-256 042d0f0475b76c3bd7df61313da4a34ec907d26f07ab0044360132f4bf05a0d7

See more details on using hashes here.

File details

Details for the file bitwarden_exporter-1.7.0-py3-none-any.whl.

File metadata

File hashes

Hashes for bitwarden_exporter-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e870babff464c2fe22063af662e2b934cf20800df7e0f4d7984350a565a28e7c
MD5 906b639c7755009b4fb7decac63a3f00
BLAKE2b-256 47b51a3ecadfecbfdcd879edb67f7df8513c1acb2f7b134362adcdb0670a1aea

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