.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.3 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "PIP-INSTALL" "1" "Feb 05, 2026" "26.0" "pip"
.SH NAME
pip-install \- description of pip install command
.SH DESCRIPTION
.sp
Install packages from:
.INDENT 0.0
.IP \(bu 2
PyPI (and other indexes) using requirement specifiers.
.IP \(bu 2
VCS project urls.
.IP \(bu 2
Local project directories.
.IP \(bu 2
Local or remote source archives.
.UNINDENT
.sp
pip also supports installing from \(dqrequirements files\(dq, which provide
an easy way to specify a whole environment to be installed.

.SH USAGE
.INDENT 0.0
.INDENT 3.5
.sp
.EX
python \-m pip install [options] <requirement specifier> [package\-index\-options] ...
python \-m pip install [options] \-r <requirements file> [package\-index\-options] ...
python \-m pip install [options] [\-e] <vcs project url> ...
python \-m pip install [options] [\-e] <local project path> ...
python \-m pip install [options] <archive url/path> ...
.EE
.UNINDENT
.UNINDENT
.SH OPTIONS
.sp
.INDENT 0.0
.TP
.B \-r, \-\-requirement <file>
Install from the given requirements file. This option can be used multiple times.
.sp
(environment variable: \fBPIP_REQUIREMENT\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-c, \-\-constraint <file>
Constrain versions using the given constraints file. This option can be used multiple times.
.sp
(environment variable: \fBPIP_CONSTRAINT\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-build\-constraint <file>
Constrain build dependencies using the given constraints file. This option can be used multiple times.
.sp
(environment variable: \fBPIP_BUILD_CONSTRAINT\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-requirements\-from\-script <file>
Install dependencies of the given script fileas defined by PEP 723 inline metadata.
.sp
(environment variable: \fBPIP_REQUIREMENTS_FROM_SCRIPT\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-deps
Don\(aqt install package dependencies.
.sp
(environment variable: \fBPIP_NO_DEPS\fP, \fBPIP_NO_DEPENDENCIES\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-e, \-\-editable <path/url>
Install a project in editable mode (i.e. setuptools \(dqdevelop mode\(dq) from a local project path or a VCS url.
.sp
(environment variable: \fBPIP_EDITABLE\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-dry\-run
Don\(aqt actually install anything, just print what would be. Can be used in combination with \-\-ignore\-installed to \(aqresolve\(aq the requirements.
.sp
(environment variable: \fBPIP_DRY_RUN\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-t, \-\-target <dir>
Install packages into <dir>. By default this will not replace existing files/folders in <dir>. Use \-\-upgrade to replace existing packages in <dir> with new versions.
.sp
(environment variable: \fBPIP_TARGET\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-platform <platform>
Only use wheels compatible with <platform>. Defaults to the platform of the running system. Use this option multiple times to specify multiple platforms supported by the target interpreter.
.sp
(environment variable: \fBPIP_PLATFORM\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-python\-version <python_version>
The Python interpreter version to use for wheel and \(dqRequires\-Python\(dq
compatibility checks. Defaults to a version derived from the running
interpreter. The version can be specified using up to three dot\-separated
integers (e.g. \(dq3\(dq for 3.0.0, \(dq3.7\(dq for 3.7.0, or \(dq3.7.3\(dq). A major\-minor
version can also be given as a string without dots (e.g. \(dq37\(dq for 3.7.0).
.sp
(environment variable: \fBPIP_PYTHON_VERSION\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-implementation <implementation>
Only use wheels compatible with Python implementation <implementation>, e.g. \(aqpp\(aq, \(aqjy\(aq, \(aqcp\(aq,  or \(aqip\(aq. If not specified, then the current interpreter implementation is used.  Use \(aqpy\(aq to force implementation\-agnostic wheels.
.sp
(environment variable: \fBPIP_IMPLEMENTATION\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-abi <abi>
Only use wheels compatible with Python abi <abi>, e.g. \(aqpypy_41\(aq. If not specified, then the current interpreter abi tag is used. Use this option multiple times to specify multiple abis supported by the target interpreter. Generally you will need to specify \-\-implementation, \-\-platform, and \-\-python\-version when using this option.
.sp
(environment variable: \fBPIP_ABI\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-user
Install to the Python user install directory for your platform. Typically ~/.local/, or %APPDATA%Python on Windows. (See the Python documentation for site.USER_BASE for full details.)
.sp
(environment variable: \fBPIP_USER\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-root <dir>
Install everything relative to this alternate root directory.
.sp
(environment variable: \fBPIP_ROOT\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-prefix <dir>
Installation prefix where lib, bin and other top\-level folders are placed. Note that the resulting installation may contain scripts and other resources which reference the Python interpreter of pip, and not that of \fB\-\-prefix\fP\&. See also the \fB\-\-python\fP option if the intention is to install packages into another (possibly pip\-free) environment.
.sp
(environment variable: \fBPIP_PREFIX\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-src <dir>
Directory to check out editable projects into. The default in a virtualenv is \(dq<venv path>/src\(dq. The default for global installs is \(dq<current dir>/src\(dq.
.sp
(environment variable: \fBPIP_SRC\fP, \fBPIP_SOURCE\fP, \fBPIP_SOURCE_DIR\fP, \fBPIP_SOURCE_DIRECTORY\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-U, \-\-upgrade
Upgrade all specified packages to the newest available version. The handling of dependencies depends on the upgrade\-strategy used.
.sp
(environment variable: \fBPIP_UPGRADE\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-upgrade\-strategy <upgrade_strategy>
Determines how dependency upgrading should be handled [default: only\-if\-needed]. \(dqeager\(dq \- dependencies are upgraded regardless of whether the currently installed version satisfies the requirements of the upgraded package(s). \(dqonly\-if\-needed\(dq \-  are upgraded only when they do not satisfy the requirements of the upgraded package(s).
.sp
(environment variable: \fBPIP_UPGRADE_STRATEGY\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-force\-reinstall
Reinstall all packages even if they are already up\-to\-date.
.sp
(environment variable: \fBPIP_FORCE_REINSTALL\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-I, \-\-ignore\-installed
Ignore the installed packages, overwriting them. This can break your system if the existing package is of a different version or was installed with a different package manager!
.sp
(environment variable: \fBPIP_IGNORE_INSTALLED\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ignore\-requires\-python
Ignore the Requires\-Python information.
.sp
(environment variable: \fBPIP_IGNORE_REQUIRES_PYTHON\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-build\-isolation
Disable isolation when building a modern source distribution. Build dependencies specified by PEP 518 must be already installed if this option is used.
.sp
(environment variable: \fBPIP_NO_BUILD_ISOLATION\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-check\-build\-dependencies
Check the build dependencies.
.sp
(environment variable: \fBPIP_CHECK_BUILD_DEPENDENCIES\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-break\-system\-packages
Allow pip to modify an EXTERNALLY\-MANAGED Python installation
.sp
(environment variable: \fBPIP_BREAK_SYSTEM_PACKAGES\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-C, \-\-config\-settings <settings>
Configuration settings to be passed to the build backend. Settings take the form KEY=VALUE. Use multiple \-\-config\-settings options to pass multiple keys to the backend.
.sp
(environment variable: \fBPIP_CONFIG_SETTINGS\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-compile
Compile Python source files to bytecode
.sp
(environment variable: \fBPIP_COMPILE\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-compile
Do not compile Python source files to bytecode
.sp
(environment variable: \fBPIP_NO_COMPILE\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-warn\-script\-location
Do not warn when installing scripts outside PATH
.sp
(environment variable: \fBPIP_NO_WARN_SCRIPT_LOCATION\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-warn\-conflicts
Do not warn about broken dependencies
.sp
(environment variable: \fBPIP_NO_WARN_CONFLICTS\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-require\-hashes
Require a hash to check each requirement against, for repeatable installs. This option is implied when any package in a requirements file has a \-\-hash option.
.sp
(environment variable: \fBPIP_REQUIRE_HASHES\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-progress\-bar <progress_bar>
Specify whether the progress bar should be used. In \(aqauto\(aq mode, \-\-quiet will suppress all progress bars. [auto, on, off, raw] (default: auto)
.sp
(environment variable: \fBPIP_PROGRESS_BAR\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-root\-user\-action <root_user_action>
Action if pip is run as a root user [warn, ignore] (default: warn)
.sp
(environment variable: \fBPIP_ROOT_USER_ACTION\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-report <file>
Generate a JSON file describing what pip did to install the provided requirements. Can be used in combination with \-\-dry\-run and \-\-ignore\-installed to \(aqresolve\(aq the requirements. When \- is used as file name it writes to stdout. When writing to stdout, please combine with the \-\-quiet option to avoid mixing pip logging output with JSON output.
.sp
(environment variable: \fBPIP_REPORT\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-group <[path:]group>
Install a named dependency\-group from a \(dqpyproject.toml\(dq file. If a path is given, the name of the file must be \(dqpyproject.toml\(dq. Defaults to using \(dqpyproject.toml\(dq in the current directory.
.sp
(environment variable: \fBPIP_GROUP\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-clean
Don\(aqt clean up build directories.
.sp
(environment variable: \fBPIP_NO_CLEAN\fP)
.UNINDENT

.SH Author
pip developers
.SH Copyright
The pip developers
.\" End of generated man page.