发布工具

Clawdbot技能的专业文档与发布

一键生成优化采纳率的README并发布至GitHub和ClawdHub。

⚠️ 前提条件

• bash
• jq（用于JSON解析）
• ghCLI（GitHub操作）
• clawdhubCLI（发布）
• git

📋 功能说明

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

文档生成

1. 读取您的SKILL.md以理解技能功能
2. 使用已验证模式生成3个单行描述选项
3. 遵循GitHub最佳实践创建README：
   • 开篇阐明问题与解决方案
   • 采用倒金字塔结构
   • 使用表情符号标题增强可浏览性
   • 突出显示关键成果
   • 高亮文本低于15%
4. 更新SKILL.md文件的前置元数据，填入选定的描述

发布

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]

示例："让你的Claude访问令牌保持24/7新鲜"

模式B：问题消除

[Do thing] without [pain point]

示例："无需硬编码路径即可构建跨设备工具"

模式C：自动化

Automatically [action] [thing] [when]

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

📚 已生成README结构

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

核心部分（首屏显示）

• 标题 + 副标题
• 问题描述：（一句话）
• 本工具：（一句话）
• 📋 系统要求
• ⚡ 功能说明（先呈现效果，再说明特性）
• 🚀 安装指南
• 🔧 工作原理（先呈现结果，再说明过程）

可选部分（可折叠）

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

🔧 工作原理

第一阶段：分析

• 读取SKILL.md前置元数据（如存在）
• 提取关键信息：名称、描述、要求
• 解析脚本以识别依赖关系

阶段二：一句话简介生成

分析您的SKILL.md描述并生成3个选项：

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

向您展示全部3个选项，供您选择或自定义编写

阶段三：README生成

使用来自~/clawd/templates/README-template.md的模板：

• 填入标题、问题描述、解决方案
• 从SKILL.md提取需求
• 根据描述生成"功能说明"
• 创建安装步骤
• 构建包含示例的"工作原理"说明

阶段四：发布

1. 检查ghCLI（如果缺失则指导设置）
2. 读取VERSION文件获取版本号
3. 创建 GitHub 仓库（使用gh repo create）
4. 提交并推送所有文件
5. 发布到 ClawdHub，使用clawdhub publish

📁 预期的文件结构

your-skill/
├── SKILL.md           # Required: skill description
├── VERSION            # Required: version number (e.g., "1.0.0")
├── scripts/           # Optional: your scripts
│   └── main.sh
├── README.md          # Generated by this tool
└── .gitignore         # Optional

⚙️ 配置

无需配置。该工具会自动从以下文件中检测所有信息：

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

🐛 故障排除

"gh: 未找到命令"

安装 GitHub CLI：

brew install gh
gh auth login

"未找到 SKILL.md"

创建一个最小的 SKILL.md：

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

# your-skill

More details about your skill here.

"未找到 VERSION 文件"

创建一个 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