diff options
Diffstat (limited to 'docs/cli.rst')
| -rw-r--r-- | docs/cli.rst | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/cli.rst b/docs/cli.rst index 654c00a..2051d03 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -69,7 +69,7 @@ parameters. You can override the values in each GitLab server section. - Integer - Number of seconds to wait for an answer before failing. * - ``api_version`` - - ``3`` ou ``4`` + - ``3`` or ``4`` - The API version to use to make queries. Requires python-gitlab >= 1.3.0. * - ``per_page`` - Integer between 1 and 100 @@ -78,6 +78,11 @@ parameters. You can override the values in each GitLab server section. You must define the ``url`` in each GitLab server section. +.. warning:: + + If the GitLab server you are using redirects requests from http to https, + make sure to use the ``https://`` protocol in the ``url`` definition. + Only one of ``private_token`` or ``oauth_token`` should be defined. If neither are defined an anonymous request will be sent to the Gitlab server, with very limited permissions. @@ -152,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. |