Skip to main content

A supercharged, interactive Kafka shell built on top of the existing Kafka CLI tools.

Project description

kafka-shell

Build Status codecov PyPI PyPI - Python Version License

A supercharged, interactive Kafka shell built on top of the existing Kafka CLI tools.

Kafka shell allows you to configure a list of clusters, and properties such as --bootstrap-server and --zookeeper for the currently selected cluster will automatically be added when the command is run. No more remembering long server addresses or ports!

Installation

Kafka shell requires python and pip. Kafka shell is a wrapper over the existing Kafka command-line tools, so those must exist within your PATH.

You can install kafka-shell using pip:

pip install kafka-shell

Usage

Kafka shell is an interactive shell. You can run it from the terminal by:

kafka-shell

From here, you can start typing kafka and the autocomplete will kick in.

Key Commands

  • Change Cluster: The selected cluster commands are run against can be cycled through by pressing F2.
  • Fuzzy Search: By default, fuzzy search of commands is enabled. This can be toggled on & off by pressing F3.
  • In-line Help: By default, in-line help is shown along side the drop-down suggestion list. This can be toggled on & off by pressing F9.
  • Exit: The shell can be exited by pressing F10 or by typing exit.

Configuration

Kafka shell allows you to configure settings and Kafka clusters to run commands against through a configuration file.

By default, when kafka-shell is first run, a directory in your home directory is generated at ~/.kafka-shell. A configuration file called config.yaml is generated in that new folder. It is a YAML file containing details about clusters, kafka-shell configuration, and more.

See CONFIGURATION.md to add a cluster to your configuration or to set other kafka-shell settings.

Features

Kafka shell simplifies running complex Kafka CLI commands as well as provides smart auto-completion of commands, options, and more. /Users/shawn/.kafka-shell/config.yaml

  • Auto-completion of commands, options, and configurations
  • Configure clusters to run commands against and switch between them
  • Fish-style auto suggestions
  • Command history
  • Contextual help
  • Toolbar options

Completion of Configurations

Auto completion of Kafka configuration keys and their values.

Configure Clusters, Schema Registries, & More

Configure clusters and their properties will automatically be added to commands being run.

Supported Commands

Currently, the following commands are supported:

  • kafka-topics
  • kafka-configs
  • kafka-console-consumer
  • kafka-console-producer
  • kafka-avro-console-consumer
  • kafka-avro-console-producer
  • kafka-verifiable-consumer
  • kafka-verifiable-producer
  • kafka-preferred-replica-election
  • kafka-replica-verification
  • kafka-reassign-partitions
  • kafka-broker-api-versions
  • kafka-consumer-groups
  • kafka-delete-records
  • kafka-log-dirs
  • kafka-dump-log
  • kafka-acls
  • ksql

Helper Commands

Currently, kafka-shell has helper commands:

  • exit: exit the shell
  • clear: clear the shell
  • cluster-select: select a cluster
  • cluster-describe: describe a cluster config

In-line help for each command and option is shown by default. This can be toggled by F9.

Contributing

Contributions are very welcome. See CONTRIBUTING.md for details.

Acknowledgement

This project was inspired by multiple amazing shells & prompts, such as saws, kube-shell, kube-prompt, http-prompt, and wharfee. It was built using prompt-toolkit. Much ❤️ to Apache Kafka and Confluent for their helpful CLI tools.

License

Copyright (c) 2019 Shawn Seymour.

Licensed under the Apache 2.0 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kafka-shell-0.1.4.tar.gz (30.1 kB view hashes)

Uploaded source

Built Distribution

kafka_shell-0.1.4-py3-none-any.whl (45.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page