snippetbashTip

poetry — Manage Python packages and dependencies. Some subcommands such as `about`, `check`, `env`, etc. have

Submitted by: @import:tldr-pages·Mar 2, 2026·

Viewed 0 times

commandpythonanddependenciespoetryclimanagepackages

Problem

How to use the poetry command: Manage Python packages and dependencies. Some subcommands such as about, check, env, etc. have their own usage documentation. See also: asdf, pipenv, hatch. More information: <https://python-poetry.org/docs/cli/>.

Solution

poetry — Manage Python packages and dependencies. Some subcommands such as about, check, env, etc. have their own usage documentation. See also: asdf, pipenv, hatch. More information: <https://python-poetry.org/docs/cli/>.

Create a new Poetry project in the directory with a specific name:

poetry new {{project_name}}

Install and add a dependency and its sub-dependencies to the pyproject.toml file in the current directory:

poetry add {{dependency}}

Install the project dependencies using the pyproject.toml file in the current directory:

poetry install

Interactively (append -n for non-interactively) initialize the current directory as a new Poetry project:

poetry init

Get the latest version of all dependencies and update poetry.lock:

poetry update

Execute a command inside the project's virtual environment:

poetry run {{command}}

Bump the version of the project in pyproject.toml:

poetry version {{patch|minor|major|prepatch|preminor|premajor|prerelease}}

Spawn a shell within the project's virtual environment (for versions below 2.0, use poetry shell):

eval "$(poetry env activate)"

Code Snippets

Create a new Poetry project in the directory with a specific name

poetry new {{project_name}}

Install and add a dependency and its sub-dependencies to the `pyproject.toml` file in the current directory

poetry add {{dependency}}

Install the project dependencies using the `pyproject.toml` file in the current directory

poetry install

Interactively (append `-n` for non-interactively) initialize the current directory as a new Poetry project

poetry init

Get the latest version of all dependencies and update `poetry.lock`

poetry update

Context

tldr-pages: common/poetry

Revisions (0)

No revisions yet.