← 返回 Skills 市场
Skill Doc Formatter
作者
austindixson
· GitHub ↗
· v1.0.0
536
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install skill-doc-formatter
功能描述
Formats SKILL.md (OpenClaw/Cursor skill docs) for optimal display on ClawHub. Produces a consistent structure—Description, Installation, Usage with benefit-f...
安全使用建议
This package appears to do exactly what it says: format SKILL.md files and run a local static security checklist. It's safe to run locally with these caveats: 1) Prefer running without --inplace first (use stdout or -o) so you can review changes before overwriting; 2) The security checker is heuristic (regex-based) and may report false positives/negatives — treat its output as guidance, not authoritative proof; 3) The source/owner is unknown (no homepage), so if you plan to run this on sensitive repositories, review the scripts yourself (they're bundled and small) before use. If you want stronger assurance, inspect scripts/security_review.py and scripts/format_skill_doc.py in full (they are included) or run them in an isolated environment.
功能分析
Type: OpenClaw Skill
Name: skill-doc-formatter
Version: 1.0.0
This skill bundle is designed for documentation formatting and security review of *other* OpenClaw skills. The `SKILL.md` clearly outlines its purpose, including a detailed 'Security Review' section that describes various checks for common vulnerabilities (e.g., secret logging, undeclared dependencies, unsafe command execution patterns). The Python scripts (`format_skill_doc.py` and `security_review.py`) implement these features. `format_skill_doc.py` performs text processing and calls `security_review.py` via `subprocess.run`, which is a legitimate internal invocation. `security_review.py` scans other skill files for security issues but does not perform any malicious actions itself. There is no evidence of data exfiltration, unauthorized execution, persistence, or prompt injection against the agent. The entire package is geared towards improving skill quality and security, not compromising it.
能力评估
Purpose & Capability
The name/description (format SKILL.md for ClawHub) matches the provided files and behavior. The repo contains a formatter (scripts/format_skill_doc.py), templates, and a security checker (scripts/security_review.py). No unrelated credentials, binaries, or install steps are requested.
Instruction Scope
SKILL.md instructs running the formatter against local SKILL.md files and optionally running the bundled security review. The scripts read files in the supplied skill directory, parse frontmatter and sections, and may write output (with --inplace or -o). The security checker inspects files for patterns (subprocess usage, logging, env vars, missing files) but does not send data off-host or execute third-party code. Note: --inplace will overwrite files, so review output before overwriting.
Install Mechanism
No install specification is present (instruction-only with shipped scripts). The tool is run with Python from source; it does not download archives or execute installers. This is low-risk and proportionate for a formatter utility.
Credentials
The skill declares no required environment variables or credentials. The bundled security checker scans code for uses of env vars and secrets but does not itself require or request credentials.
Persistence & Privilege
No persistent/background behavior is requested (always:false). The skill does not modify other skills or global agent settings; it operates on files you point it at.
如何使用
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install skill-doc-formatter - 安装完成后,直接呼叫该 Skill 的名称或使用
/skill-doc-formatter触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.0.0
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.
元数据
常见问题
Skill Doc Formatter 是什么?
Formats SKILL.md (OpenClaw/Cursor skill docs) for optimal display on ClawHub. Produces a consistent structure—Description, Installation, Usage with benefit-f... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 536 次。
如何安装 Skill Doc Formatter?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install skill-doc-formatter」即可一键安装,无需额外配置。
Skill Doc Formatter 是免费的吗?
是的,Skill Doc Formatter 完全免费(开源免费),可自由下载、安装和使用。
Skill Doc Formatter 支持哪些平台?
Skill Doc Formatter 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 Skill Doc Formatter?
由 austindixson(@austindixson)开发并维护,当前版本 v1.0.0。
推荐 Skills