A maintenance utility that synchronizes agent documentation, FAQs, and examples by reverse-engineering SKILL.md and local script resources.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install skill-readme-rebuilder
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install skill-readme-rebuilder using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Skill README Rebuilder?
Skill README Rebuilder is a specialized tool designed to eliminate documentation rot in AI agent development. By analyzing the core SKILL.md file alongside your scripts and resources, it ensures that your READMEs, FAQs, and usage examples stay perfectly aligned with the actual technical implementation. As a core part of the Openclaw Skills ecosystem, it provides a structured approach to documentation maintenance, preventing the manual effort of updating multiple files whenever a skill's metadata or logic changes.
This skill is particularly valuable for developers who need to maintain professional standards across complex agent projects. It doesn't just copy text; it audits the directory to identify missing descriptions, consistency risks, and dependency gaps, ensuring that the final output is both accurate and comprehensive.
Skill README Rebuilder Use Cases
- Rebuilding a README file from a specific skill directory to reflect recent code updates.
- Generating automated FAQ sections and technical usage examples based on metadata.
- Auditing an Openclaw Skills project for consistency risks and missing dependency declarations.
- Standardizing documentation across multiple skills using a unified template and specification.
How Skill README Rebuilder Works
- The tool accepts a directory path and identifies the primary SKILL.md and resource files.
- It analyzes the directory structure to provide an overview of the current status and identify missing documentation components.
- A structured task list is created based on the technical facts found in the script files and metadata.
- If the environment permits, it executes a Python-based processing script using provided templates; otherwise, it performs a direct text synthesis.
- It outputs a reviewable draft of the documentation, followed by a dry-run plan or executable checklist for the final write.
Skill README Rebuilder Setup
This skill requires python3 to be available in your environment. It is compatible with macOS, Linux, and Windows.
# Ensure you are in your skill development directory
cd /your/skill/project/path
# Run the rebuilder using the included Python script
python3 "{baseDir}/scripts/run.py" --input <input_file> --output <output_file>
Skill README Rebuilder Data Schema & Taxonomy
The skill utilizes a set of internal resource files to govern the generation of documentation for Openclaw Skills.
| Resource Path | Purpose |
|---|---|
| resources/spec.json | Defines the technical specification and schema for the skill. |
| resources/template.md | The Markdown skeleton used for all generated README files. |
| examples/ | Stores sample input and output data for reference. |
| tests/smoke-test.md | Used for verification and validation of the documentation logic. |
Skill README Rebuilder Advanced Features
- Consistency Risk Auditing: Automatically flags discrepancies between the skill's code and its declared documentation.
- Template-Based Synthesis: Uses a predefined template.md to maintain a consistent look and feel across all your Openclaw Skills.
- Safety Boundaries: Operates on a read-only basis by default, providing auditable drafts before any system changes are made.
- Dependency Tracking: Extracts bin and OS requirements directly from metadata to ensure installation instructions are never outdated.
SKILL.md
Loading
Related Openclaw Skills
screenshot-to-task
A specialized tool for Openclaw Skills that transforms visual inspirations and screenshot context into structured, prioritized task lists.
SBOM Explainer
An AI-powered skill that converts technical SBOM data into prioritized, human-readable risk assessments.
Command Execution Safety Inspector
A dedicated security skill that identifies and audits dangerous shell command patterns before execution to prevent system compromise.
Personal Deadline Radar
An intelligent scanning tool designed to identify upcoming deadline risks and scheduling conflicts across tasks, meetings, and messages.
Skill Risk Splitter
A specialized architectural tool designed to decompose complex AI agent skills into safer, modular, and more manageable components.
Skill Routing Benchmark
A specialized benchmarking tool to detect description conflicts and generate test cases for AI agent skills.
Featured*
