Skills
.Work. You
Rest

cli-descriptions

Official

Standardize CLI command and flag descriptions in Kubebuilder.

Software Engineering#documentation#cli#help-text#kubebuilder#command descriptions#flag standards
Authorkubernetes-sigs
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill provides clear and consistent guidelines for writing CLI command descriptions, help text, and examples, ensuring enhanced usability and readability across Kubebuilder tools.

Core Features & Use Cases

  • Help Text Formatting: Enforces standard patterns for boolean, value, and list flags to improve user understanding.
  • Command Documentation: Crafts concise short descriptions and comprehensive long descriptions with behavioral notes.
  • Example Generation: Creates realistic, step-by-step command examples demonstrating common workflows.
  • Review Assistance: Offers a framework for reviewing help texts and flag descriptions for consistency and clarity.

Quick Start

Use this skill to create, review, or refine help text and command descriptions for a Kubebuilder plugin or CLI command.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: cli-descriptions
Download link: https://github.com/kubernetes-sigs/kubebuilder/archive/main.zip#cli-descriptions

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.