You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/installation.rst
+25-6Lines changed: 25 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,16 +19,17 @@ Or using pip:
19
19
20
20
pip install poethepoet
21
21
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.
23
23
24
-
2. Install Poe the Poet into your poetry project
25
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24
+
2. Install the CLI globally using |brew_link|
25
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26
26
27
-
.. code-block:: sh
27
+
The ``poe`` CLI is also available as a |formula_link| to be installed globally:
28
28
29
-
poetry add --group dev poethepoet
29
+
.. code-block:: sh
30
30
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
32
33
33
34
3. Install Poe the Poet as a poetry plugin
34
35
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -41,6 +42,16 @@ It'll then be available as the :sh:`poetry poe` command anywhere in your system.
41
42
42
43
See the :doc:`poetry plugin docs <poetry_plugin>` for more details about this option.
43
44
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
+
44
55
.. tip::
45
56
46
57
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.
0 commit comments