kafeman

README

kafeman

kaf inspired cli for kafka management

• Optimizations for fast performance in large kafka clusters
• Simplified work with proto in topics
• Alternative output in json format
• Work not only with offsets but also with timestamps
• More informative describe

Install

Homebrew

brew tap worldbug/kafeman
brew install kafeman

Go

go install github.com/wordlbug/kafeman/cmd/kafeman@latest

make sure go/bin is in PATH

export PATH=$PATH:$GOROOT/bin:$GOPATH/bin

completions

Aftrer install you can add completions for shell

Bash:

# For current session
source <(kafeman completion bash)

# Linux:
kafeman completion bash > /etc/bash_completion.d/kafeman

# MacOS:
kafeman completion bash > /usr/local/etc/bash_completion.d/kafeman

Zsh:

kafeman completion zsh > "${fpath[1]}/_kafeman"
# You will need to start a new shell for this setup to take effect.

Fish:

kafeman completion fish | source
# To load completions for each session, execute once:
kafeman completion fish > ~/.config/fish/completions/kafeman.fish

PowerShell:

%[1]s completion powershell | Out-String | Invoke-Expression
# To load completions for every new session, run:
%[1]s completion powershell > %[1]s.ps1
# and source this file from your PowerShell profile.

Config

Before starting, initialize the config

kafeman config init

In the config you can configure which proto type is consumed in which topic

current_cluster: prod
clusters:
- name: prod
  brokers:
  - kafkabroker.prod:9092
- name: stg
  brokers:
  - kafkabroker.stg:9092
- name: local
  brokers:
  - localhost:9092
topics:
  - name: my-topic-1
    proto_type: myTopic.Event
    proto_paths:
    - project/protos

See also usages examples

Status

Legend

✅ Fully implemented
❌ Not implemented
✔️ Partially implemented

Supported messages types

state	type
✅	json
✅	protobuf
✅	message-pack
✅	avro
✅	base64

consume

kafeman	kaf
✅	commit
✅	follow
✅	group
✅	help
✅	offset
✅	partitions
✅	raw
✅	tail
✅	key-proto-type
✅	proto-include
✅	proto-type
✅	proto-exclude
✅	limit-messages
✅	decode-msgpack

group

kafeman	kaf
✔️	commit
✅	delete
✅	describe
✅	ls
❌	peek

topic

kafeman	kaf
✅	describe
✅	ls
✅	create
✅	delete
✅	update