[KAFKA-7418] Add '--help' option to all available Kafka CLI commands (KIP-374)

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.2.0
• Component/s: tools
• Assignee: Srinivas Reddy
• Reporter: Attila Sasvári
• Created: 18/Sep/18 08:48
• Updated: 11/Mar/20 20:45
• Resolved: 22/Nov/18 11:43

Description

Currently, the '--help' option is not recognized by some Kafka commands . For example:

$ kafka-console-producer --help
help is not a recognized option

However, the '--help' option is supported by other commands:

$ kafka-verifiable-producer --help
usage: verifiable-producer [-h] --topic TOPIC --broker-list HOST1:PORT1[,HOST2:PORT2[...]] [--max-messages MAX-MESSAGES] [--throughput THROUGHPUT] [--acks ACKS]
                           [--producer.config CONFIG_FILE] [--message-create-time CREATETIME] [--value-prefix VALUE-PREFIX]

...

To provide a consistent user experience, it would be nice to add a '--help' option to all Kafka commands.

Issue Links

• duplicates: KAFKA-6971 Passing in help flag to kafka-console-producer should print arg options
• fixes: KAFKA-1292 Command-line tools should print what they do as part of their usage command
• links to: GitHub Pull Request #5910
• mentioned in: Page Loading...
• mentioned in: Page Loading...