Skip to content
sefysefy

export

Writes the whole vault out as plain, unencrypted JSON. This exists so a vault is never a trap: contents can be migrated, kept in another form, or moved to a different tool.

Usage

Section titled “Usage”
Terminal window
sefy export --i-know-this-writes-plaintext [OPTIONS]
Option Meaning
-o, --output <PATH> Where to write it; omit to print to stdout.
--i-know-this-writes-plaintext Required.
--force Overwrite the destination if it exists.
Terminal window
$ sefy export --i-know-this-writes-plaintext -o backup.json
wrote backup.json in the clear
Terminal window
sefy export --i-know-this-writes-plaintext | gpg -c > backup.json.gpg

Why the flag is required

Section titled “Why the flag is required”

The acknowledgement flag is required rather than a printed warning: a warning arrives after the file is already on disk, and scripts do not read them at all.

The resulting file is exactly as sensitive as the vault and protects nothing. Every password, note and stored file is in it in the clear. Write it somewhere that is not synced or backed up, and delete it when you are done — or pipe it straight into whatever consumes it, so it never reaches disk.

Format

Section titled “Format”
{
  "sefy_export": 1,
  "items": [
    { "uuid": "5f2b…", "title": "bank", "kind": "note", "tags": ["money"],
      "text": "code 4815" },
    { "uuid": "9c14…", "title": "mail", "kind": "credential", "login": "someone",
      "password": "…", "url": "…", "totp": "…", "notes": "…" },
    { "uuid": "a077…", "title": "key", "kind": "file", "filename": "id_ed25519",
      "bytes_base64": "…" }
  ]
}

Notes need text; credentials need login and password; files need filename and bytes_base64. Everything else is optional. This is a plain enough shape to generate from another tool by hand.

uuid is the identity the item had in the vault it came from. It is what lets import recognise an item it already holds instead of duplicating it. Leave it out when writing an export by hand — an entry without one is simply added.

Section titled “Related”