/ˈkæf.kən/ (k2n)

kaeffken, or in short k2n (/keɪ tuː ɛn/ ) is a cli for generating ai based claims or inlcude statements. The generation is based on examples and rulesets. claims are user-facing Kubernetes custom resources (CRDs) that allow application teams (developers, workloads) to request infrastructure or services without knowing the underlying implementation details

DEV

LINTING

# RUN LINTING w/ DEFAULTS
task go-lint:lint-go

# FOR CONFIGURE OPTIONS
task go-lint:lint-go-interactive

USAGE-EXAMPLES

OPENROUTER

export AI_PROVIDER="openrouter"
export AI_MODEL="deepseek/deepseek-r1-0528:free" # pragma: allowlist secret
export AI_API_KEY="sk-or.." # pragma: allowlist secret
# AI_BASE_URL is optional (defaults to https://openrouter.ai/api/v1/chat/completions)
# export AI_BASE_URL="https://openrouter.ai/api/v1/chat/completions"

GEMINI

export AI_PROVIDER="gemini"
export AI_API_KEY="your-gemini-api-key" # pragma: allowlist secret

VERBOSE OUTPUT OF THE PROMPT (w/o SENDING IT)

k2n gen \
--examples-dirs _examples/examples \
--ruleset-env-dir _examples/ruleset-env \
--ruleset-usecase-dir _examples/ruleset-runner \
--usecase crosssplane \
--instruction "give me a runner-claim for the repository dagger for the cluster sthings" \
--verbose=true \
--prompt-to-ai=false

PROMPT AI + OUTPUT TO STDOUT

export AI_PROVIDER="gemini"
export AI_API_KEY="your-gemini-api-key" # pragma: allowlist secret

k2n gen \
--examples-dirs _examples/examples \
--ruleset-env-dir _examples/ruleset-env \
--ruleset-usecase-dir _examples/ruleset-runner \
--usecase crosssplane \
--instruction "give me a runner-claim for the repository dagger for the cluster sthings"

PROMPT AI + OUTPUT TO FOLDER

k2n gen \
--examples-dirs _examples/examples \
--ruleset-env-dir _examples/ruleset-env \
--ruleset-usecase-dir _examples/ruleset-runner \
--usecase crosssplane \
--instruction "give me a runner-claim for the repository dagger for the cluster sthings. add also a proposal for a branch name and a pr title" \
--destination "/tmp/runner/" \
--verbose=true

AUTHOR

Patrick Hermann, stuttgart-things 07/2025

LICENSE

Licensed under the Apache License, Version 2.0 (the "License").

You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" basis, without WARRANTIES or conditions of any kind, either express or implied.

See the License for the specific language governing permissions and limitations under the License.