.. _cli-command-reference:

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

.. toctree::
   :hidden:

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

.. include:: ../../includes/cli.rst
   :start-after: cli_limitations_start
   :end-before: cli_limitations_end


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

The available commands are:

============================== ==================================================
Command                        Description
============================== ==================================================
:ref:`confluent_local_acl`     Specify an ACL for a service.
:ref:`confluent_local_config`  View or set connector configuration properties.
:ref:`confluent_local_consume` Consume data from topics.
:ref:`confluent_local_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:`confluent_local_demo`    Run Confluent Platform demos.
:ref:`confluent_local_destroy` Delete an existing Confluent run.
:ref:`cli-confluent-help`      Print command information.
:ref:`confluent_local_list`    List all available services or plugins.
:ref:`confluent_local_load`    Load a bundled connector with a predefined name or
                               custom connector.
:ref:`confluent_local_log`     View a snapshot or tail the log of a service.
:ref:`confluent_local_produce` Produce data to topics.
:ref:`confluent_local_start`   Start  |cp| services.
:ref:`confluent_local_status`  Get the status of all services or the status of a
                               specific service and its dependencies.
:ref:`confluent_local_stop`    Stop services.
:ref:`confluent_local_top`     View service resource usage.
:ref:`confluent_local_unload`  Unload a connector.
============================== ==================================================

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

.. codewithvars:: 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.
       consume     Consume data from topics
       current     Get the path of the data and logs of the services managed by the current confluent run.
       demo        Run Confluent Platform demos.
       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.
       produce     Produce data to topics
       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`.

To configure properties for specific services via environment variable, use the given prefix for
the corresponding service:

+-----------------+-----------------------+
| Service         | Prefix                |
+=================+=======================+
| |zk|            | ``$ZOOKEEPER_``       |
+-----------------+-----------------------+
| |ak-tm|         | ``$KAFKA_``           |
+-----------------+-----------------------+
| |sr|            | ``$SCHEMA_REGISTRY_`` |
+-----------------+-----------------------+
| REST Proxy      | ``$KAFKAREST_``       |
+-----------------+-----------------------+
| |kconnect-long| | ``$CONNECT_``         |
+-----------------+-----------------------+

For example, to set the system property
``-Djava.security.auth.login.config=/tmp/kafka_client_jaas.conf`` when starting |kconnect-long|, run the
command:

.. codewithvars:: bash

   export CONNECT_OPTS="-Djava.security.auth.login.config=/tmp/kafka_client_jaas.conf"
   |confluent_start| connect

and to set the same system property when invoking |ak| core, run the command:

.. codewithvars:: bash

   export KAFKA_OPTS="-Djava.security.auth.login.config=/tmp/kafka_client_jaas.conf"
   |confluent_start| kafka

The |ak-tm| startup scripts for |kconnect-long| (``bin/connect-standalone.sh`` and
``bin/connect-distributed.sh``) use variables prefixed with ``$KAFKA_`` (e.g. ``$KAFKA_OPTS`` and
``$KAFKA_LOG4J_OPTS``). For simplicity, the Confluent CLI uses ``$CONNECT_`` for |kconnect-long|
settings and ``$KAFKA_`` for core |ak| settings.