diff --git a/tools/README.md b/tools/README.md index cdb892348..d5d9d244a 100644 --- a/tools/README.md +++ b/tools/README.md @@ -4,6 +4,6 @@ This folder contains applications that are useful for exploration of your Kafka Some of these tools mirror tools that ship with Kafka, but these tools won't require installing the JVM to function. - [kafka-console-producer](./kafka-console-producer): a command line tool to produce a single message to your Kafka custer. -- [kafka-console-topicconsumer](./kafka-console-topicconsumer): a command line tool to consume partitions of a topic on your Kafka cluster. +- [kafka-console-consumer](./kafka-console-consumer): a command line tool to consume partitions of a topic on your Kafka cluster. To install all tools, run `go get github.com/Shopify/sarama/tools/...` diff --git a/tools/kafka-console-consumer/.gitignore b/tools/kafka-console-consumer/.gitignore new file mode 100644 index 000000000..67da9dfa9 --- /dev/null +++ b/tools/kafka-console-consumer/.gitignore @@ -0,0 +1,2 @@ +kafka-console-consumer +kafka-console-consumer.test diff --git a/tools/kafka-console-topicconsumer/README.md b/tools/kafka-console-consumer/README.md similarity index 52% rename from tools/kafka-console-topicconsumer/README.md rename to tools/kafka-console-consumer/README.md index d786ebf3a..4e77f0b70 100644 --- a/tools/kafka-console-topicconsumer/README.md +++ b/tools/kafka-console-consumer/README.md @@ -1,29 +1,29 @@ -# kafka-console-topicconsumer +# kafka-console-consumer -A simple command line tool to consume partitions of a topic and print the messages -on the standard output. +A simple command line tool to consume partitions of a topic and print the +messages on the standard output. ### Installation - go get github.com/Shopify/sarama/tools/kafka-console-topicconsumer + go get github.com/Shopify/sarama/tools/kafka-console-consumer ### Usage # Minimum invocation - kafka-console-topicconsumer -topic=test -brokers=kafka1:9092 + kafka-console-consumer -topic=test -brokers=kafka1:9092 # It will pick up a KAFKA_PEERS environment variable export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092 - kafka-console-topicconsumer -topic=test + kafka-console-consumer -topic=test # You can specify the offset you want to start at. It can be either # `oldest`, `newest`. The default is `newest`. - kafka-console-topicconsumer -topic=test -offset=oldest - kafka-console-topicconsumer -topic=test -offset=newest + kafka-console-consumer -topic=test -offset=oldest + kafka-console-consumer -topic=test -offset=newest # You can specify the partition(s) you want to consume as a comma-separated # list. The default is `all`. - kafka-console-topicconsumer -topic=test -partitions=1,2,3 + kafka-console-consumer -topic=test -partitions=1,2,3 # Display all command line options - kafka-console-topicconsumer -help + kafka-console-consumer -help diff --git a/tools/kafka-console-topicconsumer/kafka-console-topicconsumer.go b/tools/kafka-console-consumer/kafka-console-consumer.go similarity index 100% rename from tools/kafka-console-topicconsumer/kafka-console-topicconsumer.go rename to tools/kafka-console-consumer/kafka-console-consumer.go diff --git a/tools/kafka-console-topicconsumer/.gitignore b/tools/kafka-console-topicconsumer/.gitignore deleted file mode 100644 index 2787203a3..000000000 --- a/tools/kafka-console-topicconsumer/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -kafka-console-topicconsumer -kafka-console-topicconsumer.test