Skip to content

Commit f500668

Browse files
committed
Add installation instructions for homebrew formula
1 parent 0c75767 commit f500668

1 file changed

Lines changed: 25 additions & 6 deletions

File tree

docs/installation.rst

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,17 @@ Or using pip:
1919
2020
pip install poethepoet
2121
22-
The :sh:`poe` executable will then be available anywhere in your system.
22+
The ``poe`` executable will then be available anywhere in your system.
2323

24-
2. Install Poe the Poet into your poetry project
25-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24+
2. Install the CLI globally using |brew_link|
25+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2626

27-
.. code-block:: sh
27+
The ``poe`` CLI is also available as a |formula_link| to be installed globally:
2828

29-
poetry add --group dev poethepoet
29+
.. code-block:: sh
3030
31-
The :sh:`poe` executable will then be available when inside a :sh:`poetry shell` or as :sh:`poetry run poe`.
31+
brew tap nat-n/poethepoet
32+
brew install nat-n/poethepoet/poethepoet
3233
3334
3. Install Poe the Poet as a poetry plugin
3435
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -41,6 +42,16 @@ It'll then be available as the :sh:`poetry poe` command anywhere in your system.
4142

4243
See the :doc:`poetry plugin docs <poetry_plugin>` for more details about this option.
4344

45+
46+
4. Install Poe the Poet into your poetry project
47+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48+
49+
.. code-block:: sh
50+
51+
poetry add --group dev poethepoet
52+
53+
The :sh:`poe` executable will then be available when inside a :sh:`poetry shell` or as :sh:`poetry run poe`.
54+
4455
.. tip::
4556

4657
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.
108119

109120
<a href="https://pypa.github.io/pipx/" target="_blank">pipx</a>
110121

122+
.. |brew_link| raw:: html
123+
124+
<a href="https://brew.sh/" target="_blank">homebrew</a>
125+
126+
.. |formula_link| raw:: html
127+
128+
<a href="https://github.com/nat-n/homebrew-poethepoet" target="_blank">homebrew formula</a>
129+

0 commit comments

Comments
 (0)