Back to Ohmyzsh

Poetry Plugin

plugins/poetry/README.md

latest4.7 KB
Original Source

Poetry Plugin

This plugin automatically installs Poetry's completions for you, and keeps them up to date as your Poetry version changes.

To use it, add poetry to the plugins array in your zshrc file:

zsh
plugins=(... poetry)

Aliases

AliasCommandDescription
padpoetry addAdd packages to pyproject.toml and install them
pbldpoetry buildBuild the source and wheels archives
pchpoetry checkValidate the content of the pyproject.toml and its consistency with the poetry.lock
pcmdpoetry listDisplay all the available Poetry commands
pconfpoetry config --listAllow you to edit poetry config settings and repositories
pexp`poetry export --without-hashes > requirements.txtExport the lock file to requirements.txt
pinpoetry initCreate a pyproject.toml interactively
pinstpoetry installRead the pyproject.toml, resolve the dependencies, and install them
plckpoetry lockLock the dependencies in pyproject.toml without installing
pnewpoetry newCreate a directory structure suitable for most Python projects
ppathpoetry env info --pathGet the path of the currently activated virtualenv`
pplugpoetry self show pluginsList all the installed Poetry plugins
ppubpoetry publishPublish the builded (poetry build command) package to the remote repository
prmpoetry removeRemove packages from pyproject.toml and uninstall them
prunpoetry runExecutes the given command inside the project’s virtualenv
psadpoetry self addAdd the Poetry plugin and install dependencies to make it work
pshpoetry shellSpawns a shell within the virtual environment. If one doesn’t exist, it will be created
pshwpoetry showList all the available dependencies
psltpoetry show --latestList lastest version of the dependencies
psuppoetry self updateUpdate Poetry to the latest version (default) or to the specified version
psyncpoetry install --syncSynchronize your environment with the poetry.lock
ptreepoetry show --treeList the dependencies as tree
puppoetry updateGet the latest versions of the dependencies and to update the poetry.lock
pvinfpoetry env infoGet basic information about the currently activated virtualenv
pvoffpoetry config virtualenvs.create falseDisable automatic virtualenv creation
pvrmpoetry env removeDelete existing virtualenvs
pvrmapoetry env remove --allDelete all existing virtualenvs
pvupoetry env useSwitch between existing virtualenvs