# Kafka TypeScript tools

> Core client, admin CLI, generic config loader, and local Studio UI. Node.js 24+ or Bun 1.4+.

Docs version: 2.6.1. Source revision: b44fa31a7bc13327d62e12e4496106792b4c2bf8.
Offsets are bigint; import public APIs from package roots. Core defaults: idempotent false, read_committed isolation, murmur2 partitioning. Check each feature’s broker requirements.
Use the skill matching your installed package version. This index describes the deployed docs; older release source snapshots are linked from the documentation-access guide.

Machine index: https://cookiemonsterdev.github.io/kafka/docs-index.json

## Core 2.6.1

- [Introduction](https://cookiemonsterdev.github.io/kafka/docs/core/start/introduction/index.md): A TypeScript Kafka client for Kafka 0.10+
- [Installation](https://cookiemonsterdev.github.io/kafka/docs/core/start/installation/index.md): Install @cookiemonsterdev/kafka-core with npm, pnpm, yarn, or bun
- [Your first message](https://cookiemonsterdev.github.io/kafka/docs/core/start/getting-started/index.md): Start a local broker, create a topic, and run a producer and consumer
- [Agent skills](https://cookiemonsterdev.github.io/kafka/docs/core/start/agent-skills/index.md): Coding-agent skills that ship inside the npm packages and update with them
- [Documentation for tools and agents](https://cookiemonsterdev.github.io/kafka/docs/core/start/documentation-access/index.md): Read Markdown, machine indexes, versioned sources, and package agent skills
- [Producer](https://cookiemonsterdev.github.io/kafka/docs/core/guides/producer/index.md): send, sendBatch, acks, linger, partitioners, and abort
- [Consumer](https://cookiemonsterdev.github.io/kafka/docs/core/guides/consumer/index.md): subscribe, run, stream, pause, seek, and assigners
- [Admin](https://cookiemonsterdev.github.io/kafka/docs/core/guides/admin/index.md): Topics, configs, offsets, groups, ACLs, and SCRAM
- [Errors](https://cookiemonsterdev.github.io/kafka/docs/core/guides/errors/index.md): Catch KafkaError, retries, and broker protocol codes
- [Security](https://cookiemonsterdev.github.io/kafka/docs/core/guides/security/index.md): TLS and SASL PLAIN, SCRAM, OAUTHBEARER, GSSAPI, and delegation tokens
- [Testing](https://cookiemonsterdev.github.io/kafka/docs/core/guides/testing/index.md): Run unit and integration tests against a broker version
- [Throughput](https://cookiemonsterdev.github.io/kafka/docs/core/guides/throughput/index.md): Throughput preset, linger and batching, and the heavy-load consume API
- [Observability](https://cookiemonsterdev.github.io/kafka/docs/core/guides/observability/index.md): Client-side OpenTelemetry metrics from instrumentation events
- [Configuration](https://cookiemonsterdev.github.io/kafka/docs/core/guides/configuration/index.md): Share KafkaConfig across producer, consumer, and admin with a kafka.config.ts file
- [Troubleshooting](https://cookiemonsterdev.github.io/kafka/docs/core/guides/troubleshooting/index.md): Diagnose connection failures, missing records, duplicates, and unstable consumers
- [Production readiness](https://cookiemonsterdev.github.io/kafka/docs/core/guides/production-readiness/index.md): Choose delivery guarantees, lifecycle, security, and monitoring before deployment
- [Task recipes](https://cookiemonsterdev.github.io/kafka/docs/core/guides/recipes/index.md): Follow practical paths for replay, failed messages, authentication, and consumer lag
- [Process messages and batches](https://cookiemonsterdev.github.io/kafka/docs/core/guides/consumer-processing/index.md): Choose eachMessage, eachBatch, stream, and delivery limits
- [Offsets and manual assignment](https://cookiemonsterdev.github.io/kafka/docs/core/guides/consumer-offsets/index.md): Assign partitions, seek, pause, and inspect committed offsets and lag
- [Groups and rebalances](https://cookiemonsterdev.github.io/kafka/docs/core/guides/consumer-rebalances/index.md): Choose assigners and protocols, and handle partition lifecycle callbacks
- [Share consumers](https://cookiemonsterdev.github.io/kafka/docs/core/guides/share-consumers/index.md): Acquire and acknowledge queue-like records on Kafka 4.1+
- [Kafka client](https://cookiemonsterdev.github.io/kafka/docs/core/reference/kafka/index.md): new Kafka, producer, consumer, admin, and logger
- [Producer API](https://cookiemonsterdev.github.io/kafka/docs/core/reference/producer/index.md): Producer methods, Message, and RecordMetadata
- [Consumer API](https://cookiemonsterdev.github.io/kafka/docs/core/reference/consumer/index.md): Consumer methods, KafkaMessage, and run options
- [Admin API](https://cookiemonsterdev.github.io/kafka/docs/core/reference/admin/index.md): Implemented admin methods
- [Configuration](https://cookiemonsterdev.github.io/kafka/docs/core/reference/configuration/index.md): KafkaConfig, ProducerConfig, ConsumerConfig, and AdminConfig
- [Errors](https://cookiemonsterdev.github.io/kafka/docs/core/reference/errors/index.md): Public error classes and broker protocol codes
- [Public API](https://cookiemonsterdev.github.io/kafka/docs/core/reference/public-api/index.md): What @cookiemonsterdev/kafka-core exports
- [Compatibility](https://cookiemonsterdev.github.io/kafka/docs/core/reference/compatibility/index.md): Broker support and constructor defaults, the implemented surface, and APIs this client does not implement
- [Config file](https://cookiemonsterdev.github.io/kafka/docs/core/reference/config-file/index.md): kafka.config.* discovery, precedence, Kafka.fromConfig, and Kafka.from
- [Environment variables and secrets](https://cookiemonsterdev.github.io/kafka/docs/core/reference/environment-variables/index.md): fromEnv, the KAFKA_* allow-list, and redactKafkaConfig
- [Bun](https://cookiemonsterdev.github.io/kafka/docs/core/reference/bun/index.md): Supported runtimes, running the CLI and studio on Bun, and what behaves differently there
- [Migrating from kafkajs](https://cookiemonsterdev.github.io/kafka/docs/core/migration/from-kafkajs/index.md): Replace kafkajs with a maintained client that keeps the same producer, consumer, and admin API shape
- [Client differences](https://cookiemonsterdev.github.io/kafka/docs/core/migration/breaking-changes/index.md): Offsets as bigint, MessageSet, built-in ZSTD, and environment variables
- [Upgrade between releases](https://cookiemonsterdev.github.io/kafka/docs/core/migration/upgrading/index.md): Check installed versions, review release changes, and roll out client upgrades

## Config 1.3.0

- [Introduction](https://cookiemonsterdev.github.io/kafka/docs/config/start/introduction/index.md): A generic, zero-dependency config-file loader
- [Getting started](https://cookiemonsterdev.github.io/kafka/docs/config/start/getting-started/index.md): Discover, validate, load, and merge a standalone application config
- [API reference](https://cookiemonsterdev.github.io/kafka/docs/config/reference/api/index.md): discoverConfigFile, loadConfigFileAsync (and the deprecated loadConfigFileSync), mergeConfigLayers, createDefineConfig

## CLI 1.11.0

- [Introduction](https://cookiemonsterdev.github.io/kafka/docs/cli/start/introduction/index.md): A command-line admin client for Apache Kafka
- [Installation](https://cookiemonsterdev.github.io/kafka/docs/cli/start/installation/index.md): Run @cookiemonsterdev/kafka-cli with npx, pnpm dlx, or a global install
- [Getting started](https://cookiemonsterdev.github.io/kafka/docs/cli/start/getting-started/index.md): Run your first commands against a broker
- [Configuration](https://cookiemonsterdev.github.io/kafka/docs/cli/guides/configuration/index.md): kafka.config files, profiles, and resolution order
- [Output and scripting with JSON](https://cookiemonsterdev.github.io/kafka/docs/cli/guides/output-and-scripting/index.md): Machine-readable output, exit codes, and jq recipes
- [Command reference](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/index.md): Every kafka command, one page each, generated from the command registry
- [Exit codes](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/exit-codes/index.md): The exit-code taxonomy every command shares
- [Global options and defaults](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/global-options/index.md): Shared connection, output, logging, and help options for every command
- [completion](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/completion/index.md): Print a shell completion script for bash, zsh, or fish
- [doctor](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/doctor/index.md): Report where connection settings come from — config file, environment, profile, or flag
- [init](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/init/index.md): Scaffold a kafka.config file in the current directory
- [ping](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/ping/index.md): Check connectivity to the cluster
- [profiles](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/profiles/index.md): List the named connection profiles configured under cli.profiles
- [studio](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/studio/index.md): Launch the local web UI for browsing and driving the cluster
- [acl add](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/acl/add/index.md): Create one or more ACLs, granting or denying an operation
- [acl list](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/acl/list/index.md): List ACLs matching a filter, or every ACL by default
- [acl remove](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/acl/remove/index.md): Delete every ACL matching a filter, per principal
- [admin call](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/admin/call/index.md): Call any Admin method by name — the escape hatch for everything without its own command
- [admin methods](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/admin/methods/index.md): List every Admin method admin call can reach, and how each is classified
- [cluster elect-leaders](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/cluster/elect-leaders/index.md): Trigger a preferred or unclean leader election on one or more partitions
- [cluster features](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/cluster/features/index.md): Describe supported and finalized feature versions
- [cluster info](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/cluster/info/index.md): Describe the cluster: its brokers, controller, and cluster id
- [cluster log-dirs](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/cluster/log-dirs/index.md): Describe log directories and their partition sizes, per broker
- [cluster quorum](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/cluster/quorum/index.md): Describe the metadata quorum: leader, voters, and observers
- [cluster raft-voter add](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/cluster/raft-voter-add/index.md): Add a voter to the KRaft metadata quorum
- [cluster raft-voter remove](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/cluster/raft-voter-remove/index.md): Remove a voter from the KRaft metadata quorum
- [cluster reassign execute](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/cluster/reassign-execute/index.md): Execute a partition reassignment from a kafka-reassign-partitions.sh-shaped JSON file
- [cluster reassign list](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/cluster/reassign-list/index.md): List every active partition reassignment
- [cluster unregister-broker](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/cluster/unregister-broker/index.md): Unregister a broker from the cluster (KRaft broker decommissioning)
- [cluster update-features](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/cluster/update-features/index.md): Upgrade, safe-downgrade, or unsafe-downgrade one or more finalized feature versions
- [config describe](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/config/describe/index.md): Describe the configs of one or more resources
- [config list-resources](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/config/list-resources/index.md): List every config resource the broker knows about
- [config set](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/config/set/index.md): Set one or more config entries on a resource
- [config unset](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/config/unset/index.md): Remove one or more config entries from a resource, reverting them to default
- [group delete](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/group/delete/index.md): Delete one or more consumer groups
- [group delete-offsets](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/group/delete-offsets/index.md): Delete a consumer group's committed offsets on one or more topics
- [group describe](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/group/describe/index.md): Describe one or more consumer groups
- [group list](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/group/list/index.md): List every consumer group the cluster knows about
- [group offsets](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/group/offsets/index.md): Show a consumer group's committed offsets
- [group remove-members](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/group/remove-members/index.md): Remove one or more static members from a consumer group's session
- [group reset-offsets](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/group/reset-offsets/index.md): Reset a consumer group's committed offsets on one or more topics
- [quota alter](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/quota/alter/index.md): Set or remove client quota values for one entity
- [quota describe](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/quota/describe/index.md): Describe client quotas matching an entity filter
- [scram delete](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/scram/delete/index.md): Delete a SCRAM credential for one or more users
- [scram list](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/scram/list/index.md): List SCRAM credentials for one or more users, or every user
- [scram set](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/scram/set/index.md): Create or update a SCRAM credential for one or more users
- [share-group delete](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/share-group/delete/index.md): Delete one or more share groups
- [share-group describe](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/share-group/describe/index.md): Describe one or more share groups
- [share-group list](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/share-group/list/index.md): List every share group the cluster knows about
- [share-group offsets](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/share-group/offsets/index.md): Read, set, or delete a share group’s committed start offsets
- [token create](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/token/create/index.md): Create a delegation token
- [token expire](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/token/expire/index.md): Expire a delegation token, immediately by default
- [token list](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/token/list/index.md): List delegation tokens, optionally filtered by owner
- [token renew](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/token/renew/index.md): Renew a delegation token, extending its expiry
- [topic add-partitions](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/topic/add-partitions/index.md): Raise a topic to a new total partition count
- [topic create](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/topic/create/index.md): Create one or more topics
- [topic delete](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/topic/delete/index.md): Delete one or more topics
- [topic delete-records](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/topic/delete-records/index.md): Delete records before a given offset, per partition
- [topic describe](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/topic/describe/index.md): Describe one or more topics
- [topic list](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/topic/list/index.md): List every topic
- [topic offsets](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/topic/offsets/index.md): Show partition offsets for a topic
- [topic producers](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/topic/producers/index.md): Show a topic's active producer state, per partition
- [txn abort](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/txn/abort/index.md): Write an abort marker for one in-flight transaction on a topic partition
- [txn describe](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/txn/describe/index.md): Describe one or more transactional ids
- [txn fence](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/txn/fence/index.md): Fence out a transactional id's current producer, bumping its epoch
- [txn list](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/txn/list/index.md): List transactions known to the cluster, optionally filtered
- [txn terminate](https://cookiemonsterdev.github.io/kafka/docs/cli/reference/commands/txn/terminate/index.md): Force-terminate a transactional id's current transaction
- [Embedding the CLI](https://cookiemonsterdev.github.io/kafka/docs/cli/integrations/embedding/index.md): Reuse Kafka CLI commands, help, completion and formatting in a host application

## Studio 1.3.0

- [Introduction](https://cookiemonsterdev.github.io/kafka/docs/studio/start/introduction/index.md): A local web UI for inspecting and driving an Apache Kafka cluster
- [Installation](https://cookiemonsterdev.github.io/kafka/docs/studio/start/installation/index.md): Install @cookiemonsterdev/kafka-studio, standalone or through the CLI
- [Explore your first topic](https://cookiemonsterdev.github.io/kafka/docs/studio/start/getting-started/index.md): Connect Studio, produce a message, inspect history, and diagnose a consumer group
- [Running it against a broker](https://cookiemonsterdev.github.io/kafka/docs/studio/guides/local-development/index.md): Point the studio at a real cluster, or a one-command local Docker broker
- [Debug event flows](https://cookiemonsterdev.github.io/kafka/docs/studio/guides/debugger/index.md): Search and correlate events, replay failures, inspect compacted state, use schemas, and run repeatable scenarios
- [API reference](https://cookiemonsterdev.github.io/kafka/docs/studio/reference/api/index.md): The studio server's HTTP surface, its response envelope, and its security model

## Agent skills

- [cli/skills/kafka-cli/SKILL.md](https://cookiemonsterdev.github.io/kafka/agent-skills/cli/skills/kafka-cli/SKILL.md)
- [config/skills/kafka-config/SKILL.md](https://cookiemonsterdev.github.io/kafka/agent-skills/config/skills/kafka-config/SKILL.md)
- [core/skills/kafka-core/SKILL.md](https://cookiemonsterdev.github.io/kafka/agent-skills/core/skills/kafka-core/SKILL.md)
- [core/skills/kafka-core-admin/SKILL.md](https://cookiemonsterdev.github.io/kafka/agent-skills/core/skills/kafka-core-admin/SKILL.md)
- [core/skills/kafka-core-consumer/SKILL.md](https://cookiemonsterdev.github.io/kafka/agent-skills/core/skills/kafka-core-consumer/SKILL.md)
- [core/skills/kafka-core-migrate-from-kafkajs/SKILL.md](https://cookiemonsterdev.github.io/kafka/agent-skills/core/skills/kafka-core-migrate-from-kafkajs/SKILL.md)
- [core/skills/kafka-core-producer/SKILL.md](https://cookiemonsterdev.github.io/kafka/agent-skills/core/skills/kafka-core-producer/SKILL.md)
- [core/skills/kafka-core-setup/SKILL.md](https://cookiemonsterdev.github.io/kafka/agent-skills/core/skills/kafka-core-setup/SKILL.md)
- [studio/skills/kafka-studio/SKILL.md](https://cookiemonsterdev.github.io/kafka/agent-skills/studio/skills/kafka-studio/SKILL.md)