@skilly-hand/skilly-hand 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/LICENSE +23 -0
- package/README.md +107 -0
- package/catalog/README.md +30 -0
- package/catalog/catalog-index.json +6 -0
- package/catalog/skills/agents-root-orchestrator/SKILL.md +135 -0
- package/catalog/skills/agents-root-orchestrator/assets/AGENTS-ROOT-TEMPLATE.md +67 -0
- package/catalog/skills/agents-root-orchestrator/manifest.json +34 -0
- package/catalog/skills/skill-creator/SKILL.md +176 -0
- package/catalog/skills/skill-creator/assets/SKILL-TEMPLATE.md +94 -0
- package/catalog/skills/skill-creator/manifest.json +36 -0
- package/catalog/skills/spec-driven-development/SKILL.md +168 -0
- package/catalog/skills/spec-driven-development/agents/apply.md +26 -0
- package/catalog/skills/spec-driven-development/agents/orchestrate.md +25 -0
- package/catalog/skills/spec-driven-development/agents/plan.md +27 -0
- package/catalog/skills/spec-driven-development/agents/verify.md +24 -0
- package/catalog/skills/spec-driven-development/assets/delta-spec-template.md +51 -0
- package/catalog/skills/spec-driven-development/assets/design-template.md +31 -0
- package/catalog/skills/spec-driven-development/assets/spec-template.md +56 -0
- package/catalog/skills/spec-driven-development/assets/validation-checklist.md +32 -0
- package/catalog/skills/spec-driven-development/manifest.json +41 -0
- package/catalog/skills/token-optimizer/SKILL.md +141 -0
- package/catalog/skills/token-optimizer/manifest.json +33 -0
- package/catalog/skills/token-optimizer/references/complexity-indicators.md +138 -0
- package/catalog/templates/AGENTS.template.md +37 -0
- package/package.json +41 -0
- package/packages/catalog/package.json +6 -0
- package/packages/catalog/src/index.js +223 -0
- package/packages/cli/package.json +9 -0
- package/packages/cli/src/bin.js +144 -0
- package/packages/core/package.json +6 -0
- package/packages/core/src/index.js +304 -0
- package/packages/detectors/package.json +6 -0
- package/packages/detectors/src/index.js +169 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project are documented in this file.
|
|
4
|
+
|
|
5
|
+
## [Unreleased]
|
|
6
|
+
|
|
7
|
+
### Added
|
|
8
|
+
- Added automated changelog rotation via `scripts/release-changelog.mjs` to create dated release sections with npm version links.
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
- Updated release workflow documentation and publish validation to include `CHANGELOG.md`.
|
|
12
|
+
|
|
13
|
+
### Fixed
|
|
14
|
+
- _None._
|
|
15
|
+
|
|
16
|
+
### Removed
|
|
17
|
+
- _None._
|
package/LICENSE
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
Creative Commons Attribution-NonCommercial 4.0 International
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 skilly-hand contributors
|
|
4
|
+
|
|
5
|
+
This work is licensed under the Creative Commons Attribution-NonCommercial
|
|
6
|
+
4.0 International License (CC BY-NC 4.0).
|
|
7
|
+
|
|
8
|
+
You are free to:
|
|
9
|
+
- Share: copy and redistribute the material in any medium or format
|
|
10
|
+
- Adapt: remix, transform, and build upon the material
|
|
11
|
+
|
|
12
|
+
Under the following terms:
|
|
13
|
+
- Attribution: You must give appropriate credit, provide a link to the
|
|
14
|
+
license, and indicate if changes were made.
|
|
15
|
+
- NonCommercial: You may not use the material for commercial purposes.
|
|
16
|
+
- No additional restrictions: You may not apply legal terms or technological
|
|
17
|
+
measures that legally restrict others from doing anything the license permits.
|
|
18
|
+
|
|
19
|
+
License details:
|
|
20
|
+
https://creativecommons.org/licenses/by-nc/4.0/
|
|
21
|
+
|
|
22
|
+
Full legal code:
|
|
23
|
+
https://creativecommons.org/licenses/by-nc/4.0/legalcode
|
package/README.md
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
```text
|
|
4
|
+
██████╗██╗ ██╗██╗██╗ ██╗ ██╗ ██╗ ██╗ ██╗ █████╗ ███╗ ██╗██████╗
|
|
5
|
+
██╔════╝██║ ██╔╝██║██║ ██║ ╚██╗ ██╔╝ ██║ ██║██╔══██╗████╗ ██║██╔══██╗
|
|
6
|
+
╚█████╗ █████╔╝ ██║██║ ██║ ╚████╔╝ ███████║███████║██╔██╗ ██║██║ ██║
|
|
7
|
+
╚══██╗ ██╔═██╗ ██║██║ ██║ ╚██╔╝ ██╔══██║██╔══██║██║╚██╗██║██║ ██║
|
|
8
|
+
██████╔╝██║ ██╗██║███████╗███████╗ ██║ ██║ ██║██║ ██║██║ ╚████║██████╔╝
|
|
9
|
+
╚═════╝ ╚═╝ ╚═╝╚═╝╚══════╝╚══════╝ ╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═══╝╚═════╝
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
**Portable AI agent skills. One CLI. Every coding assistant.**
|
|
13
|
+
|
|
14
|
+
[](https://www.npmjs.com/package/@skilly-hand/skilly-hand)
|
|
15
|
+
[](./LICENSE)
|
|
16
|
+
[](https://nodejs.org)
|
|
17
|
+
[](https://nodejs.org/api/esm.html)
|
|
18
|
+
|
|
19
|
+
</div>
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## What it does
|
|
24
|
+
|
|
25
|
+
- **Installs portable AI agent skills** into your project from a curated catalog
|
|
26
|
+
- **Auto-detects your stack** and recommends relevant skills automatically
|
|
27
|
+
- **Supports every major coding assistant** — Claude Code, OpenCode, Cursor, Copilot, Gemini, and Codex — from a single command
|
|
28
|
+
- **Preserves original agentic structures** in `source/legacy/` as a migration reference
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## Quick Start
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npm install
|
|
36
|
+
npx skilly-hand
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Commands
|
|
42
|
+
|
|
43
|
+
| Command | Description |
|
|
44
|
+
| ------- | ----------- |
|
|
45
|
+
| `npx skilly-hand install` | Install skills into the current project |
|
|
46
|
+
| `npx skilly-hand detect` | Auto-detect project stack and suggest skills |
|
|
47
|
+
| `npx skilly-hand list` | List all available skills in the catalog |
|
|
48
|
+
| `npx skilly-hand doctor` | Diagnose installation and configuration issues |
|
|
49
|
+
| `npx skilly-hand uninstall` | Remove installed skills |
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Release Workflow (npm)
|
|
54
|
+
|
|
55
|
+
1. Confirm session: `npm whoami` (or `npm login`).
|
|
56
|
+
2. Keep `CHANGELOG.md` up to date under `## [Unreleased]` as work lands.
|
|
57
|
+
3. Regenerate derived catalog files when needed: `npm run build && npm run catalog:sync`.
|
|
58
|
+
4. Run publish gate: `npm run verify:publish`.
|
|
59
|
+
5. Inspect package payload: `npm pack --dry-run --json`.
|
|
60
|
+
6. Bump version intentionally: `npm version patch|minor|major` (this auto-rotates `CHANGELOG.md`, creates a dated release section, and inserts a version-specific npm link).
|
|
61
|
+
7. Publish the root package: `npm publish` (or `npm publish --tag next` for prereleases).
|
|
62
|
+
8. Smoke test after publish: `npx @skilly-hand/skilly-hand@<version> --help`.
|
|
63
|
+
9. Verify npm metadata (README render, changelog, license, executable bin).
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## Stack Detection
|
|
68
|
+
|
|
69
|
+
Automatic detection covers the most common Node.js stacks:
|
|
70
|
+
|
|
71
|
+
Node.js · TypeScript · React · Next.js · Angular · Vite · Playwright · Vitest · Tailwind CSS · Storybook
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Supported Assistants
|
|
76
|
+
|
|
77
|
+
Skills are installed into `.skilly-hand/` with the correct format for each tool:
|
|
78
|
+
|
|
79
|
+
| Tool | Install Target |
|
|
80
|
+
| ---- | -------------- |
|
|
81
|
+
| Claude Code / OpenCode | `.claude/skills/` |
|
|
82
|
+
| Cursor | `.cursor/skills/` |
|
|
83
|
+
| GitHub Copilot | `.github/copilot-instructions.md` |
|
|
84
|
+
| Gemini CLI | `.gemini/skills/` |
|
|
85
|
+
| Codex (OpenAI) | `.codex/skills/` |
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## Project Structure
|
|
90
|
+
|
|
91
|
+
```text
|
|
92
|
+
catalog/
|
|
93
|
+
skills/ # portable skill catalog published by the CLI
|
|
94
|
+
packages/
|
|
95
|
+
cli/ # main binary
|
|
96
|
+
core/ # installation, rendering, and restore logic
|
|
97
|
+
detectors/ # stack auto-detection
|
|
98
|
+
catalog/ # catalog access and validation
|
|
99
|
+
source/legacy/
|
|
100
|
+
agentic-structure/ # original material preserved as reference
|
|
101
|
+
tests/
|
|
102
|
+
fixtures/ # simulated repos for integration testing
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
Licensed under [CC BY-NC 4.0](./LICENSE).
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# Portable Skill Catalog
|
|
4
|
+
|
|
5
|
+
*Published portable skills consumed by the `skilly-hand` CLI.*
|
|
6
|
+
|
|
7
|
+
</div>
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Skills
|
|
12
|
+
|
|
13
|
+
| Skill | Description | Tags |
|
|
14
|
+
| ----- | ----------- | ---- |
|
|
15
|
+
| `agents-root-orchestrator` | Author root `AGENTS.md` as a Where/What/When orchestrator that routes tasks and skill invocation clearly. | `core` `workflow` `orchestration` |
|
|
16
|
+
| `skill-creator` | Create and standardize AI skills with reusable structure, metadata rules, and templates. | `core` `workflow` `authoring` |
|
|
17
|
+
| `spec-driven-development` | Plan, execute, and verify multi-step work through versioned specs with small, testable tasks. | `core` `workflow` `planning` |
|
|
18
|
+
| `token-optimizer` | Classify task complexity and right-size reasoning depth, context gathering, and response detail to reduce wasted tokens. | `core` `workflow` `efficiency` |
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Install a skill
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npx skilly-hand install <skill-name>
|
|
26
|
+
npx skilly-hand install agents-root-orchestrator
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
> [!NOTE]
|
|
30
|
+
> Legacy source under `source/legacy/agentic-structure` is preserved as reference material and is **excluded from installation**.
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# AGENTS Root Orchestrator Guide
|
|
2
|
+
|
|
3
|
+
## When to Use
|
|
4
|
+
|
|
5
|
+
Use this skill when:
|
|
6
|
+
|
|
7
|
+
- Creating a new root `AGENTS.md` for a repository.
|
|
8
|
+
- Refactoring root AI instructions that have grown inconsistent.
|
|
9
|
+
- Converting scattered guidance into a single routing guide.
|
|
10
|
+
- Defining explicit trigger-based skill invocation behavior.
|
|
11
|
+
|
|
12
|
+
Do not use this skill for:
|
|
13
|
+
|
|
14
|
+
- Subfolder-only guides that inherit from parent AGENTS files.
|
|
15
|
+
- One-off prompt notes with no reusable routing value.
|
|
16
|
+
- Agent-specific mirror files (`CLAUDE.md`, `GEMINI.md`) as primary source.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Core Structure: Where / What / When
|
|
21
|
+
|
|
22
|
+
### Where (Context and Boundaries)
|
|
23
|
+
|
|
24
|
+
Define where the guide applies and where to escalate:
|
|
25
|
+
|
|
26
|
+
- Repository scope and ownership boundaries.
|
|
27
|
+
- Folder map and key domains.
|
|
28
|
+
- Escalation path when a task exceeds local scope.
|
|
29
|
+
|
|
30
|
+
### What (Capabilities and Routing)
|
|
31
|
+
|
|
32
|
+
Define what AI should use:
|
|
33
|
+
|
|
34
|
+
- Installed skill registry with concise purpose.
|
|
35
|
+
- Role-oriented routing tables (task -> skill chain).
|
|
36
|
+
- Non-negotiable rules and default conventions.
|
|
37
|
+
|
|
38
|
+
### When (Triggers and Sequencing)
|
|
39
|
+
|
|
40
|
+
Define when skills must be invoked:
|
|
41
|
+
|
|
42
|
+
- Auto-invoke trigger table by action.
|
|
43
|
+
- Ordered workflow chains for recurring tasks.
|
|
44
|
+
- Prerequisite rules so downstream skills are never invoked first.
|
|
45
|
+
|
|
46
|
+
### Chaining Notations (Workflow Composition)
|
|
47
|
+
|
|
48
|
+
Define integrated multi-skill chains using explicit notation:
|
|
49
|
+
|
|
50
|
+
- Use `->` to document prerequisite order.
|
|
51
|
+
- Keep each chain named and scoped to one repeated workflow.
|
|
52
|
+
- Add a one-line "when to use" note after each chain.
|
|
53
|
+
- Treat earlier steps as mandatory unless explicitly marked optional.
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Decision Tree
|
|
58
|
+
|
|
59
|
+
```text
|
|
60
|
+
Is this the repository-wide instruction entry point?
|
|
61
|
+
YES -> Create/update root AGENTS.md with Where/What/When
|
|
62
|
+
NO -> Use subfolder AGENTS conventions and inherit parent rules
|
|
63
|
+
|
|
64
|
+
Does the task require routing across multiple skill types?
|
|
65
|
+
YES -> Add Task -> Skill chain table in What
|
|
66
|
+
NO -> Keep concise capability list and direct triggers
|
|
67
|
+
|
|
68
|
+
Are trigger conditions currently implicit or ambiguous?
|
|
69
|
+
YES -> Add explicit action-based trigger rows in When
|
|
70
|
+
NO -> Keep existing triggers but normalize wording
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Example Outline
|
|
76
|
+
|
|
77
|
+
### Example 1: Where Section
|
|
78
|
+
|
|
79
|
+
```markdown
|
|
80
|
+
## Where
|
|
81
|
+
|
|
82
|
+
- Scope: repository root and all descendant folders unless overridden.
|
|
83
|
+
- Primary map: app code in `src/`, automation in `scripts/`, tests in `tests/`.
|
|
84
|
+
- Escalate to maintainers when task changes CI, security, or release flows.
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Example 2: When Section
|
|
88
|
+
|
|
89
|
+
```markdown
|
|
90
|
+
## When
|
|
91
|
+
|
|
92
|
+
| Action | Skill |
|
|
93
|
+
| ------ | ----- |
|
|
94
|
+
| Planning multi-step feature work | `spec-driven-development` |
|
|
95
|
+
| Creating new reusable skill instructions | `skill-creator` |
|
|
96
|
+
| Updating root AGENTS orchestration map | `agents-root-orchestrator` |
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Example 3: Chaining Notations Section
|
|
100
|
+
|
|
101
|
+
````markdown
|
|
102
|
+
## Chaining Notations
|
|
103
|
+
|
|
104
|
+
Chaining notations document integrated workflows where multiple skills are sequentially invoked for complex tasks. Always invoke skills in documented order.
|
|
105
|
+
|
|
106
|
+
### Skill Creation Workflow
|
|
107
|
+
|
|
108
|
+
```text
|
|
109
|
+
Asking for a new skill
|
|
110
|
+
-> skill-creator
|
|
111
|
+
-> spec-driven-development
|
|
112
|
+
-> agents-root-orchestrator
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
When to use: creating and registering a new reusable skill workflow.
|
|
116
|
+
````
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Commands
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
mkdir -p .skilly-hand/catalog/agents-root-orchestrator/assets
|
|
124
|
+
cp .skilly-hand/catalog/agents-root-orchestrator/assets/AGENTS-ROOT-TEMPLATE.md AGENTS.md
|
|
125
|
+
npx skilly-hand install --dry-run
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## Resources
|
|
131
|
+
|
|
132
|
+
- Template: [assets/AGENTS-ROOT-TEMPLATE.md](assets/AGENTS-ROOT-TEMPLATE.md)
|
|
133
|
+
- Companion skills:
|
|
134
|
+
- [../skill-creator/SKILL.md](../skill-creator/SKILL.md)
|
|
135
|
+
- [../spec-driven-development/SKILL.md](../spec-driven-development/SKILL.md)
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# {{projectName}} AI Agent Orchestrator
|
|
2
|
+
|
|
3
|
+
> Root guidance for repository-wide AI routing. This file defines where work belongs, what capabilities to invoke, and when triggers apply.
|
|
4
|
+
|
|
5
|
+
## Where
|
|
6
|
+
|
|
7
|
+
- **Scope**: Repository root and all descendants unless a deeper `AGENTS.md` overrides locally.
|
|
8
|
+
- **Folder Map**:
|
|
9
|
+
- `src/` -> application and feature implementation.
|
|
10
|
+
- `tests/` -> automated verification and integration coverage.
|
|
11
|
+
- `scripts/` -> operational automation and maintenance flows.
|
|
12
|
+
- **Escalation**: For cross-cutting architecture, CI/CD, or policy changes, route to maintainers before implementation.
|
|
13
|
+
|
|
14
|
+
## What
|
|
15
|
+
|
|
16
|
+
### Installed Skill Registry
|
|
17
|
+
|
|
18
|
+
| Skill | Purpose | Tags |
|
|
19
|
+
| ----- | ------- | ---- |
|
|
20
|
+
{{skillsTable}}
|
|
21
|
+
|
|
22
|
+
### Task Routing
|
|
23
|
+
|
|
24
|
+
| Task Type | Recommended Skill Chain |
|
|
25
|
+
| --------- | ----------------------- |
|
|
26
|
+
| Multi-step planning | `spec-driven-development` |
|
|
27
|
+
| Creating/updating reusable skills | `skill-creator` |
|
|
28
|
+
| Root AGENTS orchestration updates | `agents-root-orchestrator` |
|
|
29
|
+
|
|
30
|
+
## When
|
|
31
|
+
|
|
32
|
+
### Auto-invoke Triggers
|
|
33
|
+
|
|
34
|
+
| Action | Skill |
|
|
35
|
+
| ------ | ----- |
|
|
36
|
+
{{autoInvokeTable}}
|
|
37
|
+
|
|
38
|
+
### Sequencing Rules
|
|
39
|
+
|
|
40
|
+
1. Classify task complexity first.
|
|
41
|
+
2. Invoke prerequisite skills before implementation skills.
|
|
42
|
+
3. Verify outcomes and update routing guidance when workflow changes.
|
|
43
|
+
|
|
44
|
+
## Chaining Notations
|
|
45
|
+
|
|
46
|
+
Chaining notations document integrated workflows where multiple skills are sequentially invoked for complex tasks. Always invoke skills in documented order.
|
|
47
|
+
|
|
48
|
+
### Root Orchestration Maintenance Workflow
|
|
49
|
+
|
|
50
|
+
```text
|
|
51
|
+
Updating root AGENTS orchestration guidance
|
|
52
|
+
-> agents-root-orchestrator
|
|
53
|
+
-> skill-creator (if workflow guidance changes)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
When to use: maintaining repository-level routing, trigger, and escalation guidance.
|
|
57
|
+
|
|
58
|
+
### Skill Introduction Workflow
|
|
59
|
+
|
|
60
|
+
```text
|
|
61
|
+
Asking for a new reusable skill
|
|
62
|
+
-> skill-creator
|
|
63
|
+
-> spec-driven-development
|
|
64
|
+
-> agents-root-orchestrator
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
When to use: introducing a new catalogued skill and registering it in root orchestration guidance.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "agents-root-orchestrator",
|
|
3
|
+
"title": "AGENTS Root Orchestrator",
|
|
4
|
+
"description": "Author root AGENTS.md as a Where/What/When orchestrator that routes tasks and skill invocation clearly.",
|
|
5
|
+
"portable": true,
|
|
6
|
+
"tags": ["core", "workflow", "orchestration"],
|
|
7
|
+
"detectors": ["always"],
|
|
8
|
+
"detectionTriggers": ["always"],
|
|
9
|
+
"installsFor": ["all"],
|
|
10
|
+
"agentSupport": ["codex", "claude", "cursor", "gemini", "copilot"],
|
|
11
|
+
"skillMetadata": {
|
|
12
|
+
"author": "skilly-hand",
|
|
13
|
+
"last-edit": "2026-04-03",
|
|
14
|
+
"license": "Apache-2.0",
|
|
15
|
+
"version": "1.0.0",
|
|
16
|
+
"changelog": "Added root AGENTS orchestration guidance around Where/What/When structure; improves AI task routing clarity and trigger recognition; affects root AGENTS authoring workflow",
|
|
17
|
+
"auto-invoke": "Creating or updating root AGENTS.md orchestration guidance",
|
|
18
|
+
"allowed-tools": [
|
|
19
|
+
"Read",
|
|
20
|
+
"Edit",
|
|
21
|
+
"Write",
|
|
22
|
+
"Glob",
|
|
23
|
+
"Grep",
|
|
24
|
+
"Bash",
|
|
25
|
+
"Task",
|
|
26
|
+
"SubAgent"
|
|
27
|
+
]
|
|
28
|
+
},
|
|
29
|
+
"files": [
|
|
30
|
+
{ "path": "SKILL.md", "kind": "instruction" },
|
|
31
|
+
{ "path": "assets/AGENTS-ROOT-TEMPLATE.md", "kind": "asset" }
|
|
32
|
+
],
|
|
33
|
+
"dependencies": []
|
|
34
|
+
}
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
# Skill Creator Guide
|
|
2
|
+
|
|
3
|
+
## When to Create a Skill
|
|
4
|
+
|
|
5
|
+
Create a skill when:
|
|
6
|
+
|
|
7
|
+
- A pattern is used repeatedly and AI needs guidance.
|
|
8
|
+
- Project-specific conventions differ from generic best practices.
|
|
9
|
+
- Complex workflows need step-by-step instructions.
|
|
10
|
+
- Decision trees help AI choose the right approach.
|
|
11
|
+
|
|
12
|
+
Do not create a skill when:
|
|
13
|
+
|
|
14
|
+
- Documentation already exists and a reference is enough.
|
|
15
|
+
- The pattern is trivial or self-explanatory.
|
|
16
|
+
- It is a one-off task.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Skill Structure
|
|
21
|
+
|
|
22
|
+
```text
|
|
23
|
+
skills/{skill-name}/
|
|
24
|
+
├── SKILL.md # Required - main skill file
|
|
25
|
+
├── assets/ # Optional - templates, schemas, examples
|
|
26
|
+
│ ├── template.py
|
|
27
|
+
│ └── schema.json
|
|
28
|
+
├── agents/ # Optional - sub-agents for complex skills
|
|
29
|
+
│ ├── agent1/
|
|
30
|
+
│ │ └── SKILL.md
|
|
31
|
+
│ └── agent2/
|
|
32
|
+
│ └── SKILL.md
|
|
33
|
+
└── references/ # Optional - links to local docs
|
|
34
|
+
└── docs.md
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Naming Conventions
|
|
40
|
+
|
|
41
|
+
| Type | Pattern | Examples |
|
|
42
|
+
|------|---------|----------|
|
|
43
|
+
| Generic skill | `{technology}` | `pytest`, `playwright`, `typescript` |
|
|
44
|
+
| `{product-name}`-specific | `{product-name}-{purpose}` | `{product-name}-best-practices`, `{product-name}-code-connect`, `{product-name}-a11y-checker` |
|
|
45
|
+
| `{product-name}` testing | `{product-name}-{function}-{target}` | `{product-name}-unit-test`, `{product-name}-token-audit` |
|
|
46
|
+
| Workflow skill | `{action}-{target}` | `skill-creator`, `commit-writer`, `pr-writer` |
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## Decision: assets/ vs references/ vs agents/
|
|
51
|
+
|
|
52
|
+
```text
|
|
53
|
+
Need code templates? -> assets/
|
|
54
|
+
Need JSON schemas? -> assets/
|
|
55
|
+
Need example configs? -> assets/
|
|
56
|
+
Link to existing docs? -> references/
|
|
57
|
+
Link to external guides? -> references/ (with local path)
|
|
58
|
+
Skill needs sub-agents? -> agents/
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Key Rule: `references/` should point to local files, not web URLs.
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## Decision: `{product-name}`-Specific vs Generic
|
|
66
|
+
|
|
67
|
+
```text
|
|
68
|
+
Patterns apply to any project? -> Generic skill (e.g., pytest, typescript)
|
|
69
|
+
Patterns are {product-name}-specific? -> {product-name}-{name} skill
|
|
70
|
+
Generic skill needs {product-name} info? -> Add references/ pointing to {product-name} docs
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Frontmatter Fields
|
|
76
|
+
|
|
77
|
+
| Field | Required | Format | Description |
|
|
78
|
+
|-------|----------|--------|-------------|
|
|
79
|
+
| `name` | Yes | `lowercase-hyphens` | Skill identifier |
|
|
80
|
+
| `description` | Yes | Block with trigger | What skill does plus explicit `Trigger: ...` clause for AI recognition |
|
|
81
|
+
| `metadata.author` | Yes | String | Always `skilly-hand` |
|
|
82
|
+
| `metadata.last-edit` | Yes | ISO 8601 date | Format: `YYYY-MM-DD` (e.g., `2026-03-21`) |
|
|
83
|
+
| `metadata.license` | Yes | String | Always `Apache-2.0` for `skilly-hand` |
|
|
84
|
+
| `metadata.version` | Yes | Semantic version | Format: `"X.Y.Z"` as string |
|
|
85
|
+
| `metadata.changelog` | Yes | Structured text | Format: `"<what changed>; <why it matters>; <where it affects>"` |
|
|
86
|
+
| `metadata.auto-invoke` | Yes | String | Explicit trigger condition (e.g., `"When auditing, reviewing, or validating an existing skill"`) |
|
|
87
|
+
| `allowed-tools` | Yes | Comma-separated | All tools this skill can invoke (e.g., `Read, Edit, Write, SubAgent`) |
|
|
88
|
+
| `allowed-modes` | Optional | YAML list | Use only when skill has an `agents/` folder |
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## Metadata Standards
|
|
93
|
+
|
|
94
|
+
### Changelog Format Structure
|
|
95
|
+
|
|
96
|
+
Use this structure:
|
|
97
|
+
|
|
98
|
+
```text
|
|
99
|
+
"<what changed>; <why it matters>; <where it affects>"
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Example:
|
|
103
|
+
|
|
104
|
+
```text
|
|
105
|
+
"Added integrated metadata validation guidance; improves consistency and reviewability; affects skill quality checks and maintenance workflows"
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Guidelines:
|
|
109
|
+
|
|
110
|
+
- What changed: Be specific about the modification.
|
|
111
|
+
- Why it matters: Explain business or technical value.
|
|
112
|
+
- Where it affects: Document impact area.
|
|
113
|
+
|
|
114
|
+
### last-edit Format
|
|
115
|
+
|
|
116
|
+
Always use ISO 8601 date format: `YYYY-MM-DD` (e.g., `2026-03-21`).
|
|
117
|
+
|
|
118
|
+
### allowed-modes Field Rule
|
|
119
|
+
|
|
120
|
+
Include `allowed-modes` only when your skill has an `agents/` subfolder with sub-agents.
|
|
121
|
+
|
|
122
|
+
Include it when:
|
|
123
|
+
|
|
124
|
+
- The skill orchestrates multiple specialized sub-agents.
|
|
125
|
+
- Each sub-agent has its own `SKILL.md` under `skills/{skill-name}/agents/{subagent-name}/`.
|
|
126
|
+
- Different modes delegate to different sub-agents.
|
|
127
|
+
|
|
128
|
+
Omit it when:
|
|
129
|
+
|
|
130
|
+
- The skill has no `agents/` folder.
|
|
131
|
+
- The skill behaves the same regardless of mode.
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## Content Guidelines
|
|
136
|
+
|
|
137
|
+
Do:
|
|
138
|
+
|
|
139
|
+
- Start with the most critical patterns.
|
|
140
|
+
- Use tables for decision trees.
|
|
141
|
+
- Keep code examples minimal and focused.
|
|
142
|
+
- Include a Commands section with copy-paste commands.
|
|
143
|
+
- Use ISO 8601 format for all dates (`YYYY-MM-DD`).
|
|
144
|
+
- Include explicit `Trigger:` clause in description for AI recognition.
|
|
145
|
+
- Add `allowed-modes` only if the skill has `agents/` with sub-agents.
|
|
146
|
+
|
|
147
|
+
Do not:
|
|
148
|
+
|
|
149
|
+
- Add a Keywords section (agent searches frontmatter, not body).
|
|
150
|
+
- Duplicate content from existing docs (reference instead).
|
|
151
|
+
- Include lengthy explanations when a concise rule is enough.
|
|
152
|
+
- Add troubleshooting sections when they are not essential.
|
|
153
|
+
- Use web URLs in references.
|
|
154
|
+
- Leave `changelog` empty or informal.
|
|
155
|
+
- Use non-ISO date formats.
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
## Checklist Before Creating
|
|
160
|
+
|
|
161
|
+
- [ ] Skill does not already exist.
|
|
162
|
+
- [ ] Pattern is reusable (not one-off).
|
|
163
|
+
- [ ] Name follows conventions.
|
|
164
|
+
- [ ] Frontmatter includes all required fields.
|
|
165
|
+
- [ ] `description` includes explicit `Trigger: ...` clause.
|
|
166
|
+
- [ ] `last-edit` uses ISO format (`YYYY-MM-DD`).
|
|
167
|
+
- [ ] `changelog` uses structured format: `what; why; where`.
|
|
168
|
+
- [ ] `allowed-modes` is present only when `agents/` exists.
|
|
169
|
+
- [ ] `allowed-tools` matches actual tool usage.
|
|
170
|
+
- [ ] Critical patterns are clear and concise.
|
|
171
|
+
- [ ] Code examples are minimal and focused.
|
|
172
|
+
- [ ] Commands section exists with copy-paste commands.
|
|
173
|
+
|
|
174
|
+
## Resources
|
|
175
|
+
|
|
176
|
+
- Template: [assets/SKILL-TEMPLATE.md](assets/SKILL-TEMPLATE.md)
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: {skill-name}
|
|
3
|
+
description: >
|
|
4
|
+
{Brief description of what this skill enables}.
|
|
5
|
+
Trigger: {When the AI should load this skill - explicit trigger condition}.
|
|
6
|
+
metadata:
|
|
7
|
+
author: skilly-hand
|
|
8
|
+
last-edit: {YYYY-MM-DD}
|
|
9
|
+
license: Apache-2.0
|
|
10
|
+
version: "1.0.0"
|
|
11
|
+
changelog: "{<what changed>; <why it matters>; <where it affects>}"
|
|
12
|
+
auto-invoke: "{Complete with a brief and specific phrase if the skill needs auto-invoke}"
|
|
13
|
+
allowed-tools: {tool1, tool2, tool3} # Examples: Read, Edit, Write, Bash, Grep, SubAgent, Task, WebFetch
|
|
14
|
+
# IMPORTANT: Only include 'allowed-modes' if your skill has an agents/ folder with sub-agents.
|
|
15
|
+
# If you don't have agents/, delete the lines below.
|
|
16
|
+
allowed-modes:
|
|
17
|
+
- {mode-name} # {Description of when this mode is used}
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# {Name of the Skill} Guide
|
|
21
|
+
|
|
22
|
+
## When to Use
|
|
23
|
+
|
|
24
|
+
Use this skill when:
|
|
25
|
+
|
|
26
|
+
- {Condition 1}.
|
|
27
|
+
- {Condition 2}.
|
|
28
|
+
- {Condition 3}.
|
|
29
|
+
|
|
30
|
+
Do not use this skill for:
|
|
31
|
+
|
|
32
|
+
- {Condition 1}.
|
|
33
|
+
- {Condition 2}.
|
|
34
|
+
- {Condition 3}.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Critical Patterns
|
|
39
|
+
|
|
40
|
+
{The most important rules the AI must follow}
|
|
41
|
+
|
|
42
|
+
### Pattern 1: {Name}
|
|
43
|
+
|
|
44
|
+
```{language}
|
|
45
|
+
{code example}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Pattern 2: {Name}
|
|
49
|
+
|
|
50
|
+
```{language}
|
|
51
|
+
{code example}
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Decision Tree
|
|
57
|
+
|
|
58
|
+
```text
|
|
59
|
+
{Question 1}? -> {Action A}
|
|
60
|
+
{Question 2}? -> {Action B}
|
|
61
|
+
Otherwise -> {Default action}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## Code Examples
|
|
67
|
+
|
|
68
|
+
### Example 1: {Description}
|
|
69
|
+
|
|
70
|
+
```{language}
|
|
71
|
+
{minimal, focused example}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Example 2: {Description}
|
|
75
|
+
|
|
76
|
+
```{language}
|
|
77
|
+
{minimal, focused example}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Commands
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
{command 1} # {description}
|
|
86
|
+
{command 2} # {description}
|
|
87
|
+
{command 3} # {description}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## Resources
|
|
93
|
+
|
|
94
|
+
- Template assets: Place reusable templates, schemas, and examples in `assets/`.
|