pipx - Man Page
install and execute apps from Python packages
Examples (TL;DR)
- Run an app in a temporary virtual environment:
pipx run pycowsay moo - Install a package in a virtual environment and add entry points to path:
pipx install package - List installed packages:
pipx list - Run an app in a temporary virtual environment with a package name different from the executable:
pipx run --spec httpx-cli httpx http://www.github.com
Synopsis
Description
Binaries can either be installed globally into isolated virtual environments or run directly in a temporary virtual environment.
Options
Optional Arguments
- -h, --help
Show a help message and exit
- --version
Print version and exit
Subcommands
Each of the following has a corresponding man page: for example, pipx-install(1) for “pipx install”. Or, get help for commands with pipx COMMAND --help.
- pipx install
Install a package
- pipx inject
Install packages into an existing virtual environment
- pipx upgrade
Upgrade a package
- pipx upgrade-all
Upgrade all packages. Runs pip install -U pkgname for each package.
- pipx uninstall
Uninstall a package
- pipx uninstall-all
Uninstall all packages
- pipx reinstall
Reinstall a package
- pipx reinstall-all
Reinstall all packages
- pipx list
List installed packages
- pipx run
Download the latest version of a package to a temporary virtual environment, then run an app from it. Also compatible with local __pypackages__ directory (experimental).
- pipx runpip
Run pip in an existing pipx(1)-managed virtual environment
- pipx ensurepath
Ensure directories necessary for pipx(1) operation are in your PATH environment variable.
- pipx completions
Print instructions on enabling shell completions for pipx(1)
Environment
Optional environment variables:
- PIPX_HOME
Overrides default pipx(1) location. Virtual environments will be installed to $PIPX_HOME/venvs.
- PIPX_BIN_DIR
Overrides location of app installations. Apps are symlinked or copied here.
- USE_EMOJI
Overrides emoji behavior. Default value varies based on platform.
- PIPX_DEFAULT_PYTHON
Overrides default python used for commands.
Files
Virtual environment location is $HOME/.local/pipx/venvs by default. Symlinks to apps are placed in $HOME/.local/bin by default. See also the Environment section.
See Also
pipx-completions(1), pipx-ensurepath(1), pipx-inject(1), pipx-install(1), pipx-list(1), pipx-reinstall(1), pipx-reinstall-all(1), pipx-run(1), pipx-runpip(1), pipx-uninstall(1), pipx-uninstall-all(1), pipx-upgrade(1), pipx-upgrade-all(1)
Referenced By
pipx-completions(1), pipx-ensurepath(1), pipx-inject(1), pipx-install(1), pipx-list(1), pipx-reinstall(1), pipx-reinstall-all(1), pipx-run(1), pipx-runpip(1), pipx-uninstall(1), pipx-uninstall-all(1), pipx-upgrade(1), pipx-upgrade-all(1).