Skip to content

README.md

Latest commit

 

History

History
68 lines (43 loc) · 2.91 KB

README.md

File metadata and controls

68 lines (43 loc) · 2.91 KB
Raw

helm-chart-best-practices

A reusable Agent Skill and plugin that helps agents review and generate Helm charts following the official Helm Chart Best Practices Guide.

The skill captures the eight chapters of the official guide — General Conventions, Values, Templates, Dependencies, Labels and Annotations, Pods and PodTemplates, Custom Resource Definitions, and Role-Based Access Control — and turns them into a routine an agent can run on any chart you give it.

What it does

When the skill triggers, the agent will:

  • Review mode — Walk a Helm chart directory, run helm lint / helm template when available, and produce a categorized report of best-practice violations with suggested fixes and references to the upstream guidance.
  • Generate mode — Scaffold a new chart that already follows the guide (correct chart name, SemVer, standard labels, flat values with documentation, helper templates, secure pod defaults, etc.).
  • Refactor mode — Apply edits in-place to bring an existing chart up to the guide.

Installation

Claude Code

# Register this repository as a marketplace
/plugin marketplace add KEY60228/helm-chart-best-practices

# Install the plugin
/plugin install helm-chart-best-practices@helm-chart-best-practices

Codex

# Register this repository as a marketplace
codex plugin marketplace add KEY60228/helm-chart-best-practices

# Install the plugin
codex plugin add helm-chart-best-practices@helm-chart-best-practices

The plugin is also available in the interactive Codex plugin browser:

codex
/plugins

The repository ships marketplace metadata for both Claude Code and Codex. Both marketplaces point at the same plugin bundle under plugins/helm-chart-best-practices/, which is the source of truth for the skill and both plugin manifests.

Other agents (open Agent Skills standard)

The skill follows the open Agent Skills standard, so any tool that resolves ~/.agents/skills/ (Codex, Claude Code, Copilot CLI, …) can use it directly without a plugin wrapper:

git clone https://github.com/KEY60228/helm-chart-best-practices.git
ln -s "$(pwd)/helm-chart-best-practices/plugins/helm-chart-best-practices/skills/helm-chart-best-practices" \
      "$HOME/.agents/skills/helm-chart-best-practices"

Or download the helm-chart-best-practices.skill artifact from a Release and unpack it into ~/.agents/skills/.

Authoritative source

This skill mirrors the structure and wording of the official Helm documentation at the time of writing. Whenever the upstream guide changes, the references should be refreshed and a new version released.

Contributing

See CONTRIBUTING.md for local development, evaluation, and release instructions.

License

Apache-2.0. See LICENSE.