https://github.com/birdayz/kaf

Modern CLI for Apache Kafka, written in Go.
https://github.com/birdayz/kaf

Last synced: 3 months ago
JSON representation

Modern CLI for Apache Kafka, written in Go.

• Host: GitHub
• URL: https://github.com/birdayz/kaf
• Owner: birdayz
• License: apache-2.0
• Created: 2018-09-11T22:57:19.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-27T12:55:59.000Z (3 months ago)
• Last Synced: 2024-07-27T14:03:09.975Z (3 months ago)
• Language: Go
• Homepage:
• Size: 15.5 MB
• Stars: 2,155
• Watchers: 24
• Forks: 137
• Open Issues: 63
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - birdayz/kaf - Modern CLI for Apache Kafka, written in Go. (Go)

README

        
# Kaf

Kafka CLI inspired by kubectl & docker

[![Actions Status](https://github.com/birdayz/kaf/workflows/Go/badge.svg)](https://github.com/birdayz/kaf/actions)

[![GoReportCard](https://goreportcard.com/badge/github.com/birdayz/kaf)](https://goreportcard.com/report/github.com/birdayz/kaf)

[![GoDoc](https://godoc.org/github.com/birdayz/kaf?status.svg)](https://godoc.org/github.com/birdayz/kaf)

![AUR version](https://img.shields.io/aur/version/kaf-bin)

![asciicinema](asciicinema.gif)

## 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](https://aur.archlinux.org/packages/kaf-bin/):

```

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`

### Group Inspection

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`

### Offset Reset

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`

Set offset to oldest

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

Set offset to 1001 for partition 0

`kaf group commit dispatcher -t mqtt.messages.incoming --offset 1001 --partition 0`

## Configuration

See the [examples](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](https://github.com/redpanda-data/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

### [Zerodha](https://zerodha.tech)