Automatically generates comprehensive, professional README.md files by analyzing your project's source code and metadata.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install readme-gen
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 readme-gen 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 README Gen?
The readme-gen skill is a powerful documentation automation tool designed to transform empty or minimal project repositories into professional, well-documented codebases. As part of the ecosystem of Openclaw Skills, it eliminates the tedious task of manually drafting project overviews, installation guides, and API documentation by analyzing your project's source code and metadata directly.
By leveraging this skill, developers can ensure their projects make a great first impression. It automatically identifies package details, exports, and CLI commands to build a structured Markdown file complete with status badges and clear usage examples, allowing you to focus on writing code while maintaining high-quality documentation standards.
README Gen Use Cases
- Launching a new open-source repository with full documentation from day one.
- Updating existing projects that have missing or outdated README.md files.
- Standardizing documentation across multiple npm packages or internal company libraries.
- Generating specialized CLI documentation for command-line tools.
How README Gen Works
- The tool scans the root directory to identify key files like package.json and configuration settings.
- It performs a deep analysis of source code to detect exported functions, classes, and CLI command structures.
- Relevant metadata is extracted to generate appropriate status badges for registries, licenses, and build pipelines.
- The skill synthesizes the gathered information into a structured Markdown template including intro, installation, API, and usage sections.
- A final README.md file is generated or updated, ready for immediate deployment to version control.
README Gen Setup
To use this tool within the Openclaw Skills environment, you can run it directly using npx. Ensure you have Node.js 18 or higher installed on your system.
npx ai-readme
To see all available configuration options and flags, run:
npx ai-readme --help
README Gen Data Schema & Taxonomy
| Component | Data Source | Output Format |
|---|---|---|
| Project Info | package.json | Header, Name, Version |
| Badges | GitHub/NPM metadata | Markdown Image Links |
| API Docs | Source Exports | Markdown Tables/Lists |
| Install Steps | Package Manager lockfiles | Code Blocks (npm/yarn/pnpm) |
| Examples | Test files or source comments | Usage Code Blocks |
README Gen Advanced Features
- Custom section filtering using the --sections flag to include only specific documentation parts.
- Specialized generation modes for different project types, such as the --type cli flag for command-line interfaces.
- Automated badge integration for build status, license, and registry versioning.
- Output path customization via the --output parameter to target specific file locations.
- Seamless integration with other Openclaw Skills for end-to-end project initialization.
SKILL.md
Loading
Related Openclaw Skills
Rate Limiter Generator
An AI-driven tool to generate production-ready rate limiting middleware and configurations from simple natural language descriptions.
Rate Limit Generator
A natural language configuration tool that generates ready-to-use rate limiting middleware for APIs and web applications.
Queue Generator
Automatically generate BullMQ configurations, worker code, and job producers from a simple natural language description.
Queue Generator (queue-gen)
A command-line utility that instantly generates production-ready BullMQ queue configurations and worker code from a simple text description.
Readme Writer
Generate polished README.md files from your codebase automatically using AI-driven analysis.
Redis Gen
An AI-powered CLI tool that generates optimized Redis key patterns, data structure designs, and TTL recommendations from natural language descriptions.
Featured*
