mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2026-08-22 16:13:23 +08:00
53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
# Pipenv
|
|
|
|
This plugin provides some features to simplify the use of [Pipenv](https://pipenv.pypa.io/) while working on ZSH.
|
|
|
|
In your `.zshrc` file, add `pipenv` to the plugins section
|
|
|
|
```
|
|
plugins=(... pipenv ...)
|
|
```
|
|
|
|
## Features
|
|
|
|
- Adds completion for pipenv ([install the `argcomplete` package to get it working with pipenv >= 2026.5.0](https://pipenv.pypa.io/en/latest/shell.html#shell-completion))
|
|
- 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`
|
|
- `pupd` is aliased to `pipenv update`
|
|
- `pwh` is aliased to `pipenv --where`
|
|
- `pvenv` is aliased to `pipenv --venv`
|
|
- `ppy` is aliased to `pipenv --py`
|
|
|
|
## Cache
|
|
|
|
This plugin caches the Pipenv version to avoid running `pipenv --version` on every shell startup. The cache is automatically refreshed asynchronously when the plugin is loaded, which is usually when you start a new terminal session.
|
|
|
|
For legacy Pipenv versions, the generated completion script is also cached.
|
|
|
|
The cache is stored at:
|
|
|
|
- `$ZSH_CACHE_DIR/pipenv_version` version of Pipenv, used to choose between argcomplete-based completion and legacy Click-based completion.
|
|
|
|
- `$ZSH_CACHE_DIR/completions/_pipenv` legacy Click-based completion script.
|
|
|
|
## 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
|
|
```
|