SQ(1)

✨ SQ(1) — the manual, but make it cute ✨

okay bestie, this is a page from the SQ(1) manual — specifically sq-network-wkd-publish. yes the header says SQ(1) and yes we're doing the whole thing. grab a strawberry 🍓 and let's go.

---

💖 NAME 💖

sq-network-wkd-publish — publish certificates in a Web Key Directory

like, it puts your certs where the people can find them. main character behavior fr.

---

🦋 SYNOPSIS 🦋

sq network wkd publish [OPTIONS] DEST

that's it. that's the whole vibe. DEST is the moment. 🫶

---

🌸 DESCRIPTION 🌸

Publish certificates in a Web Key Directory.

So basically: this command publishes certificates — or certificate updates — into a Web Key Directory (a WKD, iykyk). If you want, you can create or update a whole WKD hierarchy right on your local system by handing it a path as the destination. local slay.

But typically a WKD lives on a web server. So if you pass --rsync, this command goes full long-distance-relationship mode and manages remote WKD directory hierarchies by using rsync(1). remote slay. ✨

Wanna insert a new cert into the WKD? That's what --cert is for, bestie.

And here's the iconic part: any updates for certificates that are already in the WKD get published automatically. no extra steps. obsessed.

⚠️ Note, and this one's important: to update a WKD hierarchy, it first gets copied to a temporary location on the local machine, then new certs / cert updates get inserted into that local copy, and then the whole hierarchy is copied back to where it came from. The way that this is not an atomic operation… yeah. So you gotta be careful and avoid concurrent updates. like, seriously. protect your peace AND your WKD. 😭

---

💅 OPTIONS 💅

🎀 Subcommand options 🎀

• --all — Publish authenticated certs with a user ID matching domain

Use every certificate that has a user ID matching the domain you gave to the --domain parameter and that can be fully authenticated. only the verified besties.

• --cert=FINGERPRINT|KEYID — Use certificates with the specified fingerprint or key ID
• --cert-email=EMAIL — Use certificates where a user ID includes the specified email address
• --cert-file=PATH — Read certificates from PATH
• --cert-userid=USERID — Use certificates with the specified user ID
• --create — Create the WKD hierarchy if it does not exist yet

manifesting a WKD into existence, literally.

• --domain=FQDN — Generate a WKD for a fully qualified domain name for email
• --method=METHOD — Select kind of WKD hierarchy to be created

The advanced method is the default and should be preferred — it's hosted on a separate domain (e.g. openpgpkey.example.org). 💖

The direct method is hosted on the same domain (e.g. example.org).

[possible values: advanced, direct]

• --rsync — Use rsync(1) to access DEST
• --rsync-path=RSYNC — Path to the local rsync command to use, implies --rsync
• DEST — Location of the WKD on the local or remote machine

If --rsync is given, this is passed as-is to rsync(1). no edits, no notes, straight through. 🧚

🌈 Global options 🌈

See sq(1) for a description of the global options. (yes, go read that one too, it's giving lore.)

---

⭐ EXAMPLES ⭐

Create a new WKD hierarchy in the local directory public_html, and insert Alice's cert.

sq network wkd publish --create \
       --cert=EB28F26E2739A4870ECC47726F0073F60FD0CBF0 \
       --domain=example.org public_html

Add Bob's cert to the existing WKD hierarchy in the local directory public_html.

sq network wkd publish \
       --cert=511257EBBF077B7AEDAE5D093F68CB84CE537C9A \
       --domain=example.org public_html

Add all certs with an authenticated user ID in example.org to the existing WKD hierarchy.

sq network wkd publish --domain=example.org --all public_html

Refresh all certs in the existing WKD hierarchy in the local directory public_html from the cert store.

sq network wkd publish --domain=example.org public_html

---

🔥 SEE ALSO 🔥

• sq(1), sq-network(1), sq-network-wkd(1).

For the full documentation see <https://book.sequoia-pgp.org/>. 👑

---

💜 VERSION 💜

1.5.0

---

okay that's the whole page, you ate that. no cap. 🎀✨

Sequoia PGP — version 1.5.0, same energy as this page, mwah 💋 stay slaying out there bestie 🦋💖