Environment variables¶
pipx has no user configuration file. Every setting is an environment variable, all of them optional. Run pipx
environment to print the resolved value of each one on your system.
Settable variables¶
Variable |
Meaning and default |
|---|---|
|
Root directory for pipx virtual environments. Default: |
|
Directory for application entry-point symlinks. Default: |
|
Directory for man page symlinks. Default: |
|
Directory for shell completion symlinks. Default: |
|
Root directory for global ( |
|
Entry-point directory for global installs. Default: |
|
Man page directory for global installs. Default: |
|
Shell completion directory for global installs. Default: |
|
Override the shared libraries directory. Default: |
|
Python interpreter used when |
|
Backend for new venvs, |
|
When to fetch a standalone Python build: |
|
Deprecated alias for |
|
Set to a truthy value to skip automatic shared library upgrades. Default: unset. |
|
Set to a falsy value to disable emoji output. Default: enabled when the terminal encoding supports the emoji glyphs. |
|
Number of log files to keep in the log directory. Default: |
Note
USE_EMOJI (unprefixed) is honored as a fallback when PIPX_USE_EMOJI is unset.
Note
pipx forwards the standard PIP_* environment variables (for example PIP_INDEX_URL) to pip. See
Troubleshoot if pip behaves unexpectedly.
Legacy fallback home¶
If a legacy home directory already exists on disk, pipx keeps its virtual environments there instead of the
PIPX_HOME default: ~/.local/pipx on any platform, and ~\pipx on Windows. These are used only when present
and when PIPX_HOME is unset. See Configure paths to migrate off them.
On Unix, a pipx installation that manages itself recovers PIPX_HOME, PIPX_BIN_DIR, and PIPX_DEFAULT_PYTHON
from its own virtual environment when those variables are unset, so later shells stay attached to the same
installation.
Derived (read-only) values¶
pipx environment also reports the following values. pipx computes them from the settable variables and the
platform; they are reported, not set.
Value |
Meaning |
|---|---|
|
Directory holding the per-package virtual environments ( |
|
Directory holding command logs. |
|
Staging directory for deletions on the same filesystem as the venvs. |
|
Cache directory for |
|
Cache directory for downloaded standalone Python builds. |
|
Backend pipx resolved for new venvs ( |
|
Where the resolved backend came from (CLI flag, environment, or auto-detection). |
|
Path to the uv binary pipx would use, or empty when none is found. |
|
Value of |