名称： publisher
描述： 让你的技能易于理解且不容忽视

publisher

Clawdbot 技能的专业文档与发布工具

一键生成优化版 README，并发布至 GitHub 和 ClawdHub。

⚠️ 前置要求

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

📋 功能概述

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

文档生成

1. 读取你的 SKILL.md 以理解技能功能
2. 使用已验证的模式生成 3 个一句话简介选项
3. 遵循 GitHub 最佳实践创建 README：
   • 开篇点明问题/解决方案
   • 采用倒金字塔结构
   • 使用表情符号标题增强可读性
   • 加粗突出成果
   • 高亮文本比例低于 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：持续收益

保持 [对象] [期望状态] [时间范围]

示例：“保持你的 Claude 访问令牌 24/7 新鲜有效”

模式 B：消除痛点

[执行操作] 而无需 [痛点]

示例：“构建跨设备工具而无需硬编码路径”

模式 C：自动化

自动 [动作] [对象] [时机]

示例：“在令牌过期前自动刷新”

📚 生成的 README 结构

遵循 GitHub 文档最佳实践框架：

核心部分（首屏可见）

• 标题 + 副标题
• 问题描述：（1 句话）
• 本工具：（1 句话）
• 📋 前置要求
• ⚡ 功能概述（先讲成果，再列特性）
• 🚀 安装
• 🔧 工作原理（先讲结果，再讲过程）

可选部分（可折叠）

• 配置选项
• 故障排除
• 开发者指南
• 实现细节

🔧 工作原理

阶段 1：分析

• 读取 SKILL.md 的 frontmatter（如果存在）
• 提取关键信息：名称、描述、要求
• 解析脚本以获取依赖项

阶段 2：一句话简介生成

分析你的 SKILL.md 描述并生成 3 个选项：
- 模式 A：持续收益格式
- 模式 B：痛点消除格式
- 模式 C：自动化格式
展示全部 3 个选项，供你选择或自定义。

阶段 3：README 生成

使用 ~/clawd/templates/README-template.md 模板：
- 填充标题、问题、解决方案
- 从 SKILL.md 提取要求
- 根据描述生成“功能概述”
- 创建安装步骤
- 构建包含示例的“工作原理”部分

阶段 4：发布

1. 检查 gh CLI（如缺失则引导安装）
2. 读取 VERSION 文件获取版本号
3. 创建 GitHub 仓库（使用 gh repo create）
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：

---
**名称：** your-skill
**描述：** 简要描述其功能
---

# your-skill

关于你技能的更多细节写在这里。

“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
• 一句话简介公式：参见上方的“一句话简介生成模式”部分

许可证

MIT