Commit 2571a423 by Bartosz Sokorski Committed by GitHub

docs: rework completions section (#5879)

Co-authored-by: Bjorn Neergaard <bjorn@neersighted.com>
parent faf02de7
...@@ -282,38 +282,46 @@ To uninstall Poetry, simply delete the entire `$VENV_PATH` directory. ...@@ -282,38 +282,46 @@ To uninstall Poetry, simply delete the entire `$VENV_PATH` directory.
`poetry` supports generating completion scripts for Bash, Fish, and Zsh. `poetry` supports generating completion scripts for Bash, Fish, and Zsh.
See `poetry help completions` for full details, but the gist is as simple as using one of the following: See `poetry help completions` for full details, but the gist is as simple as using one of the following:
### Bash
#### Auto-loaded (recommended)
```bash ```bash
# Bash poetry completions bash >> ~/.bash_completion
poetry completions bash > /etc/bash_completion.d/poetry ```
# Fish #### Lazy-loaded
poetry completions fish > ~/.config/fish/completions/poetry.fish
# Zsh ```bash
poetry completions zsh > ~/.zfunc/_poetry poetry completions bash > ${XDG_DATA_HOME:~/.local/share}/bash_completion/completions/poetry
```
# Oh-My-Zsh
mkdir $ZSH_CUSTOM/plugins/poetry
poetry completions zsh > $ZSH_CUSTOM/plugins/poetry/_poetry
# prezto ### Fish
poetry completions zsh > ~/.zprezto/modules/completion/external/src/_poetry
```fish
poetry completions fish > ~/.config/fish/completions/poetry.fish
``` ```
{{% note %}} ### Zsh
You may need to restart your shell in order for the changes to take effect.
{{% /note %}}
For `zsh`, you must then add the following lines in your `~/.zshrc` ```zsh
poetry completions zsh > ~/.zfunc/_poetry
```
You must then add the following lines in your `~/.zshrc`, if they do not already exist:
```bash ```bash
fpath+=~/.zfunc fpath+=~/.zfunc
autoload -Uz compinit && compinit autoload -Uz compinit && compinit
``` ```
For `oh-my-zsh`, you must then enable poetry in your `~/.zshrc` plugins #### Oh My Zsh
```zsh
mkdir $ZSH_CUSTOM/plugins/poetry
poetry completions zsh > $ZSH_CUSTOM/plugins/poetry/_poetry
```
You must then add `poetry` to your plugins array in `~/.zshrc`:
```text ```text
plugins( plugins(
...@@ -321,3 +329,13 @@ plugins( ...@@ -321,3 +329,13 @@ plugins(
... ...
) )
``` ```
#### prezto
```zsh
poetry completions zsh > ~/.zprezto/modules/completion/external/src/_poetry
```
{{% note %}}
You may need to restart your shell in order for these changes to take effect.
{{% /note %}}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment