1HATCH(1)                         User Commands                        HATCH(1)
2
3
4

NAME

6       hatch – A modern project, package, and virtual env manager
7

SYNOPSIS

9       hatch [OPTIONS] COMMAND [ARGS]...
10

OPTIONS

12       -e, --env TEXT
13              The name of the environment to use [env var: HATCH_ENV]
14
15       -p, --project TEXT
16              The name of the project to work on [env var: HATCH_PROJECT]
17
18       --color / --no-color
19              Whether or not to display colored output (default is auto-detec‐
20              tion) [env vars: FORCE_COLOR/NO_COLOR]
21
22       --interactive / --no-interactive
23              Whether or not to allow features like prompts and progress  bars
24              (default is auto-detection) [env var: HATCH_INTERACTIVE]
25
26       -v, --verbose
27              Increase verbosity (can be used additively) [env var: HATCH_VER‐
28              BOSE]
29
30       -q, --quiet
31              Decrease  verbosity  (can  be   used   additively)   [env   var:
32              HATCH_QUIET]
33
34       --data-dir TEXT
35              The  path  to  a custom directory used to persist data [env var:
36              HATCH_DATA_DIR]
37
38       --cache-dir TEXT
39              The path to a custom directory used  to  cache  data  [env  var:
40              HATCH_CACHE_DIR]
41
42       --config TEXT
43              The path to a custom config file to use [env var: HATCH_CONFIG]
44
45       --version
46              Show the version and exit.
47
48       -h, --help
49              Show a help message and exit.
50
51   COMMANDS
52       build  Build a project
53
54              See hatch-build(1).
55
56       clean  Remove build artifacts
57
58              See hatch-clean(1).
59
60       config Manage the config file
61
62              See hatch-config(1).
63
64       dep    Manage environment dependencies
65
66              See hatch-dep(1).
67
68       env    Manage project environments
69
70              See hatch-env(1).
71
72       new    Create or initialize a project
73
74              See hatch-new(1).
75
76       project
77              View project information
78
79              See hatch-project(1).
80
81       publish
82              Publish build artifacts
83
84              See hatch-publish(1).
85
86       run    Run commands within project environments
87
88              See hatch-run(1).
89
90       shell  Enter a shell within a project’s environment
91
92              See hatch-shell(1).
93
94       status Show information about the current environment
95
96              See hatch-status(1).
97
98       version
99              View or set a project’s version
100
101              See hatch-version(1).
102

ENVIRONMENT

104       HATCH_ENV
105              The name of the environment to use [option: -e, --env]
106
107       HATCH_PROJECT
108              The name of the project to work on [option: -p, --project]
109
110       FORCE_COLOR
111              Display  colored  output  (default  is  auto-detection) [option:
112              --color]
113
114       NO_COLOR
115              Do not display colored output (default is  auto-detection)  [op‐
116              tion: --no-color]
117
118       HATCH_INTERACTIVE
119              Whether  or not to allow features like prompts and progress bars
120              (default is auto-detection) [options:  --interactive/--no-inter‐
121              active]
122
123       HATCH_VERBOSE
124              Increase verbosity [option: -v, --verbose]
125
126       HATCH_QUIET
127              Decrease verbosity [option: -q, --quiet]
128
129       HATCH_DATA_DIR
130              The  path  to  a  custom directory used to persist data [option:
131              --data-dir]
132
133       HATCH_CACHE_DIR
134              The path to a custom  directory  used  to  acahe  data  [option:
135              --cache-dir]
136
137       HATCH_CONFIG
138              The  path  to a custom custom config file to use [option: --con‐
139              fig]
140

SEE ALSO

142       hatch-build(1),    hatch-clean(1),    hatch-config(1),    hatch-dep(1),
143       hatch-env(1),    hatch-new(1),    hatch-project(1),   hatch-publish(1),
144       hatch-run(1), hatch-shell(1), hatch-status(1), hatch-version(1)
145
146
147
148                                 October 2022                         HATCH(1)
Impressum