SQ(1)

✨ NAME ✨

sq-key-export β€” bestie, this is the one that exports keys from the key store πŸ’–

(She's part of the SQ(1) fam β€” this is the page for sq key export, k?)


πŸ¦‹ SYNOPSIS πŸ¦‹

sq key export [OPTIONS]

πŸ’… DESCRIPTION πŸ’…

Okay so. This command exports keys from the key store. That's the whole vibe. ✨

More specifically: it exports the secret key material that's associated with a certificate. Now listen, because this part is lowkey important β€” even if secret key material is available, that does not mean it's exportable. Fr fr. For example, secret key material stored on a hardware security module usually can't be yoinked off the device at all. It's giving "locked in, stays locked in." πŸ”’

So here's what actually happens: it iterates over all of the specified certificates and exports any keys (primary key and subkeys) that have secret key material. An error gets returned if any specified certificate doesn't contain any secret key material. No secret material, no export, no mercy. 😭

And psst β€” if you only want one particular key and not all the keys hanging out with a certificate, you want sq key subkey export instead. Different tool, different girlie. πŸŽ€


πŸ‘‘ OPTIONS πŸ‘‘

πŸ’– Subcommand options πŸ’–

  • --cert=FINGERPRINT|KEYID β€” export keys with the specified fingerprint or key ID. Give her the exact ID and that's who gets pulled πŸ”₯
  • --cert-domain=DOMAIN β€” export keys where a user ID includes an email address for the specified domain
  • --cert-email=EMAIL β€” export keys where a user ID includes the specified email address πŸ“§
  • --cert-grep=PATTERN β€” export keys with a user ID that matches the pattern, and it's matched case insensitively (so no stress about caps, she does not care)
  • --cert-userid=USERID β€” export keys with the specified user ID
  • --output=FILE β€” write to FILE, or to stdout if you leave it out

[default: -]

🌈 Global options 🌈

See sq(1) for a description of the global options. They're all described over there, bestie 🫢


πŸ“ EXAMPLES πŸ“

Export Alice's certificate with all available secret key material.

sq key export --cert EB28F26E2739A4870ECC47726F0073F60FD0CBF0

Export Alice's certificate with all available secret key material identified by email address.

sq key export --cert-email alice@example.org

🧚 SEE ALSO 🧚

sq(1), sq-key(1).

For the full documentation see <https://book.sequoia-pgp.org/>. πŸ“–


⭐ VERSION ⭐

1.5.0


Okay that's the whole page, mwah πŸ’‹ This was Sequoia PGP version 1.5.0, and yes the version number is genuinely that iconic that it shows up twice. Go export something. Not the HSM one though, we talked about this πŸ’€πŸŒΈ
πŸ“¦ where this page comes from