diff --git a/docs/installation.rst b/docs/installation.rst index ee8915af..589283e9 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -19,16 +19,17 @@ Or using pip: pip install poethepoet -The :sh:`poe` executable will then be available anywhere in your system. +The ``poe`` executable will then be available anywhere in your system. -2. Install Poe the Poet into your poetry project -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +2. Install the CLI globally using |brew_link| +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. code-block:: sh +The ``poe`` CLI is also available as a |formula_link| to be installed globally: - poetry add --group dev poethepoet +.. code-block:: sh -The :sh:`poe` executable will then be available when inside a :sh:`poetry shell` or as :sh:`poetry run poe`. + brew tap nat-n/poethepoet + brew install nat-n/poethepoet/poethepoet 3. Install Poe the Poet as a poetry plugin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -41,6 +42,16 @@ It'll then be available as the :sh:`poetry poe` command anywhere in your system. See the :doc:`poetry plugin docs ` for more details about this option. + +4. Install Poe the Poet into your poetry project +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: sh + + poetry add --group dev poethepoet + +The :sh:`poe` executable will then be available when inside a :sh:`poetry shell` or as :sh:`poetry run poe`. + .. tip:: If you prefer not to install poe globally, then you might want to create for yourself an alias such like :sh:`alias poe="poetry run poe"` or :sh:`alias poe="poetry poe"`, which should enable you to still benefit from tab completion. @@ -108,3 +119,11 @@ macOS, linux and windows. pipx +.. |brew_link| raw:: html + + homebrew + +.. |formula_link| raw:: html + + homebrew formula +