← Back to Skills Marketplace
README Auto Generator
by
ericlooi504
· GitHub ↗
· v1.0.0
· MIT-0
29
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install readme-auto-gen
Description
Auto-generate comprehensive, well-structured README.md files by analyzing your project's codebase, dependencies, configuration, and structure. Scans package....
README (SKILL.md)
k97bbxr43z14qn7xh9v4hf5ktx865nad
Usage Guidance
This appears safe for normal use as a README generator. Before installing or invoking it, make sure you are comfortable with the agent reading the target project’s files and review any generated README changes before committing them.
Capability Analysis
Type: OpenClaw Skill
Name: readme-auto-gen
Version: 1.0.0
The skill bundle describes a utility for auto-generating README.md files by scanning project structure, source code, and configuration files (e.g., package.json, pyproject.toml). While the instructions in SKILL.md mention analyzing environment variables and configuration files, this behavior is consistent with the stated goal of documenting project requirements and setup. No evidence of data exfiltration, malicious execution, or harmful prompt injection was found in the provided files.
Capability Assessment
Purpose & Capability
The described behavior—analyzing a codebase, configs, dependencies, and existing docs to generate README.md—is directly aligned with the skill’s purpose.
Instruction Scope
The skill says it may scan the entire project and update or generate README.md, so users should invoke it only in the intended repository and review the resulting documentation before publishing.
Install Mechanism
There is no install script or bundled code; it is instruction-only. The only declared required binary is git, which is reasonable for repository-aware documentation generation.
Credentials
Reading source code, package files, CI configs, and existing docs is proportionate for README generation, but it may expose project details to the agent context.
Persistence & Privilege
No credential use, background persistence, autonomous worker, or persistent memory mechanism is described in the artifacts.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install readme-auto-gen - After installation, invoke the skill by name or use
/readme-auto-gen - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release — auto-generate README.md from project structure and code analysis
Metadata
Frequently Asked Questions
What is README Auto Generator?
Auto-generate comprehensive, well-structured README.md files by analyzing your project's codebase, dependencies, configuration, and structure. Scans package.... It is an AI Agent Skill for Claude Code / OpenClaw, with 29 downloads so far.
How do I install README Auto Generator?
Run "/install readme-auto-gen" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is README Auto Generator free?
Yes, README Auto Generator is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does README Auto Generator support?
README Auto Generator is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created README Auto Generator?
It is built and maintained by ericlooi504 (@ericlooi504); the current version is v1.0.0.
More Skills