闲社服务运行正常AI智能体自动化平台
s

文档格式化

技能标识:skill-doc-formatter

Formats SKILL.md (OpenClaw/Cursor skill docs) for optimal display on ClawHub. Produces a consistent structure—Description, Installation, Usage with benefit-focused examples, and Commands—so skill pages are clear and scannable.

作者:admin | 来源记录:ClawHub
登记来源
ClawHub
版本
V 1.0.0
检测标记
后台标记通过
免费
免费获取
0
收藏
来源与检测标记为平台登记信息,并不代表已展示可复核的检测报告。使用前请核对版本、依赖和所需权限,建议先在隔离环境中运行。
概述
安装方式
版本历史

文档格式化

Skill Doc Formatter | ClawHub

描述

格式化 SKILL.md(OpenClaw/Cursor 技能文档),使其在 ClawHub 上获得最佳展示效果。生成一致的结构——描述、安装、使用(附有突出优势的示例)和命令——确保技能页面清晰且易于浏览。

Skill Doc Formatter | ClawHub

格式化 SKILL.md 技能文档,使其在 ClawHub 上获得最佳展示效果。输出采用一致的结构,便于技能页面快速浏览:描述、安装、使用(附有展示优势的示例)和命令。

清晰的描述:说明技能的功能及使用场景。易于浏览。

安装

bash
clawhub install your-skill

或:git clone https://github.com/Org/your-skill.git workspace/skills/your-skill

使用

  • - 准备或更新要在 ClawHub 上发布的技能
  • 将现有的 SKILL.md 转换为 ClawHub 推荐的布局
  • 当缺少示例时,根据技能描述生成使用示例
  • 将多个技能标准化为相同的文档结构
  1. 1. 步骤或场景一。
  2. 步骤或场景二。
  3. 何时运行哪个命令(指向下方的命令部分)。

示例

示例 1:[优势]
场景: 用户想要执行 X 操作。
操作: 运行 your-command --foo。
结果: 展示优势的简要结果。

示例 2:[优势]
(相同模式。)

命令

bash
python3 /scripts/script.py command [options] # 功能说明
python3 /scripts/script.py other # 功能说明

  • - command — 简短描述。
  • other — 简短描述。

目标结构(ClawHub 优化版)

格式化程序生成或规范化以下部分:

部分目的
描述一段清晰的说明(来自前置元数据 description 加上可选的简短介绍)。说明技能的功能及使用场景。
安装
如何安装:clawhub install 、git clone 或其他步骤。可直接复制粘贴。 |
| 使用 | 如何使用技能:步骤、场景或工作流程。简洁明了。 |
| 示例 | 展示优势的具体示例(例如前后对比、带结果的示例命令)。如果缺少则自动生成。 |
| 命令 | 所有 CLI 命令集中在一个代码块中,附有简短描述。使用绝对路径或 等占位符。 |

如何运行

从要格式化的技能目录或格式化技能目录运行:

bash

按路径格式化技能(输出到标准输出)


python3 /path/to/skill-doc-formatter/scripts/formatskilldoc.py /path/to/other-skill/SKILL.md

将格式化结果写入新文件

python3 scripts/formatskilldoc.py /path/to/skill/SKILL.md -o /path/to/skill/SKILL.clawhub.md

使用格式化程序自身的 SKILL.md 作为输入(演示)

python3 scripts/formatskilldoc.py SKILL.md

选项:

  • - -o FILE — 将输出写入文件而非标准输出。
  • --generate-examples — 当示例部分缺失或内容不足时,根据描述生成示例使用块。
  • --inplace — 用格式化版本覆盖输入的 SKILL.md(谨慎使用;建议使用 -o 进行审查)。
  • --security-check — 格式化后运行安全审查检查,以识别 ClawHub 安全扫描问题。

安全审查

格式化程序包含一个安全审查检查器(security_review.py),可帮助识别可能导致 ClawHub 安全扫描将技能标记为可疑的问题。运行方式:

bash
python3 scripts/security_review.py

或在格式化时使用 --security-check 标志:

bash
python3 scripts/formatskilldoc.py /SKILL.md --security-check

