← Back to Skills Marketplace
121
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install skylv-readme-generator
Description
Auto-generates professional README.md from code structure, package.json, and directory analysis. Triggers: generate readme, create readme, readme from code,...
Usage Guidance
This skill appears coherent and limited to reading the project tree and source to produce a README. Before installing/using it, be aware it will inspect repository files and may copy code snippets into the README — review the generated README before publishing to avoid leaking secrets (API keys, credentials, private endpoints). Run the skill on a copy or in a restricted environment if the repo may contain sensitive files; consider excluding directories like .env, node_modules, build artifacts, or any files with secrets. Also verify that the agent running this skill has only the filesystem access you intend (project directory only) and that you review any externally-linked badges (shields.io URLs) you do not want to expose publicly.
Capability Analysis
Type: OpenClaw Skill
Name: skylv-readme-generator
Version: 1.0.0
The skill is a standard documentation utility designed to generate a README.md file by analyzing project structure and manifest files (e.g., package.json, setup.py). The instructions in SKILL.md use common system commands (dir, find) for directory discovery and do not contain any evidence of data exfiltration, malicious execution, or harmful prompt injection.
Capability Assessment
Purpose & Capability
The name/description (generate README from codebase) align with the instructions: listing directories, detecting language-specific manifest files, parsing source to extract signatures/exports, and composing README sections are all reasonable and expected operations for this task.
Instruction Scope
The SKILL.md explicitly instructs the agent to run directory-listing commands (dir/find) and to read and parse source files for function signatures, exports, and examples. That is within scope for README generation, but it means the agent will examine repository files (which could contain secrets or sensitive data). The skill does not instruct network exfiltration, but it does ask to include 'actual code examples' which increases the risk of unintentionally including sensitive content in the generated README.
Install Mechanism
Instruction-only skill with no install spec and no code files. Nothing will be downloaded or written by an installer step.
Credentials
No environment variables, credentials, or config paths are requested. The lack of external credentials is proportional to a README generator.
Persistence & Privilege
The skill does not request always:true, does not install persistent components, and does not modify other skills or system-wide settings.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install skylv-readme-generator - After installation, invoke the skill by name or use
/skylv-readme-generator - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of skylv-readme-generator.
- Automatically analyzes project structure and code to generate a professional README.md.
- Detects project type (JavaScript, Python, Rust, Go, Java) based on config files.
- Builds README sections including title, badges, description, features, installation, usage, API, contributing, and license.
- Supports triggers like "generate readme" or "create documentation".
- Outputs a ready-to-use, comprehensive README.md in markdown format.
Metadata
Frequently Asked Questions
What is Skylv Readme Generator?
Auto-generates professional README.md from code structure, package.json, and directory analysis. Triggers: generate readme, create readme, readme from code,... It is an AI Agent Skill for Claude Code / OpenClaw, with 121 downloads so far.
How do I install Skylv Readme Generator?
Run "/install skylv-readme-generator" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Skylv Readme Generator free?
Yes, Skylv Readme Generator is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Skylv Readme Generator support?
Skylv Readme Generator is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Skylv Readme Generator?
It is built and maintained by SKY-lv (@sky-lv); the current version is v1.0.0.
More Skills