pipx-run - Man Page

download the latest version of a package to a temporary virtual environment, then run an app from it

Synopsis

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

Description

Download the latest version of a package to a temporary virtual environment, then run an app from it. The environment will be cached and re-used for up to 14 days. This means subsequent calls to pipx-run(1) for the same package will be faster since they can re-use the cached Virtual Environment.

In support of PEP 582 pipx-run(1) will use apps found in a local __pypackages__ directory, if present. Please note that this behavior is experimental, and acts as a companion tool to pythonloc(1). It may be modified or removed in the future. See pythonloc.

Options

Positional Arguments

app ...

app/package name and any arguments to be passed to it

Optional Arguments

-h,  --help

Show a help message and exit

--no-cache

Do not re-use cached virtual environment if it exists

--pypackages

Require app to be run from local __pypackages__ directory

--spec SPEC

The package name or specific installation source passed to pip(1). Runs pip install -U SPEC. For example --spec mypackage==2.0.0 or --spec git+https://github.com/user/repo.git@branch

--verbose
--python PYTHON

The Python executable used to run package’s CLI app with. 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

See Also

pip(1), pip-install(1)

python(1)

pythonloc(1)

pipx(1), pipx-completions(1), pipx-ensurepath(1), pipx-install(1), pipx-inject(1), pipx-list(1), pipx-reinstall(1), pipx-reinstall-all(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-install(1), pipx-list(1), pipx-reinstall(1), pipx-reinstall-all(1), pipx-runpip(1), pipx-uninstall(1), pipx-uninstall-all(1), pipx-upgrade(1), pipx-upgrade-all(1).

April 2021