/plugin-authoring
The authoring procedures for this marketplace: how to create a skill, how to
create a plugin, what to update when either changes, and how to delete one
without leaving dangling metadata.
Promoted out of CLAUDE.md (issue #2140) because all four are procedures with
a clear trigger — they do not need to be resident when the user is debugging a
hook. CLAUDE.md keeps only the repo blurb, the rules index, and the gotchas.
Detailed patterns live in the rules this skill names; it is the sequence, not a
second copy of them.
Creating New Skills
See .claude/rules/skill-development.md for detailed patterns.
Note (Claude Code 2.1.157): plugins placed in .claude/skills are now auto-loaded without a marketplace entry — handy for local or quick one-off plugins. This repo's published plugins still use the full marketplace + release-please lifecycle described in Plugin Lifecycle below.
Quick Start
- Create skill directory:
mkdir -p <plugin>/skills/<skill-name>
- Create
skill.md with YAML frontmatter:---
name: <Skill Name>
description: <1-2 sentence description>
allowed-tools: Bash, Read, Grep, Glob, TodoWrite
created: YYYY-MM-DD
modified: YYYY-MM-DD
reviewed: YYYY-MM-DD
---
- Follow content structure: Core Expertise → Commands → Patterns → Quick Reference
- Include agentic optimizations table
- Update all metadata files (see Plugin Lifecycle section)
Skill Granularity Decision
| Choose... |
When... |
| Single skill |
Operations are related and share context |
| Multiple skills |
Distinct workflows, different user intents |
Example: bun-package-manager (deps) vs bun-development (run/test/build)
Creating User-Invocable Skills
Skills are invocable via /plugin:skill-name syntax. See .claude/rules/skill-naming.md for naming conventions.
- Create skill directory:
mkdir -p <plugin>/skills/<skill-name>
- Create
SKILL.md with YAML frontmatter:---
name: <skill-name>
description: What it does. Use when...
args: <arg-spec>
allowed-tools: Bash, Read
argument-hint: human hint
created: YYYY-MM-DD
modified: YYYY-MM-DD
reviewed: YYYY-MM-DD
---
- Include: Context → Execution → Post-actions
Plugin Lifecycle
Files to Update
When creating, modifying, or deleting a plugin, update these files:
| File |
Location |
Action |
plugin.json |
<plugin>/.claude-plugin/plugin.json |
Create/update plugin manifest |
README.md |
<plugin>/README.md |
Create/update plugin documentation |
marketplace.json |
.claude-plugin/marketplace.json |
Add/update/remove plugin entry |
release-please-config.json |
Root |
Add/remove plugin package config |
.release-please-manifest.json |
Root |
Add/remove plugin version entry |
PLUGIN-MAP.md |
docs/PLUGIN-MAP.md |
Add/remove plugin from navigation map |
settings.json |
.claude/settings.json |
Add/remove the plugin in enabledPlugins (<plugin>@laurigates-claude-plugins) — enforced by the Plugin: Enablement drift check |
Creating a New Plugin
Quick scaffold (Claude Code 2.1.157): claude plugin init <name> scaffolds a new plugin in .claude/skills (auto-loaded, no marketplace entry needed). Use it for local/quick plugins; for plugins published from this repo, follow the full marketplace + release-please steps below.
- Create plugin directory structure (see Project Structure in
CLAUDE.md)
- Create
.claude-plugin/plugin.json with required fields
- Create
README.md with plugin documentation
- Add entry to
.claude-plugin/marketplace.json (under the plugins array):{
"name": "new-plugin",
"source": "./new-plugin",
"description": "Plugin description",
"version": "1.0.0",
"keywords": ["keyword1", "keyword2"],
"category": "category-name"
}
Note: marketplace.json has structure { "name": "...", "plugins": [...] } — add to the plugins array.
- Add to
release-please-config.json:"new-plugin": {
"component": "new-plugin",
"release-type": "simple",
"extra-files": [
{"type": "json", "path": ".claude-plugin/plugin.json", "jsonpath": "$.version"}
],
"changelog-sections": [
{"type": "feat", "section": "Features"},
{"type": "fix", "section": "Bug Fixes"},
{"type": "perf", "section": "Performance"},
{"type": "refactor", "section": "Code Refactoring"},
{"type": "docs", "section": "Documentation"}
]
}
- Add to
.release-please-manifest.json:"new-plugin": "1.0.0"
- Enable it in
.claude/settings.json so the repo dogfoods it:"enabledPlugins": { "new-plugin@laurigates-claude-plugins": true }
The Plugin: Enablement drift check (scripts/check-enabled-plugins-drift.sh) fails CI if a marketplace plugin is left disabled.
Deleting a Plugin
- Remove plugin directory
- Remove entry from
.claude-plugin/marketplace.json
- Remove package from
release-please-config.json
- Remove version from
.release-please-manifest.json
- Remove the
<plugin>@laurigates-claude-plugins key from .claude/settings.json enabledPlugins
Development Workflow
- Research documentation - Use context7, web search
- Plan skill structure - Decide granularity, scope
- Write skills - Follow standard structure
- Update all metadata files - See Plugin Lifecycle section
- Commit early - Use conventional commit format (see
.claude/rules/conventional-commits.md)
- Test - Verify skills load and work
- Create PR - Use conventional commit format for title (drives automation)
Verify
After a plugin add or delete, the two guards that catch dangling metadata:
bash scripts/check-docs-index.sh
bash scripts/plugin-compliance-check.sh
check-docs-index.sh cross-checks the plugin set and per-plugin skill/agent
counts against disk across README.md, docs/PLUGIN-MAP.md, and the d2
diagram — use /docs-refresh to repair count drift it reports. It also gates
two name-level invariants at ERROR severity (--strict therefore fails CI):
the committed docs/diagrams/plugin-relationships.svg must render the same
per-plugin labels its .d2 source states (re-render with
d2 docs/diagrams/plugin-relationships.d2 docs/diagrams/plugin-relationships.svg
— never hand-edit the .svg), and every leading-cell /<ns>:<name> row in a
plugin README must resolve to a skill directory (#2453).
Related
.claude/rules/skill-development.md — skill creation patterns
.claude/rules/skill-naming.md — namespace conventions for user-invocable skills
.claude/rules/skill-quality.md — size limits, required sections, quality checklist
.claude/rules/plugin-structure.md — plugin.json schema and directory layout
.claude/rules/release-please.md — version management and changelog automation
.claude/rules/conventional-commits.md — the commit/PR-title format that drives release-please
.claude/rules/skill-consolidation.md — merging or deleting skills (distinct from the plugin-level checklist here)
/docs-refresh — repairs catalog count drift after a skill or plugin lands
1---2name: plugin-authoring3description: Add, modify, or delete a skill or plugin in this repo — frontmatter shape, the seven metadata files a plugin touches, and the create/delete checklists. Use when creating a new skill or plugin, removing one, or asking which files a plugin change must update.4---5
6# /plugin-authoring
7
8The authoring procedures for this marketplace: how to create a skill, how to
9create a plugin, what to update when either changes, and how to delete one
10without leaving dangling metadata.
11
12Promoted out of `CLAUDE.md` (issue #2140) because all four are **procedures with
13a clear trigger** — they do not need to be resident when the user is debugging a
14hook. `CLAUDE.md` keeps only the repo blurb, the rules index, and the gotchas.
15
16Detailed patterns live in the rules this skill names; it is the sequence, not a
17second copy of them.
18
19## Creating New Skills
20
21See `.claude/rules/skill-development.md` for detailed patterns.
22
23> **Note (Claude Code 2.1.157):** plugins placed in `.claude/skills` are now auto-loaded without a marketplace entry — handy for local or quick one-off plugins. This repo's *published* plugins still use the full marketplace + release-please lifecycle described in Plugin Lifecycle below.
24
25### Quick Start
26
271. Create skill directory: `mkdir -p <plugin>/skills/<skill-name>`
282. Create `skill.md` with YAML frontmatter:
29 ```yaml
30 ---
31 name: <Skill Name>
32 description: <1-2 sentence description>
33 allowed-tools: Bash, Read, Grep, Glob, TodoWrite
34 created: YYYY-MM-DD
35 modified: YYYY-MM-DD
36 reviewed: YYYY-MM-DD
37 ---
38 ```
393. Follow content structure: Core Expertise → Commands → Patterns → Quick Reference
404. Include agentic optimizations table
415. Update all metadata files (see Plugin Lifecycle section)
42
43### Skill Granularity Decision
44
45| Choose... | When... |
46|-----------|---------|
47| Single skill | Operations are related and share context |
48| Multiple skills | Distinct workflows, different user intents |
49
50Example: `bun-package-manager` (deps) vs `bun-development` (run/test/build)
51
52## Creating User-Invocable Skills
53
54Skills are invocable via `/plugin:skill-name` syntax. See `.claude/rules/skill-naming.md` for naming conventions.
55
561. Create skill directory: `mkdir -p <plugin>/skills/<skill-name>`
572. Create `SKILL.md` with YAML frontmatter:
58 ```yaml
59 ---
60 name: <skill-name>
61 description: What it does. Use when...
62 args: <arg-spec>
63 allowed-tools: Bash, Read
64 argument-hint: human hint
65 created: YYYY-MM-DD
66 modified: YYYY-MM-DD
67 reviewed: YYYY-MM-DD
68 ---
69 ```
703. Include: Context → Execution → Post-actions
71
72## Plugin Lifecycle
73
74### Files to Update
75
76When creating, modifying, or deleting a plugin, update these files:
77
78| File | Location | Action |
79|------|----------|--------|
80| `plugin.json` | `<plugin>/.claude-plugin/plugin.json` | Create/update plugin manifest |
81| `README.md` | `<plugin>/README.md` | Create/update plugin documentation |
82| `marketplace.json` | `.claude-plugin/marketplace.json` | Add/update/remove plugin entry |
83| `release-please-config.json` | Root | Add/remove plugin package config |
84| `.release-please-manifest.json` | Root | Add/remove plugin version entry |
85| `PLUGIN-MAP.md` | `docs/PLUGIN-MAP.md` | Add/remove plugin from navigation map |
86| `settings.json` | `.claude/settings.json` | Add/remove the plugin in `enabledPlugins` (`<plugin>@laurigates-claude-plugins`) — enforced by the `Plugin: Enablement drift` check |
87
88### Creating a New Plugin
89
90> **Quick scaffold (Claude Code 2.1.157):** `claude plugin init <name>` scaffolds a new plugin in `.claude/skills` (auto-loaded, no marketplace entry needed). Use it for local/quick plugins; for plugins published from this repo, follow the full marketplace + release-please steps below.
91
921. Create plugin directory structure (see Project Structure in `CLAUDE.md`)
932. Create `.claude-plugin/plugin.json` with required fields
943. Create `README.md` with plugin documentation
954. Add entry to `.claude-plugin/marketplace.json` (under the `plugins` array):
96 ```json
97 {
98 "name": "new-plugin",
99 "source": "./new-plugin",
100 "description": "Plugin description",
101 "version": "1.0.0",
102 "keywords": ["keyword1", "keyword2"],
103 "category": "category-name"
104 }
105 ```
106 Note: marketplace.json has structure `{ "name": "...", "plugins": [...] }` — add to the `plugins` array.
1075. Add to `release-please-config.json`:
108 ```json
109 "new-plugin": {
110 "component": "new-plugin",
111 "release-type": "simple",
112 "extra-files": [
113 {"type": "json", "path": ".claude-plugin/plugin.json", "jsonpath": "$.version"}
114 ],
115 "changelog-sections": [
116 {"type": "feat", "section": "Features"},
117 {"type": "fix", "section": "Bug Fixes"},
118 {"type": "perf", "section": "Performance"},
119 {"type": "refactor", "section": "Code Refactoring"},
120 {"type": "docs", "section": "Documentation"}
121 ]
122 }
123 ```
1246. Add to `.release-please-manifest.json`:
125 ```json
126 "new-plugin": "1.0.0"
127 ```
1287. Enable it in `.claude/settings.json` so the repo dogfoods it:
129 ```json
130 "enabledPlugins": { "new-plugin@laurigates-claude-plugins": true }
131 ```
132 The `Plugin: Enablement drift` check (`scripts/check-enabled-plugins-drift.sh`) fails CI if a marketplace plugin is left disabled.
133
134### Deleting a Plugin
135
1361. Remove plugin directory
1372. Remove entry from `.claude-plugin/marketplace.json`
1383. Remove package from `release-please-config.json`
1394. Remove version from `.release-please-manifest.json`
1405. Remove the `<plugin>@laurigates-claude-plugins` key from `.claude/settings.json` `enabledPlugins`
141
142## Development Workflow
143
1441. **Research documentation** - Use context7, web search
1452. **Plan skill structure** - Decide granularity, scope
1463. **Write skills** - Follow standard structure
1474. **Update all metadata files** - See Plugin Lifecycle section
1485. **Commit early** - Use conventional commit format (see `.claude/rules/conventional-commits.md`)
1496. **Test** - Verify skills load and work
1507. **Create PR** - Use conventional commit format for title (drives automation)
151
152## Verify
153
154After a plugin add or delete, the two guards that catch dangling metadata:
155
156```
157bash scripts/check-docs-index.sh
158bash scripts/plugin-compliance-check.sh
159```
160
161`check-docs-index.sh` cross-checks the plugin set and per-plugin skill/agent
162counts against disk across `README.md`, `docs/PLUGIN-MAP.md`, and the d2
163diagram — use `/docs-refresh` to repair count drift it reports. It also gates
164two name-level invariants at ERROR severity (`--strict` therefore fails CI):
165the **committed** `docs/diagrams/plugin-relationships.svg` must render the same
166per-plugin labels its `.d2` source states (re-render with
167`d2 docs/diagrams/plugin-relationships.d2 docs/diagrams/plugin-relationships.svg`
168— never hand-edit the `.svg`), and every leading-cell `/<ns>:<name>` row in a
169plugin README must resolve to a skill directory (#2453).
170
171## Related
172
173- `.claude/rules/skill-development.md` — skill creation patterns
174- `.claude/rules/skill-naming.md` — namespace conventions for user-invocable skills
175- `.claude/rules/skill-quality.md` — size limits, required sections, quality checklist
176- `.claude/rules/plugin-structure.md` — plugin.json schema and directory layout
177- `.claude/rules/release-please.md` — version management and changelog automation
178- `.claude/rules/conventional-commits.md` — the commit/PR-title format that drives release-please
179- `.claude/rules/skill-consolidation.md` — merging or deleting skills (distinct from the plugin-level checklist here)
180- `/docs-refresh` — repairs catalog count drift after a skill or plugin lands