Skip to content
This repository was archived by the owner on Feb 15, 2026. It is now read-only.

Commit 790ac7c

Browse files
KemingHegithub-actions[bot]
authored andcommitted
docs(src/assets/): update pip official documentation
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 05b0dd2 commit 790ac7c

116 files changed

Lines changed: 12476 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/assets/pip/_metadata.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
source_repo: pypa/pip
2+
docs_path: docs
3+
updated_at: 2025-07-16T02:46:00Z
4+
commit_sha: 18694f6a0c568e996e0d27c3f8b3c0efe08a00fa

src/assets/pip/html/cli/index.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Commands
2+
3+
The general options that apply to all the commands listed below can be
4+
found [under the `pip` page in this section](pip).
5+
6+
```{toctree}
7+
:maxdepth: 1
8+
:hidden:
9+
10+
pip
11+
```
12+
13+
```{toctree}
14+
:maxdepth: 1
15+
:caption: Environment Management and Introspection
16+
17+
pip_install
18+
pip_uninstall
19+
pip_inspect
20+
pip_list
21+
pip_show
22+
pip_freeze
23+
pip_check
24+
```
25+
26+
```{toctree}
27+
:maxdepth: 1
28+
:caption: Resolving dependencies
29+
30+
pip_lock
31+
```
32+
33+
```{toctree}
34+
:maxdepth: 1
35+
:caption: Handling Distribution Files
36+
37+
pip_download
38+
pip_wheel
39+
pip_hash
40+
```
41+
42+
```{toctree}
43+
:maxdepth: 1
44+
:caption: Package Index information
45+
46+
pip_search
47+
pip_index
48+
```
49+
50+
```{toctree}
51+
:maxdepth: 1
52+
:caption: Managing pip itself
53+
54+
pip_cache
55+
pip_config
56+
pip_debug
57+
```

