README.md

Kaf

Kafka CLI inspired by kubectl & docker

Modifications in this fork

Possible to encode and decode avro messages with a .avsc schema file (non-ambiguous record required) e.g. schema.avsc

{
    "namespace": "sdp.scraper.collection.msg",
    "type": "record",
    "name": "DatasourceScrapeEntry",
    "fields": [
      {
        "name": "status",
        "type": "string",
        "default": "ok"
      },
      {
        "name": "dlFilePath",
        "type": "string",
        "default": "<none>"
      },
      {
        "name": "ts",
        "type" : {
          "type" : "long",
          "logicalType" : "timestamp-millis"
        }
      }
    ]
  }

consume:
./kaf -b kafka.kafka.svc.cluster.local:9092 consume topic -l 1 -a test.avsc
produce:
./kaf -b kafka.kafka.svc.cluster.local:9092 -a test.avsc produce topic
then e.g., type
{"dlFilePath": "velo.tf_msm.datasource.20200101T0000.csv","status":"ok", "ts": 1680168047722}, or save to file.json and cat file.json | ./kaf command from above...

Install

Install via Go from source:

go install github.com/birdayz/kaf/cmd/kaf@latest

Install via install script:

curl https://raw.githubusercontent.com/birdayz/kaf/master/godownloader.sh | BINDIR=$HOME/bin bash

Install on Archlinux via AUR:

yay -S kaf-bin

Install via Homebrew:

brew tap birdayz/kaf
brew install kaf

Usage

Show the tool version

kaf --version

Add a local Kafka with no auth

kaf config add-cluster local -b localhost:9092

Select cluster from dropdown list

kaf config select-cluster

Describe and List nodes

kaf node ls

List topics, partitions and replicas

kaf topics

Describe a given topic called mqtt.messages.incoming

kaf topic describe mqtt.messages.incoming

List consumer groups

kaf groups

Describe a given consumer group called dispatcher

kaf group describe dispatcher

Write message into given topic from stdin

echo test | kaf produce mqtt.messages.incoming

Set offset for consumer group dispatcher consuming from topic mqtt.messages.incoming to latest for all partitions

kaf group commit dispatcher -t mqtt.messages.incoming --offset latest --all-partitions

Configuration

See the examples folder

Shell autocompletion

Source the completion script in your shell commands file:

Bash Linux:

kaf completion bash > /etc/bash_completion.d/kaf

Bash MacOS:

kaf completion bash > /usr/local/etc/bash_completion.d/kaf

Zsh

kaf completion zsh > "${fpath[1]}/_kaf"

Fish

kaf completion fish > ~/.config/fish/completions/kaf.fish

Powershell

Invoke-Expression (@(kaf completion powershell) -replace " ''\)$"," ' ')" -join "`n")

Sponsors

Redpanda

• The streaming data platform for developers
• Single binary w/no dependencies
• Fully Kafka API compatible
• 10x lower P99 latencies, 6x faster transactions
• Zero data loss by default