Uploaded image for project: 'Kafka'
  1. Kafka
  2. KAFKA-7418

Add '--help' option to all available Kafka CLI commands (KIP-374)

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.2.0
    • Component/s: tools
    • Labels:
      None

      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.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                mrsrinivas Srinivas Reddy
                Reporter:
                asasvari Attila Sasvari
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: