skill-scaffold

AI代理技能脚手架CLI。立即为 OpenClaw、Moltbot、Claude、Cursor、ChatGPT、Copilot 创建技能。 Vibe 编码准备就绪。兼容 MCP。

# Skill Scaffold

Create AI agent skills in seconds. Supports OpenClaw/Moltbot, MCP servers, and generic skill structures.

## Trigger Words

Use this skill when the user mentions:
- "create a skill"
- "scaffold a skill"
- "new skill template"
- "skill generator"
- "make a openclaw skill"
- "mcp server template"

## Quick Start

```bash
# Install globally
npm install -g skill-scaffold

# Create a OpenClaw skill
skill-scaffold my-awesome-skill

# Create an MCP server
skill-scaffold my-api --template mcp

# With all options
skill-scaffold weather-bot --template openclaw --cli --description "Weather alerts for agents"
```

## Commands

| Command | Description |
|---------|-------------|
| `skill-scaffold <name>` | Create skill with default (openclaw) template |
| `skill-scaffold <name> --template mcp` | Create MCP server scaffold |
| `skill-scaffold <name> --template generic` | Create minimal skill |
| `skill-scaffold <name> --cli` | Include CLI binary scaffold |
| `skill-scaffold --help` | Show help |

## Templates

### OpenClaw (default)
Full skill structure for OpenClaw/Moltbot agents:
- SKILL.md with YAML frontmatter, trigger words, commands table
- README.md with badges, installation, features
- scripts/ folder for helpers

### MCP
Model Context Protocol server scaffold:
- SKILL.md with MCP config examples
- Tools and resources documentation
- Ready for Claude Desktop/Cursor integration

### Generic
Minimal structure:
- Basic SKILL.md
- Simple README.md

## Options

| Option | Description | Default |
|--------|-------------|---------|
| `--template <type>` | Template: openclaw, mcp, generic | openclaw |
| `--author <name>` | Author name | NextFrontierBuilds |
| `--description <text>` | Skill description | Auto-generated |
| `--dir <path>` | Output directory | Current directory |
| `--cli` | Include CLI binary scaffold | false |
| `--no-scripts` | Skip scripts folder | false |

## Usage Examples

```bash
# Create in current directory
skill-scaffold my-skill

# Create in specific directory
skill-scaffold my-skill --dir ~/clawd/skills

# MCP server with custom author
skill-scaffold github-mcp --template mcp --author "YourName"

# Full CLI tool
skill-scaffold awesome-cli --cli --description "Does awesome things"
```

## Output Structure

```
my-skill/
├── SKILL.md       # Main documentation (OpenClaw reads this)
├── README.md      # GitHub/npm readme
├── scripts/       # Helper scripts (optional)
└── bin/           # CLI binary (if --cli flag used)
    └── my-skill.js
```

## After Creating

1. `cd my-skill`
2. Edit SKILL.md with your actual documentation
3. Add implementation (scripts or bin/)
4. Test locally
5. Publish: `clawdhub publish .` or `npm publish`

## Notes

- Skill names must be lowercase with hyphens only
- SEO keywords are auto-included in generated files
- Works with OpenClaw, Moltbot, and any agent that reads SKILL.md

---

## 中文说明

# Skill Scaffold

数秒内创建 AI 代理技能。支持 OpenClaw/Moltbot、MCP 服务器以及通用技能结构。

## 触发词

当用户提到以下内容时使用本技能：
- "create a skill"
- "scaffold a skill"
- "new skill template"
- "skill generator"
- "make a openclaw skill"
- "mcp server template"

## 快速开始

```bash
# Install globally
npm install -g skill-scaffold

# Create a OpenClaw skill
skill-scaffold my-awesome-skill

# Create an MCP server
skill-scaffold my-api --template mcp

# With all options
skill-scaffold weather-bot --template openclaw --cli --description "Weather alerts for agents"
```

## 命令

| 命令 | 说明 |
|---------|-------------|
| `skill-scaffold <name>` | 使用默认（openclaw）模板创建技能 |
| `skill-scaffold <name> --template mcp` | 创建 MCP 服务器脚手架 |
| `skill-scaffold <name> --template generic` | 创建最简技能 |
| `skill-scaffold <name> --cli` | 包含 CLI 可执行文件脚手架 |
| `skill-scaffold --help` | 显示帮助 |

## 模板

### OpenClaw（默认）
面向 OpenClaw/Moltbot 代理的完整技能结构：
- 含 YAML frontmatter、触发词、命令表的 SKILL.md
- 含徽章、安装说明、功能介绍的 README.md
- 用于放置辅助脚本的 scripts/ 文件夹

### MCP
Model Context Protocol 服务器脚手架：
- 含 MCP 配置示例的 SKILL.md
- 工具与资源文档
- 可直接用于 Claude Desktop/Cursor 集成

### Generic
最简结构：
- 基础 SKILL.md
- 简单 README.md

## 选项

| 选项 | 说明 | 默认值 |
|--------|-------------|---------|
| `--template <type>` | 模板：openclaw、mcp、generic | openclaw |
| `--author <name>` | 作者名 | NextFrontierBuilds |
| `--description <text>` | 技能描述 | 自动生成 |
| `--dir <path>` | 输出目录 | 当前目录 |
| `--cli` | 包含 CLI 可执行文件脚手架 | false |
| `--no-scripts` | 跳过 scripts 文件夹 | false |

## 使用示例

```bash
# Create in current directory
skill-scaffold my-skill

# Create in specific directory
skill-scaffold my-skill --dir ~/clawd/skills

# MCP server with custom author
skill-scaffold github-mcp --template mcp --author "YourName"

# Full CLI tool
skill-scaffold awesome-cli --cli --description "Does awesome things"
```

## 输出结构

```
my-skill/
├── SKILL.md       # Main documentation (OpenClaw reads this)
├── README.md      # GitHub/npm readme
├── scripts/       # Helper scripts (optional)
└── bin/           # CLI binary (if --cli flag used)
    └── my-skill.js
```

## 创建之后

1. `cd my-skill`
2. 用你实际的文档内容编辑 SKILL.md
3. 添加实现（scripts 或 bin/）
4. 在本地测试
5. 发布：`clawdhub publish .` 或 `npm publish`

## 备注

- 技能名称必须为小写，且只能使用连字符
- SEO 关键词会自动包含在生成的文件中
- 适用于 OpenClaw、Moltbot 以及任何读取 SKILL.md 的代理