.. _cli-confluent-help:

==============
confluent help
==============

Description
-----------
Print command information.


Usage
-----

.. sourcecode:: bash

    confluent help <command>

Options
-------

None.


Positional arguments
--------------------

===========================  =======  ====================================================
Name, shorthand              Default  Description
===========================  =======  ====================================================
``<command>``                         Print command information.
===========================  =======  ====================================================

Example
-------

For example, to print the command information for ``confluent list``:

.. sourcecode:: bash

    confluent help list

The output should resemble:

.. sourcecode:: bash

    Usage: confluent list [ plugins | connectors ]

    Description:
        List all the available services or plugins.

        Without arguments it prints the list of all the available services.

        Given 'plugins' as subcommand, prints all the connector-plugins which are
        discoverable in the current Confluent Platform deployment.

        Given 'connectors' as subcommand, prints a list of connector names that map to predefined
        connectors. Their configuration files can be found under 'etc/' directory in Confluent Platform.


    Examples:
        confluent list
            Prints the available services.

        confluent list plugins
            Prints all the connector plugins (connector classes) discoverable by Connect runtime.

        confluent list connectors
            Prints a list of predefined connectors.