Browse documentation

Quickstart

1. Install Kafma

Choose the package for your operating system and architecture:

PlatformPackageDownload
macOS.dmgApple Silicon · Intel
Windows.exex64 · ARM64
Linux.debx64 · ARM64
Linux.rpmx64 · ARM64
Linux.AppImagex64 · ARM64

Choose Apple Silicon for an M-series Mac or Intel for an Intel Mac; most Windows and Linux machines use x64.

  • macOS — open the .dmg and drag Kafma into Applications.
  • Windows — run the .exe. If SmartScreen appears, choose More info, then Run anyway.
  • Linux — install the .deb or .rpm with your package manager, or run the AppImage directly. The examples below use x64; replace x86_64 with arm64 for ARM.Debian or Ubuntu:
    sudo apt install ./Kafma-linux-x86_64.deb
    
    Fedora or RHEL:
    sudo dnf install ./Kafma-linux-x86_64.rpm
    
    AppImage:
    chmod +x Kafma-linux-x86_64.AppImage
    ./Kafma-linux-x86_64.AppImage
    

Open Kafma. It shows Welcome until you add your first cluster; after that, the same page becomes Home.

The Kafma Welcome screen on first launch, before any cluster is connected

2. Connect to a Kafka cluster

Choose a shortcut on Welcome to open the New Cluster form. Local Docker uses localhost:9092 with no authentication; Confluent Cloud and AWS MSK preselect their authentication settings; Custom Configuration starts empty.

The New Cluster form in Kafma, connecting to a local Kafka broker at localhost:9092 with no authentication

Set Environment so production clusters stand out. Choosing Production enables Read-Only, which blocks writes; turn it off only when you intend to modify the cluster.

Choose Test Connection to verify the settings, then Save to add the cluster.

Kafma Free supports one connection; Pro removes the limit. For Confluent Cloud, Amazon MSK, and other authentication options, see Connect to a cluster.

3. Open a topic

Select +, search for a topic, and press Enter to open it.

Kafma's topic picker filtering a list of Kafka topics by name, with partition and replica counts

Results show partition and replica counts. Topics whose names start with __ are hidden by default.

If the cluster has no topics, create one.

4. Read and produce messages

Open a topic to load its latest messages and producer in the same Console tab.

A Kafka topic open in Kafma, listing JSON messages above and the producer composing the next one below

Enter a key and value, then choose Produce. Refresh the message list to see the new record, or switch From to Live before producing to watch it arrive automatically.

Choose a format for the key and value. If the topic has a registered schema, select it to validate and serialize the payload before sending.

Home keeps pinned topics, schema subjects, and consumer groups in Watchlist, and recently opened resources in Recents.

The Kafma home screen showing pinned Kafka topics and consumer groups in the Watchlist alongside recently opened resources

Use ⌘P on macOS or Ctrl+P on Windows and Linux to search topics, schema subjects, and consumer groups across connected clusters. Use ⌘D or Ctrl+D to pin a result.

Next steps