# Poetry Plugin: Shell
[](https://python-poetry.org/)
> [!NOTE]
> We are looking for maintainers, see the [issue](https://github.com/python-poetry/poetry-plugin-shell/issues/3).
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.
```bash
poetry self add poetry-plugin-shell
```
If you used `pipx` to install Poetry you can add the plugin via the `pipx inject` command.
```bash
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.
```bash
pip install poetry-plugin-shell
```
## Usage
The plugin provides a `shell` command to run a subshell with virtual environment activated.
```bash
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](https://github.com/sarugaku/shellingham) project to detect current active shell.
Raw data
{
"_id": null,
"home_page": "https://python-poetry.org/",
"name": "poetry-plugin-shell",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "S\u00e9bastien Eustace",
"author_email": "sebastien@eustace.io",
"download_url": "https://files.pythonhosted.org/packages/7c/de/eb51fa4f65050be11c73dd88de9b2b01c466910d843999d622b7be8ace29/poetry_plugin_shell-1.0.1.tar.gz",
"platform": null,
"description": "# Poetry Plugin: Shell\n\n[](https://python-poetry.org/)\n\n> [!NOTE]\n> We are looking for maintainers, see the [issue](https://github.com/python-poetry/poetry-plugin-shell/issues/3).\n\nThis package is a plugin that runs a subshell with virtual environment activated.\n\n\nThis plugin replaces the same feature as the `shell` command previously available in Poetry.\n\n\n## Installation\n\nThe easiest way to install the `shell` plugin is via the `self add` command of Poetry.\n\n```bash\npoetry self add poetry-plugin-shell\n```\n\nIf you used `pipx` to install Poetry you can add the plugin via the `pipx inject` command.\n\n```bash\npipx inject poetry poetry-plugin-shell\n```\n\nOtherwise, if you used `pip` to install Poetry you can add the plugin packages via the `pip install` command.\n\n```bash\npip install poetry-plugin-shell\n```\n\n\n## Usage\n\nThe plugin provides a `shell` command to run a subshell with virtual environment activated.\n\n```bash\npoetry shell\n```\n\nBy default, the current active shell is detected and used. Failing that,\nthe shell defined via the environment variable `SHELL` (on *nix) or\n`COMSPEC` (on Windows) is used.\n\nIf a virtual environment does not exist, it will be created.\n\nNote that this command starts a new shell and activates the virtual environment.\n\nAs such, `exit` should be used to properly exit the shell and the virtual environment instead of `deactivate`.\n\n> [!NOTE]\n> This plugin internally uses the [Shellingham](https://github.com/sarugaku/shellingham) project to detect current active shell.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Poetry plugin to run subshell with virtual environment activated",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://python-poetry.org/",
"Repository": "https://github.com/python-poetry/poetry-plugin-shell"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ac6f94cabf9c8e46eda1aaa24962a0a6b84ed987b25e7ebcbe007bc689350c4",
"md5": "ddae143c5978776ea7d481dc0148e9e3",
"sha256": "9d862799a31fa710b5e52f91415ae3b9e3374e302b7646b3829c6d776ffe2c36"
},
"downloads": -1,
"filename": "poetry_plugin_shell-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ddae143c5978776ea7d481dc0148e9e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 6405,
"upload_time": "2025-01-05T14:30:22",
"upload_time_iso_8601": "2025-01-05T14:30:22.238490Z",
"url": "https://files.pythonhosted.org/packages/3a/c6/f94cabf9c8e46eda1aaa24962a0a6b84ed987b25e7ebcbe007bc689350c4/poetry_plugin_shell-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7cdeeb51fa4f65050be11c73dd88de9b2b01c466910d843999d622b7be8ace29",
"md5": "19199fee8f5ecb729919b405ced059ca",
"sha256": "2c2f878f2dbf488cdfd990fc7205af858280942f4ff766d7bbc5aa8b198a1762"
},
"downloads": -1,
"filename": "poetry_plugin_shell-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "19199fee8f5ecb729919b405ced059ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 9495,
"upload_time": "2025-01-05T14:30:23",
"upload_time_iso_8601": "2025-01-05T14:30:23.829756Z",
"url": "https://files.pythonhosted.org/packages/7c/de/eb51fa4f65050be11c73dd88de9b2b01c466910d843999d622b7be8ace29/poetry_plugin_shell-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-05 14:30:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "python-poetry",
"github_project": "poetry-plugin-shell",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "poetry-plugin-shell"
}
JSON
