.. _cp-all-cli:
=======================
|cp| CLI Tools
=======================
|cp| provides the following command-line tools. All of these are located in the |cp| ``bin`` directory, except
for the ``ccloud`` tool which is installed separately.
================================ ===================================================================================================
Name Description
================================ ===================================================================================================
ccloud This tool creates and manages |ak-tm| topics in |ccloud|.
For more information, see `Confluent Cloud CLI `__.
confluent This tool installs and administers a development |cp| environment under ``localhost``.
This tool is for development purposes only and is not suitable for a production environment.
For more information, see :ref:`cli`.
confluent-hub This tool installs and manages connectors. For more information,
see :ref:`confluent-hub-client-command-reference`.
confluent-rebalancer This tool balances data and partitions between brokers. For more
information, see :ref:`rebalancer`.
connect-distributed This tool runs |kconnect| in distributed mode. For more information,
see :ref:`connect_userguide`.
connect-standalone This tool runs |kconnect| in standalone mode. For more information, see
see :ref:`connect_userguide`.
control-center-3_0_0-reset This tool is used during upgrades from |c3-short| version 3.0.0. For more information,
see :ref:`controlcenter_upgrade`.
control-center-3_0_1-reset This tool is used during upgrades from |c3-short| version 3.0.1. For more information,
see :ref:`controlcenter_upgrade`.
control-center-console-consumer This tool starts the |c3-short| console consumer. For more information,
see :ref:`controlcenter_clients`.
control-center-export This tool exports data from |c3-short| to an output file.
control-center-reset This tool resets |c3-short| and deletes all data. For more information,
see :ref:`controlcenter_install`.
control-center-run-class This tool is a thin wrapper around the |c3-short| Java class. It is mainly used by the
start and stop scripts and should not be run by itself.
control-center-set-acls This tool is used to set the |c3-short| ACLs. For more information, see
:ref:`ui_authentication`.
control-center-start This tool starts |c3-short|. For a usage example, see :ref:`prod-kafka-cli-install`.
control-center-stop This tool stops |c3-short|. For a usage example, see :ref:`ff_c3_edit_broker_configs`.
kafka-acls This tool adds, removes, and lists ACLs. For more
information, see :ref:`kafka_authorization`.
kafka-avro-console-consumer This tool receives Avro data in JSON format from the console. For more
information, see :ref:`serializer_and_formatter`.
kafka-avro-console-producer This tool sends Avro data in JSON format to the console. For more
information, see :ref:`serializer_and_formatter`.
kafka-broker-api-versions This tool displays the API versions of all nodes in the cluster.
kafka-configs This tool updates broker configs. For more information, see
:ref:`kafka_dyn_broker_config`.
kafka-console-consumer This tool reads data from |ak| topics and sends output to STDOUT.
For more information, see :ref:`kafka_consumer`.
kafka-console-producer This tool sends data to |ak| topics. For more information, see
:ref:`kafka_producer`.
kafka-consumer-groups This tool gets a list of the active groups in the cluster. For more
information, see :ref:`kafka_consumer_describe_group`.
kafka-consumer-perf-test This tool tests the consumer performance for the |ak| cluster.
kafka-delegation-tokens This tool creates, renews, expires, and describes delegation tokens. For more
information, see :ref:`kafka_sasl_delegate_auth`.
kafka-delete-records This tool deletes partition records.
kafka-dump-log This tool parses a log file and dumps its contents to the console. This is
useful for debugging log segments.
kafka-log-dirs This tool gets a list of replicas per log directory on a broker.
kafka-mirror-maker This tool runs |mmaker|. For more information, see `Mirroring data between clusters `_ in the |ak| Documentation.
kafka-mqtt-run-class This tool is a thin wrapper around the |mqtt| Java class. It is mainly used by the
start and stop scripts and should not be run by itself. For more information, see
:ref:`kafka_mqtt_intro`.
kafka-mqtt-start This tool starts |mqtt|. For more information, see :ref:`kafka_mqtt_intro`.
kafka-mqtt-stop This tool stops |mqtt|. For more information, see :ref:`kafka_mqtt_intro`.
kafka-preferred-replica-election This tool transfers the leadership for each partition back to the "preferred replica"
and is used to balance leadership among the servers. For more information, see the
`Apache Kafka wiki `_
kafka-producer-perf-test This tool tests the producer performance for the |ak| cluster. For more
information, see :ref:`rebalancer`.
kafka-reassign-partitions This tool moves topic partitions between replicas. For more information,
see :ref:`scaling-the-cluster`.
kafka-replica-verification This tool validates that all replicas for a set of topics have the same data.
kafka-rest-run-class This tool is a thin wrapper around the |crest| Java class. It is mainly used by the
start and stop scripts and should not be run by itself. For more information, see
:ref:`kafkarest_intro`.
kafka-rest-start This tool starts the |crest|. For more information, see :ref:`kafkarest_intro`.
kafka-rest-stop This tool stops the |crest|. For more information, see :ref:`kafkarest_intro`.
kafka-rest-stop-service This tool stops all running instances of the |crest|. For more information, see
:ref:`kafkarest_intro`.
kafka-run-class This tool is a thin wrapper around the |ak| Java class. It is mainly used by the
start and stop scripts and should not be run by itself.
kafka-server-start This tool starts |ak|.
kafka-server-stop This tool stops |ak|.
kafka-streams-application-reset This tool resets an application and forces it to reprocess its data from
the beginning. For more information, see :ref:`streams_developer-guide_app-reset`.
kafka-topics This tool is used to create, delete, describe, or change a |ak| topic. For more
information, see :ref:`adding-topics`.
kafka-verifiable-consumer This tool consumes messages from a topic and emits consumer events as JSON
objects to STDOUT. For example, group rebalances, received messages, and offsets
committed.
kafka-verifiable-producer This tool produces increasing integers to the specified topic and prints
JSON metadata to STDOUT on each "send" request. This makes externally
visible which messages have been ``acked`` and which have not.
ksql This tool runs KSQL. For more information, see :ref:`install_cli-config`.
ksql-datagen This tool generates test data that complies with a custom schema that you
define. For more information, see :ref:`ksql_generate-custom-test-data`.
ksql-print-metrics This tool collects JMX metrics from the KSQL server process. For more
information, see :ref:`check-ksql-server-health`.
ksql-run-class This tool is a thin wrapper around the KSQL Java class. It is mainly used by the
start and stop scripts and should not be run by itself.
ksql-server-start This tool starts the KSQL server. For more information,
see :ref:`start_ksql-server`.
ksql-server-stop This tool stops the KSQL server. For more information,
see :ref:`ksql_operations`.
ksql-stop This tool stops the KSQL CLI. For more information, see :ref:`install_ksql`.
replicator This tool runs |crep-full|. For more information, see :ref:`multi_dc`.
schema-registry-run-class This tool is a thin wrapper around the |sr| Java class. It is mainly used by the
start and stop scripts and should not be run by itself. For more information, see
:ref:`schemaregistry_using`.
schema-registry-start This tool starts |sr|. For more information, see :ref:`schemaregistry_using`.
schema-registry-stop This tool stops |sr|. For more information, see :ref:`schemaregistry_using`.
schema-registry-stop-service This tool stops all running instances of the |sr|. For more information, see
:ref:`schemaregistry_using`.
security-plugins-run-class This tool is a thin wrapper around the Confluent Security Plugins Java class. It is
mainly used by the start and stop scripts and should not be run by itself.
sr-acl-cli This tool runs the |sr| ACL CLI tool. For more information, see
:ref:`confluentsecurityplugins_sracl_authorizer`.
zookeeper-security-migration This tool is used to update the ACLs of znodes as part of the process of setting up
|zk| authentication. For more information, see :ref:`zookeeper_adding_security`.
zookeeper-server-start This tool starts |zk|. For more information, see :ref:`prod-kafka-cli-install`.
zookeeper-server-stop This tool stops |zk|. For more information, see :ref:`prod-kafka-cli-install`.
zookeeper-shell This tool connects to the |zk| shell.
================================ ===================================================================================================