1GENERATE_MAN.PY(1) Generated Python Manual GENERATE_MAN.PY(1)
2
6 generate_man.py - Install and execute apps from Python packages.
7
9 generate_man.py [-h] [--version] {install,uninject,inject,upgrade,up‐
10 grade-all,uninstall,uninstall-all,reinstall,reinstall-all,list,run,run‐
11 pip,ensurepath,environment,completions} ...
12
14 Install and execute apps from Python packages.
15 Binaries can either be installed globally into isolated Virtual Envi‐
17 ronments or run directly in a temporary Virtual Environment.
18 Virtual Environment location is ~/.local/pipx/venvs. Symlinks to apps
20 are placed in ~/.local/bin.
21 optional environment variables:
23 PIPX_HOME Overrides default pipx location. Virtual Envi‐
24 ronments
25 will be installed to $PIPX_HOME/venvs.
26 PIPX_BIN_DIR Overrides location of app installations. Apps
27 are
28 symlinked or copied here.
29 PIPX_DEFAULT_PYTHON Overrides default python used for commands.
30 USE_EMOJI Overrides emoji behavior. Default value varies
31 based
32 on platform.
33
36 --version
37 Print version and exit
38
41 generate_man.py install
42 Install a package
43 generate_man.py uninject
45 Uninstall injected packages from an existing Virtual Environment
46 generate_man.py inject
48 Install packages into an existing Virtual Environment
49 generate_man.py upgrade
51 Upgrade a package
52 generate_man.py upgrade-all
54 Upgrade all packages. Runs `pip install -U <pkgname>` for each
55 package.
56 generate_man.py uninstall
58 Uninstall a package
59 generate_man.py uninstall-all
61 Uninstall all packages
62 generate_man.py reinstall
64 Reinstall a package
65 generate_man.py reinstall-all
67 Reinstall all packages
68 generate_man.py list
70 List installed packages
71 generate_man.py run
73 Download the latest version of a package to a temporary virtual
74 environment, then run an app from it. Also compatible with local
75 `__pypackages__` directory (experimental).
76 generate_man.py runpip
78 Run pip in an existing pipx-managed Virtual Environment
79 generate_man.py ensurepath
81 Ensure directories necessary for pipx operation are in your PATH
82 environment variable.
83 generate_man.py environment
85 Print a list of variables used in pipx.constants.
86 generate_man.py completions
88 Print instructions on enabling shell completions for pipx
89
92 usage: generate_man.py install [-h] [--include-deps] [--verbose]
93 [--force]
94 [--suffix SUFFIX] [--python PYTHON]
95 [--system-site-packages]
96 [--index-url INDEX_URL] [--editable]
97 [--pip-args PIP_ARGS]
98 package_spec
99 The install command is the preferred way to globally install apps from
101 python packages on your system. It creates an isolated virtual environ‐
102 ment for the package, then ensures the package's apps are accessible on
103 your $PATH.
104 The result: apps you can run from anywhere, located in packages you can
106 cleanly upgrade or uninstall. Guaranteed to not have dependency version
107 conflicts or interfere with your OS's python packages. 'sudo' is not
108 required to do this.
109 pipx install PACKAGE_NAME pipx install --python PYTHON PACKAGE_NAME
111 pipx install VCS_URL pipx install ./LOCAL_PATH pipx install ZIP_FILE
112 pipx install TAR_GZ_FILE
113 The PACKAGE_SPEC argument is passed directly to `pip install`.
115 The default virtual environment location is ~/.local/pipx and can be
117 overridden by setting the environment variable `PIPX_HOME` (Virtual En‐
118 vironments will be installed to `$PIPX_HOME/venvs`).
119 The default app location is ~/.local/bin and can be overridden by set‐
121 ting the environment variable `PIPX_BIN_DIR`.
122 The default python executable used to install a package is
124 /usr/bin/python3 and can be overridden by setting the environment vari‐
125 able `PIPX_DEFAULT_PYTHON`.
126 package_spec
129 package name or pip installation spec
130
133 --include-deps
134 Include apps of dependent packages
135 --verbose
138 --force, -f
141 Modify existing virtual environment and files in PIPX_BIN_DIR
142 --suffix SUFFIX
145 Optional suffix for virtual environment and executable names.
146 NOTE: The suffix feature is experimental and subject to change.
147 --python PYTHON
150 The Python executable used to create the Virtual Environment and
151 run the associated app/apps. Must be v3.6+.
152 --system-site-packages
155 Give the virtual environment access to the system site-packages
156 dir.
157 --index-url INDEX_URL, -i INDEX_URL
160 Base URL of Python Package Index
161 --editable, -e
164 Install a project in editable mode
165 --pip-args PIP_ARGS
168 Arbitrary pip arguments to pass directly to pip install/upgrade
169 commands
170
173 usage: generate_man.py uninject [-h] [--leave-deps] [--verbose]
174 package dependencies [dependencies ...]
175 Uninstalls injected packages from an existing pipx-managed virtual en‐
177 vironment.
178 package
181 Name of the existing pipx-managed Virtual Environment to inject
182 into
183 dependencies
186 the package names to uninject from the Virtual Environment
187
190 --leave-deps
191 Only uninstall the main injected package but leave its dependen‐
192 cies installed.
193 --verbose
196
199 usage: generate_man.py inject [-h] [--include-apps] [--include-deps]
200 [--system-site-packages] [--index-url IN‐
201 DEX_URL]
202 [--editable] [--pip-args PIP_ARGS]
203 [--force]
204 [--verbose]
205 package dependencies [dependencies ...]
206 Installs packages to an existing pipx-managed virtual environment.
208 package
211 Name of the existing pipx-managed Virtual Environment to inject
212 into
213 dependencies
216 the packages to inject into the Virtual Environment--either
217 package name or pip package spec
218
221 --include-apps
222 Add apps from the injected packages onto your PATH
223 --include-deps
226 Include apps of dependent packages
227 --system-site-packages
230 Give the virtual environment access to the system site-packages
231 dir.
232 --index-url INDEX_URL, -i INDEX_URL
235 Base URL of Python Package Index
236 --editable, -e
239 Install a project in editable mode
240 --pip-args PIP_ARGS
243 Arbitrary pip arguments to pass directly to pip install/upgrade
244 commands
245 --force, -f
248 Modify existing virtual environment and files in PIPX_BIN_DIR
249 --verbose
252
255 usage: generate_man.py upgrade [-h] [--include-injected] [--force]
256 [--system-site-packages]
257 [--index-url INDEX_URL] [--editable]
258 [--pip-args PIP_ARGS] [--verbose]
259 package
260 Upgrade a package in a pipx-managed Virtual Environment by running 'pip
262 install --upgrade PACKAGE'
263 package
266
269 --include-injected
270 Also upgrade packages injected into the main app's environment
271 --force, -f
274 Modify existing virtual environment and files in PIPX_BIN_DIR
275 --system-site-packages
278 Give the virtual environment access to the system site-packages
279 dir.
280 --index-url INDEX_URL, -i INDEX_URL
283 Base URL of Python Package Index
284 --editable, -e
287 Install a project in editable mode
288 --pip-args PIP_ARGS
291 Arbitrary pip arguments to pass directly to pip install/upgrade
292 commands
293 --verbose
296
299 usage: generate_man.py upgrade-all [-h] [--include-injected]
300 [--skip SKIP [SKIP ...]] [--force]
301 [--verbose]
302 Upgrades all packages within their virtual environments by running 'pip
304 install --upgrade PACKAGE'
305
308 --include-injected
309 Also upgrade packages injected into the main app's environment
310 --skip SKIP [SKIP ...]
313 skip these packages
314 --force, -f
317 Modify existing virtual environment and files in PIPX_BIN_DIR
318 --verbose
321
324 usage: generate_man.py uninstall [-h] [--verbose] package
325 Uninstalls a pipx-managed Virtual Environment by deleting it and any
327 files that point to its apps.
328 package
331
334 --verbose
335
338 usage: generate_man.py uninstall-all [-h] [--verbose]
339 Uninstall all pipx-managed packages
341
344 --verbose
345
348 usage: generate_man.py reinstall [-h] [--python PYTHON] [--verbose]
349 package
350 Reinstalls a package.
352 Package is uninstalled, then installed with pipx install PACKAGE with
354 the same options used in the original install of PACKAGE.
355 package
358
361 --python PYTHON
362 The Python executable used to recreate the Virtual Environment
363 and run the associated app/apps. Must be v3.6+.
364 --verbose
367
370 usage: generate_man.py reinstall-all [-h] [--python PYTHON]
371 [--skip SKIP [SKIP ...]] [--ver‐
372 bose]
373 Reinstalls all packages.
375 Packages are uninstalled, then installed with pipx install PACKAGE with
377 the same options used in the original install of PACKAGE. This is use‐
378 ful if you upgraded to a new version of Python and want all your pack‐
379 ages to use the latest as well.
380
383 --python PYTHON
384 The Python executable used to recreate the Virtual Environment
385 and run the associated app/apps. Must be v3.6+.
386 --skip SKIP [SKIP ...]
389 skip these packages
390 --verbose
393
396 usage: generate_man.py list [-h] [--include-injected] [--json |
397 --short]
398 [--verbose]
399 List packages and apps installed with pipx
401
404 --include-injected
405 Show packages injected into the main app's environment
406 --json Output rich data in json format.
409 --short
412 List packages only.
413 --verbose
416
419 usage: generate_man.py run [-h] [--no-cache] [--pypackages] [--spec
420 SPEC]
421 [--verbose] [--python PYTHON]
422 [--system-site-packages] [--index-url IN‐
423 DEX_URL]
424 [--editable] [--pip-args PIP_ARGS]
425 app ...
426 Download the latest version of a package to a temporary virtual envi‐
428 ronment, then run an app from it. The environment will be cached and
429 re-used for up to 14 days. This means subsequent calls to 'run' for the
430 same package will be faster since they can re-use the cached Virtual
431 Environment.
432 In support of PEP 582 'run' will use apps found in a local __pypack‐
434 ages__ directory, if present. Please note that this behavior is experi‐
435 mental, and acts as a companion tool to pythonloc. It may be modified
436 or removed in the future. See https://github.com/cs01/pythonloc.
437 app ...
440 app/package name and any arguments to be passed to it
441
444 --no-cache
445 Do not re-use cached virtual environment if it exists
446 --pypackages
449 Require app to be run from local __pypackages__ directory
450 --spec SPEC
453 The package name or specific installation source passed to pip.
454 Runs `pip install -U SPEC`. For example `--spec mypack‐
455 age==2.0.0` or `--spec
456 git+https://github.com/user/repo.git@branch`
457 --verbose
460 --python PYTHON
463 The Python version to run package's CLI app with. Must be v3.6+.
464 --system-site-packages
467 Give the virtual environment access to the system site-packages
468 dir.
469 --index-url INDEX_URL, -i INDEX_URL
472 Base URL of Python Package Index
473 --editable, -e
476 Install a project in editable mode
477 --pip-args PIP_ARGS
480 Arbitrary pip arguments to pass directly to pip install/upgrade
481 commands
482
485 usage: generate_man.py runpip [-h] [--verbose] package ...
486 Run pip in an existing pipx-managed Virtual Environment
488 package
491 Name of the existing pipx-managed Virtual Environment to run pip
492 in
493 pipargs
496 Arguments to forward to pip command
497
500 --verbose
501
504 usage: generate_man.py ensurepath [-h] [--force]
505 Ensure directory where pipx stores apps is in your PATH environment
507 variable. Also if pipx was installed via `pip install --user`, ensure
508 pipx itself is in your PATH. Note that running this may modify your
509 shell's configuration file(s) such as '~/.bashrc'.
510
513 --force, -f
514 Add text to your shell's config file even if it looks like your
515 PATH already contains paths to pipx and pipx-install apps.
516
519 usage: generate_man.py environment [-h] [--value VARIABLE]
520 Available variables: PIPX_HOME, PIPX_BIN_DIR, PIPX_SHARED_LIBS,
522 PIPX_LOCAL_VENVS, PIPX_LOG_DIR, PIPX_TRASH_DIR, PIPX_VENV_CACHEDIR
523 Only PIPX_HOME and PIPX_BIN_DIR can be set by users in the above list.
525
528 --value VARIABLE, -v VARIABLE
529 Print the value of the variable.
530
533 usage: generate_man.py completions [-h]
534 Print instructions on enabling shell completions for pipx
536
539 pipx(1) was written by Chad Smith and contributors. The project can be
540 found online at ⟨https://pypa.github.io/pipx/⟩
541
543 pip(1), virtualenv(1)
544generate_man.py 2023-11-03 GENERATE_MAN.PY(1)