HATCH-PUBLISH(1)

🚀 HATCH-PUBLISH(1) — the "put your build artifacts out into the world" one

okay bestie so this is a User Commands page (that's the manual it lives in, mwah) and it's all about hatch publish, aka the moment your lil build artifacts get to leave the nest and go be famous 💅

---

✨ NAME ✨

hatch publish — Publish build artifacts 🎀

like. that's it. that's the whole job. you made the thing, now you ship the thing.

---

🌸 SYNOPSIS 🌸

hatch publish [OPTIONS] [ARTIFACTS]...

so you run it, you optionally hand it some ARTIFACTS, and it does the publish-y thing. no cap.

---

👑 OPTIONS 👑

every single one of these, coming right up, no skips, no summarising, we don't do that here:

• -r, --repo TEXT — the repository you're publishing artifacts to 🏠 [env var: HATCH_INDEX_REPO]
• -u, --user TEXT — the user you authenticate as 🔑 [env var: HATCH_INDEX_USER]
• -a, --auth TEXT — the credentials used for authentication 🤫 [env var: HATCH_INDEX_AUTH]
• --ca-cert TEXT — the path to a CA bundle 📜 [env var: HATCH_INDEX_CA_CERT]
• --client-cert TEXT — the path to a client certificate, which may optionally contain the private key 🪪 [env var: HATCH_INDEX_CLIENT_CERT]
• --client-key TEXT — the path to the client certificate's private key 🗝️ [env var: HATCH_INDEX_CLIENT_KEY]
• -n, --no-prompt — disable prompts, like the ones for missing required fields 🙅‍♀️
• --initialize-auth — save first-time authentication info even if nothing was published 👀 (yes, even then. it's giving "prepared")
• -p, --publisher TEXT — the publisher plugin to use (default is index) 🧩 [env var: HATCH_PUBLISHER]
• -o, --option TEXT — options to pass to the publisher plugin. you can pick this multiple times, e.g. -o foo=bar -o baz=23 🎛️ [env var: HATCH_PUBLISHER_OPTIONS]
• -y, --yes — confirm without prompting when the plugin is disabled ✅
• -h, --help — show a help message and exit 🆘

---

🌈 ENVIRONMENT 🌈

these are the env vars, and every one of them has a matching option, so pick your fighter:

• HATCH_INDEX_REPO — the repository with which to publish artifacts 🏠 [option: -r, --repo]
• HATCH_INDEX_USER — the user with which to authenticate 🔑 [option: -u, --user]
• HATCH_INDEX_AUTH — the credentials to use for authentication 🤫 [option: -a, --auth]
• HATCH_INDEX_CA_CERT — the path to a CA bundle 📜 [option: --ca-cert]
• HATCH_INDEX_CLIENT_CERT — the path to a client certificate, optionally containing the private key 🪪 [option: --client-cert]
• HATCH_INDEX_CLIENT_KEY — the path to the client certificate's private key 🗝️ [option: --client-key]
• HATCH_PUBLISHER — the publisher plugin to use (default is index) 🧩 [option: -p, --publisher]
• HATCH_PUBLISHER_OPTIONS — options to pass to the publisher plugin 🎛️ [option: -o, --option]

---

💖 SEE ALSO 💖

the whole friend group, go say hi:

• hatch-build(1)
• hatch-clean(1)
• hatch-config(1)
• hatch-dep(1)
• hatch-env(1)
• hatch-fmt(1)
• hatch-new(1)
• hatch-project(1)
• hatch-python(1)
• hatch-run(1)
• hatch-self(1)
• hatch-shell(1)
• hatch-status(1)
• hatch-test(1)
• hatch-version(1)

and obviously the main character herself: hatch(1) 💅

---

this page is hatch-publish(1), born August 2024, and it ate. periodt. 🫶💜