Skip to content

docs: add AI agent skills for the Kyma CLI (v3) - #2975

Merged
grego952 merged 2 commits into
kyma-project:mainfrom
jacekon:docs/add-kyma-cli-ai-skills
Oct 12, 2026
Merged

grego952 merged 2 commits into
kyma-project:mainfrom
jacekon:docs/add-kyma-cli-ai-skills

Conversation

@jacekon

@jacekon jacekon commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Description

Changes proposed in this pull request:

  • Add a top-level skills/ directory with four AI coding-agent skills for the open-source Kyma CLI (v3), in SAP AI Skills Library format (SKILL.md + name/description frontmatter; agent-agnostic — works with Claude Code, Codex, Cursor, etc.):
    • kyma-cli — general orientation: install, command groups (kyma module, kyma app, kyma alpha), RBAC authorization, dashboard, kubeconfig, completion, diagnostics.
    • kyma-module-lifecycle — full module lifecycle: discover → enable → configure → verify → manage/unmanage → delete, incl. KLM prerequisites and channel semantics.
    • kyma-app-deploy — deploying apps with kyma app push (source/Dockerfile/image), --expose, Istio injection, env/secret injection, and update-in-place (SSA) behavior.
    • kyma-troubleshoot — read-only-first diagnosis via kyma alpha diagnose + kubectl, with a common-failure reference table.
  • Add skills/README.md describing the format and scope.

This is based on #2974 by @Jan0412, extended with the following corrections and additions after code review and live testing against Kyma CLI v3.5.0:

  1. kyma alpha authorize added — the full command group (user, group, serviceaccount, repository) was absent from all skills. Covers flags, examples, and dry-run.
  2. kyma app push update-in-place behavior documented — second run uses Kubernetes Server-Side Apply and updates the existing Deployment/Service/APIRule in-place; no --replace flag needed.
  3. Shell completion install instructions fixed — kyma completion zsh only prints to stdout; correct permanent install paths (fpath / Homebrew) added.
  4. Module channel semantics explained — regular (stable/production) vs fast (newer/testing) explained with a note that not all modules publish to every channel.
  5. Catalog output format corrected from live testing — the skill previously described two different table formats for KLM vs bare clusters; live testing on a KLM-managed cluster (v3.5.0) shows kyma module catalog always outputs NAME | AVAILABLE VERSIONS | ORIGIN with channel info encoded as 3.11.0(regular), 3.12.0(fast) tuples.

Related issue(s)

See also #2974

Adds a skills/ directory with four AI coding-agent skills for the
open-source Kyma CLI v3, in SAP AI Skills Library format (SKILL.md +
name/description frontmatter; agent-agnostic).

Skills: kyma-cli (orientation, authorize, completion, app push),
kyma-module-lifecycle (full lifecycle incl. channel semantics),
kyma-app-deploy (push, update-in-place / SSA behavior, inject),
kyma-troubleshoot (read-only-first diagnosis, common failure table).

Based on kyma-project#2974 by @Jan0412, extended with:
- kyma alpha authorize command group (user/group/sa/repository)
- app push idempotency / Server-Side Apply update-in-place semantics
- correct shell completion install instructions
- regular vs fast channel explanation
- catalog output format corrected from live cluster testing (v3.5.0)
@jacekon
jacekon requested a review from a team as a code owner October 9, 2026 11:32
@cla-assistant

cla-assistant Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@cla-assistant

cla-assistant Bot commented Oct 9, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown

✅ Proposed changes verification passed

This pull request comes with up-to-date documentation and no illegal standard output usages.

Find more detailed information in the verify-pr-code / standards action.

1 similar comment
@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown

✅ Proposed changes verification passed

This pull request comes with up-to-date documentation and no illegal standard output usages.

Find more detailed information in the verify-pr-code / standards action.

@github-actions

Copy link
Copy Markdown

✅ Proposed changes verification passed

This pull request comes with up-to-date documentation and no illegal standard output usages.

Find more detailed information in the verify-pr-code / standards action.

@grego952
grego952 enabled auto-merge (squash) October 12, 2026 10:51
@grego952
grego952 merged commit c9aaa2a into kyma-project:main Oct 12, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants