kaskade is a terminal user interface for kafka
Project description
Kaskade
Kaskade is a text user interface (TUI) for Apache Kafka, built with Textual by Textualize. It includes features like:
- Admin:
- List topics, partitions, groups and group members.
- Topic information like lag, replicas and records count.
- Create, edit and delete topics.
- Filter topics by name.
- Consumer:
- Json, string, integer, long, float, boolean and double deserialization.
- Filter by key, value, header and/or partition.
- Schema Registry support with avro.
- Protobuf deserialization support.
Screenshots
Installation
Install it with brew
:
brew install kaskade
Install it with pipx
:
pipx install kaskade
Running kaskade
Admin view:
kaskade admin -b my-kafka:9092
Consumer view:
kaskade consumer -b my-kafka:9092 -t my-topic
Configuration examples
Multiple bootstrap servers:
kaskade admin -b my-kafka:9092,my-kafka:9093
Consume and deserialize:
kaskade consumer -b my-kafka:9092 -t my-topic -k json -v json
Consuming from the beginning:
kaskade consumer -b my-kafka:9092 -t my-topic -x auto.offset.reset=earliest
Schema registry simple connection and avro deserialization:
kaskade consumer -b my-kafka:9092 \
-s url=http://my-schema-registry:8081 \
-t my-topic -k avro -v avro
For more information about Schema Registry configurations go to: Confluent Schema Registry client.
SSL encryption example:
kaskade admin -b my-kafka:9092 -x security.protocol=SSL
For more information about SSL encryption and SSL authentication go to: SSL support in librdkafka.
Confluent cloud admin and consumer:
kaskade admin -b ${BOOTSTRAP_SERVERS} \
-x security.protocol=SASL_SSL \
-x sasl.mechanism=PLAIN \
-x sasl.username=${CLUSTER_API_KEY} \
-x sasl.password=${CLUSTER_API_SECRET}
kaskade consumer -b ${BOOTSTRAP_SERVERS} \
-x security.protocol=SASL_SSL \
-x sasl.mechanism=PLAIN \
-x sasl.username=${CLUSTER_API_KEY} \
-x sasl.password=${CLUSTER_API_SECRET} \
-s url=${SCHEMA_REGISTRY_URL} \
-s basic.auth.user.info=${SR_API_KEY}:${SR_API_SECRET} \
-t my-topic \
-k string \
-v avro
More about confluent cloud configuration at: Kafka Client Quick Start for Confluent Cloud.
Running with docker:
docker run --rm -it --network my-networtk sauljabin/kaskade:latest \
admin -b my-kafka:9092
docker run --rm -it --network my-networtk sauljabin/kaskade:latest \
consumer -b my-kafka:9092 -t my-topic
Protobuf consumer:
Install protoc
command:
brew install protobuf
Generate a Descriptor Set file from your .proto
file:
protoc --include_imports \
--descriptor_set_out=my-descriptor.desc \
--proto_path=${PROTO_PATH} \
${PROTO_PATH}/my-proto.proto
Consume using my-descriptor.desc
file:
kaskade consumer -b my-kafka:9092 -x auto.offset.reset=earliest \
-k string -v protobuf \
-t my-protobuf-topic \
-p descriptor=my-descriptor.desc -p value=mypackage.MyMessage
More about protobuf and
FileDescriptorSet
at: Protocol Buffers Documentation.
Development
For development instructions see DEVELOPMENT.md.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file kaskade-2.3.7.tar.gz
.
File metadata
- Download URL: kaskade-2.3.7.tar.gz
- Upload date:
- Size: 20.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15ba36c466cdaef95065fe2f7ac60ff699891429ad2ea0769656998efce6de04 |
|
MD5 | 21cfc1c42da8c52b8a74599deb01fe48 |
|
BLAKE2b-256 | 147bfa38da904d8e4b83ad5d957907629f382c3cae929318cb829c18bbdd964f |
File details
Details for the file kaskade-2.3.7-py3-none-any.whl
.
File metadata
- Download URL: kaskade-2.3.7-py3-none-any.whl
- Upload date:
- Size: 24.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b51b991a05cddbe121561775675682a410e0857560ef5a5be584a2d764203f26 |
|
MD5 | 90c69e8444681411056be76307096412 |
|
BLAKE2b-256 | 484a19157facab0c39fb880fefaaae47dda5b1a677b4310bb5a4178b8a3114ec |