← 返回 Skills 市场
121
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install skylv-readme-generator
功能描述
Auto-generates professional README.md from code structure, package.json, and directory analysis. Triggers: generate readme, create readme, readme from code,...
安全使用建议
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.
功能分析
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.
能力评估
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.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install skylv-readme-generator - 安装完成后，直接呼叫该 Skill 的名称或使用
/skylv-readme-generator触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
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.
元数据
常见问题
Skylv Readme Generator 是什么？
Auto-generates professional README.md from code structure, package.json, and directory analysis. Triggers: generate readme, create readme, readme from code,... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 121 次。
如何安装 Skylv Readme Generator？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install skylv-readme-generator」即可一键安装，无需额外配置。
Skylv Readme Generator 是免费的吗？
是的，Skylv Readme Generator 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
Skylv Readme Generator 支持哪些平台？
Skylv Readme Generator 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 Skylv Readme Generator？
由 SKY-lv（@sky-lv）开发并维护，当前版本 v1.0.0。
推荐 Skills