This plugin allows you to define aliases or shortcuts for commonly used commands in your Poetry projects. It simplifies command execution by providing custom aliases for complex or frequently used commands.
-
Installation:
Install the plugin using Poetry:
pip install poetry-plugin-commands
or
pip install --user poetry-plugin-commands
or at least
poetry self add poetry-plugin-commands
-
Define Aliases:
Add your aliases to the
pyproject.toml
file under the[tool.poetry-plugin-commands]
section:[tool.poetry-plugin-commands] stree = "tree src" test_var = "echo $VAR" run_app = "PYTHONPATH=src:. poetry run python src/app_launch/main.py"
Here,
stree
,test_var
, andrun_app
are the custom aliases, and their corresponding commands are specified. -
Execute Commands:
Now you can use the defined aliases with Poetry:
poetry stree
poetry test_var
poetry run_app
These commands will execute the respective commands defined as aliases.
-
List Available Commands:
To get a list of available aliases along with their corresponding commands, run:
poetry user-commands
This will display a list of aliases and their associated commands:
stree -> `tree src` test_var -> `echo $VAR` run_app -> `PYTHONPATH=src:. poetry run python src/app_launch/main.py`
Feel free to contribute to this plugin by reporting issues, suggesting features, or submitting pull requests on GitHub.
This plugin is licensed under the Apache 2. License. See the LICENSE file for details.