cli-descriptions

Standardize Kubebuilder CLI help texts, flag descriptions, and usage examples.

9.3k|1.7k|Updated Mar 14, 2018
One-click install
npx skills add https://github.com/kubernetes-sigs/kubebuilder --skill cli-descriptions
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cli-descriptions
Source: https://github.com/kubernetes-sigs/kubebuilder/tree/main/.agents/skills/cli-descriptions
Command: npx skills add https://github.com/kubernetes-sigs/kubebuilder --skill cli-descriptions

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about cli-descriptions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I standardize Kubebuilder CLI command descriptions and help text?

To standardize Kubebuilder CLI command descriptions, use this Skill to enforce consistent help text formatting, craft concise short and long descriptions, and generate realistic command examples.

What is the best way to format help text for boolean and list flags in Kubebuilder?

Formatting help text for Kubebuilder flags requires enforcing standard patterns for boolean, value, and list flags to improve user understanding and ensure documentation consistency.

How do I write consistent examples for Kubebuilder commands?

Writing consistent examples for Kubebuilder commands involves creating realistic, step-by-step demonstrations of common workflows that clearly guide users through expected command functions and behaviors.

Can I use this to review existing CLI documentation for Kubebuilder plugins?

Yes, you can review existing CLI documentation for Kubebuilder plugins by applying its framework to check help texts and flag descriptions for clarity, consistency, and compliance with industry standards.

When do I need to standardize command-line interface documentation for Kubebuilder?

You need to standardize command-line interface documentation for Kubebuilder when you want to improve user experience, provide clear guidance on flag behaviors, and align with industry best practices for CLI design.

Does this approach address flag behaviors and command functions in CLI design?

Yes, this approach addresses flag behaviors and command functions by providing clear guidelines for writing CLI command descriptions and help text, ensuring enhanced usability and readability across Kubebuilder tools.