pipx-install - Man Page

install a package

Synopsis

pipx install [-h] [--include-deps] [--verbose] [--force] [--suffix SUFFIX] [--python PYTHON] [--system-site-packages] [--index-url INDEX_URL] [--editable] [--pip-args PIP_ARGS] package_spec

Description

The install command is the preferred way to globally install apps from python packages on your system. It creates an isolated virtual environment for the package, then ensures the package’s apps are accessible on your $PATH.

The result: apps you can run from anywhere, located in packages you can cleanly upgrade or uninstall. Guaranteed to not have dependency version conflicts or interfere with your OS’s python packages. sudo(8) is not required to do this.

The package_spec argument is passed directly to pip install.

Options

Positional Arguments

package_spec

Package name or pip(1) installation spec

Optional Arguments

-h,  --help

Show a help message and exit

--include-deps

Include apps of dependent packages

--verbose
--force,  -f

Modify existing virtual environment and files in PIPX_BIN_DIR

--suffix SUFFIX

Optional suffix for virtual environment and executable names.

NOTE: The suffix feature is experimental and subject to change.

--python PYTHON

The Python executable used to create the virtual environment and run the associated app/apps. Must be v3.5+.

--system-site-packages

Give the virtual environment access to the system site-packages dir.

--index-url INDEX_URL, -i INDEX_URL

Base URL of Python Package Index

--editable,  -e

Install a project in editable mode

--pip-args PIP_ARGS

Arbitrary pip(1) arguments to pass directly to pip-install(1)/upgrade commands

Environment

PIPX_HOME

The default virtual environment location is $HOME/.local/pipx and can be overridden by setting the environment variable PIPX_HOME (Virtual environments will be installed to $PIPX_HOME/venvs).

PIPX_BIN_DIR

The default app location is $HOME/.local/bin and can be overridden by setting the environment variable PIPX_BIN_DIR.

PIPX_DEFAULT_PYTHON

The default python executable used to install a package is /usr/bin/python3 and can be overridden by setting the environment variable PIPX_DEFAULT_PYTHON.

Files

See the Environment section.

Examples

pipx install PACKAGE_NAME
pipx install --python PYTHON PACKAGE_NAME
pipx install VCS_URL
pipx install ./LOCAL_PATH
pipx install ZIP_FILE
pipx install TAR_GZ_FILE

See Also

pip(1), pip-install(1)

python(1)

pipx(1), pipx-completions(1), pipx-ensurepath(1), pipx-inject(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(1), pipx-completions(1), pipx-ensurepath(1), pipx-inject(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).

April 2021