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

NAME

6       pipx - install and execute apps from Python packages
7

SYNOPSIS

9       pipx [-h] [--version] SUBCOMMAND [OPTION]...
10

DESCRIPTION

12       Binaries  can  either be installed globally into isolated virtual envi‐
13       ronments or run directly in a temporary virtual environment.
14

OPTIONS

16   OPTIONAL ARGUMENTS
17       -h, --help
18              Show a help message and exit
19
20       --version
21              Print version and exit
22

SUBCOMMANDS

24       Each of the following  has  a  corresponding  man  page:  for  example,
25       pipx-install(1)  for  “pipx install”.   Or,  get help for commands with
26       pipx COMMAND --help.
27
28       pipx install
29              Install a package
30
31       pipx inject
32              Install packages into an existing virtual environment
33
34       pipx upgrade
35              Upgrade a package
36
37       pipx upgrade-all
38              Upgrade all  packages.   Runs  pip install -U pkgname  for  each
39              package.
40
41       pipx uninstall
42              Uninstall a package
43
44       pipx uninstall-all
45              Uninstall all packages
46
47       pipx reinstall
48              Reinstall a package
49
50       pipx reinstall-all
51              Reinstall all packages
52
53       pipx list
54              List installed packages
55
56       pipx run
57              Download  the latest version of a package to a temporary virtual
58              environment, then run an app from it.  Also compatible with  lo‐
59              cal __pypackages__ directory (experimental).
60
61       pipx runpip
62              Run pip in an existing pipx(1)-managed virtual environment
63
64       pipx ensurepath
65              Ensure  directories  necessary for pipx(1) operation are in your
66              PATH environment variable.
67
68       pipx completions
69              Print instructions on enabling shell completions for pipx(1)
70

ENVIRONMENT

72       Optional environment variables:
73
74       PIPX_HOME
75              Overrides default pipx(1) location.  Virtual  environments  will
76              be installed to $PIPX_HOME/venvs.
77
78       PIPX_BIN_DIR
79              Overrides  location of app installations.  Apps are symlinked or
80              copied here.
81
82       USE_EMOJI
83              Overrides emoji behavior.  Default value varies based  on  plat‐
84              form.
85
86       PIPX_DEFAULT_PYTHON
87              Overrides default python used for commands.
88

FILES

90       Virtual  environment  location  is  $HOME/.local/pipx/venvs by default.
91       Symlinks to apps are placed in $HOME/.local/bin by default.   See  also
92       the ENVIRONMENT section.
93

SEE ALSO

95       pip(1)
96
97       python(1)
98
99       pipx-completions(1),   pipx-ensurepath(1),   pipx-inject(1),   pipx-in‐
100       stall(1),   pipx-list(1),   pipx-reinstall(1),   pipx-reinstall-all(1),
101       pipx-run(1),  pipx-runpip(1), pipx-uninstall(1), pipx-uninstall-all(1),
102       pipx-upgrade(1), pipx-upgrade-all(1)
103
104
105
106                                  April 2021                           PIPX(1)
Impressum