CLI Help Writer Skill

--help

• If the user writes their prompt or requests the output in Chinese, generate the help text in Chinese.
• If the user writes in English, generate the help text in English.

Your Responsibilities:

1. Analyze the Inputs: Identify the main command name, its description, available subcommands, options/flags (both short

   -s

   and long

   --long

   versions), and their default values or arguments.
2. Format Standard Sections: A good CLI help text must include:

   Usage

   ,

   Description

   ,

   Commands

   (if applicable),

   Options

   , and

   Examples

   .
3. Align and Beautify: Use monospaced alignment for options so that all descriptions line up perfectly on the right side.

Output Format Guidelines:

English Template:

[Command Name] - [Brief one-line description]

USAGE:
  [command] [options] <arguments>

DESCRIPTION:
  [A slightly longer description of what the tool does, wrapped to ~80 characters per line.]

COMMANDS:
  [subcommand1]   [Description of subcommand 1]
  [subcommand2]   [Description of subcommand 2]
  help            Print help information

OPTIONS:
  -h, --help               Print this help message
  -v, --version            Print version information
  -c, --config <file>      Path to the configuration file (default: ~/.config.json)
  -o, --output <dir>       Directory to save the output

EXAMPLES:
  # Basic usage
  $ [command] --config ./config.json

  # Advanced usage
  $ [command] build --output ./dist

Chinese Template:

[Command Name] - [简短的一句话描述]

用法 (USAGE):
  [command] [options] <arguments>

描述 (DESCRIPTION):
  [对该工具功能的详细描述，自动换行，保持每行约 80 个字符以内。]

命令 (COMMANDS):
  [subcommand1]   [子命令 1 的描述]
  [subcommand2]   [子命令 2 的描述]
  help            打印帮助信息

选项 (OPTIONS):
  -h, --help               打印此帮助信息
  -v, --version            打印版本信息
  -c, --config <file>      指定配置文件路径 (默认: ~/.config.json)
  -o, --output <dir>       指定输出目录

示例 (EXAMPLES):
  # 基础用法
  $ [command] --config ./config.json

  # 高阶用法
  $ [command] build --output ./dist

Important Rules:

• Alignment is Key: Pad the spaces between the flag definitions and their descriptions so they form a clean, vertical column. Example:
  text

  -p, --port <number>      Port to listen on
  -d, --debug              Enable debug mode

• Infer Missing Info: If the user mentions "needs a port", invent a standard flag like

  -p, --port <number>

  with a reasonable default (e.g.,

  8080

  ).
• Terminal Realism: Do not use bold (

  **

  ) or italics (

  *

  ) inside the

  text

  code block, as standard terminals do not render Markdown. Use uppercase letters for headers (e.g.,

  OPTIONS:

  ).
• Redact Sensitive Information: If the user supplies real API keys, passwords, tokens, or other sensitive credentials in their examples or default values, redact them (e.g., replace with

  <REDACTED>

  or

  ***

  ) before generating the help text. Never echo sensitive credentials verbatim.