.. _cli-command-reference:

=================
Command Reference
=================

.. toctree::
    :hidden:

    confluent_help
    confluent_completion
    confluent_cluster_describe
    confluent-iam/index
    confluent-local/index
    confluent_login
    confluent_logout
    confluent-secret/index
    confluent_update
    confluent_version

Available Commands
------------------

Here are the available commands

=========================================== ============================================================================
Command                                     Description
=========================================== ============================================================================
:ref:`confluent_completion`                 Print shell completion code.
:ref:`confluent_cluster_describe`           Discover IDs for |cp| components.
:ref:`confluent_help`                       Print command information.
:ref:`confluent_iam`                        Manage |rbac-long| and IAM permissions.
:ref:`confluent_local`                      Try out |cp| by running a single-node instance locally on your machine.
:ref:`confluent_login`                      Log in to |cp|.
:ref:`confluent_logout`                     Log out of |cp|.
:ref:`confluent_secret`                     Manage secrets for |cp|.
:ref:`confluent_update`                     Update the ``confluent`` CLI.
:ref:`confluent_version`                    Print the ``confluent`` CLI version.
=========================================== ============================================================================

To list available commands, run ``confluent`` with no parameters:

::

   Manage your Confluent Platform.

   Usage:
     confluent [command]

   Available Commands:
     completion  Print shell completion code.
     help        Help about any command
     iam         Manage RBAC and IAM permissions.
     local       Manage local Confluent Platform development environment.
     login       Log in to Confluent Platform.
     logout      Log out of Confluent Platform.
     secret      Manage secrets for Confluent Platform.
     update      Update the confluent CLI.
     version     Print the confluent CLI version.

   Flags:
     -h, --help            help for confluent
     -v, --verbose count   Increase verbosity (-v for warn, -vv for info, -vvv for debug, -vvvv for trace).
         --version         version for confluent

   Use "confluent [command] --help" for more information about a command.