CLI Tools Shipped With Confluent Platform

Confluent Platform provides several command-line (CLI) tools, which includes the Kafka CLI tools and additional Confluent Platform-specific tools.

All of these tools can be found in the Confluent Platform bin directory. The confluent tool can be installed separately, but it is recommended that you use the version provided with Confluent Platform.

You can find versions of some of these tools for use with Windows (.bat files), under CONFLUENT_HOME/bin/windows/.

Note that if you are using a Kafka CLI tool that is provided with Confluent Platform, the tool does not have an .sh extension.

For a list of Kafka CLI tools with usage instructions, see Kafka CLI Tools.

Search by tool name

Tool list

confluent

This tool manages Confluent Cloud and Confluent Platform, including RBAC, secrets, and the ability to deploy a single-node Confluent Platform instance as well as creating, updating, and deleting topics. For more information, see Confluent CLI.

confluent-hub

This tool installs and manages connectors. For more information, see Confluent Hub Command Reference.

confluent-rebalancer

This tool balances data and partitions between brokers. For more information, see Quick Start for Auto Data Balancing in Confluent Platform.

connect-distributed

This tool runs Connect in distributed mode. For more information, see Getting Started with Kafka Connect.

connect-standalone

This tool runs Connect in standalone mode. For more information, see see Getting Started with Kafka Connect.

control-center-console-consumer

This tool starts the Control Center console consumer. For more information, see Monitor Production and Consumption Using Control Center in Confluent Platform.

control-center-export

This tool exports data from Control Center to an output file.

control-center-reset

This tool resets Control Center and deletes all data. For more information, see Manage Control Center for Confluent Platform.

control-center-run-class

This tool is a thin wrapper around the Control Center 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 Control Center ACLs. For more information, see Configure HTTP Basic Authentication with Control Center.

control-center-start

This tool starts Control Center. For a usage example, see Control Center.

control-center-stop

This tool stops Control Center. For a usage example, see Enable and disable dynamic editing of broker configurations.

kafka-acls

This tool adds, removes, and lists ACLs. For more information, see Use ACLs.

kafka-add-brokers

This tool describes the status of the Confluent Balancer broker addition operations. For more information, see Add a broker (restart).

kafka-avro-console-consumer

This tool receives Avro data in JSON format from the console. For more information, see Formats, Serializers, and Deserializers.

kafka-avro-console-producer

This tool sends Avro data in JSON format to the console. For more information, see Formats, Serializers, and Deserializers.

kafka-broker-api-versions

This tool displays the API versions of all nodes in the cluster.

kafka-cells-admin

This tool manages cells in a Kafka cluster.

kafka-configs

This tool updates broker configs and topic configs. For more information, see Dynamically change broker settings and Modifying topics.

kafka-cluster

Use this tool to get the ID of a cluster or unregister a cluster. For more information, see Generate and format IDs.

kafka-console-consumer

This tool reads data from Kafka topics and sends output to STDOUT. For more information, see Kafka Consumer.

kafka-console-producer

This tool sends data to Kafka topics. For more information, see Kafka Producer.

kafka-consumer-groups

This tool gets a list of the active groups in the cluster. For more information, see Kafka consumer group tool.

kafka-consumer-perf-test

This tool tests the consumer performance for the Kafka cluster.

kafka-delegation-tokens

This tool creates, renews, expires, and describes delegation tokens. For more information, see Authentication using Delegation Tokens.

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. For more information, see Debug log segments.

kafka-features

This tool manages feature flags to disable or enable functionality at runtime in Kafka.

kafka-get-offsets

This tool provides an interactive shell for getting topic-partition offsets.

kafka-json-schema-console-producer

This tool sends JSON schema data in JSON format from the console. For more information, see Formats, Serializers, and Deserializers.

kafka-json-schema-console-consumer

This tool receives JSON schema data in JSON format from the console. For more information, see Formats, Serializers, and Deserializers.

kafka-leader-election

This tool initiates leader election for topic partitions.

kafka-leader-exclusion

This tool makes calls to Leadership Priority API. It changes leadership priority and describes demoted brokers. Demoted brokers will be less preferred as partition leaders compared to brokers with normal leadership priority.

kafka-log-dirs

This tool gets a list of replicas per log directory on a broker.

kafka-metadata-quorum

This tool describes the metadata quorum status. This tool is useful when you are debugging a cluster in KRaft mode. For more information, see Describe runtime status.

kafka-metadata-shell

This tool enables you to interactively examine the metadata stored in a KRaft cluster. For more information, see Inspect the metadata partition.

kafka-mirror-maker

This tool runs MirrorMaker. For more information, see Mirroring data between clusters in the Kafka Documentation.

kafka-mirrors

This tool creates and manages identical mirror topics between clusters using Cluster Linking.

kafka-mqtt-run-class

This tool is a thin wrapper around the MQTT Proxy Java class. It is mainly used by the start and stop scripts and should not be run by itself. For more information, see MQTT Proxy for Confluent Platform.

kafka-mqtt-start

This tool starts MQTT Proxy. For more information, see MQTT Proxy for Confluent Platform.

