publisher

面向 Clawdbot 技能的专业化文档编写与发布工具

一键生成面向用户采纳优化的 README，并同步发布至 GitHub 与 ClawdHub。

⚠️ 必需依赖

• bash
• jq（用于 JSON 解析）
• gh CLI（执行 GitHub 相关操作）
• clawdhub CLI（用于发布）
• git

📋 功能说明

自动化完成完整的发布工作流：

文档生成

1. 读取您的 SKILL.md 文件，理解该技能的功能定位
2. 基于已验证有效的表达模式，生成 3 个备选的一行式描述（one-liner）
3. 依据 GitHub 文档最佳实践生成 README：
   • 开篇直击问题与解决方案
   • 采用倒金字塔结构组织内容
   • 使用 Emoji 作为标题前缀，提升可扫描性
   • 关键成果加粗强调
   • 全文高亮文本占比不超过 15%
4. 将选定的一行式描述自动更新至 SKILL.md 的 frontmatter 中

发布流程

5. 若仓库尚不存在，则自动创建 GitHub 仓库
6. 将代码推送至 GitHub
7. 自动识别版本号，并发布至 ClawdHub

🚀 安装方式

clawdhub install skill-publisher

💡 使用方法

cd ~/clawd/skills/your-skill
skill-publisher

脚本将执行以下步骤：

1. 展示 3 个一栏式描述选项（可从中选择，或自行撰写）
2. 生成 README 预览
3. 请求用户确认是否继续
4. 向 GitHub 与 ClawdHub 同步发布

🎯 一行式描述生成模式

本工具基于三种已被验证有效的表达模式生成备选描述：

模式 A：持续性收益

Keep [thing] [desired state] [timeframe]

示例："Keep your Claude access token fresh 24/7"

模式 B：痛点消除

[Do thing] without [pain point]

示例："Build cross-device tools without hardcoding paths"

模式 C：自动化动作

Automatically [action] [thing] [when]

示例："Automatically refresh tokens before they expire"

📚 生成的 README 结构

严格遵循 GitHub 官方文档最佳实践框架：

核心章节（首屏可见区域）

• 标题 + 副标题
• 问题所在：（一句话概括）
• 本工具作用：（一句话概括）
• 📋 必需依赖
• ⚡ 功能说明（先列明成果，再展开特性）
• 🚀 安装方式
• 🔧 工作原理（先说明结果，再解释实现过程）

可选章节（默认折叠）

• 配置项
• 故障排查
• 开发者须知
• 实现细节

🔧 工作原理

阶段 1：分析

• 读取 SKILL.md 的 frontmatter（如存在）
• 提取关键信息：名称、描述、依赖项
• 解析脚本文件以识别运行时依赖

阶段 2：一行式描述生成

基于 SKILL.md 中的描述内容，生成 3 种格式的备选方案：

• 模式 A：持续性收益格式
• 模式 B：痛点消除格式
• 模式 C：自动化动作格式

全部展示供您选择，亦支持自定义输入。

阶段 3：README 生成

使用模板文件 ~/clawd/templates/README-template.md 进行填充：

• 填入标题、问题陈述、解决方案
• 从 SKILL.md 中提取依赖项列表
• 基于技能描述生成 “What It Does” 章节
• 构建标准化安装步骤
• 结合示例生成 “How It Works” 章节

阶段 4：发布

1. 检查系统中是否存在 gh CLI（缺失时提供引导式安装指引）
2. 读取 VERSION 文件获取版本号
3. 调用 gh repo create 创建 GitHub 仓库
4. 提交并推送全部文件
5. 调用 clawdhub publish 发布至 ClawdHub

📁 预期文件结构

your-skill/
├── SKILL.md           # 必需：技能描述文件
├── VERSION            # 必需：版本号（例如 "1.0.0"）
├── scripts/           # 可选：您的脚本目录
│   └── main.sh
├── README.md          # 由本工具自动生成
└── .gitignore         # 可选

⚙️ 配置说明

无需任何手动配置。本工具自动从以下位置提取全部所需信息：

• SKILL.md（名称、描述、依赖项）
• VERSION（版本号）
• scripts/（代码示例、依赖关系）

🐛 故障排查

"gh: command not found"

请安装 GitHub CLI：

brew install gh
gh auth login

"SKILL.md not found"

请创建一个最简化的 SKILL.md：

---
name: your-skill
description: Brief description of what it does
---

# your-skill

More details about your skill here.

"VERSION file not found"

请创建一个 VERSION 文件：

echo "1.0.0" > VERSION

📖 参考资料

• GitHub 文档最佳实践：https://docs.github.com/en/contributing/writing-for-github-docs/best-practices-for-github-docs
• README 模板路径：~/clawd/templates/README-template.md
• 一行式描述公式：参见上方 “One-Liner Generation Patterns” 小节

License

MIT