summaryrefslogtreecommitdiff
path: root/plugins/pipenv/README.md
diff options
context:
space:
mode:
authorCarlo Sala <carlosalag@protonmail.com>2023-09-06 19:01:41 +0200
committerCarlo Sala <carlosalag@protonmail.com>2023-09-06 19:01:41 +0200
commit079dbff2c4f22935a71101c511e2285327d8ab68 (patch)
treecc84e8fb9e4e6349fb301e50dc484b31e0342a77 /plugins/pipenv/README.md
parent6a7aab47dd6071b7f264477195b06efb7e7bd480 (diff)
downloadzsh-079dbff2c4f22935a71101c511e2285327d8ab68.tar.gz
zsh-079dbff2c4f22935a71101c511e2285327d8ab68.tar.bz2
zsh-079dbff2c4f22935a71101c511e2285327d8ab68.zip
feat(pipenv): add option to disable auto shell feature
Closes #11472
Diffstat (limited to 'plugins/pipenv/README.md')
-rw-r--r--plugins/pipenv/README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/plugins/pipenv/README.md b/plugins/pipenv/README.md
index 4329feb32..e78ef0e3b 100644
--- a/plugins/pipenv/README.md
+++ b/plugins/pipenv/README.md
@@ -1,6 +1,7 @@
# Pipenv
## Installation
+
In your `.zshrc` file, add `pipenv` to the plugins section
```
@@ -8,7 +9,9 @@ plugins=(... pipenv ...)
```
## Features
-This plugin provides some features to simplify the use of Pipenv while working on ZSH.
+
+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
@@ -27,3 +30,13 @@ This plugin provides some features to simplify the use of Pipenv while working o
- `pwh` is aliased to `pipenv --where`
- `pvenv` is aliased to `pipenv --venv`
- `ppy` is aliased to `pipenv --py`
+
+## Configuration
+
+### Shell activation
+
+If you want to disable the shell activation and deactivation feature, add the following style to your `.zshrc` before sourcing `oh-my-zsh.sh`:
+
+```zsh
+zstyle ':omz:plugins:pipenv' auto-shell no
+```