diff options
| author | Max Wittig <max.wittig95@gmail.com> | 2018-10-07 17:34:44 +0200 |
|---|---|---|
| committer | Max Wittig <max.wittig95@gmail.com> | 2018-10-09 20:41:55 +0200 |
| commit | d29a48981b521bf31d6f0304b88f39a63185328a (patch) | |
| tree | e40c2e50b41ac2b0952fca3223d8ee262608e205 /docs/cli.rst | |
| parent | 6585c967732fe2a53c6ad6d4d2ab39aaa68258b0 (diff) | |
| download | gitlab-d29a48981b521bf31d6f0304b88f39a63185328a.tar.gz | |
docs(cli): add PyYAML requirement noticeci-output-option
Fixes #606
Diffstat (limited to 'docs/cli.rst')
| -rw-r--r-- | docs/cli.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/cli.rst b/docs/cli.rst index 220f079..2051d03 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -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. |