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

NAME

6       pipx install - install a package
7

SYNOPSIS

9       pipx install [-h] [--include-deps] [--verbose] [--force] [--suffix SUF‐
10       FIX] [--python PYTHON] [--system-site-packages] [--index-url INDEX_URL]
11       [--editable] [--pip-args PIP_ARGS] package_spec
12

DESCRIPTION

14       The  install command is the preferred way to globally install apps from
15       python packages on your system.  It creates an isolated  virtual  envi‐
16       ronment for the package, then ensures the package’s apps are accessible
17       on your $PATH.
18
19       The result: apps you can run from anywhere, located in packages you can
20       cleanly  upgrade  or uninstall.  Guaranteed to not have dependency ver‐
21       sion conflicts or interfere with your OS’s python packages.  sudo(8) is
22       not required to do this.
23
24       The package_spec argument is passed directly to pip install.
25

OPTIONS

27   POSITIONAL ARGUMENTS
28       package_spec
29              Package name or pip(1) installation spec
30
31   OPTIONAL ARGUMENTS
32       -h, --help
33              Show a help message and exit
34
35       --include-deps
36              Include apps of dependent packages
37
38       --verbose
39
40       --force, -f
41              Modify existing virtual environment and files in PIPX_BIN_DIR
42
43       --suffix SUFFIX
44              Optional suffix for virtual environment and executable names.
45
46              NOTE: The suffix feature is experimental and subject to change.
47
48       --python PYTHON
49              The Python executable used to create the virtual environment and
50              run the associated app/apps.  Must be v3.5+.
51
52       --system-site-packages
53              Give the virtual environment access to the system  site-packages
54              dir.
55
56       --index-url INDEX_URL, -i INDEX_URL
57              Base URL of Python Package Index
58
59       --editable, -e
60              Install a project in editable mode
61
62       --pip-args PIP_ARGS
63              Arbitrary   pip(1)   arguments   to  pass  directly  to  pip-in‐
64              stall(1)/upgrade commands
65

ENVIRONMENT

67       PIPX_HOME
68              The default virtual environment  location  is  $HOME/.local/pipx
69              and  can  be  overridden  by  setting  the  environment variable
70              PIPX_HOME   (Virtual   environments   will   be   installed   to
71              $PIPX_HOME/venvs).
72
73       PIPX_BIN_DIR
74              The default app location is $HOME/.local/bin and can be overrid‐
75              den by setting the environment variable PIPX_BIN_DIR.
76
77       PIPX_DEFAULT_PYTHON
78              The default python executable  used  to  install  a  package  is
79              /usr/bin/python3  and  can be overridden by setting the environ‐
80              ment variable PIPX_DEFAULT_PYTHON.
81

FILES

83       See the ENVIRONMENT section.
84

EXAMPLES

86           pipx install PACKAGE_NAME
87           pipx install --python PYTHON PACKAGE_NAME
88           pipx install VCS_URL
89           pipx install ./LOCAL_PATH
90           pipx install ZIP_FILE
91           pipx install TAR_GZ_FILE
92

SEE ALSO

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