.TH PIPX "1" "April 2021" "" "User Commands"
.SH NAME
pipx \- install and execute apps from Python packages
.SH SYNOPSIS
.B pipx
.RB [ \-h ]
.RB [ \-\-version ]
.I SUBCOMMAND
.RI [ OPTION ]...\:
.SH DESCRIPTION
Binaries can either be installed globally into isolated virtual environments
or run directly in a temporary virtual environment.
.SH OPTIONS
.SS "OPTIONAL\ ARGUMENTS"
.TP
.B \-h, \-\-help
Show a help message and exit
.TP
.B \-\-version
Print version and exit
.SH SUBCOMMANDS
.P
Each of the following has a corresponding man page: for example,
.BR pipx\-install (1)
for
.RB \(lq pipx\ install \(rq.
Or, get help for commands with
.B pipx\ \fICOMMAND\fB\ \-\-help\fR.
.TP
.B pipx\ install
Install a package
.TP
.B pipx\ inject
Install packages into an existing virtual environment
.TP
.B pipx\ upgrade
Upgrade a package
.TP
.B pipx\ upgrade\-all
Upgrade all packages.
Runs
.B pip\ install\ \-U\ \fIpkgname
for each package.
.TP
.B pipx\ uninstall
Uninstall a package
.TP
.B pipx\ uninstall\-all
Uninstall all packages
.TP
.B pipx\ reinstall
Reinstall a package
.TP
.B pipx\ reinstall\-all
Reinstall all packages
.TP
.B pipx\ list
List installed packages
.TP
.B pipx\ run
Download the latest version of a package to a temporary virtual environment,
then run an app from it.
Also compatible with local
.B __pypackages__
directory
.RI ( experimental ).
.TP
.B pipx\ runpip
Run pip in an existing
.BR pipx (1)-managed
virtual environment
.TP
.B pipx\ ensurepath
Ensure directories necessary for
.BR pipx (1)
operation are in your
.B PATH
environment variable.
.TP
.B pipx\ completions
Print instructions on enabling shell completions for
.BR pipx (1)
.SH ENVIRONMENT
Optional environment variables:
.TP
.B PIPX_HOME
Overrides default
.BR pipx (1)
location.
Virtual environments will be installed to
.IB $PIPX_HOME /venvs\fR.
.TP
.B PIPX_BIN_DIR
Overrides location of app installations.
Apps are symlinked or copied here.
.TP
.B USE_EMOJI
Overrides emoji behavior.
Default value varies based on platform.
.TP
.B PIPX_DEFAULT_PYTHON
Overrides default python used for commands.
.SH FILES
Virtual environment location is
.IB $HOME /.local/pipx/venvs
by default.
Symlinks to apps are placed in
.IB $HOME /.local/bin
by default.
See also the
.B ENVIRONMENT
section.
.SH "SEE\ ALSO"
.BR pip (1)
.P
.BR python (1)
.P
.BR pipx\-completions (1),
.BR pipx\-ensurepath (1),
.BR pipx\-inject (1),
.BR pipx\-install (1),
.BR pipx\-list (1),
.BR pipx\-reinstall (1),
.BR pipx\-reinstall\-all (1),
.BR pipx\-run (1),
.BR pipx\-runpip (1),
.BR pipx\-uninstall (1),
.BR pipx\-uninstall\-all (1),
.BR pipx\-upgrade (1),
.BR pipx\-upgrade\-all (1)