Skip to content

keaz/kcli

Repository files navigation

kfcli

kfcli is a command-line interface (CLI) tool written in Rust. It provides utilities to monitor Kafka topics and consumers.

Test CI

Features

  • Topic Monitor: Monitor Kafka topics, list all topics, get details of a topic, create, delete, and tail topics.
  • Broker Monitor: Monitor Kafka brokers.
  • Consumer Group Monitor: Monitor Kafka consumer groups.

Task Completed

  • MVP
  • Support JSON
  • Tail Topics
  • Inspect Topic/Groups
  • Manage different Environments
  • Support XML
  • Unit tests
  • Performance improvement
  • Documentation

Installation

Using Cargo

To install kfcli using Cargo, you can use the following command:

cargo install kfcli

Using Homebrew (macOS)

To install kfcli on macOS using Homebrew, you can use the following commands:

brew tap keaz/homebrew
brew install kfcli

Usage

Here are some examples of how to use kfcli:

Config Commands

Set the active environment

kfcli config active <environment_name>

Topic Commands

List all topics

kfcli topic list

Get details of a topic

kfcli topics details <topic_name>

Create a topic

kfcli topics create <topic_name> --partitions <num_partitions> --replication-factor <replication_factor>

Delete a topic

kfcli topics delete <topic_name>

Tail a topic

kfcli topics tail <topic_name>

Tail a topic with filters

kfcli topics tail  <topic_name>  "<filter>"

Example:

kfcli topics tail another-topic  "data.attributes.name=19"

kfcli

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.

Contact

For any questions or feedback, please contact [email protected].

About

A CLI tool to inspect Kafka clusters

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published