summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/pip/README.md
diff options
context:
space:
mode:
authorAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
committerAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
commitedc449275b6c04445f58b108ca0937a87c1e8430 (patch)
tree9fd484d58145b616f29a78857cc0b1c8b1c18f05 /oh-my-zsh/plugins/pip/README.md
parent6f5424ca96c4221ef433f545642669e9c104d0ed (diff)
add zsh
Diffstat (limited to 'oh-my-zsh/plugins/pip/README.md')
-rw-r--r--oh-my-zsh/plugins/pip/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/pip/README.md b/oh-my-zsh/plugins/pip/README.md
new file mode 100644
index 0000000..70d40c7
--- /dev/null
+++ b/oh-my-zsh/plugins/pip/README.md
@@ -0,0 +1,36 @@
+# pip plugin
+
+This plugin adds completion for [pip](https://pip.pypa.io/en/latest/),
+the Python package manager.
+
+To use it, add `pip` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... pip)
+```
+
+## pip cache
+
+The pip plugin caches the names of available pip packages from the PyPI index.
+To trigger the caching process, try to complete `pip install`,
+or you can run `zsh-pip-cache-packages` directly.
+
+To reset the cache, run `zsh-pip-clear-cache` and it will be rebuilt next
+the next time you autocomplete `pip install`.
+
+## Aliases
+
+| Alias | Description |
+| :------- | :-------------------------------------------- |
+| pipi | Install packages |
+| pipig | Install package from GitHub repository |
+| pipigb | Install package from GitHub branch |
+| pipigp | Install package from GitHub pull request |
+| pipu | Upgrade packages |
+| pipun | Uninstall packages |
+| pipgi | Grep through installed packages |
+| piplo | List outdated packages |
+| pipreq | Create requirements file |
+| pipir | Install packages from `requirements.txt` file |
+| pipupall | Update all installed packages |
+| pipunall | Uninstall all installed packages |