Skip to content

Instantly share code, notes, and snippets.

@gvalkov
Created January 3, 2012 20:19
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save gvalkov/1556718 to your computer and use it in GitHub Desktop.
Save gvalkov/1556718 to your computer and use it in GitHub Desktop.
pip help proposal
Usage: pip <command> [options]
Commands:
bundle create pybundle
freeze list installed packages
help show available commands
install install packages
search search pypi
uninstall uninstall packages
unzip unzip individual packages
zip zip individual packages
General Options:
-h, --help show this help message and exit
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
-l, --log path log file (maximum verbosity)
--proxy proxy specify proxy as user:pswd@proxy.server:port
--timeout sec set the socket timeout (default 15 seconds)
Python Environment Options:
-E, --env arg virtualenv environment to activate
-s, --site-packages include site-packages in virtualenv
Further information:
[1] man 5 pip
[2] http://www.pip-installer.org/en/latest/index.html
Usage: pip COMMAND [OPTIONS]
Options:
--version show program's version number and exit
-h, --help Show help
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record will be
kept
--proxy=PROXY Specify a proxy in the form user:passwd@proxy.server:port.
Note that the user:password@ is optional and required only if
you are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
Commands available:
bundle: Create pybundles (archives containing multiple packages)
freeze: Output all currently installed packages (exact versions) to stdout
help: Show available commands
install: Install packages
search: Search PyPI
uninstall: Uninstall packages
unzip: Unzip individual packages
zip: Zip individual packages
Usage: pip install [options] <package> [<package> ...]
General Options:
-h, --help show this help message and exit
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
-l, --log path log file (maximum verbosity)
--proxy proxy specify proxy as user:pswd@proxy.server:port
--timeout sec set the socket timeout (default 15 seconds)
Python Environment Options:
-E, --env path virtualenv environment to activate
-s, --site-packages include site-packages in virtualenv
--user install to user-site
Package Index Options:
--no-index ignore package index
-f, --find-links url url to look for packages at
-i, --index-url url base Python Package Index url
-M, --use-mirrors use pypI mirrors as a fallback
--extra-index url extra package index urls (in addition to --index-url)
--mirror url specific mirror urls to query when --use-mirrors
Install Options:
-r, --requirement path install all packages in requirements file
-b, --build dir unpack packages into <dir> and build from there
-d, --download dir download packages into <dir> instead of installing them
--download-cache dir cache downloaded packages in DIR
--src, --source dir check out --editable packages into <dir>
-U, --upgrade upgrade all packages to the newest available version
-I, --ignore-installed ignore the installed packages (reinstalling instead)
--no-deps ignore package dependencies
--no-install download and unpack, but don't install
--no-download install only downloaded packages (completes --no-install)
--install-option options
extra arguments to be supplied to the setup.py install
command (use like --install-option="--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 options
extra global options to be supplied to the
setup.pycall before the install command
-e, --editable <VCS+REPOS_URL[@REV]#egg=PACKAGE
Install a package directly from a checkout. Source
will be checked out into src/PACKAGE (lower-case) and
installed in-place (using setup.py develop). You can
run this on an existing directory/checkout (like pip
install -e src/mycheckout). This option may be
provided multiple times. Possible values for VCS are:
svn, git, hg and bzr.
Usage: /tmp/pip-venv/bin/pip install [OPTIONS] PACKAGE_NAMES...
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record will be
kept
--proxy=PROXY Specify a proxy in the form user:passwd@proxy.server:port.
Note that the user:password@ is optional and required only if
you are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
-e VCS+REPOS_URL[@REV]#egg=PACKAGE, --editable=VCS+REPOS_URL[@REV]#egg=PACKAGE
Install a package directly from a checkout. Source will be
checked out into src/PACKAGE (lower-case) and installed in-
place (using setup.py develop). You can run this on an
existing directory/checkout (like pip install -e
src/mycheckout). This option may be provided multiple times.
Possible values for VCS are: svn, git, hg and bzr.
-r FILENAME, --requirement=FILENAME
Install all the packages listed in the given requirements
file. This option can be used multiple times.
-f URL, --find-links=URL
URL to look for packages at
-i URL, --index-url=URL, --pypi-url=URL
Base URL of Python Package Index (default
http://pypi.python.org/simple/)
--extra-index-url=URL
Extra URLs of package indexes to use in addition to --index-
url
--no-index Ignore package index (only looking at --find-links URLs
instead)
-M, --use-mirrors Use the PyPI mirrors as a fallback in case the main index is
down.
--mirrors=URL Specific mirror URLs to query when --use-mirrors is used
-b DIR, --build=DIR, --build-dir=DIR, --build-directory=DIR
Unpack packages into DIR (default /tmp/pip-venv/build) and
build from there
-d DIR, --download=DIR, --download-dir=DIR, --download-directory=DIR
Download packages into DIR instead of installing them
--download-cache=DIR Cache downloaded packages in DIR
--src=DIR, --source=DIR, --source-dir=DIR, --source-directory=DIR
Check out --editable packages into DIR (default /tmp/pip-
venv/src)
-U, --upgrade Upgrade all packages to the newest available version
--force-reinstall When upgrading, reinstall all packages even if they are
already up-to-date.
-I, --ignore-installed
Ignore the installed packages (reinstalling instead)
--no-deps, --no-dependencies
Ignore package dependencies
--no-install Download and unpack all packages, but don't actually install
them
--no-download Don't download any packages, just install the ones already
downloaded (completes an install run with --no-install)
--install-option=INSTALL_OPTIONS
Extra arguments to be supplied to the setup.py install command
(use like --install-option="--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=GLOBAL_OPTIONS
Extra global options to be supplied to the setup.pycall before
the install command
--user Install to user-site
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment