A CLI tool that scans your project to automatically generate comprehensive onboarding documentation for new developers.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install onboarding-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 onboarding-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 Onboard Generator?
Onboard Generator is a specialized utility within the Openclaw Skills collection designed to solve the 'blank page' problem in documentation. It automatically inspects project files—such as configuration files, script definitions, and directory structures—to build a cohesive onboarding guide. By leveraging Openclaw Skills, teams can ensure that setup instructions, environment variable requirements, and architectural overviews are always current and accurate, significantly reducing the time it takes for new engineers to become productive.
Onboard Generator Use Cases
- Onboarding new team members to a codebase quickly.
- Improving project documentation as part of a DevOps or DX initiative.
- Auditing project structure and identifying missing setup steps.
- Standardizing onboarding across multiple repositories using Openclaw Skills.
- Refreshing outdated README files with minimal manual effort.
How Onboard Generator Works
- The tool initiates a recursive scan of the project root to detect configuration files like package.json or docker-compose.yml.
- It extracts metadata regarding build scripts, test suites, and deployment processes.
- The utility identifies environment variables required for local development.
- Using the intelligence of Openclaw Skills, it generates a structured Markdown document.
- The final guide is saved to the project directory, ready for version control.
Onboard Generator Setup
To utilize this tool within your Openclaw Skills workflow, ensure Node.js 18 or higher is installed. You must also provide an OpenAI API key.
# Set your environment variable
export OPENAI_API_KEY='your_api_key'
# Run the generator via npx
npx ai-onboard
# Generate a specific file
npx ai-onboard -o ONBOARDING.md
Onboard Generator Data Schema & Taxonomy
| Data Point | Extraction Source |
|---|---|
| Dependencies | package.json / requirements.txt |
| Setup Commands | Scripts and configuration files |
| Environment | .env.example or configuration templates |
| Architecture | Directory tree and naming conventions |
Onboard Generator Advanced Features
- Customizable output destinations for better integration with existing documentation.
- Intelligent detection of technology stacks and frameworks.
- Zero-config execution for immediate results within the Openclaw Skills ecosystem.
- Automated troubleshooting section generation based on common project patterns.
SKILL.md
Loading
Related Openclaw Skills
Onboard Gen
Automate the creation of comprehensive developer onboarding documentation directly from your source code.
Script Generator (script-gen)
An AI-driven CLI tool that generates optimized and syntactically correct npm scripts for your package.json based on natural language descriptions.
nginx-gen
A powerful CLI tool that converts natural language descriptions into production-ready Nginx configuration files.
nginx-gen
Transform natural language descriptions into fully functional, secure Nginx configuration files instantly.
Performance Auditor
A powerful AI-driven performance auditing tool that generates prioritized code fixes for Lighthouse reports.
Permission Auditor
An automated security tool that scans API route handlers to generate middleware-ready RBAC permission configurations.
Featured*
