← Back to Skills Marketplace
1033
Downloads
0
Stars
3
Active Installs
1
Versions
Install in OpenClaw
/install readme-generator
Description
Generate a production-quality README.md by analyzing project structure, framework, and code
Usage Guidance
This skill appears to do what it says: scan files in a repository and generate a README. Before installing or running it, confirm the agent will only be given access to the project directory (so it doesn't read unrelated files), back up any existing README (or choose README.generated.md) as the instructions suggest, and ensure the repository does not contain secrets you wouldn't want read by the agent. Also verify how your agent implements filesystem access and whether it will actually prompt before overwriting files in your environment.
Capability Analysis
Type: OpenClaw Skill
Name: readme-generator
Version: 1.0.0
The OpenClaw AgentSkill bundle 'readme-generator' is benign. Its instructions and embedded shell commands (`find`, `Get-ChildItem`) are entirely consistent with its stated purpose of analyzing project structure to generate a README.md. It reads common project configuration files and lists file paths, explicitly excluding sensitive directories like `.git` and `node_modules`. There is no evidence of data exfiltration, malicious execution, persistence, or prompt injection. The skill also includes a safeguard to ask the user before overwriting an existing `README.md`.
Capability Assessment
Purpose & Capability
The name/description (README generator) matches the actions in SKILL.md: inspecting manifests, source files, CI, Dockerfiles, and producing a README. There are no unrelated credentials, binaries, or configuration paths requested.
Instruction Scope
Runtime instructions explicitly direct the agent to read repository files and run simple directory-listing commands (find / Get-ChildItem) and to write README.md (with a confirmation step described). These actions are within scope for generating a README. The skill does not instruct the agent to read unrelated system files, environment variables, or post data to external endpoints.
Install Mechanism
No install spec or code files are present (instruction-only). Nothing is downloaded or written to disk by an installer, so install risk is minimal.
Credentials
The skill declares no required env vars, credentials, or config paths. The SKILL.md does not attempt to access environment secrets beyond inferring configuration from repository files.
Persistence & Privilege
always is false and the skill does not request or modify other skills' configs or system-wide agent settings. It asks to write README.md in project root but specifies asking before overwriting.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install readme-generator - After installation, invoke the skill by name or use
/readme-generator - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
- Initial release of readme-generator.
- Analyzes project files and structure to generate a production-quality README.md.
- Detects frameworks, dependencies, and project configuration across multiple languages (Node.js, Python, Rust, Go, etc.).
- Infers install/run commands, generates relevant badges, and tailors documentation sections based on detected tools and frameworks.
- Handles monorepos, missing config files, and existing READMEs with user prompts and sensible defaults.
Metadata
Frequently Asked Questions
What is README Generator?
Generate a production-quality README.md by analyzing project structure, framework, and code. It is an AI Agent Skill for Claude Code / OpenClaw, with 1033 downloads so far.
How do I install README Generator?
Run "/install readme-generator" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is README Generator free?
Yes, README Generator is completely free (open-source). You can download, install and use it at no cost.
Which platforms does README Generator support?
README Generator is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created README Generator?
It is built and maintained by Fratua (@fratua); the current version is v1.0.0.
More Skills