SQ(1)

🦋 SQ(1) 🦋

okay bestie, gather round 💖 this is the manual page for sq-keyring-filter, a User Command (section 1, that's what the 1 is doing there, iykyk). it's all about joining keys into a keyring while applying a filter ✨ no cap, it's lowkey iconic. let's get into it 🫶

🌸 NAME 🌸

sq-keyring-filter — join keys into a keyring applying a filter 💅

🎀 SYNOPSIS 🎀

sq keyring filter [OPTIONS] FILE

✨ DESCRIPTION ✨

Join keys into a keyring applying a filter. that's the whole vibe 💖

so like, you can use this to filter keys based on given predicates — for example, whether they have a user id containing an email address with a certain domain 👑 and on top of that, the keys can be pruned so they only include components matching the predicates. very demure, very mindful.

if no filters are supplied, everything matches. the filter said "everyone's welcome" 🥰

if multiple predicates are given, they are or'ed, i.e., a key matches if any of the predicates match. to require all predicates to match, you chain multiple invocations of this command together 🌈 see EXAMPLES for inspiration, bestie, they ate.

⚠️ note: this command is considered experimental and may change in future releases 😭 to acknowledge this, you must give the --experimental flag when invoking this command. no flag, no service 💀

💖 OPTIONS 💖

🧚 Subcommand options 🧚

• --cert=FINGERPRINT|KEYID — match on certificate fingerprints and key IDs ✨ matches on primary keys, including those certificates that match the given fingerprint or key ID 👑
• --domain=FQDN — match on email domain FQDN 🌐 it parses user IDs into name and email address, then case-sensitively matches on the domain of the email address, and it requires an exact match. not a vibe match, an exact one fr fr.
• --email=ADDRESS — match on email ADDRESS 📧 same deal: it parses user IDs into name and email address and case-sensitively matches on the email address, requiring an exact match.
• --experimental — opt-in to using an experimental feature 🧪 this command is considered experimental and may change in future releases. to acknowledge this, you must give the --experimental flag when invoking this command.

in the future, we may stabilize this command. when that happens, --experimental will no longer be required, but will be ignored silently 🤫 (it'll just be there, chilling, main character energy, no complaints)

• --key=FINGERPRINT|KEYID — match on (sub)key fingerprints and key IDs 🔑 matches on both primary keys and subkeys, including those certificates that match the given fingerprint or key ID.
• --name=NAME — match on NAME 🏷️ it parses user IDs into name and email and case-sensitively matches on the name, requiring an exact match.
• --output=FILE — write to FILE or stdout if omitted 📝

[default: -]

• --prune-certs — remove certificate components not matching the filter ✂️
• --to-cert — convert any keys in the input to certificates 🎀 converting a key to a certificate removes secret key material from the key thereby turning it into a certificate. so like, the secret stuff is gone gone 💀
• --userid=USERID — match on USERID 🪪 case-sensitively matches on the user ID, requiring an exact match.
• FILE — read from FILE or stdin if omitted 👀

🌈 Global options 🌈

see sq(1) for a description of the global options.

---

🔥 EXAMPLES 🔥

convert all keys to certificates (i.e. remove any secret key material).

sq keyring filter --experimental --to-cert certs.pgp

get all certificates with a user ID on example.org.

sq keyring filter --experimental --domain=example.org \
       certs.pgp

get all certificates with a user ID on example.org or example.net.

sq keyring filter --experimental --domain=example.org \
       --domain=example.net certs.pgp

get all certificates with a name user ID matching Romeo.

sq keyring filter --experimental --name=Romeo certs.pgp

get all certificates with a name user ID matching Romeo on example.org.

sq keyring filter --experimental --domain=example.org \
       certs.pgp \
       | sq keyring filter --experimental --name=Romeo

get all certificates with a user ID on example.org, pruning other user IDs.

sq keyring filter --experimental --domain=example.org \
       --prune-certs certs.pgp

⭐ SEE ALSO ⭐

sq(1), sq-keyring(1) 💜

for the full documentation see <https://book.sequoia-pgp.org/> 📚

👑 VERSION 👑

1.5.0

---

and that's the whole page, bestie 🫶 this lil' manual came to you from Sequoia PGP, version 1.5.0 — so go forth, filter those keys, give --experimental your acknowledgement, and slay 💅✨ bye!!