Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
P
python-poetry
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
open
python-poetry
Commits
2571a423
Unverified
Commit
2571a423
authored
Jun 21, 2022
by
Bartosz Sokorski
Committed by
GitHub
Jun 20, 2022
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: rework completions section (#5879)
Co-authored-by: Bjorn Neergaard <bjorn@neersighted.com>
parent
faf02de7
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
35 additions
and
17 deletions
+35
-17
docs/_index.md
+35
-17
No files found.
docs/_index.md
View file @
2571a423
...
...
@@ -282,38 +282,46 @@ To uninstall Poetry, simply delete the entire `$VENV_PATH` directory.
`
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:
### Bash
#### Auto-loaded (recommended)
```bash
# Bash
poetry completions bash > /etc/bash_completion.d/poetry
poetry completions bash >> ~/.bash_completion
```
# Fish
poetry completions fish > ~/.config/fish/completions/poetry.fish
#### Lazy-loaded
# Zsh
poetry completions zsh > ~/.zfunc/_poetry
# Oh-My-Zsh
mkdir $ZSH_CUSTOM/plugins/poetry
poetry completions zsh > $ZSH_CUSTOM/plugins/poetry/_poetry
```bash
poetry completions bash > ${XDG_DATA_HOME:~/.local/share}/bash_completion/completions/poetry
```
# prezto
poetry completions zsh > ~/.zprezto/modules/completion/external/src/_poetry
### Fish
```fish
poetry completions fish > ~/.config/fish/completions/poetry.fish
```
{{% note %}}
You may need to restart your shell in order for the changes to take effect.
{{% /note %}}
### Zsh
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
fpath+=~/.zfunc
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
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 %}}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment