Skip to content
Back to search

jikkou

MarketplaceWorks with Claude CodeGitHub

The Open source Resource as Code framework for Apache Kafka. Jikkou helps you implement GitOps for Kafka at scale!

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/streamthoughts--kafka-specs/badge.svg)](/listings/streamthoughts--kafka-specs)

HTML

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

Install

Install instructions from the README

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

Install

# Via SDKMan (recommended)
sdk install jikkou

# Or via Docker
docker pull streamthoughts/jikkou

> See the full [installation guide](https://jikkou.io/docs/install/) for native binaries, Homebrew, and more.

Define a Kafka topic

# kafka-topics.yaml
apiVersion: 'kafka.jikkou.io/v1beta2'
kind: 'KafkaTopic'
metadata:
  name: 'my-topic'
spec:
  partitions: 12
  replicas: 3
  configs:
    min.insync.replicas: 2

Preview, then apply

# Preview the change against the real cluster, not a state file
jikkou diff --files ./kafka-topics.yaml

# Apply it
jikkou apply --files ./kafka-topics.yaml

That's it. Jikkou computes the diff and applies only the necessary changes:

TASK [CREATE] Create a new topic my-topic (partitions=12, replicas=3) - CHANGED
EXECUTION in 2s 661ms
ok: 0, created: 1, altered: 0, deleted: 0, failed: 0

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.

.claude-plugin/marketplace.json · Manifest · 11 lines

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

  1. {
  2. "name": "jikkou",
  3. "owner": { "name": "Jikkou" },
  4. "plugins": [
  5. {
  6. "name": "jikkou",
  7. "source": "./",
  8. "description": "Official Jikkou skills for AI agents: manage Kafka topics, ACLs, quotas, schemas, and connectors declaratively with the Jikkou CLI."
  9. }
  10. ]
  11. }
README.md · README · 224 lines

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

  1. <p align="center">
  2. <img src="./assets/jikkou-logo-title.png" alt="Jikkou Logo" width="400"/>
  3. </p>
  4. <h3 align="center">Resource as Code for Apache Kafka and beyond</h3>
  5. <p align="center">
  6. Topics, ACLs, schemas, quotas, and connectors: declared in Git, reconciled against your real clusters.<br/>
  7. Kafka-first. Platform-ready.
  8. </p>
  9. <p align="center">
  10. <a href="https://github.com/streamthoughts/jikkou/actions/workflows/maven-build.yml"><img src="https://github.com/streamthoughts/jikkou/actions/workflows/maven-build.yml/badge.svg" alt="Build Status"/></a>
  11. <a href="https://github.com/streamthoughts/jikkou/blob/main/LICENSE"><img src="https://img.shields.io/github/license/streamthoughts/jikkou" alt="License"/></a>
  12. <a href="https://github.com/streamthoughts/jikkou/releases"><img src="https://img.shields.io/github/v/release/streamthoughts/jikkou?color=blue&label=latest" alt="Release"/></a>
  13. <a href="https://github.com/streamthoughts/jikkou/stargazers"><img src="https://img.shields.io/github/stars/streamthoughts/jikkou?style=flat" alt="Stars"/></a>
  14. </p>
  15. <p align="center">
  16. <a href="https://sonarcloud.io/dashboard?id=streamthoughts_jikkou"><img src="https://sonarcloud.io/api/project_badges/measure?project=streamthoughts_jikkou&metric=reliability_rating" alt="Reliability"/></a>
  17. <a href="https://sonarcloud.io/dashboard?id=streamthoughts_jikkou"><img src="https://sonarcloud.io/api/project_badges/measure?project=streamthoughts_jikkou&metric=sqale_rating" alt="Maintainability"/></a>
  18. <a href="https://sonarcloud.io/dashboard?id=streamthoughts_jikkou"><img src="https://sonarcloud.io/api/project_badges/measure?project=streamthoughts_jikkou&metric=coverage" alt="Coverage"/></a>
  19. </p>
  20. <p align="center">
  21. <a href="https://jikkou.io/">Documentation</a> &bull;
  22. <a href="https://jikkou.io/docs/install/">Install</a> &bull;
  23. <a href="https://jikkou.io/docs/tutorials/">Tutorials</a> &bull;
  24. <a href="https://join.slack.com/t/jikkou-io/shared_invite/zt-27c0pt61j-F10NN7d7ZEppQeMMyvy3VA">Slack</a>
  25. </p>
  26. ---
  27. **Your platform team runs Kafka for everyone else.** Fifty app teams, and every new topic is a ticket.
  28. Configs drift between staging and production because someone "fixed" something by hand during an incident.
  29. Nobody can say who changed what, or why.
  30. **Jikkou** (jikkou / 実行, *execution* in Japanese) fixes this the way `kubectl` fixed Kubernetes:
  31. declare your Kafka resources (topics, ACLs, quotas, schemas, connectors) as YAML in Git, review changes
  32. in pull requests, and let Jikkou reconcile the desired state against your **real clusters**. Kafka-first,
  33. and platform-ready: the same engine manages Schema Registry, Kafka Connect, Confluent Cloud, Aiven,
  34. Amazon MSK, AWS Glue, and Apache Iceberg.
  35. <p align="center">
  36. <img src="./assets/demo.gif" alt="Jikkou in action" width="800"/>
  37. </p>
  38. ## Why Jikkou?
  39. | Your problem | Jikkou's answer |
  40. |---|---|
  41. | "Someone changed a topic by hand and nobody noticed" | **Stateless reconciliation.** No state file; `jikkou diff` compares Git against the actual cluster, so drift is always visible |
  42. | "300 topics that differ by one value" | **Jinja templating.** One definition, per-environment values files |
  43. | "Same config must land on five clusters" | **Multi-cluster apply.** Provider groups target a whole fleet in one command |
  44. | "Every change needs review and an audit trail" | **GitOps-native.** YAML in Git, `diff` in the pull request, `apply` in CI |
  45. | "We can't let a typo reach production" | **Validations & dry-run.** Platform rules (naming, min ISR, partition limits) enforced before anything is applied |
  46. | "We also run Schema Registry, Connect, Iceberg…" | **One agnostic engine.** Pluggable providers, one resource model across your whole data platform |
  47. ## How Jikkou Compares
  48. - **[Jikkou vs Terraform](https://www.jikkou.io/docs/comparisons/jikkou-vs-terraform/)**: Terraform provisions clusters; Jikkou manages what lives inside them, without a state file to drift.
  49. - **[Jikkou vs Strimzi Topic Operator](https://www.jikkou.io/docs/comparisons/jikkou-vs-strimzi/)**: on Strimzi, keep the Topic Operator for topics; Jikkou covers everything it can't reach.
  50. ## Quick Start
  51. ### Install
  52. ```bash
  53. # Via SDKMan (recommended)
  54. sdk install jikkou
  55. # Or via Docker
  56. docker pull streamthoughts/jikkou
  57. ```
  58. > See the full [installation guide](https://jikkou.io/docs/install/) for native binaries, Homebrew, and more.
  59. ### Define a Kafka topic
  60. ```yaml
  61. # kafka-topics.yaml
  62. apiVersion: 'kafka.jikkou.io/v1beta2'
  63. kind: 'KafkaTopic'
  64. metadata:
  65. name: 'my-topic'
  66. spec:
  67. partitions: 12
  68. replicas: 3
  69. configs:
  70. min.insync.replicas: 2
  71. ```
  72. ### Preview, then apply
  73. ```bash
  74. # Preview the change against the real cluster, not a state file
  75. jikkou diff --files ./kafka-topics.yaml
  76. # Apply it
  77. jikkou apply --files ./kafka-topics.yaml
  78. ```
  79. That's it. Jikkou computes the diff and applies only the necessary changes:
  80. ```
  81. TASK [CREATE] Create a new topic my-topic (partitions=12, replicas=3) - CHANGED
  82. EXECUTION in 2s 661ms
  83. ok: 0, created: 1, altered: 0, deleted: 0, failed: 0
  84. ```
  85. ## One Model, Every Platform
  86. The same declarative YAML model covers your entire streaming platform. And because the engine is
  87. platform-agnostic, it extends beyond Kafka: Apache Iceberg tables, views, and namespaces are managed
  88. with the exact same workflow.
  89. | Apache Kafka | Schema Registry | Kafka Connect | Apache Iceberg | Cloud Providers |
  90. |:---:|:---:|:---:|:---:|:---:|
  91. | Topics & Configs | Avro Schemas | Connectors | Tables | Aiven (ACLs, Quotas) |
  92. | ACLs | JSON Schemas | | Views | Confluent Cloud (RBAC) |
  93. | Quotas | Protobuf Schemas | | Namespaces | AWS Glue Schemas |
  94. | Consumer Groups | | | | |
  95. | Brokers & Users | | | | |
  96. | KTable Records | | | | |
  97. ## How It Works
  98. <p align="center">
  99. <img src="./docs/content/en/docs/Overview/jikkou-architecture-overview.png" alt="Architecture" width="800"/>
  100. </p>
  101. Jikkou follows a simple reconciliation loop:
  102. 1. **Read** your resource definitions from YAML files (with Jinja templating support)
  103. 2. **Compute** the differences between desired state and actual cluster state
  104. 3. **Apply** only the minimal set of changes needed
  105. 4. **Report** what was created, updated, or deleted
  106. ## Deployment Modes
  107. | Mode | Description |
  108. |-------------------|-----------------------------------------------------------------------------------------------|
  109. | **CLI** | Run as a command-line tool — perfect for local development and CI/CD pipelines |
  110. | **API Server** | Run as a REST API server — ideal for platform teams and automation |
  111. | **Docker** | Available as container images on [Docker Hub](https://hub.docker.com/r/streamthoughts/jikkou) |
  112. | **Native Binary** | GraalVM-compiled native executables for instant startup |
  113. ## Use Jikkou with AI Agents
  114. Jikkou ships official [Agent Skills](https://agentskills.io) so coding agents can manage
  115. your Kafka resources through the CLI — with validation and dry-runs built into the workflow.
  116. **Claude Code:**
  117. ```
  118. /plugin marketplace add streamthoughts/jikkou
  119. /plugin install jikkou
  120. ```
  121. **Other agents:** copy [`skills/managing-kafka-resources`](./skills/managing-kafka-resources) into your agent's skills directory.
  122. The skill never applies changes without showing a diff or dry-run first, and asks before
  123. installing anything.
  124. ## Documentation
  125. Full documentation is available at **[jikkou.io](https://jikkou.io/)**.
  126. - [Getting Started](https://jikkou.io/docs/install/)
  127. - [Concepts & Architecture](https://jikkou.io/docs/concepts/)
  128. - [Providers Reference](https://jikkou.io/docs/providers/)
  129. - [Tutorials](https://jikkou.io/docs/tutorials/)
  130. ## Developers
  131. For build instructions, development setup, and contribution guidelines, see:
  132. - **[CONTRIBUTING.md](./CONTRIBUTING.md)** — How to contribute, coding guidelines, commit conventions
  133. - **[AGENTS.md](./AGENTS.md)** — Detailed development guidelines, build commands, and architecture
  134. ### Quick Build
  135. ```bash
  136. # Build and run all tests
  137. ./mvnw clean verify
  138. # Build without tests
  139. ./mvnw clean verify -DskipTests
  140. # Apply code formatting
  141. ./mvnw spotless:apply
  142. ```
  143. **Requirements:** Java 25, Docker (for integration tests), GraalVM (for native builds)
  144. ## Contributors
  145. Jikkou is built by its community. Thank you to everyone who has contributed!
  146. <!-- CONTRIBUTORS-START -->
  147. <a href="https://github.com/streamthoughts/jikkou/graphs/contributors">
  148. <img src="https://contrib.rocks/image?repo=streamthoughts/jikkou&max=100&columns=12" alt="Contributors"/>
  149. </a>
  150. <!-- CONTRIBUTORS-END -->
  151. Want to see your name here? Check out the [contribution guide](./CONTRIBUTING.md) and [open issues](https://github.com/streamthoughts/jikkou/issues).
  152. ## Support the Project
  153. If you find Jikkou useful, please consider:
  154. - **Using Jikkou in production?** Add your organization to [ADOPTERS.md](./ADOPTERS.md) or [tell us in GitHub Discussions](https://github.com/streamthoughts/jikkou/discussions): real-world usage reports help the project more than anything else
  155. - Giving it a **[star on GitHub](https://github.com/streamthoughts/jikkou)** to help others discover it
  156. - Joining the **[Slack community](https://join.slack.com/t/jikkou-io/shared_invite/zt-27c0pt61j-F10NN7d7ZEppQeMMyvy3VA)** to ask questions and share feedback
  157. - **[Contributing](./CONTRIBUTING.md)** code, documentation, or bug reports
  158. ## License
  159. Licensed under the [Apache License, Version 2.0](./LICENSE).
  160. ---
  161. <p align="center">
  162. Developed with &#10084; by <a href="https://github.com/fhussonnois">Florian Hussonnois</a> and the Jikkou community.
  163. </p>
mvnw.cmd · Bundled script · 187 lines · 1 finding marked
  1. @REM ----------------------------------------------------------------------------
  2. @REM Licensed to the Apache Software Foundation (ASF) under one
  3. @REM or more contributor license agreements. See the NOTICE file
  4. @REM distributed with this work for additional information
  5. @REM regarding copyright ownership. The ASF licenses this file
  6. @REM to you under the Apache License, Version 2.0 (the
  7. @REM "License"); you may not use this file except in compliance
  8. @REM with the License. You may obtain a copy of the License at
  9. @REM
  10. @REM http://www.apache.org/licenses/LICENSE-2.0
  11. @REM
  12. @REM Unless required by applicable law or agreed to in writing,
  13. @REM software distributed under the License is distributed on an
  14. @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15. @REM KIND, either express or implied. See the License for the
  16. @REM specific language governing permissions and limitations
  17. @REM under the License.
  18. @REM ----------------------------------------------------------------------------
  19. @REM ----------------------------------------------------------------------------
  20. @REM Apache Maven Wrapper startup batch script, version 3.1.1
  21. @REM
  22. @REM Required ENV vars:
  23. @REM JAVA_HOME - location of a JDK home dir
  24. @REM
  25. @REM Optional ENV vars
  26. @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
  27. @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
  28. @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
  29. @REM e.g. to debug Maven itself, use
  30. @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
  31. @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
  32. @REM ----------------------------------------------------------------------------
  33. @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
  34. @echo off
  35. @REM set title of command window
  36. title %0
  37. @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
  38. @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
  39. @REM set %HOME% to equivalent of $HOME
  40. if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
  41. @REM Execute a user defined script before this one
  42. if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
  43. @REM check for pre script, once with legacy .bat ending and once with .cmd ending
  44. if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %*
  45. if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %*
  46. :skipRcPre
  47. @setlocal
  48. set ERROR_CODE=0
  49. @REM To isolate internal variables from possible post scripts, we use another setlocal
  50. @setlocal
  51. @REM ==== START VALIDATION ====
  52. if not "%JAVA_HOME%" == "" goto OkJHome
  53. echo.
  54. echo Error: JAVA_HOME not found in your environment. >&2
  55. echo Please set the JAVA_HOME variable in your environment to match the >&2
  56. echo location of your Java installation. >&2
  57. echo.
  58. goto error
  59. :OkJHome
  60. if exist "%JAVA_HOME%\bin\java.exe" goto init
  61. echo.
  62. echo Error: JAVA_HOME is set to an invalid directory. >&2
  63. echo JAVA_HOME = "%JAVA_HOME%" >&2
  64. echo Please set the JAVA_HOME variable in your environment to match the >&2
  65. echo location of your Java installation. >&2
  66. echo.
  67. goto error
  68. @REM ==== END VALIDATION ====
  69. :init
  70. @REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
  71. @REM Fallback to current working directory if not found.
  72. set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
  73. IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
  74. set EXEC_DIR=%CD%
  75. set WDIR=%EXEC_DIR%
  76. :findBaseDir
  77. IF EXIST "%WDIR%"\.mvn goto baseDirFound
  78. cd ..
  79. IF "%WDIR%"=="%CD%" goto baseDirNotFound
  80. set WDIR=%CD%
  81. goto findBaseDir
  82. :baseDirFound
  83. set MAVEN_PROJECTBASEDIR=%WDIR%
  84. cd "%EXEC_DIR%"
  85. goto endDetectBaseDir
  86. :baseDirNotFound
  87. set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
  88. cd "%EXEC_DIR%"
  89. :endDetectBaseDir
  90. IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
  91. @setlocal EnableExtensions EnableDelayedExpansion
  92. for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
  93. @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
  94. :endReadAdditionalConfig
  95. SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
  96. set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
  97. set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
  98. set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar"
    • Dismissed after review: Links to a Windows program from code, which is how droppers fetch their payload
    • Line 122 on GitHub
  99. FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
  100. IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B
  101. )
  102. @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
  103. @REM This allows using the maven wrapper in projects that prohibit checking in binary data.
  104. if exist %WRAPPER_JAR% (
  105. if "%MVNW_VERBOSE%" == "true" (
  106. echo Found %WRAPPER_JAR%
  107. )
  108. ) else (
  109. if not "%MVNW_REPOURL%" == "" (
  110. SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar"
  111. )
  112. if "%MVNW_VERBOSE%" == "true" (
  113. echo Couldn't find %WRAPPER_JAR%, downloading it ...
  114. echo Downloading from: %WRAPPER_URL%
  115. )
  116. powershell -Command "&{"^
  117. "$webclient = new-object System.Net.WebClient;"^
  118. "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
  119. "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
  120. "}"^
  121. "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^
  122. "}"
  123. if "%MVNW_VERBOSE%" == "true" (
  124. echo Finished downloading %WRAPPER_JAR%
  125. )
  126. )
  127. @REM End of extension
  128. @REM Provide a "standardized" way to retrieve the CLI args that will
  129. @REM work with both Windows and non-Windows executions.
  130. set MAVEN_CMD_LINE_ARGS=%*
  131. %MAVEN_JAVA_EXE% ^
  132. %JVM_CONFIG_MAVEN_PROPS% ^
  133. %MAVEN_OPTS% ^
  134. %MAVEN_DEBUG_OPTS% ^
  135. -classpath %WRAPPER_JAR% ^
  136. "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^
  137. %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
  138. if ERRORLEVEL 1 goto error
  139. goto end
  140. :error
  141. set ERROR_CODE=1
  142. :end
  143. @endlocal & set ERROR_CODE=%ERROR_CODE%
  144. if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost
  145. @REM check for post script, once with legacy .bat ending and once with .cmd ending
  146. if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat"
  147. if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd"
  148. :skipRcPost
  149. @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
  150. if "%MAVEN_BATCH_PAUSE%"=="on" pause
  151. if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE%
  152. cmd /C exit /B %ERROR_CODE%

Ratings and comments

Sign in to rate this skill.

Sign in

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