Skip to content
Back to search

strimzi-kafka-cli

Command Line Interface and MCP Server for the Strimzi Kafka Operator

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/systemcraftsman--strimzi-kafka-cli/badge.svg)](/listings/systemcraftsman--strimzi-kafka-cli)

HTML

<a href="/listings/systemcraftsman--strimzi-kafka-cli"><img src="/api/listings/systemcraftsman--strimzi-kafka-cli/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Using Python Package Installer

pip install strimzi-kafka-cli --user

Or to install Strimzi Kafka CLI in an isolated environment, you can simply use [pipx](https://pypa.github.io/pipx/):

pipx install strimzi-kafka-cli

To install with MCP server support:

pip install strimzi-kafka-cli[mcp] --user

Or with pipx:

pipx install strimzi-kafka-cli[mcp]

Using Homebrew

#Tap the homebrew repository first.
brew tap systemcraftsman/strimzi-kafka-cli

#Install Strimzi Kafka CLI
brew install strimzi-kafka-cli

> Installing the CLI by using Homebrew already uses a virtual environment, so you don't have to worry about your main Python environment. MCP server support is included by default.

Project requires: Python >=3.11

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 137 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <!-- mcp-name: io.github.SystemCraftsman/strimzi-kafka-cli -->
  2. ![Build](https://github.com/systemcraftsman/strimzi-kafka-cli/workflows/Build/badge.svg) ![Integration Test](https://github.com/systemcraftsman/strimzi-kafka-cli/workflows/Integration%20Test/badge.svg) ![Deploy](https://github.com/systemcraftsman/strimzi-kafka-cli/workflows/Deploy/badge.svg) [![PyPI](https://img.shields.io/pypi/v/strimzi-kafka-cli)](https://pypi.org/project/strimzi-kafka-cli/) [![Downloads](https://static.pepy.tech/badge/strimzi-kafka-cli)](https://pepy.tech/project/strimzi-kafka-cli) [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0) [![Strimzi](https://img.shields.io/badge/Strimzi-1.0.0-blue)](https://github.com/strimzi/strimzi-kafka-operator/releases/tag/1.0.0) [![MCP Server](https://badge.mcpx.dev?type=server&features=tools 'MCP Server')](https://github.com/systemcraftsman/strimzi-kafka-cli#mcp-server)
  3. ![Strimzi CLI logo](https://github.com/SystemCraftsman/strimzi-kafka-cli/assets/10568159/596ea147-9594-4262-a0c3-d63fa14f0577)
  4. # Strimzi Kafka CLI
  5. Strimzi Kafka CLI is a CLI that helps traditional Apache Kafka users -both developers and administrators- to easily adapt to [Strimzi](https://strimzi.io/),
  6. a [Kubernetes operator](https://operatorhub.io/operator/strimzi-kafka-operator) for [Apache Kafka](https://kafka.apache.org/).
  7. The main intention is to ramp up Strimzi usage by creating a similar CLI experience with the traditional Apache Kafka tools that mostly starts with `kafka-*` prefix under the `bin` directory in an ordinary Kafka package.
  8. Strimzi Kafka CLI uses the `kfk` command as an abbreviation for "**K**afka **F**or **K**ubernetes" or simply "**k** a **f** **k** a" which reminds of the `kafka-*` prefix of the ordinary Kafka script file names.
  9. While having similar set of commands or options for some of the common objects, Strimzi Kafka CLI has some extra capabilities for managing or configuring Strimzi related resources.
  10. Following are the commands of the current version of Strimzi Kafka CLI, that are used for different purposes:
  11. ``` bash
  12. Usage: kfk [OPTIONS] COMMAND [ARGS]...
  13. Strimzi Kafka CLI.
  14. Options:
  15. --version Show the version and exit.
  16. --help Show this message and exit.
  17. Commands:
  18. acls Manages ACLs on Kafka.
  19. backup Backs up and restores Strimzi resources.
  20. kafka Backs up or restores a Kafka cluster and its resources.
  21. connect Backs up or restores a Kafka Connect cluster and its connectors.
  22. clusters Creates, alters, deletes, describes Kafka cluster(s).
  23. configs Adds/Removes entity config for a topic, client, user...
  24. connect Manages Kafka Connect clusters, connectors, and MirrorMaker2.
  25. clusters Creates, alters, deletes, describes KafkaConnect cluster(s).
  26. connectors Creates, alters, deletes, describes KafkaConnector(s).
  27. mirror-maker Lists, describes, creates, deletes KafkaMirrorMaker2(s).
  28. console-consumer Reads data from Kafka topics and outputs it to...
  29. console-producer Reads data from standard input and publish it to Kafka.
  30. mcp Starts the Strimzi MCP server.
  31. node-pools Lists, describes, creates, deletes KafkaNodePool(s).
  32. operator Installs/Uninstalls Strimzi Kafka Operator.
  33. topics Creates, alters, deletes, describes Kafka topic(s).
  34. users Creates, alters, deletes, describes Kafka users(s).
  35. ```
  36. Please take a look at the relevant article [Strimzi Kafka CLI: Managing Strimzi in a Kafka Native Way](https://www.systemcraftsman.com/2020/08/25/strimzi-kafka-cli-managing-strimzi-in-a-kafka-native-way/) for more details.
  37. ## Installation
  38. ### Using Python Package Installer
  39. ``` bash
  40. pip install strimzi-kafka-cli --user
  41. ```
  42. Or to install Strimzi Kafka CLI in an isolated environment, you can simply use [pipx](https://pypa.github.io/pipx/):
  43. ``` bash
  44. pipx install strimzi-kafka-cli
  45. ```
  46. To install with MCP server support:
  47. ``` bash
  48. pip install strimzi-kafka-cli[mcp] --user
  49. ```
  50. Or with pipx:
  51. ``` bash
  52. pipx install strimzi-kafka-cli[mcp]
  53. ```
  54. ### Using Homebrew
  55. ``` bash
  56. #Tap the homebrew repository first.
  57. brew tap systemcraftsman/strimzi-kafka-cli
  58. #Install Strimzi Kafka CLI
  59. brew install strimzi-kafka-cli
  60. ```
  61. > Installing the CLI by using Homebrew already uses a virtual environment, so you don't have to worry about your main Python environment. MCP server support is included by default.
  62. Project requires: Python >=3.11
  63. ## Examples
  64. * [TLS Authentication](https://github.com/systemcraftsman/strimzi-kafka-cli/tree/master/examples/2_tls_authentication)
  65. * [Simple ACL Authorization](https://github.com/systemcraftsman/strimzi-kafka-cli/tree/master/examples/3_simple_acl_authorization)
  66. * [Topic, User and Broker Configuration](https://github.com/systemcraftsman/strimzi-kafka-cli/tree/master/examples/4_configuration)
  67. * [Kafka Connect](https://github.com/systemcraftsman/strimzi-kafka-cli/tree/master/examples/5_connect)
  68. ## MCP Server
  69. Strimzi Kafka CLI includes an [MCP (Model Context Protocol)](https://modelcontextprotocol.io/) server that allows AI assistants to manage Strimzi Kafka deployments on Kubernetes.
  70. ### Starting the MCP Server
  71. ``` bash
  72. kfk mcp
  73. ```
  74. ### Registering with Claude Code
  75. ``` bash
  76. claude mcp add strimzi-kafka-cli -- kfk mcp
  77. ```
  78. ### Available Tools (42)
  79. | Category | Tools |
  80. |----------|-------|
  81. | Kafka Clusters | `list_kafkas`, `get_kafka`, `get_kafka_status`, `create_kafka`, `delete_kafka`, `alter_kafka_config` |
  82. | Topics | `list_topics`, `get_topic`, `create_topic`, `delete_topic`, `alter_topic` |
  83. | Users | `list_users`, `get_user`, `create_user`, `delete_user`, `alter_user` |
  84. | Connect Clusters | `list_connects`, `get_connect`, `create_connect`, `delete_connect`, `alter_connect` |
  85. | Connectors | `list_connectors`, `get_connector`, `create_connector`, `delete_connector`, `alter_connector` |
  86. | MirrorMaker2 | `list_mirror_maker_2s`, `get_mirror_maker_2`, `create_mirror_maker_2`, `delete_mirror_maker_2` |
  87. | Backup | `backup_kafka`, `restore_kafka`, `backup_connect`, `restore_connect` |
  88. | ACLs | `add_or_remove_acls` |
  89. | Operator | `install_operator`, `uninstall_operator` |
  90. | Node Pools | `list_node_pools`, `get_node_pool`, `create_node_pool`, `delete_node_pool` |
  91. | Version | `get_version` |
  92. ## Dependencies
  93. ### Python Dependencies
  94. Please see [pyproject.toml](https://github.com/SystemCraftsman/strimzi-kafka-cli/blob/main/pyproject.toml) file.
  95. ### External Dependencies
  96. `Strimzi resources` are automatically downloaded when the first `kfk` command is run. Strimzi Kafka CLI uses the Python Kubernetes client to interact with the cluster directly. You can check the dependency versions with:
  97. ``` bash
  98. kfk --version
  99. ```

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.