kafka-console v1.4.22
Kafka CLI tool
Command line tool to sufficiently and easy work with Kafka
Table of Contents
Features
- Producer
- Consumer groups with seek and timeout
- Built-in message encoders/decoders with types: json, js, raw
- Custom message encoders/decoders as a js module
- Message headers
- GZIP compression
- Plain, SSL and SASL_SSL implementations
- Admin client
- TypeScript support
Installing
npm install -g kafka-console
Examples
Common options
-b, --brokers <brokers> bootstrap server host (default: "localhost:9092")
-l, --log-level <logLevel> log level
-t, --timeout <timeout> set a timeout of operation (default: "0")
-p, --pretty pretty print json
--ssl enable ssl (default: false)
--mechanism <mechanism> sasl mechanism
--username <username> sasl username
--password <password> sasl password
--auth-id <authId> sasl aws authorization identity
--access-key-id <accessKeyId> sasl aws access key id
--secret-access-key <secretAccessKey> sasl aws secret access key
--session-token <seccionToken> sasl aws session token
--oauth-bearer <oauthBearer> sasl oauth bearer token
-V, --version output the version number
-h, --help display help for command
Commands
consume [options] <topic> Consume kafka topic events
produce [options] <topic> Produce kafka topic events
metadata Displays kafka server metadata
list|ls [options] Lists kafka topics
config [options] Describes config for specific resource
create <topic> Creates kafka topic
delete <topic> Deletes kafka topic
help [command] display help for command
Consumer
kcli consume [options] <topic>
Options
-g, --group <group> consumer group name
-f, --format <format> message type decoding json, js, raw (default: "json")
-o, --output <filename> write output to specified filename
-a, --from-beginning read messages from the beginning (default: false)
-c, --count <count> a number of messages to read (default: null)
-s, --skip <skip> a number of messages to skip (default: 0)
-h, --help display help for command
General usage with authentication
kcli consume $KAFKA_TOPIC -g $KAFKA_TOPIC_GROUP -b $KAFKA_BROKERS --ssl --mechanism plain --username $KAFKA_USERNAME --password $KAFKA_PASSWORD
Stdout jq
example
kcli consume $KAFKA_TOPIC | jq .value
Custom data formatter example
kcli consume $KAFKA_TOPIC --format ./formatter/avro.js | jq
Producer
kcli produce [options] <topic>
Options
-f, --format <format> message format encoding json, js, raw (default: "json")
-i, --input <filename> input filename
-d, --delay <delay> delay in ms after event emitting (default: 0)
-h, --header <header> set a static header (default: [])
--help display help for command
General usage
kcli produce $KAFKA_TOPIC -b $KAFKA_BROKERS --ssl --mechanism plain --username $KAFKA_USERNAME --password $KAFKA_PASSWORD
Produce a json data from stdin with custom formatter
cat payload.txt|kcli produce $KAFKA_TOPIC --format ./formatter/avro.js
Produce a json data from stdin
node payloadGenerator.js|kcli produce $KAFKA_TOPIC
Produce a json array data from stdin
cat payload.json|jq -r -c .[]|kcli produce $KAFKA_TOPIC
Payload single message input interface
interface Payload {
key?: string; // kafka
value: any;
headers?: { [key: string]: value };
}
Formatters
export interface Encoder<T> {
(value: T): Promise<string | Buffer> | string | Buffer;
}
export interface Decoder<T> {
(value: Buffer): Promise<T> | T;
}
export interface Formatter<T> {
encode: Encoder<T>;
decode: Decoder<T>;
}
Environment
- KAFKA_BROKERS
- KAFKA_TIMEOUT
- KAFKA_MECHANISM
- KAFKA_USERNAME
- KAFKA_PASSWORD
- KAFKA_AUTH_ID
- KAFKA_ACCESS_KEY_ID
- KAFKA_SECRET_ACCESS_KEY
- KAFKA_SESSION_TOKEN
- KAFKA_OAUTH_BEARER
License
License The MIT License Copyright (c) 2024 Ivan Zakharchanka
5 days ago
18 days ago
17 days ago
20 days ago
21 days ago
25 days ago
26 days ago
27 days ago
28 days ago
30 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
8 months ago
7 months ago
8 months ago
7 months ago
9 months ago
9 months ago
9 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
10 months ago
10 months ago
10 months ago
10 months ago
9 months ago
10 months ago
10 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago