diff options
author | Sukin Kumar K <kullsno2@gmail.com> | 2019-10-01 16:43:18 +0530 |
---|---|---|
committer | Marc Cornellà <marc.cornella@live.com> | 2019-10-01 13:13:18 +0200 |
commit | 51f0eaad61d5870d990386ad8479bcd6a86108b6 (patch) | |
tree | fa6f2d82f4ad869c57d4ccdea23188bf8f77f36e /plugins/pip | |
parent | 8bfeb3759c34a8e2e6a5795c3f40630a220e709b (diff) | |
download | zsh-51f0eaad61d5870d990386ad8479bcd6a86108b6.tar.gz zsh-51f0eaad61d5870d990386ad8479bcd6a86108b6.tar.bz2 zsh-51f0eaad61d5870d990386ad8479bcd6a86108b6.zip |
Add README for thor and pip plugins (#8185)
Diffstat (limited to 'plugins/pip')
-rw-r--r-- | plugins/pip/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/pip/README.md b/plugins/pip/README.md new file mode 100644 index 000000000..f07b5c058 --- /dev/null +++ b/plugins/pip/README.md @@ -0,0 +1,19 @@ +# 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`. |