Poetry plugin

March 11, 2025 ยท View on GitHub

This is my personal opinionated plugin for Oh My ZSH! that adds aliases for my most freqently used poetry commands.

Installation

  • copy the poetry.plugin.zsh file to your $ZSH_CUSTOM/plugins/poetry folder
mkdir $ZSH_CUSTOM/plugins/poetry
cp poetry.plugin.zsh $ZSH_CUSTOM/plugins/poetry
  • add poetry to the plugins array in your zshrc file:
plugins=(... poetry)
  • Reload with omz reload
  • (Optional) Enable tab completion for poetry (read poetry doc)

Aliases

AliasCommandDescription
poepoetryPoetry command
poipoetry installInstall dependencies
porpoetry runRun command in Poetry environment: por <command>
potpoetry run pytest -sRun pytest with output capturing disabled
poadpoetry addAdd a dependency: poad <package>
poaddpoetry add --devAdd a dev dependency: poadd <package>
pormpoetry removeRemove a dependency: porm <package>
mkservepoetry run mkdocs serveRun MkDocs development server

More information about poetry commands.