HATCH(1)

💖 NAME 💖

ok so hatch — it's Modern, extensible Python project management, bestie. that's the whole vibe. she does it all. 🐍✨

---

🌸 SYNOPSIS 🌸

hatch [OPTIONS] COMMAND [ARGS]...

like. you give her options, a command, and args, and she GOES. periodt.

---

🎀 OPTIONS 🎀

these are your global levers, bestie — set them before the command and she listens 💅

• -e, --env TEXT — the name of the environment you wanna use [env var: HATCH_ENV]
• -p, --project TEXT — the name of the project you're working on [env var: HATCH_PROJECT]
• -v, --verbose — crank the verbosity UP (and you can stack it, additively, for extra yap) [env var: HATCH_VERBOSE]
• -q, --quiet — turn the verbosity DOWN (also stackable, also additively, shhh) [env var: HATCH_QUIET]
• --color / --no-color — do we show colored output or not? (default is auto-detection, she just knows) [env vars: FORCE_COLOR/NO_COLOR]
• --interactive / --no-interactive — are we allowing features like prompts and progress bars? (default is auto-detection again, she's psychic) [env var: HATCH_INTERACTIVE]
• --data-dir TEXT — the path to a custom directory used to persist data [env var: HATCH_DATA_DIR]
• --cache-dir TEXT — the path to a custom directory used to cache data [env var: HATCH_CACHE_DIR]
• --config TEXT — the path to a custom config file to use [env var: HATCH_CONFIG]
• --version — show the version and dip. exit. bye. 👋
• -h, --help — show a help message and dip. exit. bye. 👋

🫶 COMMANDS 🫶

ok this is the roster and honestly? every single one ate. each has her own whole manpage, so go read those too:

• build — Build a project

See hatch-build(1).

• clean — Remove build artifacts

See hatch-clean(1).

• config — Manage the config file

See hatch-config(1).

• dep — Manage environment dependencies

See hatch-dep(1).

• env — Manage project environments

See hatch-env(1).

• fmt — Lint and format source code

See hatch-fmt(1).

• new — Create or initialize a project

See hatch-new(1).

• project — View project information

See hatch-project(1).

• publish — Publish build artifacts

See hatch-publish(1).

• python — Manage Python installations

See hatch-python(1).

• run — Run commands within project environments

See hatch-run(1).

• self — Manage Hatch

See hatch-self(1).

• shell — Enter a shell within a project's environment

See hatch-shell(1).

• status — Show information about the current environment

See hatch-status(1).

• test — Run tests

See hatch-test(1).

• version — View or set a project's version

See hatch-version(1).

---

🌈 ENVIRONMENT 🌈

these are the little gremlins living in your shell that do the same job as the flags above. set 'em and forget 'em, iykyk 🦋

• HATCH_ENV — the name of the environment to use [option: -e, --env]
• HATCH_PROJECT — the name of the project to work on [option: -p, --project]
• HATCH_VERBOSE — increase verbosity [option: -v, --verbose]
• HATCH_QUIET — decrease verbosity [option: -q, --quiet]
• FORCE_COLOR — display colored output (default is auto-detection) [option: --color]
• NO_COLOR — do not display colored output (default is auto-detection) [option: --no-color]
• HATCH_INTERACTIVE — whether or not to allow features like prompts and progress bars (default is auto-detection) [options: --interactive/--no-interactive]
• HATCH_DATA_DIR — the path to a custom directory used to persist data [option: --data-dir]
• HATCH_CACHE_DIR — the path to a custom directory used to cache data [option: --cache-dir]
• HATCH_CONFIG — the path to a custom config file to use [option: --config]

---

⭐ SEE ALSO ⭐

go read the whole friend group, they're all iconic:

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-publish(1), hatch-python(1), hatch-run(1), hatch-self(1), hatch-shell(1), hatch-status(1), hatch-test(1), hatch-version(1)

---

ok that's the whole page bestie, you're officially hatch-pilled 🧚💜 this one's from August 2024, it's HATCH(1), and it's giving main character energy fr fr. now go build something slay 💅✨