{"owner":"IBM","repo":"sarama","hasSkills":true,"totalSkillsCount":5,"totalTokensCount":1071,"categories":["plugin-manifest"],"hasMcp":false,"mcpConfig":null,"found":["tools/kafka-console-producer/README.md","tools/kafka-producer-performance/README.md","tools/kafka-console-consumer/README.md","tools/README.md","tools/kafka-console-partitionconsumer/README.md"],"skills":{"tools/kafka-console-producer/README.md":"# kafka-console-producer\n\nA simple command line tool to produce a single message to Kafka.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-console-producer\n\n\n### Usage\n\n    # Minimum invocation\n    kafka-console-producer -topic=test -value=value -brokers=kafka1:9092\n\n    # It will pick up a KAFKA_PEERS environment variable\n    export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092\n    kafka-console-producer -topic=test -value=value\n\n    # It will read the value from stdin by using pipes\n    echo \"hello world\" | kafka-console-producer -topic=test\n\n    # Specify a key:\n    echo \"hello world\" | kafka-console-producer -topic=test -key=key\n\n    # Partitioning: by default, kafka-console-producer will partition as follows:\n    # - manual partitioning if a -partition is provided\n    # - hash partitioning by key if a -key is provided\n    # - random partitioning otherwise.\n    #\n    # You can override this using the -partitioner argument:\n    echo \"hello world\" | kafka-console-producer -topic=test -key=key -partitioner=random\n\n    # Display all command line options\n    kafka-console-producer -help\n","tools/kafka-producer-performance/README.md":"# kafka-producer-performance\n\nA command line tool to test producer performance.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-producer-performance\n\n\n### Usage\n\n    # Display all command line options\n    kafka-producer-performance -help\n\n\t# Minimum invocation\n    kafka-producer-performance \\\n\t\t-brokers=kafka:9092 \\\n\t\t-message-load=50000 \\\n\t\t-message-size=100 \\\n\t\t-topic=producer_test\n","tools/kafka-console-consumer/README.md":"# kafka-console-consumer\n\nA simple command line tool to consume partitions of a topic and print the\nmessages on the standard output.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-console-consumer\n\n### Usage\n\n    # Minimum invocation\n    kafka-console-consumer -topic=test -brokers=kafka1:9092\n\n    # It will pick up a KAFKA_PEERS environment variable\n    export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092\n    kafka-console-consumer -topic=test\n\n    # You can specify the offset you want to start at. It can be either\n    # `oldest`, `newest`. The default is `newest`.\n    kafka-console-consumer -topic=test -offset=oldest\n    kafka-console-consumer -topic=test -offset=newest\n\n    # You can specify the partition(s) you want to consume as a comma-separated\n    # list. The default is `all`.\n    kafka-console-consumer -topic=test -partitions=1,2,3\n\n    # Display all command line options\n    kafka-console-consumer -help\n","tools/README.md":"# Sarama tools\n\nThis folder contains applications that are useful for exploration of your Kafka cluster, or instrumentation.\nSome of these tools mirror tools that ship with Kafka, but these tools won't require installing the JVM to function.\n\n- [kafka-console-producer](./kafka-console-producer): a command line tool to produce a single message to your Kafka custer.\n- [kafka-console-partitionconsumer](./kafka-console-partitionconsumer): (deprecated) a command line tool to consume a single partition of a topic on your Kafka cluster.\n- [kafka-console-consumer](./kafka-console-consumer): a command line tool to consume arbitrary partitions of a topic on your Kafka cluster.\n- [kafka-producer-performance](./kafka-producer-performance): a command line tool to performance test producers (sync and async) on your Kafka cluster.\n\nTo install all tools, run `go install github.com/IBM/sarama/tools/...@latest`\n","tools/kafka-console-partitionconsumer/README.md":"# kafka-console-partitionconsumer\n\nNOTE: this tool is deprecated in favour of the more general and more powerful\n`kafka-console-consumer`.\n\nA simple command line tool to consume a partition of a topic and print the messages\non the standard output.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-console-partitionconsumer\n\n### Usage\n\n    # Minimum invocation\n    kafka-console-partitionconsumer -topic=test -partition=4 -brokers=kafka1:9092\n\n    # It will pick up a KAFKA_PEERS environment variable\n    export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092\n    kafka-console-partitionconsumer -topic=test -partition=4\n\n    # You can specify the offset you want to start at. It can be either\n    # `oldest`, `newest`, or a specific offset number\n    kafka-console-partitionconsumer -topic=test -partition=3 -offset=oldest\n    kafka-console-partitionconsumer -topic=test -partition=2 -offset=1337\n\n    # Display all command line options\n    kafka-console-partitionconsumer -help\n"},"files":{"tools/kafka-console-producer/README.md":"# kafka-console-producer\n\nA simple command line tool to produce a single message to Kafka.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-console-producer\n\n\n### Usage\n\n    # Minimum invocation\n    kafka-console-producer -topic=test -value=value -brokers=kafka1:9092\n\n    # It will pick up a KAFKA_PEERS environment variable\n    export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092\n    kafka-console-producer -topic=test -value=value\n\n    # It will read the value from stdin by using pipes\n    echo \"hello world\" | kafka-console-producer -topic=test\n\n    # Specify a key:\n    echo \"hello world\" | kafka-console-producer -topic=test -key=key\n\n    # Partitioning: by default, kafka-console-producer will partition as follows:\n    # - manual partitioning if a -partition is provided\n    # - hash partitioning by key if a -key is provided\n    # - random partitioning otherwise.\n    #\n    # You can override this using the -partitioner argument:\n    echo \"hello world\" | kafka-console-producer -topic=test -key=key -partitioner=random\n\n    # Display all command line options\n    kafka-console-producer -help\n","tools/kafka-producer-performance/README.md":"# kafka-producer-performance\n\nA command line tool to test producer performance.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-producer-performance\n\n\n### Usage\n\n    # Display all command line options\n    kafka-producer-performance -help\n\n\t# Minimum invocation\n    kafka-producer-performance \\\n\t\t-brokers=kafka:9092 \\\n\t\t-message-load=50000 \\\n\t\t-message-size=100 \\\n\t\t-topic=producer_test\n","tools/kafka-console-consumer/README.md":"# kafka-console-consumer\n\nA simple command line tool to consume partitions of a topic and print the\nmessages on the standard output.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-console-consumer\n\n### Usage\n\n    # Minimum invocation\n    kafka-console-consumer -topic=test -brokers=kafka1:9092\n\n    # It will pick up a KAFKA_PEERS environment variable\n    export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092\n    kafka-console-consumer -topic=test\n\n    # You can specify the offset you want to start at. It can be either\n    # `oldest`, `newest`. The default is `newest`.\n    kafka-console-consumer -topic=test -offset=oldest\n    kafka-console-consumer -topic=test -offset=newest\n\n    # You can specify the partition(s) you want to consume as a comma-separated\n    # list. The default is `all`.\n    kafka-console-consumer -topic=test -partitions=1,2,3\n\n    # Display all command line options\n    kafka-console-consumer -help\n","tools/README.md":"# Sarama tools\n\nThis folder contains applications that are useful for exploration of your Kafka cluster, or instrumentation.\nSome of these tools mirror tools that ship with Kafka, but these tools won't require installing the JVM to function.\n\n- [kafka-console-producer](./kafka-console-producer): a command line tool to produce a single message to your Kafka custer.\n- [kafka-console-partitionconsumer](./kafka-console-partitionconsumer): (deprecated) a command line tool to consume a single partition of a topic on your Kafka cluster.\n- [kafka-console-consumer](./kafka-console-consumer): a command line tool to consume arbitrary partitions of a topic on your Kafka cluster.\n- [kafka-producer-performance](./kafka-producer-performance): a command line tool to performance test producers (sync and async) on your Kafka cluster.\n\nTo install all tools, run `go install github.com/IBM/sarama/tools/...@latest`\n","tools/kafka-console-partitionconsumer/README.md":"# kafka-console-partitionconsumer\n\nNOTE: this tool is deprecated in favour of the more general and more powerful\n`kafka-console-consumer`.\n\nA simple command line tool to consume a partition of a topic and print the messages\non the standard output.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-console-partitionconsumer\n\n### Usage\n\n    # Minimum invocation\n    kafka-console-partitionconsumer -topic=test -partition=4 -brokers=kafka1:9092\n\n    # It will pick up a KAFKA_PEERS environment variable\n    export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092\n    kafka-console-partitionconsumer -topic=test -partition=4\n\n    # You can specify the offset you want to start at. It can be either\n    # `oldest`, `newest`, or a specific offset number\n    kafka-console-partitionconsumer -topic=test -partition=3 -offset=oldest\n    kafka-console-partitionconsumer -topic=test -partition=2 -offset=1337\n\n    # Display all command line options\n    kafka-console-partitionconsumer -help\n"},"items":[{"name":"README.md","path":"tools/kafka-console-consumer/README.md","rawUrl":"https://raw.githubusercontent.com/IBM/sarama/HEAD/tools/kafka-console-consumer/README.md","title":"kafka-console-consumer Documentation","category":"plugin-manifest","format":"markdown","content":"# kafka-console-consumer\n\nA simple command line tool to consume partitions of a topic and print the\nmessages on the standard output.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-console-consumer\n\n### Usage\n\n    # Minimum invocation\n    kafka-console-consumer -topic=test -brokers=kafka1:9092\n\n    # It will pick up a KAFKA_PEERS environment variable\n    export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092\n    kafka-console-consumer -topic=test\n\n    # You can specify the offset you want to start at. It can be either\n    # `oldest`, `newest`. The default is `newest`.\n    kafka-console-consumer -topic=test -offset=oldest\n    kafka-console-consumer -topic=test -offset=newest\n\n    # You can specify the partition(s) you want to consume as a comma-separated\n    # list. The default is `all`.\n    kafka-console-consumer -topic=test -partitions=1,2,3\n\n    # Display all command line options\n    kafka-console-consumer -help\n","isInternal":false,"tokens":247,"sizeBytes":944},{"name":"README.md","path":"tools/kafka-console-partitionconsumer/README.md","rawUrl":"https://raw.githubusercontent.com/IBM/sarama/HEAD/tools/kafka-console-partitionconsumer/README.md","title":"kafka-console-partitionconsumer Documentation","category":"plugin-manifest","format":"markdown","content":"# kafka-console-partitionconsumer\n\nNOTE: this tool is deprecated in favour of the more general and more powerful\n`kafka-console-consumer`.\n\nA simple command line tool to consume a partition of a topic and print the messages\non the standard output.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-console-partitionconsumer\n\n### Usage\n\n    # Minimum invocation\n    kafka-console-partitionconsumer -topic=test -partition=4 -brokers=kafka1:9092\n\n    # It will pick up a KAFKA_PEERS environment variable\n    export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092\n    kafka-console-partitionconsumer -topic=test -partition=4\n\n    # You can specify the offset you want to start at. It can be either\n    # `oldest`, `newest`, or a specific offset number\n    kafka-console-partitionconsumer -topic=test -partition=3 -offset=oldest\n    kafka-console-partitionconsumer -topic=test -partition=2 -offset=1337\n\n    # Display all command line options\n    kafka-console-partitionconsumer -help\n","isInternal":false,"tokens":248,"sizeBytes":994},{"name":"README.md","path":"tools/kafka-console-producer/README.md","rawUrl":"https://raw.githubusercontent.com/IBM/sarama/HEAD/tools/kafka-console-producer/README.md","title":"kafka-console-producer Documentation","category":"plugin-manifest","format":"markdown","content":"# kafka-console-producer\n\nA simple command line tool to produce a single message to Kafka.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-console-producer\n\n\n### Usage\n\n    # Minimum invocation\n    kafka-console-producer -topic=test -value=value -brokers=kafka1:9092\n\n    # It will pick up a KAFKA_PEERS environment variable\n    export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092\n    kafka-console-producer -topic=test -value=value\n\n    # It will read the value from stdin by using pipes\n    echo \"hello world\" | kafka-console-producer -topic=test\n\n    # Specify a key:\n    echo \"hello world\" | kafka-console-producer -topic=test -key=key\n\n    # Partitioning: by default, kafka-console-producer will partition as follows:\n    # - manual partitioning if a -partition is provided\n    # - hash partitioning by key if a -key is provided\n    # - random partitioning otherwise.\n    #\n    # You can override this using the -partitioner argument:\n    echo \"hello world\" | kafka-console-producer -topic=test -key=key -partitioner=random\n\n    # Display all command line options\n    kafka-console-producer -help\n","isInternal":false,"tokens":279,"sizeBytes":1121},{"name":"README.md","path":"tools/kafka-producer-performance/README.md","rawUrl":"https://raw.githubusercontent.com/IBM/sarama/HEAD/tools/kafka-producer-performance/README.md","title":"kafka-producer-performance Documentation","category":"plugin-manifest","format":"markdown","content":"# kafka-producer-performance\n\nA command line tool to test producer performance.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-producer-performance\n\n\n### Usage\n\n    # Display all command line options\n    kafka-producer-performance -help\n\n\t# Minimum invocation\n    kafka-producer-performance \\\n\t\t-brokers=kafka:9092 \\\n\t\t-message-load=50000 \\\n\t\t-message-size=100 \\\n\t\t-topic=producer_test\n","isInternal":false,"tokens":98,"sizeBytes":403},{"name":"README.md","path":"tools/README.md","rawUrl":"https://raw.githubusercontent.com/IBM/sarama/HEAD/tools/README.md","title":"tools Documentation","category":"plugin-manifest","format":"markdown","content":"# Sarama tools\n\nThis folder contains applications that are useful for exploration of your Kafka cluster, or instrumentation.\nSome of these tools mirror tools that ship with Kafka, but these tools won't require installing the JVM to function.\n\n- [kafka-console-producer](./kafka-console-producer): a command line tool to produce a single message to your Kafka custer.\n- [kafka-console-partitionconsumer](./kafka-console-partitionconsumer): (deprecated) a command line tool to consume a single partition of a topic on your Kafka cluster.\n- [kafka-console-consumer](./kafka-console-consumer): a command line tool to consume arbitrary partitions of a topic on your Kafka cluster.\n- [kafka-producer-performance](./kafka-producer-performance): a command line tool to performance test producers (sync and async) on your Kafka cluster.\n\nTo install all tools, run `go install github.com/IBM/sarama/tools/...@latest`\n","isInternal":false,"tokens":199,"sizeBytes":907}],"systemPromptSnippet":"<yakaai_skills repo=\"IBM/sarama\">\n<!-- File: tools/kafka-console-consumer/README.md (Tokens: ~247 | Category: plugin-manifest) -->\n# kafka-console-consumer\n\nA simple command line tool to consume partitions of a topic and print the\nmessages on the standard output.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-console-consumer\n\n### Usage\n\n    # Minimum invocation\n    kafka-console-consumer -topic=test -brokers=kafka1:9092\n\n    # It will pick up a KAFKA_PEERS environment variable\n    export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092\n    kafka-console-consumer -topic=test\n\n    # You can specify the offset you want to start at. It can be either\n    # `oldest`, `newest`. The default is `newest`.\n    kafka-console-consumer -topic=test -offset=oldest\n    kafka-console-consumer -topic=test -offset=newest\n\n    # You can specify the partition(s) you want to consume as a comma-separated\n    # list. The default is `all`.\n    kafka-console-consumer -topic=test -partitions=1,2,3\n\n    # Display all command line options\n    kafka-console-consumer -help\n\n<!-- File: tools/kafka-console-partitionconsumer/README.md (Tokens: ~248 | Category: plugin-manifest) -->\n# kafka-console-partitionconsumer\n\nNOTE: this tool is deprecated in favour of the more general and more powerful\n`kafka-console-consumer`.\n\nA simple command line tool to consume a partition of a topic and print the messages\non the standard output.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-console-partitionconsumer\n\n### Usage\n\n    # Minimum invocation\n    kafka-console-partitionconsumer -topic=test -partition=4 -brokers=kafka1:9092\n\n    # It will pick up a KAFKA_PEERS environment variable\n    export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092\n    kafka-console-partitionconsumer -topic=test -partition=4\n\n    # You can specify the offset you want to start at. It can be either\n    # `oldest`, `newest`, or a specific offset number\n    kafka-console-partitionconsumer -topic=test -partition=3 -offset=oldest\n    kafka-console-partitionconsumer -topic=test -partition=2 -offset=1337\n\n    # Display all command line options\n    kafka-console-partitionconsumer -help\n\n<!-- File: tools/kafka-console-producer/README.md (Tokens: ~279 | Category: plugin-manifest) -->\n# kafka-console-producer\n\nA simple command line tool to produce a single message to Kafka.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-console-producer\n\n\n### Usage\n\n    # Minimum invocation\n    kafka-console-producer -topic=test -value=value -brokers=kafka1:9092\n\n    # It will pick up a KAFKA_PEERS environment variable\n    export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092\n    kafka-console-producer -topic=test -value=value\n\n    # It will read the value from stdin by using pipes\n    echo \"hello world\" | kafka-console-producer -topic=test\n\n    # Specify a key:\n    echo \"hello world\" | kafka-console-producer -topic=test -key=key\n\n    # Partitioning: by default, kafka-console-producer will partition as follows:\n    # - manual partitioning if a -partition is provided\n    # - hash partitioning by key if a -key is provided\n    # - random partitioning otherwise.\n    #\n    # You can override this using the -partitioner argument:\n    echo \"hello world\" | kafka-console-producer -topic=test -key=key -partitioner=random\n\n    # Display all command line options\n    kafka-console-producer -help\n\n<!-- File: tools/kafka-producer-performance/README.md (Tokens: ~98 | Category: plugin-manifest) -->\n# kafka-producer-performance\n\nA command line tool to test producer performance.\n\n### Installation\n\n    go get github.com/IBM/sarama/tools/kafka-producer-performance\n\n\n### Usage\n\n    # Display all command line options\n    kafka-producer-performance -help\n\n\t# Minimum invocation\n    kafka-producer-performance \\\n\t\t-brokers=kafka:9092 \\\n\t\t-message-load=50000 \\\n\t\t-message-size=100 \\\n\t\t-topic=producer_test\n\n<!-- File: tools/README.md (Tokens: ~199 | Category: plugin-manifest) -->\n# Sarama tools\n\nThis folder contains applications that are useful for exploration of your Kafka cluster, or instrumentation.\nSome of these tools mirror tools that ship with Kafka, but these tools won't require installing the JVM to function.\n\n- [kafka-console-producer](./kafka-console-producer): a command line tool to produce a single message to your Kafka custer.\n- [kafka-console-partitionconsumer](./kafka-console-partitionconsumer): (deprecated) a command line tool to consume a single partition of a topic on your Kafka cluster.\n- [kafka-console-consumer](./kafka-console-consumer): a command line tool to consume arbitrary partitions of a topic on your Kafka cluster.\n- [kafka-producer-performance](./kafka-producer-performance): a command line tool to performance test producers (sync and async) on your Kafka cluster.\n\nTo install all tools, run `go install github.com/IBM/sarama/tools/...@latest`\n</yakaai_skills>"}