https://github.com/maif/yozefu
An interactive terminal user interface (TUI) application for exploring data of a kafka cluster.
https://github.com/maif/yozefu
kafka ratatui-rs rust tui
Last synced: 2 months ago
JSON representation
An interactive terminal user interface (TUI) application for exploring data of a kafka cluster.
- Host: GitHub
- URL: https://github.com/maif/yozefu
- Owner: MAIF
- License: other
- Created: 2024-12-03T10:30:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-08T23:10:14.000Z (3 months ago)
- Last Synced: 2026-04-09T01:12:29.825Z (3 months ago)
- Topics: kafka, ratatui-rs, rust, tui
- Language: Rust
- Homepage: https://maif.github.io/yozefu/
- Size: 18.5 MB
- Stars: 294
- Watchers: 6
- Forks: 13
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: security.md
- Notice: NOTICE
Awesome Lists containing this project
README
Yōzefu is an interactive terminal user interface (TUI) application for exploring data of a kafka cluster.
It is an alternative tool to [AKHQ](https://akhq.io/), [redpanda console](https://www.redpanda.com/redpanda-console-kafka-ui) or [the kafka plugin for JetBrains IDEs](https://plugins.jetbrains.com/plugin/21704-kafka).
The tool offers the following features:
- A real-time access to data published to topics.
- A [search query language](https://maif.github.io/yozefu/query-language/) inspired from SQL providing a fine-grained way filtering capabilities.
- Ability to search kafka records across multiple topics.
- Support for extending the search engine with [user-defined filters](https://maif.github.io/yozefu/search-filter/) written in WebAssembly ([Extism](https://extism.org/)).
- The tool can be used as a terminal user interface or a CLI with the `--headless` flag.
- One keystroke to export kafka records for further analysis.
- Support for registering multiple kafka clusters, each with specific kafka consumer properties.
By default, [the kafka consumer is configured](https://github.com/MAIF/yozefu/blob/main/crates/command/src/command/main_command.rs#L318-L325) with the property `enable.auto.commit` set to `false`, meaning no kafka consumer offset will be published to kafka.
## Limitations
- The tool is designed only to consume kafka records. There is no feature to produce records or manage a cluster.
- Serialization formats such as `json`, `xml` or plain text are supported. [Avro](https://avro.apache.org/) support is [experimental for now](https://maif.github.io/yozefu/schema-registry/). [Protobuf](https://protobuf.dev/) is not supported.
- The tool uses a ring buffer to store the [last 500 kafka records](https://github.com/MAIF/yozefu/blob/main/crates/tui/src/records_buffer.rs#L17).
- There is probably room for improvement regarding the throughput (lot of `clone()` and deserialization).
- Yozefu has been tested on macOS Silicon but not on Windows or Linux. Feedback or contributions are welcome.
## Getting started
```bash
RUSTFLAGS="--cfg tokio_unstable" cargo install --locked yozefu
# By default, it starts the TUI.
# The default registered cluster is localhost
yozf --cluster localhost
# You can also start the tool in headless mode.
# It prints the key of each kafka record matching the query in real time
yozf --cluster localhost \
--headless \
--topics "public-french-addresses" \
--format "json" \
'from begin value.properties.type contains "street" and offset < 356_234 limit 10' \
| jq '.key'
# Use the `configure` command to define new clusters
yozf configure
# You can create search filters
yozf create-filter --language rust key-ends-with
# And import them
yozf import-filter path/to/key-ends-with.wasm
```
You can also download pre-build binaries from the [releases section](https://github.com/MAIF/yozefu/releases). [Attestations](https://github.com/MAIF/yozefu/attestations) are available:
```bash
gh attestation verify --repo MAIF/yozefu $(which yozf)
brew install yozefu
yay -S yozefu
nix run github:MAIF/yozefu
```
## Try it
> [!NOTE]
> Docker is required to start a single node Kafka cluster on your machine. [JBang](https://www.jbang.dev/) is not required but recommended if you want to produce records with the schema registry.
```bash
# It clones this repository, starts a docker kafka node and produces json records
curl -L "https://raw.githubusercontent.com/MAIF/yozefu/refs/heads/main/docs/try-it.sh" | bash
yozf -c localhost
```
## Documentation
To check out docs, visit [https://maif.github.io/yozefu/](https://maif.github.io/yozefu/).
## Screenshots
