.. _cli-command-reference:

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

.. toctree::
   :hidden:

   confluent-acl
   confluent-config
   confluent-current
   confluent-destroy
   confluent-help
   confluent-list
   confluent-load
   confluent-log
   confluent-start
   confluent-status
   confluent-stop
   confluent-top
   confluent-unload

.. include:: ../../includes/installation.rst
   :start-line: 34
   :end-line: 37

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

The available commands are:

=============================  ==================================================
Command                        Description
=============================  ==================================================
:ref:`cli-confluent-acl`       Specify an ACL for a service.
:ref:`cli-confluent-config`    View or set connector configuration properties.
:ref:`cli-confluent-current`   Print the filesystem path of the data and logs
                               of the services managed by the current Confluent
                               run. If such a path does not exist, it will be
                               created.
:ref:`cli-confluent-destroy`   Delete an existing Confluent run.
:ref:`cli-confluent-help`      Print command information.
:ref:`cli-confluent-list`      List all available services or plugins.
:ref:`cli-confluent-load`      Load a bundled connector with a predefined name or
                               custom connector.
:ref:`cli-confluent-log`       View a snapshot or tail the log of a service.
:ref:`cli-confluent-start`     Start  |CP| services.
:ref:`cli-confluent-stop`      Stop services.
:ref:`cli-confluent-top`       View service resource usage.
:ref:`cli-confluent-unload`    Unload a connector.
=============================  ==================================================

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

.. sourcecode:: bash

   confluent: A command line interface to manage Confluent services

   Usage: confluent <command> [<subcommand>] [<parameters>]

   These are the available commands:

       acl         Specify acl for a service.
       config      Configure a connector.
       current     Get the path of the data and logs of the services managed by the current confluent run.
       destroy     Delete the data and logs of the current confluent run.
       list        List available services.
       load        Load a connector.
       log         Read or tail the log of a service.
       start       Start all services or a specific service along with its dependencies
       status      Get the status of all services or the status of a specific service along with its dependencies.
       stop        Stop all services or a specific service along with the services depending on it.
       top         Track resource usage of a service.
       unload      Unload a connector.

   'confluent help' lists available commands. See 'confluent help <command>' to read about a
   specific command.

Environment Variables
---------------------
The Confluent CLI supports the ``CONFLUENT_CURRENT`` environment variable, which can be set dynamically. For more information,
see :ref:`cli-install`.