← Back to Skills Marketplace
52yuanchangxing

Skill Readme Rebuilder

by vx:17605205782 · GitHub ↗ · v1.0.0 · MIT-0
darwinlinuxwin32 ✓ Security Clean
154
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install skill-readme-rebuilder
Description
从 SKILL.md、脚本与资源反推 README、FAQ 与示例,保持说明一致。;use for skills, readme, docs workflows;do not use for 伪造脚本能力, 跳过真实依赖声明.
Usage Guidance
This skill appears coherent and low-risk for local use: it reads a provided skill directory and produces a draft README/FAQ/report. Before running it (or allowing an agent to run it): 1) inspect scripts/run.py (it is included and readable) and run with --dry-run or on a copy/sandbox of the target directory; 2) avoid pointing it at directories containing secrets or private keys you don't want included in generated output (the pattern scanner masks long-looking secret strings but other sensitive content could still appear in reports); 3) if you will let the agent invoke the skill autonomously, be aware it can read any files under the provided directory — restrict inputs accordingly; 4) do not rely on the tool to modify external systems — it is intended to produce draft text that you should review before publishing or applying changes.
Capability Analysis
Type: OpenClaw Skill Name: skill-readme-rebuilder Version: 1.0.0 The 'skill-readme-rebuilder' bundle is a utility designed to automate the generation and auditing of documentation for OpenClaw skills. The core logic in `scripts/run.py` is transparent, using only Python standard libraries to perform directory scans, CSV analysis, and pattern matching. Notably, it includes a security-oriented 'pattern_audit' mode that proactively searches for and reports high-risk indicators like 'curl|bash' or exposed secrets, demonstrating defensive rather than malicious intent. The instructions in `SKILL.md` emphasize safety boundaries, dry-run options, and user confirmation for any high-risk actions.
Capability Assessment
Purpose & Capability
Name/description, declared requirement (python3), SKILL.md routing, resources/spec.json, and scripts/run.py all align with a 'directory_audit' README-rebuilding tool. The script's functions (directory_report, skill_audit, pattern_report, csv_report) are coherent with the stated goal of producing structured README drafts and audits.
Instruction Scope
SKILL.md instructs the agent to produce structured drafts and to run the local script when shell/exec is available (python3 "{baseDir}/scripts/run.py ..."). The script is read-only: it lists and reads files, generates reports, and has a --dry-run flag. Caveat: the tool reads file contents from the provided directory and may incorporate those contents into outputs (pattern scanning masks long-looking secrets but other file contents may be echoed). The skill explicitly warns not to fabricate capabilities or skip real dependency declarations.
Install Mechanism
No install spec is provided (instruction-only with an included helper script). No remote downloads or third-party package installs are performed. The only runtime dependency is python3 (standard library only, per README/SELF_CHECK).
Credentials
The skill requests no environment variables, no credentials, and no config paths. This is proportionate to a local directory-audit/document-generation utility.
Persistence & Privilege
always is false; the skill does not request persistent elevation or modify other skills. It can be invoked autonomously per default platform behavior, which is expected for skills — nothing in the code writes to unrelated system locations or alters other skills.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install skill-readme-rebuilder
  3. After installation, invoke the skill by name or use /skill-readme-rebuilder
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of skill-readme-rebuilder: - Generates consistent README, FAQ, and examples based on SKILL.md, scripts, and resources. - Provides structured output: status overview, missing items, README suggestions, FAQ drafts, example ideas, and consistency risks. - Clearly defines appropriate and inappropriate use cases, emphasizing documentation integrity and safety boundaries. - Prioritizes reviewable drafts and explicit confirmation for unclear items. - Includes support for platform-specific scripts, local templates, and standard outputs.
Metadata
Slug skill-readme-rebuilder
Version 1.0.0
License MIT-0
All-time Installs 0
Active Installs 0
Total Versions 1
Frequently Asked Questions

What is Skill Readme Rebuilder?

从 SKILL.md、脚本与资源反推 README、FAQ 与示例,保持说明一致。;use for skills, readme, docs workflows;do not use for 伪造脚本能力, 跳过真实依赖声明. It is an AI Agent Skill for Claude Code / OpenClaw, with 154 downloads so far.

How do I install Skill Readme Rebuilder?

Run "/install skill-readme-rebuilder" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is Skill Readme Rebuilder free?

Yes, Skill Readme Rebuilder is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does Skill Readme Rebuilder support?

Skill Readme Rebuilder is cross-platform and runs anywhere OpenClaw / Claude Code is available (darwin, linux, win32).

Who created Skill Readme Rebuilder?

It is built and maintained by vx:17605205782 (@52yuanchangxing); the current version is v1.0.0.

💬 Comments