<!doctype html>
<html class="no-js" lang="en" data-content_root="../">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="search" title="Search" href="../search.html" /><link rel="copyright" title="Copyright" href="../copyright.html" /><link rel="next" title="pip install" href="pip_install.html" /><link rel="prev" title="Commands" href="index.html" />
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>pip - pip documentation v25.1.1</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=ad9e2e31" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/tabs.css?v=4c969af8" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=4aa03575" />
<style>
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
<title>Auto light/dark, in light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
<circle cx="14.5" cy="9.55" r="3.6"/>
</svg>
</symbol>
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
<title>Auto light/dark, in dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
</svg>
</symbol>
<symbol id="svg-pencil" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
<path d="M13.5 6.5l4 4" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
<symbol id="svg-eye" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
<path
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="../index.html"><div class="brand">pip documentation v25.1.1</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
<span class="sidebar-brand-text">pip documentation v25.1.1</span>
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../getting-started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user_guide.html">User Guide</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../topics/index.html">Topic Guides</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Topic Guides</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../topics/authentication.html">Authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="../topics/caching.html">Caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="../topics/configuration.html">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../topics/dependency-resolution.html">Dependency Resolution</a></li>
<li class="toctree-l2"><a class="reference internal" href="../topics/more-dependency-resolution.html">More on Dependency Resolution</a></li>
<li class="toctree-l2"><a class="reference internal" href="../topics/https-certificates.html">HTTPS Certificates</a></li>
<li class="toctree-l2"><a class="reference internal" href="../topics/local-project-installs.html">Local project installs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../topics/repeatable-installs.html">Repeatable Installs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../topics/secure-installs.html">Secure installs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../topics/vcs-support.html">VCS Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="../topics/python-option.html">Managing a different Python interpreter</a></li>
<li class="toctree-l2"><a class="reference internal" href="../topics/workflow.html">Pip is not a workflow management tool</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/index.html">Reference</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="../reference/build-system/index.html">Build System Interface</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Build System Interface</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/build-system/pyproject-toml.html"><code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/build-system/setup-py.html"><code class="docutils literal notranslate"><span class="pre">setup.py</span></code> (legacy)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/requirement-specifiers.html">Requirement Specifiers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/requirements-file-format.html">Requirements File Format</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/installation-report.html">Installation Report</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/inspect-report.html"><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">inspect</span></code> JSON output specification</a></li>
</ul>
</li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">Commands</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of Commands</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_install.html">pip install</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_uninstall.html">pip uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_inspect.html">pip inspect</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_list.html">pip list</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_show.html">pip show</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_freeze.html">pip freeze</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_check.html">pip check</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_lock.html">pip lock</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_download.html">pip download</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_wheel.html">pip wheel</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_hash.html">pip hash</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_search.html">pip search</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_index.html">pip index</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_cache.html">pip cache</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_config.html">pip config</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_debug.html">pip debug</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Project</span></p>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../development/index.html">Development</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Development</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/getting-started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/contributing.html">Contributing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/ci.html">Continuous Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/issue-triage.html">Issue Triage</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../development/architecture/index.html">Architecture of pip’s internals</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Architecture of pip’s internals</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../development/architecture/overview.html">Broad functionality overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="../development/architecture/anatomy.html">Repository anatomy & directory structure</a></li>
<li class="toctree-l3"><a class="reference internal" href="../development/architecture/configuration-files.html">Configuration File Handling</a></li>
<li class="toctree-l3"><a class="reference internal" href="../development/architecture/package-finding.html">Finding and choosing files (<code class="docutils literal notranslate"><span class="pre">index</span></code> and <code class="docutils literal notranslate"><span class="pre">PackageFinder</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="../development/architecture/command-line-interface.html">Command Line Interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="../development/architecture/upgrade-options.html">Options that control the installation process</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../development/release-process.html">Release process</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/vendoring-policy.html">Vendoring Policy</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../ux-research-design/index.html">UX Research & Design</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of UX Research & Design</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../ux-research-design/contribute.html">How to Contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="../ux-research-design/guidance.html">UX Guidance</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../ux-research-design/research-results/index.html">UX Research Results</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of UX Research Results</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/about-our-users.html">About pip’s Users</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/mental-models.html">How Users Understand pip</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/users-and-security.html">How pip users think about security</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/ci-cd.html">How pip is used in interactive environments (i.e. CI, CD)</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/personas.html">pip Personas</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/prioritizing-features.html">Prioritizing pip Features</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/override-conflicting-dependencies.html">Providing an override to install packages with conflicting dependencies</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/pip-force-reinstall.html">pip --force-reinstall</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/pip-search.html">pip search</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/pip-upgrade-conflict.html">pip Upgrade Conflict</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/improving-pips-documentation.html">Improving pip’s Documentation</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../news.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md">Code of Conduct</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/pypa/pip">GitHub</a></li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="view-this-page">
<a class="muted-link" href="../_sources/cli/pip.rst.txt" title="View this page">
<svg><use href="#svg-eye"></use></svg>
<span class="visually-hidden">View this page</span>
</a>
</div>
<div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main" id="furo-main-content">
<section id="pip">
<h1>pip<a class="headerlink" href="#pip" title="Link to this heading">¶</a></h1>
<section id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">¶</a></h2>
<div class="tab-set docutils">
<input checked="True" class="tab-input" id="tab-set--0-input--1" name="tab-set--0" type="radio"><label class="tab-label" for="tab-set--0-input--1">Unix/macOS</label><div class="tab-content docutils">
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span><command><span class="w"> </span><span class="o">[</span>options<span class="o">]</span>
</pre></div>
</div>
</div>
<input class="tab-input" id="tab-set--0-input--2" name="tab-set--0" type="radio"><label class="tab-label" for="tab-set--0-input--2">Windows</label><div class="tab-content docutils">
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>py<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span><command><span class="w"> </span><span class="o">[</span>options<span class="o">]</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Link to this heading">¶</a></h2>
<section id="logging">
<span id="id1"></span><h3>Logging<a class="headerlink" href="#logging" title="Link to this heading">¶</a></h3>
<section id="console-logging">
<h4>Console logging<a class="headerlink" href="#console-logging" title="Link to this heading">¶</a></h4>
<p>pip offers <a class="reference internal" href="#verbose"><span class="std std-ref">-v, --verbose</span></a> and <a class="reference internal" href="#quiet"><span class="std std-ref">-q, --quiet</span></a>
to control the console log level. By default, some messages (error and warnings)
are colored in the terminal. If you want to suppress the colored output use
<a class="reference internal" href="#no-color"><span class="std std-ref">--no-color</span></a>.</p>
</section>
<section id="file-logging">
<span id="filelogging"></span><h4>File logging<a class="headerlink" href="#file-logging" title="Link to this heading">¶</a></h4>
<p>pip offers the <a class="reference internal" href="#log"><span class="std std-ref">--log</span></a> option for specifying a file where a maximum
verbosity log will be kept. This option is empty by default. This log appends
to previous logging.</p>
<p>Like all pip options, <code class="docutils literal notranslate"><span class="pre">--log</span></code> can also be set as an environment variable, or
placed into the pip config file. See the <a class="reference internal" href="../topics/configuration.html"><span class="doc">Configuration</span></a> section.</p>
</section>
</section>
<section id="exists-action-option">
<span id="exists-action"></span><h3>--exists-action option<a class="headerlink" href="#exists-action-option" title="Link to this heading">¶</a></h3>
<p>This option specifies default behavior when path already exists.
Possible cases: downloading files or checking out repositories for installation,
creating archives. If <code class="docutils literal notranslate"><span class="pre">--exists-action</span></code> is not defined, pip will prompt
when decision is needed.</p>
<dl class="simple">
<dt><em>(s)witch</em></dt><dd><p>Only relevant to VCS checkout. Attempt to switch the checkout
to the appropriate URL and/or revision.</p>
</dd>
<dt><em>(i)gnore</em></dt><dd><p>Abort current operation (e.g. don’t copy file, don’t create archive,
don’t modify a checkout).</p>
</dd>
<dt><em>(w)ipe</em></dt><dd><p>Delete the file or VCS checkout before trying to create, download, or checkout a new one.</p>
</dd>
<dt><em>(b)ackup</em></dt><dd><p>Rename the file or checkout to <code class="docutils literal notranslate"><span class="pre">{name}{'.bak'</span> <span class="pre">*</span> <span class="pre">n}</span></code>, where n is some number
of <code class="docutils literal notranslate"><span class="pre">.bak</span></code> extensions, such that the file didn’t exist at some point.
So the most recent backup will be the one with the largest number after <code class="docutils literal notranslate"><span class="pre">.bak</span></code>.</p>
</dd>
<dt><em>(a)bort</em></dt><dd><p>Abort pip and return non-zero exit status.</p>
</dd>
</dl>
<p class="rubric" id="build-system-interface">Build System Interface</p>
<p>This is now covered in <a class="reference internal" href="../reference/build-system/index.html"><span class="doc">Build System Interface</span></a>.</p>
</section>
</section>
<section id="general-options">
<span id="id2"></span><h2>General Options<a class="headerlink" href="#general-options" title="Link to this heading">¶</a></h2>
<p><span class="target" id="help"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-h">
<span id="cmdoption-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-h" title="Link to this definition">¶</a></dt>
<dd><p>Show help.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_HELP</span></code>)</p>
</dd></dl>
<span class="target" id="debug"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-debug" title="Link to this definition">¶</a></dt>
<dd><p>Let unhandled exceptions propagate outside the main subroutine, instead of logging them to stderr.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_DEBUG</span></code>)</p>
</dd></dl>
<span class="target" id="isolated"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-isolated">
<span class="sig-name descname"><span class="pre">--isolated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-isolated" title="Link to this definition">¶</a></dt>
<dd><p>Run pip in an isolated mode, ignoring environment variables and user configuration.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_ISOLATED</span></code>)</p>
</dd></dl>
<span class="target" id="require-virtualenv"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-require-virtualenv">
<span class="sig-name descname"><span class="pre">--require-virtualenv</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-require-virtualenv" title="Link to this definition">¶</a></dt>
<dd><p>Allow pip to only run in a virtual environment; exit with an error otherwise.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_REQUIRE_VIRTUALENV</span></code>, <code class="docutils literal notranslate"><span class="pre">PIP_REQUIRE_VENV</span></code>)</p>
</dd></dl>
<span class="target" id="python"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-python">
<span class="sig-name descname"><span class="pre">--python</span></span><span class="sig-prename descclassname"> <span class="pre"><python></span></span><a class="headerlink" href="#cmdoption-python" title="Link to this definition">¶</a></dt>
<dd><p>Run pip with the specified Python interpreter.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_PYTHON</span></code>)</p>
</dd></dl>
<span class="target" id="verbose"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-v">
<span id="cmdoption-verbose"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-v" title="Link to this definition">¶</a></dt>
<dd><p>Give more output. Option is additive, and can be used up to 3 times.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_VERBOSE</span></code>)</p>
</dd></dl>
<span class="target" id="version"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-V">
<span id="cmdoption-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-V" title="Link to this definition">¶</a></dt>
<dd><p>Show version and exit.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_VERSION</span></code>)</p>
</dd></dl>
<span class="target" id="quiet"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-q">
<span id="cmdoption-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-q" title="Link to this definition">¶</a></dt>
<dd><p>Give less output. Option is additive, and can be used up to 3 times (corresponding to WARNING, ERROR, and CRITICAL logging levels).</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_QUIET</span></code>)</p>
</dd></dl>
<span class="target" id="log"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-log">
<span class="sig-name descname"><span class="pre">--log</span></span><span class="sig-prename descclassname"> <span class="pre"><path></span></span><a class="headerlink" href="#cmdoption-log" title="Link to this definition">¶</a></dt>
<dd><p>Path to a verbose appending log.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_LOG</span></code>, <code class="docutils literal notranslate"><span class="pre">PIP_LOG_FILE</span></code>, <code class="docutils literal notranslate"><span class="pre">PIP_LOCAL_LOG</span></code>)</p>
</dd></dl>
<span class="target" id="no-input"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-no-input">
<span class="sig-name descname"><span class="pre">--no-input</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-no-input" title="Link to this definition">¶</a></dt>
<dd><p>Disable prompting for input.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_NO_INPUT</span></code>)</p>
</dd></dl>
<span class="target" id="keyring-provider"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-keyring-provider">
<span class="sig-name descname"><span class="pre">--keyring-provider</span></span><span class="sig-prename descclassname"> <span class="pre"><keyring_provider></span></span><a class="headerlink" href="#cmdoption-keyring-provider" title="Link to this definition">¶</a></dt>
<dd><p>Enable the credential lookup via the keyring library if user input is allowed. Specify which mechanism to use [auto, disabled, import, subprocess]. (default: auto)</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_KEYRING_PROVIDER</span></code>)</p>
</dd></dl>
<span class="target" id="proxy"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-proxy">
<span class="sig-name descname"><span class="pre">--proxy</span></span><span class="sig-prename descclassname"> <span class="pre"><proxy></span></span><a class="headerlink" href="#cmdoption-proxy" title="Link to this definition">¶</a></dt>
<dd><p>Specify a proxy in the form scheme://[user:passwd@]proxy.server:port.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_PROXY</span></code>)</p>
</dd></dl>
<span class="target" id="retries"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-retries">
<span class="sig-name descname"><span class="pre">--retries</span></span><span class="sig-prename descclassname"> <span class="pre"><retries></span></span><a class="headerlink" href="#cmdoption-retries" title="Link to this definition">¶</a></dt>
<dd><p>Maximum attempts to establish a new HTTP connection. (default: 5)</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_RETRIES</span></code>)</p>
</dd></dl>
<span class="target" id="timeout"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-timeout">
<span class="sig-name descname"><span class="pre">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre"><sec></span></span><a class="headerlink" href="#cmdoption-timeout" title="Link to this definition">¶</a></dt>
<dd><p>Set the socket timeout (default 15 seconds).</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_TIMEOUT</span></code>, <code class="docutils literal notranslate"><span class="pre">PIP_DEFAULT_TIMEOUT</span></code>)</p>
</dd></dl>
<span class="target" id="id3"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-exists-action">
<span class="sig-name descname"><span class="pre">--exists-action</span></span><span class="sig-prename descclassname"> <span class="pre"><action></span></span><a class="headerlink" href="#cmdoption-exists-action" title="Link to this definition">¶</a></dt>
<dd><p>Default action when a path already exists: (s)witch, (i)gnore, (w)ipe, (b)ackup, (a)bort.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_EXISTS_ACTION</span></code>)</p>
</dd></dl>
<span class="target" id="trusted-host"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-trusted-host">
<span class="sig-name descname"><span class="pre">--trusted-host</span></span><span class="sig-prename descclassname"> <span class="pre"><hostname></span></span><a class="headerlink" href="#cmdoption-trusted-host" title="Link to this definition">¶</a></dt>
<dd><p>Mark this host or host:port pair as trusted, even though it does not have valid or any HTTPS.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_TRUSTED_HOST</span></code>)</p>
</dd></dl>
<span class="target" id="cert"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cert">
<span class="sig-name descname"><span class="pre">--cert</span></span><span class="sig-prename descclassname"> <span class="pre"><path></span></span><a class="headerlink" href="#cmdoption-cert" title="Link to this definition">¶</a></dt>
<dd><p>Path to PEM-encoded CA certificate bundle. If provided, overrides the default. See ‘SSL Certificate Verification’ in pip documentation for more information.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_CERT</span></code>)</p>
</dd></dl>
<span class="target" id="client-cert"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-client-cert">
<span class="sig-name descname"><span class="pre">--client-cert</span></span><span class="sig-prename descclassname"> <span class="pre"><path></span></span><a class="headerlink" href="#cmdoption-client-cert" title="Link to this definition">¶</a></dt>
<dd><p>Path to SSL client certificate, a single file containing the private key and the certificate in PEM format.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_CLIENT_CERT</span></code>)</p>
</dd></dl>
<span class="target" id="cache-dir"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cache-dir">
<span class="sig-name descname"><span class="pre">--cache-dir</span></span><span class="sig-prename descclassname"> <span class="pre"><dir></span></span><a class="headerlink" href="#cmdoption-cache-dir" title="Link to this definition">¶</a></dt>
<dd><p>Store the cache data in <dir>.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_CACHE_DIR</span></code>)</p>
</dd></dl>
<span class="target" id="no-cache-dir"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-no-cache-dir">
<span class="sig-name descname"><span class="pre">--no-cache-dir</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-no-cache-dir" title="Link to this definition">¶</a></dt>
<dd><p>Disable the cache.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_NO_CACHE_DIR</span></code>)</p>
</dd></dl>
<span class="target" id="disable-pip-version-check"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-disable-pip-version-check">
<span class="sig-name descname"><span class="pre">--disable-pip-version-check</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-disable-pip-version-check" title="Link to this definition">¶</a></dt>
<dd><p>Don’t periodically check PyPI to determine whether a new version of pip is available for download. Implied with --no-index.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_DISABLE_PIP_VERSION_CHECK</span></code>)</p>
</dd></dl>
<span class="target" id="no-color"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-no-color">
<span class="sig-name descname"><span class="pre">--no-color</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-no-color" title="Link to this definition">¶</a></dt>
<dd><p>Suppress colored output.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_NO_COLOR</span></code>)</p>
</dd></dl>
<span class="target" id="use-feature"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-use-feature">
<span class="sig-name descname"><span class="pre">--use-feature</span></span><span class="sig-prename descclassname"> <span class="pre"><feature></span></span><a class="headerlink" href="#cmdoption-use-feature" title="Link to this definition">¶</a></dt>
<dd><p>Enable new functionality, that may be backward incompatible.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_USE_FEATURE</span></code>)</p>
</dd></dl>
<span class="target" id="use-deprecated"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-use-deprecated">
<span class="sig-name descname"><span class="pre">--use-deprecated</span></span><span class="sig-prename descclassname"> <span class="pre"><feature></span></span><a class="headerlink" href="#cmdoption-use-deprecated" title="Link to this definition">¶</a></dt>
<dd><p>Enable deprecated functionality, that will be removed in the future.</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_USE_DEPRECATED</span></code>)</p>
</dd></dl>
<span class="target" id="resume-retries"></span><dl class="std option">
<dt class="sig sig-object std" id="cmdoption-resume-retries">
<span class="sig-name descname"><span class="pre">--resume-retries</span></span><span class="sig-prename descclassname"> <span class="pre"><resume_retries></span></span><a class="headerlink" href="#cmdoption-resume-retries" title="Link to this definition">¶</a></dt>
<dd><p>Maximum attempts to resume or restart an incomplete download. (default: 0)</p>
<p>(environment variable: <code class="docutils literal notranslate"><span class="pre">PIP_RESUME_RETRIES</span></code>)</p>
</dd></dl>
</p>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="pip_install.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">pip install</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="index.html">
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">Commands</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
<a href="../copyright.html">Copyright</a> © The pip developers
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">pip</a><ul>
<li><a class="reference internal" href="#usage">Usage</a></li>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#logging">Logging</a><ul>
<li><a class="reference internal" href="#console-logging">Console logging</a></li>
<li><a class="reference internal" href="#file-logging">File logging</a></li>
</ul>
</li>
<li><a class="reference internal" href="#exists-action-option">--exists-action option</a></li>
</ul>
</li>
<li><a class="reference internal" href="#general-options">General Options</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script src="../_static/documentation_options.js?v=22103397"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script type="module" src="../_static/scripts/furo.js?v=d32f1409"></script>
<script src="../_static/clipboard.min.js?v=66b4909c"></script>
<script src="../_static/copybutton.js?v=80126f2a"></script>
<script src="../_static/tabs.js?v=3ee01567"></script>
</body>
</html>