src/assets/pip/html/cli/pip.rst

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
===
2+
pip
3+
===
4+
5+
6+
Usage
7+
*****
8+
9+
.. tab:: Unix/macOS
10+
11+
.. code-block:: shell
12+
13+
python -m pip <command> [options]
14+
15+
.. tab:: Windows
16+
17+
.. code-block:: shell
18+
19+
py -m pip <command> [options]
20+
21+
Description
22+
***********
23+
24+
25+
.. _`Logging`:
26+
27+
28+
Logging
29+
=======
30+
31+
Console logging
32+
~~~~~~~~~~~~~~~
33+
34+
pip offers :ref:`-v, --verbose <--verbose>` and :ref:`-q, --quiet <--quiet>`
35+
to control the console log level. By default, some messages (error and warnings)
36+
are colored in the terminal. If you want to suppress the colored output use
37+
:ref:`--no-color <--no-color>`.
38+
39+
40+
.. _`FileLogging`:
41+
42+
File logging
43+
~~~~~~~~~~~~
44+
45+
pip offers the :ref:`--log <--log>` option for specifying a file where a maximum
46+
verbosity log will be kept. This option is empty by default. This log appends
47+
to previous logging.
48+
49+
Like all pip options, ``--log`` can also be set as an environment variable, or
50+
placed into the pip config file. See the :doc:`../topics/configuration` section.
51+
52+
.. _`exists-action`:
53+
54+
--exists-action option
55+
======================
56+
57+
This option specifies default behavior when path already exists.
58+
Possible cases: downloading files or checking out repositories for installation,
59+
creating archives. If ``--exists-action`` is not defined, pip will prompt
60+
when decision is needed.
61+
62+
*(s)witch*
63+
Only relevant to VCS checkout. Attempt to switch the checkout
64+
to the appropriate URL and/or revision.
65+
*(i)gnore*
66+
Abort current operation (e.g. don't copy file, don't create archive,
67+
don't modify a checkout).
68+
*(w)ipe*
69+
Delete the file or VCS checkout before trying to create, download, or checkout a new one.
70+
*(b)ackup*
71+
Rename the file or checkout to ``{name}{'.bak' * n}``, where n is some number
72+
of ``.bak`` extensions, such that the file didn't exist at some point.
73+
So the most recent backup will be the one with the largest number after ``.bak``.
74+
*(a)bort*
75+
Abort pip and return non-zero exit status.
76+
77+
.. _`2-build-system-interface`:
78+
.. rubric:: Build System Interface
79+
80+
This is now covered in :doc:`../reference/build-system/index`.
81+
82+
.. _`General Options`:
83+
84+
General Options
85+
***************
86+
87+
.. pip-general-options::
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
.. _`pip cache`:
3+
4+
pip cache
5+
---------
6+
7+
8+
Usage
9+
*****
10+
11+
.. tab:: Unix/macOS
12+
13+
.. pip-command-usage:: cache "python -m pip"
14+
15+
.. tab:: Windows
16+
17+
.. pip-command-usage:: cache "py -m pip"
18+
19+
Description
20+
***********
21+
22+
.. pip-command-description:: cache
23+
24+
Options
25+
*******
26+
27+
.. pip-command-options:: cache
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
.. _`pip check`:
2+
3+
=========
4+
pip check
5+
=========
6+
7+
8+
Usage
9+
=====
10+
11+
.. tab:: Unix/macOS
12+
13+
.. pip-command-usage:: check "python -m pip"
14+
15+
.. tab:: Windows
16+
17+
.. pip-command-usage:: check "py -m pip"
18+
19+
20+
Description
21+
===========
22+
23+
.. pip-command-description:: check
24+
25+
26+
Examples
27+
========
28+
29+
#. If all dependencies are compatible:
30+
31+
.. tab:: Unix/macOS
32+
33+
.. code-block:: console
34+
35+
$ python -m pip check
36+
No broken requirements found.
37+
$ echo $?
38+
0
39+
40+
.. tab:: Windows
41+
42+
.. code-block:: console
43+
44+
C:\> py -m pip check
45+
No broken requirements found.
46+
C:\> echo %errorlevel%
47+
0
48+
49+
#. If a package is missing:
50+
51+
.. tab:: Unix/macOS
52+
53+
.. code-block:: console
54+
55+
$ python -m pip check
56+
pyramid 1.5.2 requires WebOb, which is not installed.
57+
$ echo $?
58+
1
59+
60+
.. tab:: Windows
61+
62+
.. code-block:: console
63+
64+
C:\> py -m pip check
65+
pyramid 1.5.2 requires WebOb, which is not installed.
66+
C:\> echo %errorlevel%
67+
1
68+
69+
#. If a package has the wrong version:
70+
71+
.. tab:: Unix/macOS
72+
73+
.. code-block:: console
74+
75+
$ python -m pip check
76+
pyramid 1.5.2 has requirement WebOb>=1.3.1, but you have WebOb 0.8.
77+
$ echo $?
78+
1
79+
80+
.. tab:: Windows
81+
82+
.. code-block:: console
83+
84+
C:\> py -m pip check
85+
pyramid 1.5.2 has requirement WebOb>=1.3.1, but you have WebOb 0.8.
86+
C:\> echo %errorlevel%
87+
1
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
.. _`pip config`:
3+
4+
==========
5+
pip config
6+
==========
7+
8+
9+
Usage
10+
=====
11+
12+
.. tab:: Unix/macOS
13+
14+
.. pip-command-usage:: config "python -m pip"
15+
16+
.. tab:: Windows
17+
18+
.. pip-command-usage:: config "py -m pip"
19+
20+
21+
Description
22+
===========
23+
24+
.. pip-command-description:: config
25+
26+
27+
Options
28+
=======
29+
30+
.. pip-command-options:: config
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
.. _`pip debug`:
2+
3+
=========
4+
pip debug
5+
=========
6+
7+
8+
Usage
9+
=====
10+
11+
.. tab:: Unix/macOS
12+
13+
.. pip-command-usage:: debug "python -m pip"
14+
15+
.. tab:: Windows
16+
17+
.. pip-command-usage:: debug "py -m pip"
18+
19+
20+
.. warning::
21+
22+
This command is only meant for debugging.
23+
Its options and outputs are provisional and may change without notice.
24+
25+
26+
Description
27+
===========
28+
29+
.. pip-command-description:: debug
30+
31+
32+
Options
33+
=======
34+
35+
.. pip-command-options:: debug

0 commit comments

Comments
 (0)