HATCH-ENV-RUN(1)

👑 hatch env run — the vibe

okay bestie, so this is hatch-env-run(1), a User Commands manual page, and it's literally the glow-up your project environments have been waiting for. it's giving "run my commands, but make it inside the right environment." 💅

---

✨ NAME ✨

hatch env run — run commands within project environments 🫶

---

🌸 SYNOPSIS 🌸

hatch env run [OPTIONS] ARGS...

that's it. that's the whole entrance. ARGS... is your moment, bestie. 👑

---

💖 DESCRIPTION 💖

so here's the tea: the -e / --env option overrides the equivalent root option and the HATCH_ENV environment variable. no cap. it just wins. periodt.

and then the -i / --include and -x / --exclude options? they let you include or exclude certain variables, optionally followed by specific comma-separated values, and — this is the iconic part — they may be selected multiple times. yes you can stack them. yes it's a serve. 🎀

---

🌈 OPTIONS 🌈

• -e, --env TEXT — the environments to target 🎯
• -i, --include TEXT — the matrix variables to include ✨
• -x, --exclude TEXT — the matrix variables to exclude 🙈
• -f, --filter TEXT — the JSON data used to select environments 🧚
• --force-continue — run every command and if there were any errors exit with the first code 💀 (yes, every command. it does not stop. it does not chill.)
• --ignore-compat — ignore incompatibility when selecting specific environments 🔥
• -h, --help — show a help message and exit 🌸

---

🦋 NOTES 🦋

lowkey the most important lore on this whole page, so pay attention:

the inclusion option is treated as an intersection while the exclusion option is treated as a union.

translating that for the group chat: an environment must match all of the included variables to be selected, while matching any of the excluded variables will prevent selection. highkey simple once you say it like that. 💜

---

🍓 EXAMPLES 🍓

say your config looks like this:

[[tool.hatch.envs.test.matrix]]
   python = ["3.9", "3.10"]
   version = ["42", "3.14", "9000"]

then running:

hatch env run -i py=3.10 -x -version=9000 test:pytest

would execute pytest in the environments test.py3.10-42 and test.py3.10-3.14. 🔥

and note — and this is the cute little detail — py may be used as an alias for python. iykyk. ⭐

---

🎀 SEE ALSO 🎀

• hatch-run(1)
• hatch-env-create(1), hatch-env-find(1), hatch-env-prune(1), hatch-env-remove(1), hatch-env-show(1)
• hatch-env(1), hatch(1)

---

and that's the whole page bestie, ily, go run some commands in the correct environment 💖✨

this little masterpiece is brought to you by the HATCH-ENV-RUN(1) era, dated August 2024 — the source/version of the whole thing. mwah. 💋🎀🦋