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

NAME

6       pipx run - download the latest version of a package to a temporary vir‐
7       tual environment, then run an app from it
8

SYNOPSIS

10       pipx run [-h]  [--no-cache]  [--pypackages]  [--spec SPEC]  [--verbose]
11       [--python PYTHON]    [--system-site-packages]   [--index-url INDEX_URL]
12       [--editable] [--pip-args PIP_ARGS] app ...
13

DESCRIPTION

15       Download the latest version of a package to a temporary  virtual  envi‐
16       ronment,  then  run an app from it.  The environment will be cached and
17       re-used for up to 14 days.  This means subsequent calls to  pipx-run(1)
18       for  the  same  package will be faster since they can re-use the cached
19       Virtual Environment.
20
21       In  support  of  PEP  582   ⟨https://www.python.org/dev/peps/pep-0582/⟩
22       pipx-run(1) will use apps found in a local __pypackages__ directory, if
23       present.  Please note that this behavior is experimental, and acts as a
24       companion  tool  to pythonloc(1).  It may be modified or removed in the
25       future.  See pythonloc ⟨https://github.com/cs01/pythonloc⟩.
26

OPTIONS

28   POSITIONAL ARGUMENTS
29       app ...
30              app/package name and any arguments to be passed to it
31
32   OPTIONAL ARGUMENTS
33       -h, --help
34              Show a help message and exit
35
36       --no-cache
37              Do not re-use cached virtual environment if it exists
38
39       --pypackages
40              Require app to be run from local __pypackages__ directory
41
42       --spec SPEC
43              The package name  or  specific  installation  source  passed  to
44              pip(1).   Runs  pip install -U SPEC.  For example --spec mypack‐
45              age==2.0.0 or --spec git+https://github.com/user/repo.git@branch
46
47       --verbose
48
49       --python PYTHON
50              The Python executable used to run package’s CLI app with.   Must
51              be  v3.5+.   --system-site-packages Give the virtual environment
52              access to the system site-packages dir.
53
54       --index-url INDEX_URL, -i INDEX_URL
55              Base URL of Python Package Index
56
57       --editable, -e
58              Install a project in editable mode
59
60       --pip-args PIP_ARGS
61              Arbitrary  pip(1)  arguments  to  pass   directly   to   pip-in‐
62              stall(1)/upgrade
63

SEE ALSO

65       pip(1), pip-install(1)
66
67       python(1)
68
69       pythonloc(1)
70
71       pipx(1),   pipx-completions(1),   pipx-ensurepath(1),  pipx-install(1),
72       pipx-inject(1), pipx-list(1), pipx-reinstall(1), pipx-reinstall-all(1),
73       pipx-runpip(1),   pipx-uninstall(1),   pipx-uninstall-all(1),  pipx-up‐
74       grade(1), pipx-upgrade-all(1)
75
76
77
78                                  April 2021                       PIPX-RUN(1)
Impressum