Skip to content

Commit 017369f

Browse files
committed
docs(cli): add PyYAML requirement notice
Fixes #606
1 parent 6585c96 commit 017369f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/cli.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,11 @@ These options must be defined before the mandatory arguments.
157157
``--output``, ``-o``
158158
Output format. Defaults to a custom format. Can also be ``yaml`` or ``json``.
159159

160+
**Notice:**
161+
162+
The `PyYAML package <https://pypi.org/project/PyYAML/>`_ is required to use the yaml output option.
163+
You need to install it separately using ``pip install PyYAML``
164+
160165
``--fields``, ``-f``
161166
Comma-separated list of fields to display (``yaml`` and ``json`` output
162167
formats only). If not used, all the object fields are displayed.

0 commit comments

Comments
 (0)