Update README.md

leizor · Mar 13, 2024 · d088bc6 · d088bc6
1 parent 431a465
commit d088bc6
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -23,3 +23,6 @@ go.work
 # Build output
 kafka-util
 dist/
+
+# Mac stuff
+.DS_Store
diff --git a/README.md b/README.md
@@ -70,3 +70,25 @@ Use the `--dry-run` flag to print the reassignments without actually executing t
 ```shell
 kafka-util stage --reassignment-json-file reassignments.json --max-moves-per-broker 1 --dry-run
 ```
+
+## Describe topics
+
+To describe topics:
+```shell
+kafka-util topics --topic foobar --topic foobaz
+```
+
+To print partition leadership distribution per topic:
+```shell
+kafka-util topics --topic foobar --topic foobaz --leader-distribution
+```
+
+To print partition replica distribution per topic:
+```shell
+kafka-util topics --topic foobar --topic foobaz --replica-distribution
+```
+
+Generate a topics-to-move JSON file:
+```shell
+kafka-util topics --topic foobar --topic foobaz --generate
+```