{
    "mode": "man",
    "parameter": "pip",
    "section": "1",
    "url": "https://www.chedong.com/phpMan.php/man/pip/1/json",
    "generated": "2026-06-03T04:25:34Z",
    "synopsis": "pip <command> [options]\npip3 <command> [options]",
    "sections": {
        "NAME": {
            "content": "pip - A tool for installing and managing Python packages\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "pip <command> [options]\n\npip3 <command> [options]\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "pip  is  a Python package installer, recommended for installing Python packages which are not\navailable in the Debian archive.  It can work with version  control  repositories  (currently\nonly  Git, Mercurial, and Bazaar repositories), logs output extensively, and prevents partial\ninstalls by downloading all requirements before starting installation.\n\nOn Debian, pip is the command to use when installing packages for Python 2, while pip3 is the\ncommand to use when installing packages for Python 3.\n",
            "subsections": []
        },
        "COMMANDS": {
            "content": "The command comes before any options.  The following commands are recognized:\n\nhelp   Show help for commands.\n",
            "subsections": [
                {
                    "name": "install",
                    "content": "Install packages.\n"
                },
                {
                    "name": "uninstall",
                    "content": "Uninstall packages.\n\nfreeze Output installed packages in requirements format.\n\nlist   List installed packages.\n\nshow   Show information about installed packages.\n\nsearch Search PyPI for packages.\n\nwheel  Build wheels from your requirements.\n"
                }
            ]
        },
        "GENERAL OPTIONS": {
            "content": "This  list  is by no means complete, and it only describes options available to all commands.\nUse pip <command> --help for more details on command specific options.  A few command options\nare provided below.\n",
            "subsections": [
                {
                    "name": "-h --help",
                    "content": "Show more detailed command help.\n",
                    "flag": "-h",
                    "long": "--help"
                },
                {
                    "name": "-v --verbose",
                    "content": "Give more output. Option is additive, and can be used up to 3 times.\n",
                    "flag": "-v",
                    "long": "--verbose"
                },
                {
                    "name": "-V --version",
                    "content": "Show version and exit.\n",
                    "flag": "-V",
                    "long": "--version"
                },
                {
                    "name": "-q --quiet",
                    "content": "Give less output.\n\n--log-file <path>\nPath  to  a verbose non-appending log, that only logs failures.  This log is active by\ndefault at ~/.pip/pip.log.\n\n--log <path>\nPath to a verbose appending log.  This log is inactive by default.\n\n--proxy <proxy>\nSpecify a proxy in the form [user:passwd@]proxy.server:port.\n\n--timeout <sec>\nSet the socket timeout (default 15 seconds).\n\n--exists-action <action>\nDefault action when a path already exists: (s)witch, (i)gnore, (w)ipe, (b)ackup.\n\n--cert <path>\nPath to alternate CA bundle.\n",
                    "flag": "-q",
                    "long": "--quiet"
                }
            ]
        },
        "INSTALL OPTIONS": {
            "content": "pip install installs packages from:\n\n• PyPI (a.k.a. The Cheeseshop) and other indexes, using requirements specifiers.\n\n• VCS project urls.\n\n• Local project directories.\n\n• Local or remote source archives\n\n• Local wheel directories (python-pip-whl installs its wheels in /usr/share/ python-wheels\nand they can be locally installed by pip using --find-links)\n",
            "subsections": [
                {
                    "name": "-e",
                    "content": "Install  a  project  in  editable  mode (i.e.  setuptools \"develop mode\") from a local\nproject path or a VCS url.\n",
                    "flag": "-e"
                },
                {
                    "name": "-r",
                    "content": "Install from the given requirements file.  This option can be used multiple times.\n",
                    "flag": "-r"
                },
                {
                    "name": "-b",
                    "content": "Directory to unpack packages into and build in.  The default in a virtualenv is \"<venv\npath>/build\".   The  default  for  global  installs is \"<OS temp dir>/pipbuild<user‐\nname>\".\n",
                    "flag": "-b"
                },
                {
                    "name": "-t",
                    "content": "Install packages into <dir>.\n",
                    "flag": "-t"
                },
                {
                    "name": "-d",
                    "content": "Download packages into <dir> instead of installing them, regardless of what's  already\ninstalled.\n\n--download-cache <dir>\nCache downloaded packages in <dir>.\n\n--src <dir>\nDirectory  to check out editable projects into.  The default in a virtualenv is \"<venv\npath>/src\".  The default for global installs is \"<current dir>/src\".\n",
                    "flag": "-d"
                },
                {
                    "name": "-U --upgrade",
                    "content": "Upgrade all packages to the newest available version.  This process is  recursive  re‐\ngardless of whether a dependency is already satisfied.\n",
                    "flag": "-U",
                    "long": "--upgrade"
                },
                {
                    "name": "--force-reinstall",
                    "content": "When upgrading, reinstall all packages even if they are already up-to-date.\n",
                    "long": "--force-reinstall"
                },
                {
                    "name": "-I --ignore-installed",
                    "content": "Ignore the installed packages (reinstalling instead).\n",
                    "flag": "-I",
                    "long": "--ignore-installed"
                },
                {
                    "name": "--no-deps",
                    "content": "Don't install package dependencies.\n\n--install-option <options>\nExtra arguments to be supplied to the setup.py install command (use like --install-op‐\ntion =\"--install-scripts=/usr/local/bin\"). Use multiple  --install-option  options  to\npass multiple options to setup.py install. If you are using an option with a directory\npath, be sure to use absolute path.\n\n--global-option <options>\nExtra global options to be supplied to the setup.py call before the install command.\n\n--user Install using the user scheme.\n\n--egg  Install packages as eggs, not 'flat', like pip normally does. This option is not about\ninstalling  from  eggs.  (WARNING:  Because this option overrides pip's normal install\nlogic, requirements files may not behave as expected.)\n\n--root <dir>\nInstall everything relative to this alternate root directory.\n",
                    "long": "--no-deps"
                },
                {
                    "name": "--compile",
                    "content": "Compile py files to pyc.\n",
                    "long": "--compile"
                },
                {
                    "name": "--no-compile",
                    "content": "Do not compile py files to pyc.\n",
                    "long": "--no-compile"
                },
                {
                    "name": "--no-use-wheel",
                    "content": "Do not find and prefer wheel archives when searching indexes and find-links locations.\n\n--pre  Include pre-release and development versions. By default, pip only finds  stable  ver‐\nsions.\n",
                    "long": "--no-use-wheel"
                },
                {
                    "name": "--no-clean",
                    "content": "Don't clean up build directories.\n\nPackage Index Options:\n",
                    "long": "--no-clean"
                },
                {
                    "name": "-i",
                    "content": "Base URL of Python Package Index (default https://pypi.python.org/simple/).\n\n--extra-index-url <url>\nExtra URLs of package indexes to use in addition to --index-url.\n",
                    "flag": "-i"
                },
                {
                    "name": "--no-index",
                    "content": "Ignore package index (only looking at --find-links URLs instead).\n",
                    "long": "--no-index"
                },
                {
                    "name": "-f",
                    "content": "If a url or path to an html file, then parse for links to archives. If a local path or\nfile:// url that's a directory, then look for archives in the directory listing.\n\n--allow-external <package>\nAllow the installation of externally hosted files\n",
                    "flag": "-f"
                },
                {
                    "name": "--allow-all-external",
                    "content": "Allow the installation of all externally hosted files\n\n--allow-unverified <package>\nAllow the installation of insecure and unverifiable files\n",
                    "long": "--allow-all-external"
                },
                {
                    "name": "--process-dependency-links",
                    "content": "Enable the processing of dependency links.\n",
                    "long": "--process-dependency-links"
                }
            ]
        },
        "UNINSTALL OPTIONS": {
            "content": "pip is able to uninstall most installed packages. Known exceptions are:\n\n• Pure distutils packages installed with python setup.py install, which  leave  behind  no\nmetadata to determine what files were installed.\n\n• Script wrappers installed by python setup.py develop.\n",
            "subsections": [
                {
                    "name": "-r",
                    "content": "Uninstall  all the packages listed in the given requirements file.  This option can be\nused multiple times.\n",
                    "flag": "-r"
                },
                {
                    "name": "-y --yes",
                    "content": "Don't ask for confirmation of uninstall deletions.\n",
                    "flag": "-y",
                    "long": "--yes"
                }
            ]
        },
        "AUTHORS": {
            "content": "This manual page was originally written by Jeff Licquia <licquia@debian.org>, later rewritten\nby  Carl  Chenet <chaica@debian.org>.  It was rewritten again and the source converted to re‐\nStructuredText by Barry Warsaw <barry@debian.org>.\n\nPermission is granted to copy, distribute and/or modify this document under the terms of  the\nGNU  General  Public  License,  version 3 or any later version published by the Free Software\nFoundation.\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "Barry Warsaw <barry@debian.org>\n\n\n\n\n1.5.6                                        2014-06-03                                       PIP(1)",
            "subsections": []
        }
    },
    "summary": "pip - A tool for installing and managing Python packages",
    "flags": [],
    "examples": [],
    "see_also": [],
    "tldr": {
        "source": "official",
        "description": "Python package manager.",
        "examples": [
            {
                "description": "Install a package (see `pip install` for more install examples)",
                "command": "pip install {{package}}"
            },
            {
                "description": "Install a package to the user's directory instead of the system-wide default location",
                "command": "pip install --user {{package}}"
            },
            {
                "description": "Upgrade a package",
                "command": "pip install {{-U|--upgrade}} {{package}}"
            },
            {
                "description": "Uninstall a package",
                "command": "pip uninstall {{package}}"
            },
            {
                "description": "Save installed packages to file",
                "command": "pip freeze > {{requirements.txt}}"
            },
            {
                "description": "List installed packages",
                "command": "pip list"
            },
            {
                "description": "Show installed package info",
                "command": "pip show {{package}}"
            },
            {
                "description": "Install packages from a file",
                "command": "pip install {{-r|--requirement}} {{requirements.txt}}"
            }
        ]
    }
}