CheatPress

pipx Python app installer

Version 1.17.14 · source

pipx, Postcard, light preview Light · Postcard 102 × 152 mm · PDF pipx, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF pipx, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
pipx, A5, light preview Light · A5 148 × 210 mm · PDF pipx, A5, dark preview Dark · A5 148 × 210 mm · PDF pipx, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
pipx, A4, light preview Light · A4 210 × 297 mm · PDF pipx, A4, dark preview Dark · A4 210 × 297 mm · PDF pipx, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
pipx, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF pipx, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF pipx, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
pipx, A3, light preview Light · A3 297 × 420 mm · PDF pipx, A3, dark preview Dark · A3 297 × 420 mm · PDF pipx, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
pipx, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF pipx, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF pipx, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
pipx, Letter, light preview Light · Letter 8.5 × 11 in · PDF pipx, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF pipx, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
pipx, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF pipx, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF pipx, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

pipx install <package>
Install a tool
pipx run <package>
Run it once
pipx list
What is installed
pipx upgrade <package>
Update one tool
pipx upgrade-all
Update everything
pipx uninstall <package>
Remove a tool
pipx inject <package> <dep>
Add a library to it
pipx ensurepath
Fix PATH

Concepts

pipx manager
One venv per app ~/.local/share/pipx/venvs
App + its deps isolated
Command link ~/.local/bin

Install

pipx install <package>
Install an app in its own venv
pipx install <package> --python <python>
Pick the Python version
Accepts an interpreter name, a path or a version like 3.12.
pipx install "<package>[<extra>]"
Install with an extra
pipx install git+<url>
Install from a git repository
pipx install ./<path>
Install a local project
pipx install --editable ./<path>
Editable local install
pipx install --include-deps <package>
Also expose dependency commands
pipx install --suffix @<tag> <package>
Install a second copy side by side
pipx install --force <package>
Overwrite an existing install
pipx install --pip-args="--pre" <package>
Pass options to pip
pipx install --global <package>
Install for all users

Run without installing

pipx run <package>
Run an app in a temporary venv
pipx run <package> <args>
Pass arguments to the app
pipx run --spec "<package>==<version>" <command>
Run a specific version
pipx run --python <python> <package>
Run on a chosen Python
pipx run <script>.py
Run a script with its inline dependencies
Reads the PEP 723 dependency block at the top of the script.
pipx run git+<url>
Run straight from git

Manage

pipx list
Show installed apps and versions
pipx list --short
One line per app
pipx upgrade <package>
Upgrade one app
pipx upgrade-all
Upgrade every app
pipx uninstall <package>
Remove an app and its venv
pipx uninstall-all
Remove every app
pipx reinstall <package>
Rebuild the venv
Use after the system Python changed or was removed.
pipx reinstall-all
Rebuild every venv
pipx upgrade --include-injected <package>
Upgrade injected libraries too

Inject and pin

pipx inject <package> <dep>
Add a library to an app's venv
pipx inject <package> -r <file>
Inject from a requirements file
pipx uninject <package> <dep>
Remove an injected library
pipx runpip <package> <pip-args>
Run pip inside an app's venv
pipx pin <package>
Block upgrades of an app
pipx unpin <package>
Allow upgrades again

Setup and environment

pipx ensurepath
Put the app directory on PATH
Open a new terminal afterwards.
python3 -m pip install --user pipx
Install pipx itself
pipx upgrade pipx
Update a self-installed pipx
pipx environment
Show paths and settings
pipx environment --value <name>
Print one value
pipx list --output json > <file>
Export installed apps
pipx install-all <file>
Restore apps from an export
pipx interpreter list
List pipx-managed Pythons
pipx completions
Show how to enable completion
Environment variables
Variable Default
PIPX_HOME ~/.local/share/pipx
PIPX_BIN_DIR ~/.local/bin
PIPX_DEFAULT_PYTHON Python running pipx
PIPX_GLOBAL_HOME /opt/pipx

Recipes

First setup on Ubuntu
sudo apt install pipxpipx ensurepath# open a new terminalpipx install black
Ansible with extra modules
pipx install --include-deps ansiblepipx inject ansible <extra-package>
Move tools to a new Python
pipx reinstall-all --python python3.13
Keep two versions
pipx install --suffix @1 "<package>==1.*"pipx install --suffix @2 "<package>==2.*"<command>@1 --version