An automated CLI tool that scans your source code to generate comprehensive, structured Markdown wikis and architectural documentation.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install wiki-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 wiki-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 Wiki Generator?
The Wiki Generator is a developer-centric utility designed to eliminate the manual burden of maintaining project documentation. By analyzing your codebase's structure, exports, and logic, it synthesizes technical details into a cohesive wiki format. This tool is a standout addition to the Openclaw Skills collection, ensuring that documentation stays updated as frequently as the code changes.
Whether you are managing a large-scale enterprise application or a small open-source library, this skill provides a zero-config solution to documentation. It helps bridge the gap between technical implementation and developer understanding by creating a navigable knowledge base directly from your source files.
Wiki Generator Use Cases
- Rapidly onboarding new developers by providing an instantly generated architectural overview.
- Generating and maintaining documentation for open-source repositories to improve contributor engagement.
- Standardizing internal technical wikis across multiple microservices or monorepos.
- Creating a structured navigation index for complex codebases to improve discoverability.
How Wiki Generator Works
- The tool performs a recursive scan of the target directory to identify modules and file relationships.
- It parses exports and logic patterns to understand the functional role of each component.
- Utilizing AI models, it generates descriptive Markdown pages for each identified module.
- It constructs a global navigation structure to link all pages into a unified project wiki.
Wiki Generator Setup
To use this feature from the Openclaw Skills set, ensure you have Node.js 18 or higher installed. You will also need an OpenAI API key configured in your environment.
# Set your API key
export OPENAI_API_KEY='your_key_here'
# Run the generator on your source folder
npx ai-wiki ./src/
Wiki Generator Data Schema & Taxonomy
The skill generates a hierarchical documentation structure based on your folder tree:
| Output Type | Description | File Format |
|---|---|---|
| Module Documentation | Individual pages describing the purpose and API of specific files. | Markdown (.md) |
| Architecture Overview | A high-level summary of the project's design patterns and modules. | Markdown (.md) |
| Navigation Index | A central file or sidebar structure to navigate the generated wiki. | Markdown (.md) |
Wiki Generator Advanced Features
- Support for custom source directories including src, lib, and app folders.
- Automated relationship mapping between modules for better architectural context.
- Zero-installation execution via npx for streamlined CI/CD integration.
- Seamless compatibility with other developer-focused Openclaw Skills for enhanced workflow automation.
SKILL.md
Loading
Related Openclaw Skills
socket-gen
A CLI utility that converts natural language descriptions into production-ready Socket.io server and client handlers.
Webhook Generator
An AI-powered CLI tool that generates production-grade webhook handlers with signature verification and retry logic.
Weather
A lightweight skill for fetching current weather conditions and forecasts directly via CLI without requiring API keys.
Core Web Vitals Fixer
Identify and fix Core Web Vitals bottlenecks using AI-driven code analysis and prioritized optimization reports.
X Algorithm Mastery
A comprehensive data-driven framework for mastering the X algorithm to maximize reach, engagement, and account growth.
XSS Scanner
Detect and fix XSS vulnerabilities in frontend code using the Openclaw Skills security suite.
Featured*
