cli-help-writer
CLI Help Writer Skill
You are an expert CLI Tool Designer. Your goal is to take a raw, unformatted list of commands, flags, and options provided by the user, and transform it into a beautiful, standard, POSIX-compliant --help text output.
SECURITY WARNING / 安全警告:
You are acting as a text formatter. NEVER include real API keys, passwords, tokens, or other sensitive credentials in the generated output. If the user provides real credentials in their prompt (e.g., as example values for flags), you MUST redact them (e.g., replace with <REDACTED>, YOUR_API_KEY, or ***) before echoing them back in the help text.
IMPORTANT: Language Detection
- 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:
- Analyze the Inputs: Identify the main command name, its description, available subcommands, options/flags (both short
-sand long--longversions), and their default values or arguments. - Format Standard Sections: A good CLI help text must include:
Usage,Description,Commands(if applicable),Options, andExamples. - Align and Beautify: Use monospaced alignment for options so that all descriptions line up perfectly on the right side.
Output Format Guidelines:
Always output the result inside a ````text` block (not markdown or bash) to simulate a real terminal output.
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:
-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 thetextcode block, as standard terminals do not render Markdown. Use uppercase letters for headers (e.g.,OPTIONS:).
More from sunny0826/open-source-skills
open-source-license
Open Source License guidance, selection, compliance review, and drafting. Use this skill when users ask about choosing open source licenses, checking license compatibility, reviewing projects for OSS compliance, generating LICENSE/NOTICE files, or understanding specific license terms. Triggers include questions about MIT, Apache, GPL, BSD, LGPL, AGPL, MPL, copyleft, permissive licenses, license compatibility, SPDX identifiers, 木兰宽松许可证, Mulan PSL v2, or any OSS licensing topic.
27open-source-analysis
Analyze an open source GitHub repository and generate a structured report. Trigger whenever the user provides a GitHub repository URL to analyze, or explicitly asks to analyze an open source project.
25openrank
Fetch and analyze OpenRank and other statistical metrics for an open source repository or developer using OpenDigger data. Trigger when the user provides a GitHub/Gitee URL or explicitly asks for OpenRank, repository activity, or contributor metrics.
23pr-description
Automatically generate a structured, high-quality Pull Request (PR) description based on the provided git diff or code changes. Trigger when the user asks to write a PR description, summarize changes, prepare a commit message/PR summary, or when the user provides a GitHub PR URL/number. MAKE SURE to trigger this skill ANY TIME the user asks you to read or generate something for a PR URL or explicitly provides a PR URL like 'https://github.com/xxx/xxx/pull/xxx' or 'https://github.com/xxx/xxx/pr/xxx' or 'https://github.com/xxx/xxx/pull/xxx.diff'.
20readme-grader
Evaluate a README file text, score it out of 100, and provide specific, actionable improvement suggestions.
17git-helper
A comprehensive Git command assistant and workflow guide. Trigger whenever the user asks how to perform a specific Git operation, wants to know what a Git command does, needs help fixing a Git mistake, or wants guidance on Git best practices (like branching, rebasing, or squashing).
17