Poetry Plugin: Shell

Note

We are looking for maintainers, see the issue.

This package is a plugin that runs a subshell with virtual environment activated.

This plugin replaces the same feature as the shell command previously available in Poetry.

Installation

The easiest way to install the shell plugin is via the self add command of Poetry.

poetry self add poetry-plugin-shell

If you used pipx to install Poetry you can add the plugin via the pipx inject command.

pipx inject poetry poetry-plugin-shell

Otherwise, if you used pip to install Poetry you can add the plugin packages via the pip install command.

pip install poetry-plugin-shell

Usage

The plugin provides a shell command to run a subshell with virtual environment activated.

poetry shell

By default, the current active shell is detected and used. Failing that, the shell defined via the environment variable SHELL (on *nix) or COMSPEC (on Windows) is used.

If a virtual environment does not exist, it will be created.

Note that this command starts a new shell and activates the virtual environment.

As such, exit should be used to properly exit the shell and the virtual environment instead of deactivate.

Note

This plugin internally uses the Shellingham project to detect current active shell.