{
"name": "pipx",
"description": "Install and Run Python Applications in Isolated Environments",
"subcommands": [
{
"name": "install",
"description": "Install a package",
"options": [
{
"names": [
"--include-deps"
],
"description": "Include apps of dependent packages"
},
{
"names": [
"--force"
],
"description": "Modify existing virtual environment and files in PIPX_BIN_DIR"
},
{
"names": [
"--suffix"
],
"description": "Optional suffix for virtual environment and executable names",
"takes_arg": true,
"arg": {
"name": "SUFFIX"
}
},
{
"names": [
"--python"
],
"description": "The Python executable used to create the Virtual Environment and run the associated app/apps. Must be v3.6+",
"takes_arg": true,
"arg": {
"name": "PYTHON"
}
},
{
"names": [
"--system-site-packages"
],
"description": "Give the virtual environment access to the system site-packages dir"
},
{
"names": [
"--index-url",
"-i"
],
"description": "Base URL of Python Package Index",
"takes_arg": true,
"arg": {
"name": "INDEX_URL"
}
},
{
"names": [
"--editable",
"-e"
],
"description": "Install a project in editable mode"
},
{
"names": [
"--pip-args"
],
"description": "Arbitrary pip arguments to pass directly to pip install/upgrade commands",
"takes_arg": true,
"arg": {
"name": "PIP_ARGS"
}
},
{
"names": [
"--verbose"
],
"description": "Show verbose output"
}
],
"args": [
{
"name": "package_spec",
"description": "Package name or pip installation spec"
}
]
},
{
"name": "inject",
"description": "Installs packages to an existing pipx-managed virtual environment",
"options": [
{
"names": [
"--include-apps"
],
"description": "Add apps from the injected packages onto your PATH"
},
{
"names": [
"--include-deps"
],
"description": "Include apps of dependent packages"
},
{
"names": [
"--system-site-packages"
],
"description": "Give the virtual environment access to the system site-packages dir"
},
{
"names": [
"--index-url",
"-i"
],
"description": "Base URL of Python Package Index",
"takes_arg": true,
"arg": {
"name": "INDEX_URL"
}
},
{
"names": [
"--editable",
"-e"
],
"description": "Install a project in editable mode"
},
{
"names": [
"--pip-args"
],
"description": "Arbitrary pip arguments to pass directly to pip install/upgrade commands",
"takes_arg": true,
"arg": {
"name": "PIP_ARGS"
}
},
{
"names": [
"--force",
"-f"
],
"description": "Modify existing virtual environment and files in PIPX_BIN_DIR"
},
{
"names": [
"--verbose"
],
"description": "Show verbose output"
}
],
"args": [
{
"name": "package",
"description": "Name of the existing pipx-managed Virtual Environment to inject into"
},
{
"name": "dependencies",
"description": "The packages to inject into the Virtual Environment--either package name or pip package spec"
}
]
},
{
"name": "upgrade",
"description": "Upgrade a package in a pipx-managed Virtual Environment by running 'pip install --upgrade PACKAGE'",
"options": [
{
"names": [
"--include-injected"
],
"description": "Also upgrade packages injected into the main app's environment"
},
{
"names": [
"--force",
"-f"
],
"description": "Modify existing virtual environment and files in PIPX_BIN_DIR"
},
{
"names": [
"--system-site-packages"
],
"description": "Give the virtual environment access to the system site-packages dir"
},
{
"names": [
"--index-url",
"-i"
],
"description": "Base URL of Python Package Index",
"takes_arg": true,
"arg": {
"name": "INDEX_URL"
}
},
{
"names": [
"--editable",
"-e"
],
"description": "Install a project in editable mode"
},
{
"names": [
"--pip-args"
],
"description": "Arbitrary pip arguments to pass directly to pip install/upgrade commands",
"takes_arg": true,
"arg": {
"name": "PIP_ARGS"
}
},
{
"names": [
"--verbose"
],
"description": "Show verbose output"
}
],
"args": [
{
"name": "package"
}
]
},
{
"name": "upgrade-all",
"description": "Upgrades all packages within their virtual environments by running 'pip install --upgrade PACKAGE'",
"options": [
{
"names": [
"--include-injected"
],
"description": "Also upgrade packages injected into the main app's environment"
},
{
"names": [
"--skip"
],
"description": "Skip these packages",
"takes_arg": true,
"arg": {
"name": "packages to skip",
"is_variadic": true
}
},
{
"names": [
"--force",
"-f"
],
"description": "Modify existing virtual environment and files in PIPX_BIN_DIR"
},
{
"names": [
"--verbose"
],
"description": "Show verbose output"
}
]
},
{
"name": "uninstall",
"description": "Uninstalls a pipx-managed Virtual Environment by deleting it and any files that point to its apps",
"options": [
{
"names": [
"--verbose"
],
"description": "Show verbose output"
}
],
"args": [
{
"name": "package"
}
]
},
{
"name": "uninstall-all",
"description": "Uninstall all pipx-managed packages",
"options": [
{
"names": [
"--verbose"
],
"description": "Show verbose output"
}
]
},
{
"name": "reinstall",
"description": "Reinstalls a package",
"options": [
{
"names": [
"--python"
],
"description": "The Python executable used to recreate the Virtual Environment and run the associated app/apps. Must be v3.6+",
"takes_arg": true,
"arg": {
"name": "PYTHON"
}
},
{
"names": [
"--verbose"
],
"description": "Show verbose output"
}
],
"args": [
{
"name": "package"
}
]
},
{
"name": "reinstall-all",
"description": "Reinstalls all packages",
"options": [
{
"names": [
"--python"
],
"description": "The Python executable used to recreate the Virtual Environment and run the associated app/apps. Must be v3.6+",
"takes_arg": true,
"arg": {
"name": "PYTHON"
}
},
{
"names": [
"--skip"
],
"description": "Skip these packages",
"takes_arg": true,
"arg": {
"name": "packages to skip",
"is_variadic": true
}
},
{
"names": [
"--verbose"
],
"description": "Show verbose output"
}
]
},
{
"name": "list",
"description": "List packages and apps installed with pipx",
"options": [
{
"names": [
"--include-injected"
],
"description": "Show packages injected into the main app's environment"
},
{
"names": [
"--json"
],
"description": "Output rich data in json format"
},
{
"names": [
"--short"
],
"description": "List packages only"
},
{
"names": [
"--verbose"
],
"description": "Show verbose output"
}
]
},
{
"name": "run",
"description": "Download the latest version of a package to a temporary virtual environment, then run an app from it",
"options": [
{
"names": [
"--no-cache"
],
"description": "Do not re-use cached virtual environment if it exists"
},
{
"names": [
"--pypackages"
],
"description": "Require app to be run from local __pypackages__ directory"
},
{
"names": [
"--spec"
],
"description": "The package name or specific installation source passed to pip",
"takes_arg": true,
"arg": {
"name": "SPEC"
}
},
{
"names": [
"--python"
],
"description": "The Python version to run package's CLI app with",
"takes_arg": true,
"arg": {
"name": "PYTHON"
}
},
{
"names": [
"--system-site-packages"
],
"description": "Give the virtual environment access to the system site-packages dir"
},
{
"names": [
"--index-url",
"-i"
],
"description": "Base URL of Python Package Index",
"takes_arg": true,
"arg": {
"name": "INDEX_URL"
}
},
{
"names": [
"--editable",
"-e"
],
"description": "Install a project in editable mode"
},
{
"names": [
"--pip-args"
],
"description": "Arbitrary pip arguments to pass directly to pip install/upgrade commands",
"takes_arg": true,
"arg": {
"name": "PIP_ARGS"
}
},
{
"names": [
"--verbose"
],
"description": "Show verbose output"
}
],
"args": [
{
"name": "app",
"description": "App/package name and any arguments to be passed to it",
"is_variadic": true
}
]
},
{
"name": "runpip",
"description": "Run pip in an existing pipx-managed Virtual Environment",
"options": [
{
"names": [
"--verbose"
],
"description": "Show verbose output"
}
],
"args": [
{
"name": "package",
"description": "Name of the existing pipx-managed Virtual Environment to run pip in"
},
{
"name": "pipargs",
"description": "Arguments to forward to pip command",
"is_variadic": true
}
]
},
{
"name": "ensurepath",
"description": "Ensure directory where pipx stores apps is in your PATH environment variable",
"options": [
{
"names": [
"--force",
"-f"
],
"description": "Add text to your shell's config file even if it looks like your PATH already contains paths to pipx and pipx-install apps"
}
]
},
{
"name": "environment",
"description": "Print a list of variables used in pipx.constants",
"options": [
{
"names": [
"--value"
],
"description": "Print the value of the variable",
"takes_arg": true,
"arg": {
"name": "VARIABLE",
"suggestions": [
"PIPX_HOME",
"PIPX_BIN_DIR",
"PIPX_SHARED_LIBS",
"PIPX_LOCAL_VENVS",
"PIPX_LOG_DIR",
"PIPX_TRASH_DIR",
"PIPX_VENV_CACHEDIR"
]
}
}
]
},
{
"name": "completions",
"description": "Print instructions on enabling shell completions for pipx"
}
],
"options": [
{
"names": [
"--help",
"-h"
],
"description": "Show help for pipx"
}
]
}