From cf1575c613b48269201ca7208dac56c7264cd884 Mon Sep 17 00:00:00 2001 From: tony mancill Date: Sun, 8 Sep 2024 20:43:31 -0700 Subject: [PATCH] Update README to refer to --kafka-conf instead of --config --- README.md | 14 +++++++------- src/cli.rs | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 27b2f4c..85f1916 100644 --- a/README.md +++ b/README.md @@ -105,12 +105,12 @@ each argument can do. -b, --brokers Initial Kafka Brokers to connect to (format: 'HOST:PORT,...'). - Equivalent to '--config=bootstrap.servers:host:port,...'. + Equivalent to '--kafka-conf bootstrap.servers:host:port,...'. --client-id Client identifier used by the internal Kafka (Admin) Client. - Equivalent to '--config=client.id:my-client-id'. + Equivalent to '--kafka-conf client.id:my-client-id'. [default: kommitted] @@ -192,16 +192,16 @@ each argument can do. ```shell $ kommitted \ --brokers {{ BOOTSTRAP_BROKERS or BROKER_ENDPOINT }} \ - --config security.protocol:SASL_SSL \ - --config sasl.mechanisms=PLAIN \ - --config sasl.username:{{ USERNAME or API_KEY }} \ - --config sasl.password:{{ PASSWORD or API_SECRET }} \ + --kafka-conf security.protocol:SASL_SSL \ + --kafka-conf sasl.mechanisms=PLAIN \ + --kafka-conf sasl.username:{{ USERNAME or API_KEY }} \ + --kafka-conf sasl.password:{{ PASSWORD or API_SECRET }} \ ... ``` ### Log verbosity -Kommitted follows the long tradition of `-v/-q` to control the verbosity of it's logging: +Kommitted follows the long tradition of `-v/-q` to control the verbosity of its logging: | Arguments | Log verbosity level | Default | |----------:|:--------------------|:-------:| diff --git a/src/cli.rs b/src/cli.rs index 5893c97..adff889 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -21,13 +21,13 @@ pub struct Cli { // ------------------------------------------------------------------ Admin Client configuration /// Initial Kafka Brokers to connect to (format: 'HOST:PORT,...'). /// - /// Equivalent to '--config=bootstrap.servers:host:port,...'. + /// Equivalent to '--kafka-conf bootstrap.servers:host:port,...'. #[arg(short, long = "brokers", value_name = "BOOTSTRAP_BROKERS")] pub bootstrap_brokers: String, /// Client identifier used by the internal Kafka (Admin) Client. /// - /// Equivalent to '--config=client.id:my-client-id'. + /// Equivalent to '--kafka-conf client.id:my-client-id'. #[arg(long = "client-id", value_name = "CLIENT_ID", default_value = env!("CARGO_PKG_NAME"))] pub client_id: String,