.. _cli:

###
CLI
###

The library comes with a CLI tool called ``rctclient`` that offers some useful subcommands.

The tool is only installed if the `click <https://click.palletsprojects.com/>`_ module's present. If installing from
`pip`, the requirement can be pulled in by specifying ``rctclient[cli]``.

For certain parameters, the tool supports shell completion, which you can activate for your current terminal::

   eval "$(_RCTCLIENT_COMPLETE=bash_source rctclient)"

Read more about this at the `click documentation <https://click.palletsprojects.com/en/7.x/bashcomplete/#activation>`_.

.. click:: rctclient.cli:cli
   :prog: rctclient
   :nested: full