安全审查检查以下内容:

  • - 缺少依赖声明:使用系统依赖项(CLI 工具如 openclaw、lsof、ps、launchctl)但未在 SKILL.md 中声明的技能
  • 秘密日志记录:包含密钥/令牌/密码的命令或值被写入日志文件
  • 缺少文件:安装脚本引用了技能包中不存在的文件
  • 环境变量:脚本使用了未记录的环境变量
  • 持久行为:LaunchAgent/守护进程安装但未在 meta.json 中设置 always: true
  • 文件权限:包含敏感数据的日志文件未设置限制性权限
  • 元数据与文档一致性:meta.json 中的 env(必需)与 optionalEnv(可选)环境变量必须与 SKILL.md/README 一致(必需变量不能标记为可选,可选变量不能标记为必需)
  • openclaw.json 读取披露:如果脚本读取 openclaw.json,SKILL.md/README 必须披露此行为并说明读取了哪些字段;建议添加安装前 / 确认您愿意授予读取权限的说明
  • CLI 与安全子进程:如果文档展示了包含用户提供的任务/消息(例如 spawn --json ...)的 CLI 示例,文档必须警告程序化使用必须使用带参数列表的 subprocess(无 shell 插值)

ClawHub 安全审查的常见修复方法:

  1. 1. 添加依赖声明部分,列出所有 CLI 工具和系统依赖项
  2. 在日志中屏蔽密钥——不要记录包含 --token 或 --password 参数的完整命令字符串
  3. 在 SKILL.md 的依赖声明部分记录环境变量
  4. 如果技能持续运行(LaunchAgent/守护进程),在 meta.json 中添加 always: true
  5. 对包含敏感数据的日志文件设置限制性权限(os.chmod(logpath, 0o600))
  6. 保持环境变量元数据与文档一致——确保 meta.json 中的 requires.env / optionalEnv 与 SKILL.md/README 同步(必需 vs 可选)
  7. 披露 openclaw.json 读取行为——说明读取了哪些字段(例如仅读取 tools.exec.host / tools.exec.node),并添加安装前,请确认您愿意授予对该文件的读取权限
  8. 警告安全调用方式——在命令/CLI 部分上方添加说明,指出 bash 示例仅适用于手动/CLI 使用,代码调用者必须使用带参数列表的 subprocess.run(..., [..., usermessage], ...)

脚本功能

  1. 1. 解析 现有的 SKILL.md(YAML 前置元数据 + Markdown 正文)。
  2. 映射 现有的 ## 部分到描述/安装/使用/示例/命令(根据标题和内容)。
  3. 规范化 部分顺序和标题,使其符合 ClawHub 结构。
  4. 提取或生成:
- 描述:前置元数据 description + 第一段或介绍。 - 安装:查找install、clawhub、clone、npm等关键词;否则添加占位符。 - 使用:保留或合并使用、何时使用、如何使用的内容。 - 示例:保留现有示例;使用 --generate-examples 时,根据描述添加 1-2 个突出优势的示例。 - 命令:收集所有围栏 bash/代码块和看起来像 CLI 命令的列表项;合并到一个命令部分。
  1. 5. 输出 一个带有清晰标题和可选目录的单一 Markdown 文档。
  2. 安全审查(可选):运行安全检查,识别可能影响 ClawHub 安全扫描的问题。

手动模板

如果您更喜欢手动编辑,请在 SKILL.md 中使用以下结构:

markdown



name: your-skill
displayName: Your Skill | OpenClaw Skill
description: 一句话描述。在[触发场景]时使用。
version: 1.0.0


您的技能名称

简短介绍:功能说明及其重要性(1-2 句话)。

依赖声明

  • - Python 3.7+
  • 输入:有效的 SKILL.md,包含 YAML 前置元数据(至少包含 name、description)。

技能文件

  • - SKILL.md — 本文件(格式化技能的使用说明)。
  • scripts/formatskilldoc.py — 解析和格式化脚本。
  • TEMPLATECLAWHUBSKILL.md — 适用于 ClawHub 优化的 SKILL.md 的复制粘贴模板。

标签

skill ai

通过对话安装

以下为平台配置的接入选项,并非逐项实测通过。能否安装取决于客户端支持、技能来源和运行环境:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 skill-doc-formatter-1776286227 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 skill-doc-formatter-1776286227 技能

通过命令行安装

skillhub install skill-doc-formatter-1776286227

下载

⬇ 下载 skill-doc-formatter v1.0.0(免费)

文件大小: 13.79 KB | 发布时间: 2026-4-16 16:55

v1.0.0 最新 2026-4-16 16:55
Initial release of Skill Doc Formatter – a tool to standardize SKILL.md documentation for ClawHub.

- Formats SKILL.md files using a clear, ClawHub-optimized structure: Description, Installation, Usage, Examples, and Commands.
- Supports automatic example generation and section mapping for consistent, benefit-focused documentation.
- Includes a security review tool to highlight common issues before ClawHub publication.
- Provides CLI options for formatting, overwriting, and output control.
- Supplies a manual template and documentation best practices for skill authors.
返回顶部