← 返回 Skills 市场
sunshine-del-ux

GitHub README Generator

作者 Sunshine-del-ux · GitHub ↗ · v1.0.0
cross-platform ⚠ suspicious
464
总下载
0
收藏
4
当前安装
1
版本数
在 OpenClaw 中安装
/install github-readme-generator
功能描述
Generate beautiful, professional GitHub README files for your projects. Supports multiple templates, languages, and customization options.
使用说明 (SKILL.md)

k97et5jhv7rb8769f2fnr80eg1824c8f

安全使用建议
This skill appears to do what it says: it runs a local shell script that writes README.md from templates and may read your local .git user.name. Before installing/running: (1) review the included github-readme-generator.sh (you already have it) and ensure you trust the author, (2) run it in a safe directory because it will overwrite README.md, (3) be aware the script uses simple sed substitutions that may behave oddly if your project name or description contain unusual characters (slashes, braces), and (4) no credentials or network calls are requested by the skill, so there is low risk of secret exfiltration. If you want extra safety, run the script in a disposable repo or review/modify it to sanitize inputs before use.
功能分析
Type: OpenClaw Skill Name: github-readme-generator Version: 1.0.0 The `github-readme-generator.sh` script is vulnerable to `sed` injection. User-provided inputs for `NAME` and `DESCRIPTION` are directly used in `sed` replacement commands without proper escaping of special characters (e.g., `/`, `&`). This allows an attacker to craft inputs that can corrupt the generated `README.md` file or inject arbitrary markdown/text, which could potentially be used for prompt injection if the `README.md` is later processed by an AI agent. This is a significant input sanitization vulnerability.
能力评估
Purpose & Capability
Name/description match the provided assets: SKILL.md documents a README generator and the repository includes a .sh script that generates README.md from templates and inputs. No unrelated credentials, binaries, or external services are requested.
Instruction Scope
Runtime instructions are limited to generating README content and invoking the included shell script. The script only reads .git/user.name (if present) to populate author name and writes README.md in the current directory. It does not send data to external endpoints or read unrelated system files. Note: placeholder replacement uses sed with unescaped user input, which can mis-handle certain characters (e.g., slashes) — a robustness issue, not evidence of malicious scope creep.
Install Mechanism
No install spec or remote downloads; the skill is instruction-only with an included shell script. Nothing is fetched from external URLs or installed automatically.
Credentials
No required environment variables or credentials. The script optionally respects AUTHOR_NAME if set and reads git config user.name locally; both are reasonable and proportional to the stated purpose.
Persistence & Privilege
Skill does not request persistent presence (always is false), does not modify other skills or system-wide agent settings, and performs only local file output (README.md).
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install github-readme-generator
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /github-readme-generator 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.0.0
Initial release of github-readme-generator. - Generate professional GitHub README files with multiple templates. - Supports English, Chinese, Japanese, Spanish, and Korean. - Auto-detects project type and generates suitable sections and badges. - Includes customizable options for template, language, table of contents, and output path. - No dependencies required; uses built-in templates.
元数据
Slug github-readme-generator
版本 1.0.0
许可证
累计安装 4
当前安装数 4
历史版本数 1
常见问题

GitHub README Generator 是什么?

Generate beautiful, professional GitHub README files for your projects. Supports multiple templates, languages, and customization options. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 464 次。

如何安装 GitHub README Generator?

在 OpenClaw 或 Claude Code 对话框中运行命令「/install github-readme-generator」即可一键安装,无需额外配置。

GitHub README Generator 是免费的吗?

是的,GitHub README Generator 完全免费(开源免费),可自由下载、安装和使用。

GitHub README Generator 支持哪些平台?

GitHub README Generator 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。

谁开发了 GitHub README Generator?

由 Sunshine-del-ux(@sunshine-del-ux)开发并维护,当前版本 v1.0.0。

💬 留言讨论