Skip to content

Commit

Permalink
docs(cli): add PyYAML requirement notice
Browse files Browse the repository at this point in the history
Fixes #606
  • Loading branch information
max-wittig committed Oct 7, 2018
1 parent 6585c96 commit 017369f
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/cli.rst
Expand Up @@ -157,6 +157,11 @@ These options must be defined before the mandatory arguments.
``--output``, ``-o``
Output format. Defaults to a custom format. Can also be ``yaml`` or ``json``.

**Notice:**

The `PyYAML package <https://pypi.org/project/PyYAML/>`_ is required to use the yaml output option.
You need to install it separately using ``pip install PyYAML``

``--fields``, ``-f``
Comma-separated list of fields to display (``yaml`` and ``json`` output
formats only). If not used, all the object fields are displayed.
Expand Down

0 comments on commit 017369f

Please sign in to comment.