Skip to content

Installation

Node.js 24 or newer is required (tested on 24 and 26); zlib.zstd* is used for ZSTD. It also runs on Bun 1.4 or newer; see Bun for what differs there.

npm install @cookiemonsterdev/kafka-core
pnpm add @cookiemonsterdev/kafka-core
yarn add @cookiemonsterdev/kafka-core
bun add @cookiemonsterdev/kafka-core

TLS and SASL are optional. See Security when the broker requires them. SASL/GSSAPI needs a KDC and either sasl.gssProvider or the optional kerberos package (npm install kerberos).

Next: Getting started.