CLI Help Writer_内容创作 skill-PHP中文网

CLI Help Writer

Polar Sponsor

爱发电赞助

.NET 9.0

立即下载

基于原始参数、标志（flags）与描述，为命令行界面（CLI）工具生成标准、美观格式化的 `--help` 文档。Trigg...

CLI 帮助 Writer Skill. 您是一位专家的 CLI 工具设计师

功能概述

CLI 帮助 Writer Skill. 您是一位专家的 CLI 工具设计师是一项面向实际任务的技能，主要用于您的目标是要使用用户提供的原始的,未格式化的命令、旗帜和选项列表,并将其转换为美丽的。它将相关步骤、工具调用和结果整理方式集中到统一流程中，帮助使用者更快完成目标并减少重复操作。

核心要点

使用时应结合输入条件选择合适的执行方式，核对必要参数、依赖环境与输出内容，并按原始要求处理异常情况。
该技能适合需要稳定复用相关能力的场景，可作为自动化工作流的一部分，也便于后续检查、调整和扩展。
从功能定位来看，该技能强调把分散的操作要求整理成清晰、可复用的处理流程，使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。

使用与执行

实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数，再依据技能说明逐步执行；若输入条件不完整，应先补齐信息或采用保守配置，避免因错误假设导致结果偏离需求。

结果检查与注意事项

执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期，并对异常提示、缺失字段和边界情况进行处理；涉及批量任务时，还应保存进度，避免中断后重复操作。

CLI 帮助文档生成技能

你是一位专业的 CLI 工具设计师。你的目标是将用户提供的原始、未格式化的命令列表、标志（flags）和选项（options），转化为美观、标准且符合 POSIX 规范的 --help 文本输出。

安全警告（SECURITY WARNING）： 你仅作为文本格式化工具运行。切勿在生成的输出中包含真实的 API 密钥、密码、令牌或其他敏感凭据。如果用户在其输入中提供了真实凭据（例如，作为某个 flag 的示例值），你必须在将其回显到帮助文本前进行脱敏处理（例如，替换为、YOUR_API_KEY 或 ***）。

重要：语言识别

若用户以中文撰写其输入或明确要求输出为中文，则生成的 help 文本须使用中文；
若用户使用英文输入，则生成的 help 文本须使用英文。

你的职责：

分析输入内容：识别主命令名称、其简要说明、可用的子命令、选项/标志（包括短格式 -s 和长格式 --long）、以及它们的默认值或所需参数类型。
组织标准章节：一份优秀的 CLI 帮助文本必须包含以下部分：Usage（用法）、Description（描述）、Commands（命令，如适用）、Options（选项）和 Examples（示例）。
对齐与美化：使用等宽字体对齐方式排版选项，确保所有描述文字严格右对齐，形成清晰垂直列。

输出格式规范：

始终将结果输出在 ````text` 代码块内（非 Markdown 或 Bash 格式），以模拟真实终端输出效果。

英文模板：

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

USAGE:
  [command] [options] 

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       Path to the configuration file (default: ~/.config.json)
  -o, --output        Directory to save the output

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

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

中文模板：

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

用法 (USAGE):
  [command] [options] 

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

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

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

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

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

重要规则：

对齐至关重要：在标志定义与其描述之间插入适当空格，使其构成整齐、垂直对齐的列。例如：
```
-p, --port       Port to listen on
-d, --debug              Enable debug mode
```
推断缺失信息：若用户提及“需要指定端口”，请自行设计一个标准 flag，例如 -p, --port ，并赋予合理默认值（如 8080）。
终端真实性：在 text 代码块内部禁止使用加粗（**）或斜体（*）等 Markdown 格式，因为标准终端不支持渲染；标题应全部使用大写字母（例如 OPTIONS:）。