Installing Poe the Poet#
There are a few ways to install Poe the Poet:
3. Install Poe the Poet as a poetry plugin#
poetry self add 'poethepoet[poetry_plugin]'
It’ll then be available as the
poetry poe command anywhere in your system.
See the poetry plugin docs for more details about this option.
4. Install Poe the Poet into your poetry project#
poetry add --group dev poethepoet
poe executable will then be available when inside a
poetry shell or as
poetry run poe.
If you prefer not to install poe globally, then you might want to create for yourself an alias such like
alias poe="poetry run poe" or
alias poe="poetry poe", which should enable you to still benefit from tab completion.
Enable tab completion for your shell#
Poe comes with tab completion scripts for bash, zsh, and fish to save you keystrokes. How to install them will depend on your shell setup.
mkdir -p ~/.oh-my-zsh/completions
poe _zsh_completion > ~/.oh-my-zsh/completions/_poe
# without oh-my-zsh
mkdir -p ~/.zfunc/
poe _zsh_completion > ~/.zfunc/_poe
You’ll need to start a new shell for the new completion script to be loaded. If it still doesn’t work try adding a call to
compinit to the end of your zshrc file.
# System bash
poe _bash_completion > /etc/bash_completion.d/poe.bash-completion
# Homebrew bash
poe _bash_completion > $(brew --prefix)/etc/bash_completion.d/poe.bash-completion
How to ensure installed bash completions are enabled may vary depending on your system.
poe _fish_completion > ~/.config/fish/completions/poe.fish
# Homebrew fish
poe _fish_completion > (brew --prefix)/share/fish/vendor_completions.d/poe.fish
Supported python versions#
Poe the Poet officially supports python >=3.8, and is tested with python 3.8 to 3.12 on macOS, linux and windows.