AnayDhawan/oss-launch
GitHub: AnayDhawan/oss-launch
一款 AI Agent 技能工具,自动扫描代码仓库并生成完整的开源文件集,帮助开发者快速规范地完成项目开源。
Stars: 8 | Forks: 2
# oss-launch
[](LICENSE)
[](https://docs.claude.com/en/docs/claude-code)
[](CHANGELOG.md)
[](https://github.com/AnayDhawan/oss-launch/stargazers)

**以正确的方式将你的仓库开源。** 运行 `/oss-launch`,它会扫描你的仓库,只询问
它无法推断的内容,然后生成一套量身定制的开源文件集:README、
LICENSE、CONTRIBUTING、CODE_OF_CONDUCT、SECURITY、CHANGELOG、`.gitignore`、GitHub issue 和
PR 模板,以及 CI。接着它会帮你完成发布:徽章、元数据、release、演示 GIF,以及
Show HN / Reddit / YouTube 的发布指南。

*这是一个风格化的动态图形演示,并非实际的录制运行。有关实际运行的
真实输出,请参见 [`example/`](example/) —— 这是一个真实的脚手架前后对比,包含真实的
`audit.sh` 得分(1/16 -> 16/16),而不是手写的样板文件。*
## 为什么需要
大多数个人项目从来没有那些枯燥但决定成败的 OSS 文件:真正的 LICENSE、贡献
指南、安全策略,以及能用一句话进行推介的 README。`oss-launch` 将扫描和
脚手架生成一次性完成,并根据你的技术栈和仓库进行定制,而不是
粘贴那些依然写着 `{{REPO}}` 的样板文件。
## 快速开始
这是一个用于 agent harness 的 skill。对于 Claude Code,请将其安装到 harness 发现 skill 的位置:
```
git clone https://github.com/AnayDhawan/oss-launch.git ~/.claude/skills/oss-launch
```
然后,在任何一个你想要开源的仓库中:
```
/oss-launch
```
它会进行扫描、报告缺口、询问几个问题,并生成相关文件。这些 shell 辅助脚本
也可以独立运行:
```
bash ~/.claude/skills/oss-launch/scripts/audit.sh . # gap checklist for the current repo
```
### 没有 agent?以无头模式运行
`scripts/apply.sh` 会从配置文件运行相同的 扫描 -> 生成 -> 重新审计 流程,
而不是通过 agent 问答环节,因此它可以在普通的 CI 或没有 agent 循环的终端中运行:
```
cp templates/oss-launch.config.example oss-launch.config # fill in AUTHOR, SECURITY_EMAIL, TAGLINE
bash scripts/apply.sh /path/to/your/repo --config oss-launch.config
```
它绝不会覆盖现有文件,并且会跳过 README.md 的生成(撰写文案是专属 agent 的
步骤),而不是生成样板文件 —— 有关各 harness 的 agent 设置,请参阅 `AGENTS.md`。
## 它的功能
```
/oss-launch
0. Scan stack, existing files, git remote, secrets/brand leaks
1. Report gap table (scripts/audit.sh)
2. Ask license, author, security contact, type, tagline (only what is unknown)
3. Generate the OSS file collection from templates/, adapted and placeholder-filled
4. Re-audit what was created/updated, what is still manual
5. Launch metadata, CI, releases, demo GIF, Show HN / Reddit / YouTube (on demand)
```
## 目录说明
| 路径 | 内容 |
|------|------|
| `SKILL.md` | 该 skill:Claude 遵循的从扫描到生成的工作流 |
| `AGENTS.md` | 非 Claude harness(Cursor、Aider、Codex CLI 等)的安装和调用说明 |
| `references/` | 详细内容:扫描、生成、README 结构、元数据、CI/CD、发布、启动、媒体 |
| `templates/` | 写入你仓库的 payload:LICENSE、README、CONTRIBUTING、CoC、SECURITY、CHANGELOG、`.gitignore` 变体、`.github/` 模板、CI workflow |
| `scripts/` | `audit.sh`、`apply.sh`(无头模式)、`release.sh`、`setup-labels.sh`、`generate-media.sh`、`update-readme-with-gif.sh` |
| `launch/` | 可直接编辑的 Show HN、Reddit 和 YouTube 帖子模板 + 截图故事板 |
| `setup/` | 一次性媒体(Playwright + ffmpeg)设置说明 |
| `example/` | 一次真实的生成运行:一个裸测试仓库的前后对比,包含实际的 `audit.sh` 得分(1/16 -> 16/16) |
`templates/` 是输出到其他仓库的 payload。根目录文件(此 README、LICENSE
等)描述的是 oss-launch 本身。
## 贡献与安全
贡献主要是新增/更新模板和修复脚本 —— 请参阅
[CONTRIBUTING.md](CONTRIBUTING.md) 和 [行为准则](CODE_OF_CONDUCT.md)。发现
漏洞?请根据 [SECURITY.md](SECURITY.md) 私下报告,不要作为公开 issue 提交。
路线图位于[待解决的 issue](https://github.com/AnayDhawan/oss-launch/issues)中。
## License
Apache-2.0。请参阅 [LICENSE](LICENSE)。此 skill 生成到你仓库中的文件归你所有;在
提示时选择它们的 License(Apache-2.0 或 MIT)。
标签:AI代理, Cutter, SOC Prime, 代码脚手架, 开发工具, 开源治理, 特征检测, 网络调试, 自动化, 项目初始化