summaryrefslogtreecommitdiff
path: root/plugins/pipenv/README.md
diff options
context:
space:
mode:
authorAlan <alan@gangleri.net>2019-05-08 08:48:28 +0100
committerMarc Cornellà <marc.cornella@live.com>2019-05-08 09:48:28 +0200
commit4cadbcd23503e3aa1f29008b6748c82bd308dce6 (patch)
tree78bea7c7f33b50a0695039e48be109fd9b3ea17d /plugins/pipenv/README.md
parent76c7bd57c332b3d9231dc2c6167f3c5d3e56e110 (diff)
downloadzsh-4cadbcd23503e3aa1f29008b6748c82bd308dce6.tar.gz
zsh-4cadbcd23503e3aa1f29008b6748c82bd308dce6.tar.bz2
zsh-4cadbcd23503e3aa1f29008b6748c82bd308dce6.zip
Add plugin for pipenv (#6698)
- Add completion for pipenv - Auto activate and deactivate for pipenv shell - Add aliases for the most common pipenv commands
Diffstat (limited to 'plugins/pipenv/README.md')
-rw-r--r--plugins/pipenv/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/plugins/pipenv/README.md b/plugins/pipenv/README.md
new file mode 100644
index 000000000..ab1c1e442
--- /dev/null
+++ b/plugins/pipenv/README.md
@@ -0,0 +1,28 @@
+# Pipenv
+
+## Installation
+In your `.zshrc` file, add `pipenv` to the plugins section
+
+```
+plugins=(... pipenv ...)
+```
+
+## Features
+This plugin provides some features to simplify the use of Pipenv while working on ZSH.
+- Adds completion for pipenv
+- Auto activates and deactivates pipenv shell
+- Adds short aliases for common pipenv commands
+ - `pch` is aliased to `pipenv check`
+ - `pcl` is aliased to `pipenv clean`
+ - `pgr` is aliased to `pipenv graph`
+ - `pi` is aliased to `pipenv install`
+ - `pidev` is aliased to `pipenv install --dev`
+ - `pl` is aliased to `pipenv lock`
+ - `po` is aliased to `pipenv open`
+ - `prun` is aliased to `pipenv run`
+ - `psh` is aliased to `pipenv shell`
+ - `psy` is aliased to `pipenv sync`
+ - `pu` is aliased to `pipenv uninstall`
+ - `pwh` is aliased to `pipenv --where`
+ - `pvenv` is aliased to `pipenv --venv`
+ - `ppy` is aliased to `pipenv --py`