jklukas/k

A general command line client for Apache Kafka.

k

A general command line client for Apache Kafka.

Install

# Set a directory where Go packages will be installed.
export GOPATH=$HOME/gocode

# Install `k` and dependencies.
go get github.com/xstevens/k

This will make k available as $GOPATH/bin/k. Add $GOPATH/bin to your $PATH to have it available as k.

Build

To run subsequent builds, use go build:

# Ensure you're in the `k` source directory.
cd $GOPATH/src/github.com/xstevens/k

# Run the build.
go build

Cross-compiling

With Go 1.5 or above, cross-compilation support is built in. See Dave Cheney's blog post for a tutorial and the golang.org docs for details on GOOS and GOARCH values for various target operating systems.

A typical build for Linux would be:

# Ensure you're in the `k` source directory.
cd $GOPATH/src/github.com/xstevens/k

# Run the build.
env GOOS=linux GOARCH=amd64 go build

Usage

$ ./k help
Usage: k <command> [options] [arguments]

Environment Variables:
    KAFKA_BROKERS
    SSL_CA_BUNDLE_PATH
    SSL_CRT_PATH
    SSL_KEY_PATH

Commands:
    produce     produce messages to given topic
    consume     consume messages from given topic
    offsets     show the oldest and newest offset for a given topic and partition
    topics      show the list of topics
    help        show help

Run 'k help <command>' for details.

License

All aspects of this software are distributed under the MIT License. See LICENSE file for full license text.

Inspirations

Heavily inspired (grabbed basis of code from) Mark McGranaghan's zk CLI for Zookeeper.