51d0e0aa1de9c7f96012b9a0feda6509ed2a025b
- Author
- Hanashiko <129686115+Hanashiko@users.noreply.github.com>
- Committer
- GitHub <noreply@github.com>
- Date
Message
docs(pip): add explanation for aliases (#13103)
Diff
1diff --git a/plugins/pip/README.md b/plugins/pip/README.md
2index 70d40c79fcdfa086ffd71f8205328998aea26adf..9d1daca9f77c39c753a90c6921bda360d769c1ed 100644
3--- a/plugins/pip/README.md
4+++ b/plugins/pip/README.md
5@@ -20,17 +20,17 @@ the next time you autocomplete `pip install`.
6
7 ## Aliases
8
9-| Alias | Description |
10-| :------- | :-------------------------------------------- |
11-| pipi | Install packages |
12-| pipig | Install package from GitHub repository |
13-| pipigb | Install package from GitHub branch |
14-| pipigp | Install package from GitHub pull request |
15-| pipu | Upgrade packages |
16-| pipun | Uninstall packages |
17-| pipgi | Grep through installed packages |
18-| piplo | List outdated packages |
19-| pipreq | Create requirements file |
20-| pipir | Install packages from `requirements.txt` file |
21-| pipupall | Update all installed packages |
22-| pipunall | Uninstall all installed packages |
23+| Alias | Command | Description |
24+| :--------|:----------------------------------------------------------------------------------|:--------------------------------------------- |
25+| pipi | `pip install` | Install packages |
26+| pipig | `pip install "git+https://github.com/user/repo.git"` | Install package from GitHub repository |
27+| pipigb | `pip install "git+https://github.com/user/repo.git@branch"` | Install package from GitHub branch |
28+| pipigp | `pip install "git+https://github.com/user/repo.git@refs/pull/PR_NUMBER/head"` | Install package from GitHub pull request |
29+| pipu | `pip install --upgrade` | Upgrade packages |
30+| pipun | `pip uninstall` | Uninstall packages |
31+| pipgi | `pip freeze \| grep` | Grep through installed packages |
32+| piplo | `pip list --outdated` | List outdated packages |
33+| pipreq | `pip freeze > requirements.txt` | Create requirements file |
34+| pipir | `pip install -r requirements.txt` | Install packages from `requirements.txt` file |
35+| pipupall | `pip list --outdated \| awk 'NR > 2 { print $1 }' \| xargs pip install --upgrade` | Update all installed packages |
36+| pipunall | `pip list --format freeze \| cut -d= -f1 \| xargs pip uninstall` | Uninstall all installed packages |