plugin-forge

原文🇺🇸 英文
已翻译
包含 2 个脚本检查通过 / 未检测到疑似敏感代码

创建并管理具有合理结构、清单文件和市场集成的Claude Code插件。适用于为插件市场创建插件、添加插件组件(命令、Agent、钩子)、更新插件版本,或者处理plugin.json/marketplace.json清单文件的场景。

3.4k次下载
添加于

NPX安装

npx skill4agent add softaworks/agent-toolkit plugin-forge

标签

翻译版元数据已加入标签,便于Agent理解和查找

SKILL.md 内容(中文)

查看翻译对照 →

CC 插件锻造工具

用途

构建并管理具有正确结构、清单文件和市场集成的Claude Code插件。包含工作流、自动化脚本和参考文档。

适用场景

  • 为插件市场创建新插件
  • 添加/修改插件组件(命令、Skill、Agent、钩子)
  • 更新插件版本
  • 处理插件或市场清单文件
  • 设置本地插件测试环境
  • 发布插件

快速开始

创建新插件

使用
create_plugin.py
生成插件结构:
bash
python scripts/create_plugin.py plugin-name \
  --marketplace-root /path/to/marketplace \
  --author-name "Your Name" \
  --author-email "your.email@example.com" \
  --description "Plugin description" \
  --keywords "keyword1,keyword2" \
  --category "productivity"
该脚本会自动完成以下操作:
  • 创建插件目录结构
  • 生成
    plugin.json
    清单文件
  • 创建README模板
  • 更新
    marketplace.json

版本更新

使用
bump_version.py
更新两个清单文件中的版本:
bash
python scripts/bump_version.py plugin-name major|minor|patch \
  --marketplace-root /path/to/marketplace
语义化版本规则:
  • major:破坏性变更(1.0.0 → 2.0.0)
  • minor:新增功能、重构(1.0.0 → 1.1.0)
  • patch:Bug修复、文档更新(1.0.0 → 1.0.1)

开发工作流

1. 创建目录结构

手动创建方式(不使用脚本时):
bash
mkdir -p plugins/plugin-name/.claude-plugin
mkdir -p plugins/plugin-name/commands
mkdir -p plugins/plugin-name/skills

2. 插件清单文件

文件路径:
plugins/plugin-name/.claude-plugin/plugin.json
json
{
  "name": "plugin-name",
  "version": "0.1.0",
  "description": "Plugin description",
  "author": {
    "name": "Your Name",
    "email": "your.email@example.com"
  },
  "keywords": ["keyword1", "keyword2"]
}

3. 在市场中注册

更新
.claude-plugin/marketplace.json
json
{
  "name": "plugin-name",
  "source": "./plugins/plugin-name",
  "description": "Plugin description",
  "version": "0.1.0",
  "keywords": ["keyword1", "keyword2"],
  "category": "productivity"
}

4. 添加组件

在对应目录中创建组件:
组件位置格式
命令
commands/
带前置元数据的Markdown文件
Skill
skills/<name>/
包含
SKILL.md
的目录
Agent
agents/
Markdown定义文件
钩子
hooks/hooks.json
事件处理器
MCP服务器
.mcp.json
外部集成配置

5. 本地测试

bash
# 添加插件市场
/plugin marketplace add /path/to/marketplace-root

# 安装插件
/plugin install plugin-name@marketplace-name

# 修改后:重新安装
/plugin uninstall plugin-name@marketplace-name
/plugin install plugin-name@marketplace-name

插件模式

框架插件

针对特定框架(React、Vue等)的插件结构:
plugins/framework-name/
├── .claude-plugin/plugin.json
├── skills/
│   └── framework-name/
│       ├── SKILL.md
│       └── references/
├── commands/
│   └── prime/
│       ├── components.md
│       └── framework.md
└── README.md

实用工具插件

针对工具和命令的插件结构:
plugins/utility-name/
├── .claude-plugin/plugin.json
├── commands/
│   ├── action1.md
│   └── action2.md
└── README.md

领域专属插件

针对特定领域知识的插件结构:
plugins/domain-name/
├── .claude-plugin/plugin.json
├── skills/
│   └── domain-name/
│       ├── SKILL.md
│       ├── references/
│       └── scripts/
└── README.md

命令命名规则

基于子目录的命名空间,使用
:
作为分隔符:
  • commands/namespace/command.md
    /namespace:command
  • commands/simple.md
    /simple
示例:
  • commands/prime/vue.md
    /prime:vue
  • commands/docs/generate.md
    /docs:generate

版本管理

重要提示: 需要在两个位置同时更新版本:
  1. plugins/<name>/.claude-plugin/plugin.json
  2. .claude-plugin/marketplace.json
使用
bump_version.py
脚本可自动完成该操作。

Git提交规范

使用约定式提交格式:
bash
git commit -m "feat: add new plugin"
git commit -m "fix: correct plugin manifest"
git commit -m "docs: update plugin README"
git commit -m "feat!: breaking change"

参考文档

包含以下详细文档:
参考文档内容
references/plugin-structure.md
目录结构、清单文件 Schema、组件说明
references/marketplace-schema.md
市场格式、插件条目、分发说明
references/workflows.md
分步工作流、插件模式、发布指南

脚本说明

脚本用途
scripts/create_plugin.py
快速搭建新插件脚手架
scripts/bump_version.py
更新插件版本
undefined