kafka-mqtt-stop

This tool stops MQTT Proxy. For more information, see MQTT Proxy for Confluent Platform.

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. This tool has been deprecated in Kafka 2.4 and was replaced by kafka-leader-election.

kafka-producer-perf-test

This tool tests the producer performance for the Kafka cluster. For more information, see Quick Start for Auto Data Balancing in Confluent Platform.

kafka-protobuf-console-producer

This tool sends Protobuf data in JSON format to the console. For more information, see Formats, Serializers, and Deserializers.

kafka-protobuf-console-consumer

This tool receives Protobuf data in JSON format from the console. For more information, see Formats, Serializers, and Deserializers.

kafka-reassign-partitions

This tool moves topic partitions between replicas. For more information, see Scaling the cluster (adding a node to a Kafka cluster).

kafka-rebalance-cluster

This tool provides visibility into the status of the SBC component, informing whether the component is disabled, starting up, or ready to serve requests. For more information, see Monitoring the balancer with kafka-rebalance-cluster.

kafka-remove-brokers

This tool executes and describes broker removal operations. For more information, see kafka-remove-brokers.

kafka-replica-exclusions

This tool sets, removes and describes broker replica placement exclusion.

kafka-replica-status

This tool prints out the replica status of partitions.

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 REST Proxy Java class. It is mainly used by the start and stop scripts and should not be run by itself. For more information, see Confluent REST Proxy for Apache Kafka.

kafka-rest-start

This tool starts the REST Proxy. For more information, see Confluent REST Proxy for Apache Kafka.

kafka-rest-stop

This tool stops the REST Proxy. For more information, see Confluent REST Proxy for Apache Kafka.

kafka-rest-stop-service

This tool stops all running instances of the REST Proxy. For more information, see Confluent REST Proxy for Apache Kafka.

kafka-run-class

This tool is a thin wrapper around the Kafka 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 Kafka.

kafka-server-stop

This tool stops Kafka.

kafka-storage

This tool generates a Cluster UUID and format storages with the cluster ID when running Kafka in KRaft mode.

kafka-streams-application-reset

This tool resets an application and forces it to reprocess its data from the beginning. For more information, see Reset Kafka Streams Applications in Confluent Platform.

kafka-topics

This tool is used to create, delete, describe, or change a Kafka topic. For more information, see Adding topics.

kafka-transactions

This tool lists and describes transactions. Use to detect and abort hanging transactions.

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 ksqlDB. For more information, see Configure ksqlDB CLI.

ksql-datagen

This tool generates test data that complies with a custom schema that you define. For more information, see Generate test data.

ksql-migrations

This tool manages metadata schemas for your ksqlDB clusters by applying statements from migration files to your ksqlDB clusters. For more info, see Manage metadata schemas.

ksql-restore-command

This tool restores the command topic.

ksql-run-class

This tool is a thin wrapper around the ksqlDB 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 ksqlDB server. For more information, see Starting the ksqlDB Server.

ksql-server-stop

This tool stops the ksqlDB server. For more information, see Operaate ksqlDB for Confluent Platform.

ksql-stop

This tool stops the ksqlDB CLI. For more information, see Install ksqlDB for Confluent Platform.

ksql-test-runner

This tool is a ksqlDB testing tool that can test a set of KSQL statements.

replicator

This tool runs Replicator. For more information, see Overview of Multi-Datacenter Deployment Solutions.

replicator-verifier

This tool verifies the Replicator configuration. For more information, see Verify Replicator Configuration for Confluent Platform.

schema-registry-run-class

This tool is a thin wrapper around the Schema Registry Java class. It is mainly used by the start and stop scripts and should not be run by itself. For more information, see Schema Registry API Usage Examples for Confluent Platform.

schema-registry-start

This tool starts Schema Registry. For more information, see Schema Registry API Usage Examples for Confluent Platform.

schema-registry-stop

This tool stops Schema Registry. For more information, see Schema Registry API Usage Examples for Confluent Platform.

schema-registry-stop-service

This tool stops all running instances of the Schema Registry. For more information, see Schema Registry API Usage Examples for Confluent Platform.

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 Schema Registry ACL CLI tool. For more information, see Schema Registry ACL Authorizer for Confluent Platform.

trogdor

This tool is a test framework for Kafka. Trogdor can run benchmarks and other workloads. Trogdor can also inject faults in order to stress test the system.

zookeeper-security-migration

This tool is used to update the ACLs of znodes as part of the process of setting up ZooKeeper authentication. For more information, see Adding security to a running ZooKeeper cluster.

zookeeper-server-start

This tool starts ZooKeeper. For more information, see Install Confluent Platform using ZIP and TAR Archives.

As of Confluent Platform 7.5, ZooKeeper is deprecated for new deployments. Confluent recommends KRaft mode for new deployments. For more information, see KRaft Overview.

zookeeper-server-stop

This tool stops ZooKeeper. For more information, see Install Confluent Platform using ZIP and TAR Archives.

zookeeper-shell

This tool connects to the ZooKeeper shell.