{ "content": [ { "type": "text", "text": "# pip3(1) (man)\n\n## TLDR\n\n> This command is an alias of `pip`.\n\n- View documentation for the original command:\n `tldr pip`\n\n*Source: tldr-pages*\n\n---\n\n**Summary:** pip - A tool for installing and managing Python packages\n\n**Synopsis:** pip [options]\npip3 [options]\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (4 lines)\n- **DESCRIPTION** (8 lines)\n- **COMMANDS** (4 lines) — 2 subsections\n - install (2 lines)\n - uninstall (12 lines)\n- **GENERAL OPTIONS** (4 lines) — 4 subsections\n - -h --help (2 lines)\n - -v --verbose (2 lines)\n - -V --version (2 lines)\n - -q --quiet (21 lines)\n- **INSTALL OPTIONS** (13 lines) — 18 subsections\n - -e (3 lines)\n - -r (2 lines)\n - -b (4 lines)\n - -t (2 lines)\n - -d (10 lines)\n - -U --upgrade (3 lines)\n - --force-reinstall (2 lines)\n - -I --ignore-installed (2 lines)\n - --no-deps (20 lines)\n - --compile (2 lines)\n - --no-compile (2 lines)\n - --no-use-wheel (5 lines)\n - --no-clean (4 lines)\n - -i (5 lines)\n - --no-index (2 lines)\n - -f (6 lines)\n - --allow-all-external (5 lines)\n - --process-dependency-links (2 lines)\n- **UNINSTALL OPTIONS** (7 lines) — 2 subsections\n - -r (3 lines)\n - -y --yes (2 lines)\n- **AUTHORS** (8 lines)\n- **AUTHOR** (6 lines)\n\n## Full Content\n\n### NAME\n\npip - A tool for installing and managing Python packages\n\n### SYNOPSIS\n\npip [options]\n\npip3 [options]\n\n### DESCRIPTION\n\npip 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\n### COMMANDS\n\nThe command comes before any options. The following commands are recognized:\n\nhelp Show help for commands.\n\n#### install\n\nInstall packages.\n\n#### uninstall\n\nUninstall 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\n### GENERAL OPTIONS\n\nThis list is by no means complete, and it only describes options available to all commands.\nUse pip --help for more details on command specific options. A few command options\nare provided below.\n\n#### -h --help\n\nShow more detailed command help.\n\n#### -v --verbose\n\nGive more output. Option is additive, and can be used up to 3 times.\n\n#### -V --version\n\nShow version and exit.\n\n#### -q --quiet\n\nGive less output.\n\n--log-file \nPath to a verbose non-appending log, that only logs failures. This log is active by\ndefault at ~/.pip/pip.log.\n\n--log \nPath to a verbose appending log. This log is inactive by default.\n\n--proxy \nSpecify a proxy in the form [user:passwd@]proxy.server:port.\n\n--timeout \nSet the socket timeout (default 15 seconds).\n\n--exists-action \nDefault action when a path already exists: (s)witch, (i)gnore, (w)ipe, (b)ackup.\n\n--cert \nPath to alternate CA bundle.\n\n### INSTALL OPTIONS\n\npip 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\n#### -e\n\nInstall a project in editable mode (i.e. setuptools \"develop mode\") from a local\nproject path or a VCS url.\n\n#### -r\n\nInstall from the given requirements file. This option can be used multiple times.\n\n#### -b\n\nDirectory to unpack packages into and build in. The default in a virtualenv is \"/build\". The default for global installs is \"/pipbuild\".\n\n#### -t\n\nInstall packages into .\n\n#### -d\n\nDownload packages into instead of installing them, regardless of what's already\ninstalled.\n\n--download-cache \nCache downloaded packages in .\n\n--src \nDirectory to check out editable projects into. The default in a virtualenv is \"/src\". The default for global installs is \"/src\".\n\n#### -U --upgrade\n\nUpgrade all packages to the newest available version. This process is recursive re‐\ngardless of whether a dependency is already satisfied.\n\n#### --force-reinstall\n\nWhen upgrading, reinstall all packages even if they are already up-to-date.\n\n#### -I --ignore-installed\n\nIgnore the installed packages (reinstalling instead).\n\n#### --no-deps\n\nDon't install package dependencies.\n\n--install-option \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 \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 \nInstall everything relative to this alternate root directory.\n\n#### --compile\n\nCompile py files to pyc.\n\n#### --no-compile\n\nDo not compile py files to pyc.\n\n#### --no-use-wheel\n\nDo 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\n#### --no-clean\n\nDon't clean up build directories.\n\nPackage Index Options:\n\n#### -i\n\nBase URL of Python Package Index (default https://pypi.python.org/simple/).\n\n--extra-index-url \nExtra URLs of package indexes to use in addition to --index-url.\n\n#### --no-index\n\nIgnore package index (only looking at --find-links URLs instead).\n\n#### -f\n\nIf 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 \nAllow the installation of externally hosted files\n\n#### --allow-all-external\n\nAllow the installation of all externally hosted files\n\n--allow-unverified \nAllow the installation of insecure and unverifiable files\n\n#### --process-dependency-links\n\nEnable the processing of dependency links.\n\n### UNINSTALL OPTIONS\n\npip 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\n#### -r\n\nUninstall all the packages listed in the given requirements file. This option can be\nused multiple times.\n\n#### -y --yes\n\nDon't ask for confirmation of uninstall deletions.\n\n### AUTHORS\n\nThis manual page was originally written by Jeff Licquia , later rewritten\nby Carl Chenet . It was rewritten again and the source converted to re‐\nStructuredText by Barry Warsaw .\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\n### AUTHOR\n\nBarry Warsaw \n\n\n\n\n1.5.6 2014-06-03 PIP(1)\n\n" } ], "structuredContent": { "command": "pip3", "section": "1", "mode": "man", "summary": "pip - A tool for installing and managing Python packages", "synopsis": "pip [options]\npip3 [options]", "tldr_summary": "This command is an alias of `pip`.", "tldr_examples": [ { "description": "View documentation for the original command", "command": "tldr pip" } ], "tldr_source": "official", "flags": [ { "flag": "-h", "long": "--help", "arg": null, "description": "Show more detailed command help." }, { "flag": "-v", "long": "--verbose", "arg": null, "description": "Give more output. Option is additive, and can be used up to 3 times." }, { "flag": "-V", "long": "--version", "arg": null, "description": "Show version and exit." }, { "flag": "-q", "long": "--quiet", "arg": null, "description": "Give less output. --log-file Path to a verbose non-appending log, that only logs failures. This log is active by default at ~/.pip/pip.log. --log Path to a verbose appending log. This log is inactive by default. --proxy Specify a proxy in the form [user:passwd@]proxy.server:port. --timeout Set the socket timeout (default 15 seconds). --exists-action Default action when a path already exists: (s)witch, (i)gnore, (w)ipe, (b)ackup. --cert Path to alternate CA bundle." }, { "flag": "-e", "long": null, "arg": null, "description": "Install a project in editable mode (i.e. setuptools \"develop mode\") from a local project path or a VCS url." }, { "flag": "-r", "long": null, "arg": null, "description": "Install from the given requirements file. This option can be used multiple times." }, { "flag": "-b", "long": null, "arg": null, "description": "Directory to unpack packages into and build in. The default in a virtualenv is \"/build\". The default for global installs is \"/pipbuild\"." }, { "flag": "-t", "long": null, "arg": null, "description": "Install packages into ." }, { "flag": "-d", "long": null, "arg": null, "description": "Download packages into instead of installing them, regardless of what's already installed. --download-cache Cache downloaded packages in . --src Directory to check out editable projects into. The default in a virtualenv is \"/src\". The default for global installs is \"/src\"." }, { "flag": "-U", "long": "--upgrade", "arg": null, "description": "Upgrade all packages to the newest available version. This process is recursive re‐ gardless of whether a dependency is already satisfied." }, { "flag": "", "long": "--force-reinstall", "arg": null, "description": "When upgrading, reinstall all packages even if they are already up-to-date." }, { "flag": "-I", "long": "--ignore-installed", "arg": null, "description": "Ignore the installed packages (reinstalling instead)." }, { "flag": "", "long": "--no-deps", "arg": null, "description": "Don't install package dependencies. --install-option Extra arguments to be supplied to the setup.py install command (use like --install-op‐ tion =\"--install-scripts=/usr/local/bin\"). Use multiple --install-option options to pass multiple options to setup.py install. If you are using an option with a directory path, be sure to use absolute path. --global-option Extra global options to be supplied to the setup.py call before the install command. --user Install using the user scheme. --egg Install packages as eggs, not 'flat', like pip normally does. This option is not about installing from eggs. (WARNING: Because this option overrides pip's normal install logic, requirements files may not behave as expected.) --root Install everything relative to this alternate root directory." }, { "flag": "", "long": "--compile", "arg": null, "description": "Compile py files to pyc." }, { "flag": "", "long": "--no-compile", "arg": null, "description": "Do not compile py files to pyc." }, { "flag": "", "long": "--no-use-wheel", "arg": null, "description": "Do not find and prefer wheel archives when searching indexes and find-links locations. --pre Include pre-release and development versions. By default, pip only finds stable ver‐ sions." }, { "flag": "", "long": "--no-clean", "arg": null, "description": "Don't clean up build directories. Package Index Options:" }, { "flag": "-i", "long": null, "arg": null, "description": "Base URL of Python Package Index (default https://pypi.python.org/simple/). --extra-index-url Extra URLs of package indexes to use in addition to --index-url." }, { "flag": "", "long": "--no-index", "arg": null, "description": "Ignore package index (only looking at --find-links URLs instead)." }, { "flag": "-f", "long": null, "arg": null, "description": "If a url or path to an html file, then parse for links to archives. If a local path or file:// url that's a directory, then look for archives in the directory listing. --allow-external Allow the installation of externally hosted files" }, { "flag": "", "long": "--allow-all-external", "arg": null, "description": "Allow the installation of all externally hosted files --allow-unverified Allow the installation of insecure and unverifiable files" }, { "flag": "", "long": "--process-dependency-links", "arg": null, "description": "Enable the processing of dependency links." }, { "flag": "-r", "long": null, "arg": null, "description": "Uninstall all the packages listed in the given requirements file. This option can be used multiple times." }, { "flag": "-y", "long": "--yes", "arg": null, "description": "Don't ask for confirmation of uninstall deletions." } ], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 4, "subsections": [] }, { "name": "DESCRIPTION", "lines": 8, "subsections": [] }, { "name": "COMMANDS", "lines": 4, "subsections": [ { "name": "install", "lines": 2 }, { "name": "uninstall", "lines": 12 } ] }, { "name": "GENERAL OPTIONS", "lines": 4, "subsections": [ { "name": "-h --help", "lines": 2, "flag": "-h", "long": "--help" }, { "name": "-v --verbose", "lines": 2, "flag": "-v", "long": "--verbose" }, { "name": "-V --version", "lines": 2, "flag": "-V", "long": "--version" }, { "name": "-q --quiet", "lines": 21, "flag": "-q", "long": "--quiet" } ] }, { "name": "INSTALL OPTIONS", "lines": 13, "subsections": [ { "name": "-e", "lines": 3, "flag": "-e" }, { "name": "-r", "lines": 2, "flag": "-r" }, { "name": "-b", "lines": 4, "flag": "-b" }, { "name": "-t", "lines": 2, "flag": "-t" }, { "name": "-d", "lines": 10, "flag": "-d" }, { "name": "-U --upgrade", "lines": 3, "flag": "-U", "long": "--upgrade" }, { "name": "--force-reinstall", "lines": 2, "long": "--force-reinstall" }, { "name": "-I --ignore-installed", "lines": 2, "flag": "-I", "long": "--ignore-installed" }, { "name": "--no-deps", "lines": 20, "long": "--no-deps" }, { "name": "--compile", "lines": 2, "long": "--compile" }, { "name": "--no-compile", "lines": 2, "long": "--no-compile" }, { "name": "--no-use-wheel", "lines": 5, "long": "--no-use-wheel" }, { "name": "--no-clean", "lines": 4, "long": "--no-clean" }, { "name": "-i", "lines": 5, "flag": "-i" }, { "name": "--no-index", "lines": 2, "long": "--no-index" }, { "name": "-f", "lines": 6, "flag": "-f" }, { "name": "--allow-all-external", "lines": 5, "long": "--allow-all-external" }, { "name": "--process-dependency-links", "lines": 2, "long": "--process-dependency-links" } ] }, { "name": "UNINSTALL OPTIONS", "lines": 7, "subsections": [ { "name": "-r", "lines": 3, "flag": "-r" }, { "name": "-y --yes", "lines": 2, "flag": "-y", "long": "--yes" } ] }, { "name": "AUTHORS", "lines": 8, "subsections": [] }, { "name": "AUTHOR", "lines": 6, "subsections": [] } ] } }