Skip to main content

Commands

./kafka-topics --version

Confluent

brew install confluentinc/tap/cli

confluent version
confluent login
confluent login --save
confluent logout

# local commands
confluent local services kafka version
confluent local services ksql-server version
confluent local services schema-registry version

confluent environment list
confluent environment use env-q2rmnp

confluent kafka cluster list
# cluster id = lkc-zmjxkd
confluent kafka cluster use lkc-zmjxkd

confluent api-key list
confluent api-key create --resource lkc-zmjxkd
confluent api-key store <api_key> <api_secret> --resource lkc-zmjxkd
confluent api-key use <api_key> --resource lkc-zmjxkd

# cloud commands
# topic
confluent kafka topic list
confluent kafka topic create test-topic
confluent kafka topic update sample_data_orders --config "num.partitions=7"

# produce
confluent kafka topic produce test-topic

# consume
confluent kafka topic consume clickstream
confluent kafka topic consume clickstream --group test-group
confluent kafka topic consume --from-beginning test-topic

# broker configuration
confluent kafka cluster configuration update --config auto.create.topics.enable=true
confluent kafka cluster configuration list --cluster lkc-abc05
confluent kafka cluster configuration describe auto.create.topics.enable

confluent-hub install confluentinc/kafka-connect-datagen:latest

Create producer or consumer config

# If you're ready to set up a producer or consumer, you can generate a configuration for the client using the CLI.
confluent kafka client-config create <LANGUAGE> --api-key <API_KEY> --api-secret <API_SECRET>
# output below
# Required connection configs for Kafka producer, consumer, and admin
bootstrap.servers=pkc-abcdef.us-east-2.aws.confluent.cloud:9092
security.protocol=SASL_SSL
sasl.mechanisms=PLAIN
sasl.username=API_KEY
sasl.password=API_SECRET

# Best practice for higher availability in librdkafka clients prior to 1.7
session.timeout.ms=45000

# Required connection configs for Confluent Cloud Schema Registry
#schema.registry.url=https://psrc-l622j.us-east-2.aws.confluent.cloud
#basic.auth.credentials.source=USER_INFO
#basic.auth.user.info={{ SR_API_KEY }}:{{ SR_API_SECRET }}

Confluent Local

confluent local kafka start

confluent local kafka topic create test-topic
confluent local kafka topic delete test-topic
confluent local kafka topic create test-topic --partitions 7

# doesn't work
confluent local kafka topic update sample_data_orders_1 --config "num.partitions=6"
confluent local kafka topic update sample_data_orders_1 --partitions 6
# works
kafka-topics --bootstrap-server localhost:9092 --alter --topic sample_data_orders_1 --partitions 6

confluent local services status
CommandDescription
confluent local services connectManage Connect.
confluent local services control-centerManage Control Center.
confluent local services kafkaManage Apache Kafka®.
confluent local services kafka-restManage Kafka REST.
confluent local services kraft-controllerManage KRaft Controller.
confluent local services ksql-serverManage ksqlDB Server.
confluent local services listList all Confluent Platform services.
confluent local services schema-registryManage Schema Registry.
confluent local services startStart all Confluent Platform services.
confluent local services statusCheck the status of all Confluent Platform services.
confluent local services stopStop all Confluent Platform services.
confluent local services topView resource usage for all Confluent Platform services.
confluent local services zookeeperManage Apache ZooKeeper™.

Install the Confluent CLI | Confluent Documentation

Tutorial: Use Confluent CLI with Confluent Cloud | Confluent Documentation

confluent local services | Confluent Documentation