claude-skills-cli 0.0.3 → 0.0.4
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/README.md +2 -2
- package/dist/commands/init.js +28 -19
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/package.js +2 -5
- package/dist/commands/package.js.map +1 -1
- package/dist/commands/stats.js +154 -0
- package/dist/commands/stats.js.map +1 -0
- package/dist/core/templates.js +63 -12
- package/dist/core/templates.js.map +1 -1
- package/dist/core/validator.js +16 -4
- package/dist/core/validator.js.map +1 -1
- package/dist/index.js +16 -3
- package/dist/index.js.map +1 -1
- package/docs/SKILL-DEVELOPMENT.md +28 -30
- package/docs/SKILL-EXAMPLES.md +27 -23
- package/docs/SKILLS-ARCHITECTURE.md +14 -14
- package/package.json +1 -1
- package/skills/skill-creator/SKILL.md +62 -301
- package/skills/skill-creator/references/anthropic-resources.md +458 -0
- package/skills/skill-creator/references/cli-feedback.md +431 -0
- package/skills/skill-creator/references/cli-reference.md +499 -0
- package/skills/skill-creator/references/skill-examples.md +77 -69
- package/skills/skill-creator/references/writing-guide.md +134 -119
|
@@ -1,345 +1,106 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: skill-creator
|
|
3
|
-
description:
|
|
3
|
+
description: Create Claude Skills using claude-skills-cli. Use when building new skills, running validation, or packaging skills for distribution with TypeScript/Node.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Skill Creator
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
## Overview
|
|
11
|
-
|
|
12
|
-
Skills are modular packages that extend Claude's capabilities with specialized knowledge, workflows, and tools. Think of them as onboarding guides for specific domains that transform Claude from a general-purpose agent into a specialist equipped with procedural knowledge.
|
|
13
|
-
|
|
14
|
-
## The 6-Step Creation Process
|
|
15
|
-
|
|
16
|
-
### Step 1: Understanding with Concrete Examples
|
|
17
|
-
|
|
18
|
-
**Goal**: Clearly understand how the skill will be used in practice.
|
|
19
|
-
|
|
20
|
-
**Questions to ask**:
|
|
21
|
-
|
|
22
|
-
- "What specific task needs this skill?"
|
|
23
|
-
- "Can you give 3-5 concrete examples of using this?"
|
|
24
|
-
- "What would trigger Claude to use this skill?"
|
|
25
|
-
- "What context are you repeatedly providing?"
|
|
26
|
-
|
|
27
|
-
**Example**:
|
|
28
|
-
|
|
29
|
-
```
|
|
30
|
-
User: "I need a database skill"
|
|
31
|
-
Claude: "What specific database operations would you use this for?"
|
|
32
|
-
User: "Querying contacts, managing relationships, writing migrations"
|
|
33
|
-
Claude: "Can you give me actual query examples you use frequently?"
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
**Output**: 3-5 concrete usage examples before proceeding.
|
|
37
|
-
|
|
38
|
-
---
|
|
39
|
-
|
|
40
|
-
### Step 2: Planning Reusable Contents
|
|
41
|
-
|
|
42
|
-
**Goal**: Determine what goes in the skill.
|
|
43
|
-
|
|
44
|
-
**For each example, identify**:
|
|
45
|
-
|
|
46
|
-
1. What code is rewritten repeatedly? → `scripts/`
|
|
47
|
-
2. What context is repeated? → `SKILL.md` or `references/`
|
|
48
|
-
3. What templates are reused? → `assets/`
|
|
49
|
-
|
|
50
|
-
**Decision Matrix**:
|
|
51
|
-
|
|
52
|
-
| Content | Location | Example |
|
|
53
|
-
| -------------- | ----------- | -------------------------------- |
|
|
54
|
-
| Core workflows | SKILL.md | "Use prepared statements" |
|
|
55
|
-
| Detailed docs | references/ | Complete schema with all columns |
|
|
56
|
-
| Repeated code | scripts/ | Validation logic, generators |
|
|
57
|
-
| Templates | assets/ | Boilerplate files, images |
|
|
58
|
-
|
|
59
|
-
**Output**: List of files to create with their purposes.
|
|
60
|
-
|
|
61
|
-
---
|
|
62
|
-
|
|
63
|
-
### Step 3: Initialize the Skill
|
|
64
|
-
|
|
65
|
-
**Use the init script**:
|
|
66
|
-
|
|
67
|
-
```bash
|
|
68
|
-
python .claude/scripts/init_skill.py \
|
|
69
|
-
--name skill-name \
|
|
70
|
-
--description "What it does and when to use it"
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
**This creates**:
|
|
74
|
-
|
|
75
|
-
```
|
|
76
|
-
.claude/skills/skill-name/
|
|
77
|
-
├── SKILL.md
|
|
78
|
-
├── README.md
|
|
79
|
-
├── references/detailed-guide.md
|
|
80
|
-
├── scripts/example.py
|
|
81
|
-
└── assets/
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
**Next**: Customize or delete example files as needed.
|
|
85
|
-
|
|
86
|
-
---
|
|
87
|
-
|
|
88
|
-
### Step 4: Edit the Skill
|
|
89
|
-
|
|
90
|
-
**Writing Guidelines**:
|
|
91
|
-
|
|
92
|
-
- ✅ Use imperative voice: "Use prepared statements"
|
|
93
|
-
- ❌ Not second person: "You should use prepared statements"
|
|
94
|
-
- ✅ Be specific: "Generate IDs with nanoid()"
|
|
95
|
-
- ❌ Not vague: "Use appropriate IDs"
|
|
96
|
-
|
|
97
|
-
**SKILL.md Structure**:
|
|
98
|
-
|
|
99
|
-
```markdown
|
|
100
|
-
---
|
|
101
|
-
name: skill-name
|
|
102
|
-
description: [What it does + when to use it, keywords for discovery]
|
|
103
|
-
---
|
|
104
|
-
|
|
105
|
-
# Skill Title
|
|
106
|
-
|
|
107
|
-
## Overview
|
|
108
|
-
|
|
109
|
-
[2-3 sentences on purpose]
|
|
8
|
+
Create effective Claude Skills using the `claude-skills-cli` tool (TypeScript/Node).
|
|
110
9
|
|
|
111
10
|
## Quick Start
|
|
112
11
|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
### Pattern 1
|
|
118
|
-
|
|
119
|
-
[Common workflow with code]
|
|
120
|
-
|
|
121
|
-
### Pattern 2
|
|
122
|
-
|
|
123
|
-
[Another common workflow]
|
|
124
|
-
|
|
125
|
-
## Advanced Usage
|
|
126
|
-
|
|
127
|
-
For detailed information:
|
|
128
|
-
|
|
129
|
-
- [references/file1.md](references/file1.md)
|
|
130
|
-
- [references/file2.md](references/file2.md)
|
|
131
|
-
|
|
132
|
-
## Scripts
|
|
133
|
-
|
|
134
|
-
- `scripts/validate.py`: Description
|
|
135
|
-
- `scripts/generate.py`: Description
|
|
12
|
+
```bash
|
|
13
|
+
# Create skill
|
|
14
|
+
npx claude-skills init --name my-skill \
|
|
15
|
+
--description "What it does. Use when [trigger keywords]"
|
|
136
16
|
|
|
137
|
-
|
|
17
|
+
# Validate
|
|
18
|
+
npx claude-skills validate .claude/skills/my-skill
|
|
138
19
|
|
|
139
|
-
|
|
140
|
-
-
|
|
20
|
+
# Package
|
|
21
|
+
npx claude-skills package .claude/skills/my-skill
|
|
141
22
|
```
|
|
142
23
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
1. What is the purpose? (2-3 sentences)
|
|
146
|
-
2. When should this be used? (triggers/contexts)
|
|
147
|
-
3. How should Claude use this? (step-by-step)
|
|
148
|
-
4. What resources are bundled? (references, scripts, assets)
|
|
149
|
-
|
|
150
|
-
**References Guidelines**:
|
|
151
|
-
|
|
152
|
-
- One topic per file
|
|
153
|
-
- Descriptive names: `authentication-flow.md` not `auth.md`
|
|
154
|
-
- Include examples and code
|
|
155
|
-
- Link from SKILL.md
|
|
156
|
-
|
|
157
|
-
**Scripts Guidelines**:
|
|
24
|
+
## Progressive Disclosure System
|
|
158
25
|
|
|
159
|
-
|
|
160
|
-
- Make executable (`chmod +x`)
|
|
161
|
-
- Add usage documentation
|
|
162
|
-
- Handle errors gracefully
|
|
26
|
+
Skills load in 3 levels:
|
|
163
27
|
|
|
164
|
-
|
|
28
|
+
| Level | When Loaded | Token Budget |
|
|
29
|
+
| --------------------------- | -------------- | ------------ |
|
|
30
|
+
| **Level 1** - Metadata | Always | ~100 tokens |
|
|
31
|
+
| **Level 2** - SKILL.md body | When triggered | <5k tokens |
|
|
32
|
+
| **Level 3** - Bundled files | As needed | Unlimited |
|
|
165
33
|
|
|
166
|
-
|
|
167
|
-
- Images used in output
|
|
168
|
-
- Boilerplate code
|
|
169
|
-
- Configuration files
|
|
170
|
-
|
|
171
|
-
---
|
|
34
|
+
**Key principle**: Keep Level 1 & 2 lean. Move details to Level 3.
|
|
172
35
|
|
|
173
|
-
|
|
36
|
+
## CLI Commands
|
|
174
37
|
|
|
175
|
-
|
|
38
|
+
### init - Create Skill
|
|
176
39
|
|
|
177
40
|
```bash
|
|
178
|
-
|
|
41
|
+
npx claude-skills init --name skill-name \
|
|
42
|
+
--description "Brief description with trigger keywords"
|
|
179
43
|
```
|
|
180
44
|
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
```bash
|
|
184
|
-
python .claude/scripts/package_skill.py .claude/skills/skill-name
|
|
185
|
-
```
|
|
45
|
+
Creates: `SKILL.md`, `README.md`, `references/`
|
|
186
46
|
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
**Validation checks**:
|
|
190
|
-
|
|
191
|
-
- YAML frontmatter format
|
|
192
|
-
- Required fields present
|
|
193
|
-
- Name matches directory
|
|
194
|
-
- References mentioned in SKILL.md
|
|
195
|
-
- Scripts are executable
|
|
196
|
-
- No TODO placeholders
|
|
197
|
-
|
|
198
|
-
---
|
|
199
|
-
|
|
200
|
-
### Step 6: Test and Iterate
|
|
201
|
-
|
|
202
|
-
**Testing**:
|
|
203
|
-
|
|
204
|
-
1. Use skill in real conversations
|
|
205
|
-
2. Notice struggles or inefficiencies
|
|
206
|
-
3. Update based on observations
|
|
207
|
-
|
|
208
|
-
**Iteration workflow**:
|
|
47
|
+
### validate - Check Quality
|
|
209
48
|
|
|
210
49
|
```bash
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
# Validate
|
|
215
|
-
python .claude/scripts/validate_skill.py .claude/skills/skill-name
|
|
216
|
-
|
|
217
|
-
# Test in conversation
|
|
218
|
-
# (Skills auto-reload in Claude Code)
|
|
219
|
-
|
|
220
|
-
# Package if sharing
|
|
221
|
-
python .claude/scripts/package_skill.py .claude/skills/skill-name
|
|
50
|
+
npx claude-skills validate .claude/skills/skill-name
|
|
51
|
+
npx claude-skills validate .claude/skills/skill-name --strict
|
|
222
52
|
```
|
|
223
53
|
|
|
224
|
-
|
|
54
|
+
Checks progressive disclosure compliance.
|
|
225
55
|
|
|
226
|
-
-
|
|
227
|
-
- Move details to references
|
|
228
|
-
- Create scripts for repeated patterns
|
|
229
|
-
- Clarify confusing instructions
|
|
230
|
-
- Enhance "when to use" guidance
|
|
56
|
+
### package - Create Zip
|
|
231
57
|
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
## Progressive Disclosure Principle
|
|
235
|
-
|
|
236
|
-
Skills load in three levels:
|
|
237
|
-
|
|
238
|
-
### Level 1: Metadata (~100 tokens)
|
|
239
|
-
|
|
240
|
-
**Always in context**
|
|
241
|
-
|
|
242
|
-
```yaml
|
|
243
|
-
name: skill-name
|
|
244
|
-
description: What it does and when to use it
|
|
58
|
+
```bash
|
|
59
|
+
npx claude-skills package .claude/skills/skill-name
|
|
245
60
|
```
|
|
246
61
|
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
**Loaded when triggered**
|
|
250
|
-
|
|
251
|
-
- SKILL.md body with core patterns
|
|
252
|
-
- Links to references and scripts
|
|
253
|
-
|
|
254
|
-
### Level 3: Resources (unlimited)
|
|
255
|
-
|
|
256
|
-
**Loaded as needed**
|
|
257
|
-
|
|
258
|
-
- references/: Documentation Claude reads
|
|
259
|
-
- scripts/: Code Claude executes
|
|
260
|
-
- assets/: Files Claude uses in output
|
|
261
|
-
|
|
262
|
-
## Best Practices
|
|
263
|
-
|
|
264
|
-
### Do:
|
|
62
|
+
Creates uploadable zip for Claude.ai or API.
|
|
265
63
|
|
|
266
|
-
|
|
267
|
-
✅ Use imperative voice
|
|
268
|
-
✅ Keep SKILL.md under 5k words
|
|
269
|
-
✅ Link to references for details
|
|
270
|
-
✅ Include "when to use" in description
|
|
271
|
-
✅ Test on real tasks
|
|
272
|
-
✅ Iterate based on usage
|
|
64
|
+
## Writing Tips
|
|
273
65
|
|
|
274
|
-
|
|
66
|
+
**Level 1 (Description)**:
|
|
275
67
|
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
❌ Use generic descriptions
|
|
280
|
-
❌ Leave TODO placeholders
|
|
281
|
-
❌ Skip validation
|
|
68
|
+
- Format: `[Tech] + [Operations] + [Trigger]`
|
|
69
|
+
- Target: <200 chars
|
|
70
|
+
- Include: "Use when...", "Use for...", "Use to..."
|
|
282
71
|
|
|
283
|
-
|
|
72
|
+
**Level 2 (SKILL.md Body)**:
|
|
284
73
|
|
|
285
|
-
|
|
74
|
+
- Target: ~50 lines
|
|
75
|
+
- Structure: Quick Start, Core Patterns (3-5), Links to references
|
|
76
|
+
- Voice: Imperative ("Use X"), not second person ("You should use X")
|
|
286
77
|
|
|
287
|
-
|
|
288
|
-
- Query patterns in SKILL.md
|
|
289
|
-
- Validation scripts for consistency
|
|
290
|
-
- Migration helpers
|
|
78
|
+
**Level 3 (References)**:
|
|
291
79
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
-
|
|
295
|
-
- Component catalog in references/
|
|
296
|
-
- Example components in assets/
|
|
297
|
-
- Type definitions included
|
|
298
|
-
|
|
299
|
-
### Integration Skills
|
|
300
|
-
|
|
301
|
-
- Auth patterns in SKILL.md
|
|
302
|
-
- API docs in references/
|
|
303
|
-
- Connection tests in scripts/
|
|
304
|
-
- Rate limit handling
|
|
305
|
-
|
|
306
|
-
### Styling Skills
|
|
307
|
-
|
|
308
|
-
- Core conventions in SKILL.md
|
|
309
|
-
- Complete reference in references/
|
|
310
|
-
- Theme examples in assets/
|
|
311
|
-
- Validation for consistency
|
|
312
|
-
|
|
313
|
-
## Quick Reference Commands
|
|
314
|
-
|
|
315
|
-
```bash
|
|
316
|
-
# Create new skill
|
|
317
|
-
python .claude/scripts/init_skill.py --name my-skill --description "..."
|
|
318
|
-
|
|
319
|
-
# Validate skill
|
|
320
|
-
python .claude/scripts/validate_skill.py .claude/skills/my-skill
|
|
321
|
-
|
|
322
|
-
# Package skill
|
|
323
|
-
python .claude/scripts/package_skill.py .claude/skills/my-skill
|
|
324
|
-
|
|
325
|
-
# Validate strictly (warnings = errors)
|
|
326
|
-
python .claude/scripts/validate_skill.py .claude/skills/my-skill --strict
|
|
327
|
-
```
|
|
80
|
+
- Move detailed docs to `references/`
|
|
81
|
+
- Link from SKILL.md
|
|
82
|
+
- Unlimited size
|
|
328
83
|
|
|
329
|
-
##
|
|
84
|
+
## Reference Documentation
|
|
330
85
|
|
|
331
|
-
|
|
86
|
+
For detailed guidance:
|
|
332
87
|
|
|
333
|
-
- [
|
|
334
|
-
- [
|
|
335
|
-
- [
|
|
336
|
-
- [
|
|
88
|
+
- [cli-reference.md](references/cli-reference.md) - Complete CLI commands and options
|
|
89
|
+
- [cli-feedback.md](references/cli-feedback.md) - Real-world usage patterns and tips
|
|
90
|
+
- [anthropic-resources.md](references/anthropic-resources.md) - Official Anthropic best practices
|
|
91
|
+
- [writing-guide.md](references/writing-guide.md) - Voice, structure, and code examples
|
|
92
|
+
- [skill-examples.md](references/skill-examples.md) - Example skills and patterns
|
|
337
93
|
|
|
338
94
|
## Notes
|
|
339
95
|
|
|
340
|
-
- Skills are
|
|
341
|
-
-
|
|
342
|
-
-
|
|
343
|
-
-
|
|
344
|
-
|
|
345
|
-
|
|
96
|
+
- Skills are iterative - start minimal, refine based on usage
|
|
97
|
+
- Description drives discovery - make it keyword-rich
|
|
98
|
+
- Validate frequently during development
|
|
99
|
+
- Test in real conversations
|
|
100
|
+
|
|
101
|
+
<!--
|
|
102
|
+
PROGRESSIVE DISCLOSURE:
|
|
103
|
+
- This is Level 2 - keep lean and scannable
|
|
104
|
+
- Move detailed content to references/
|
|
105
|
+
- Target: ~50 lines for optimal scannability
|
|
106
|
+
-->
|