claude-skills-cli 0.0.8 → 0.0.9
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.
|
@@ -12,22 +12,10 @@ Create effective Claude Skills using progressive disclosure.
|
|
|
12
12
|
|
|
13
13
|
Create a skill when you notice:
|
|
14
14
|
|
|
15
|
-
- **Repeating context** across conversations
|
|
16
|
-
|
|
17
|
-
- **Domain expertise** needed repeatedly (API integration, framework
|
|
18
|
-
conventions)
|
|
15
|
+
- **Repeating context** across conversations
|
|
16
|
+
- **Domain expertise** needed repeatedly
|
|
19
17
|
- **Project-specific knowledge** Claude should know automatically
|
|
20
18
|
|
|
21
|
-
## Skill Structure
|
|
22
|
-
|
|
23
|
-
```
|
|
24
|
-
my-skill/
|
|
25
|
-
├── SKILL.md # Core instructions + metadata
|
|
26
|
-
├── references/ # Detailed docs (loaded as needed)
|
|
27
|
-
├── scripts/ # Executable operations
|
|
28
|
-
└── assets/ # Templates, images, files
|
|
29
|
-
```
|
|
30
|
-
|
|
31
19
|
## Progressive Disclosure
|
|
32
20
|
|
|
33
21
|
Skills load in 3 levels:
|
|
@@ -39,15 +27,20 @@ Skills load in 3 levels:
|
|
|
39
27
|
|
|
40
28
|
**Key**: Keep Levels 1 & 2 lean. Move details to Level 3.
|
|
41
29
|
|
|
42
|
-
##
|
|
30
|
+
## Structure
|
|
43
31
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
32
|
+
```
|
|
33
|
+
my-skill/
|
|
34
|
+
├── SKILL.md # Core instructions + metadata
|
|
35
|
+
├── references/ # Detailed docs (loaded as needed)
|
|
36
|
+
├── scripts/ # Executable operations
|
|
37
|
+
└── assets/ # Templates, images, files
|
|
38
|
+
```
|
|
48
39
|
|
|
49
|
-
##
|
|
40
|
+
## References
|
|
50
41
|
|
|
42
|
+
- [quick-start.md](references/quick-start.md) - Creating your first
|
|
43
|
+
skill
|
|
51
44
|
- [writing-guide.md](references/writing-guide.md) - Writing effective
|
|
52
45
|
skills
|
|
53
46
|
- [development-process.md](references/development-process.md) -
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# Quick Start Guide
|
|
2
|
+
|
|
3
|
+
## Creating Your First Skill
|
|
4
|
+
|
|
5
|
+
1. **Create the skill directory**
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
mkdir -p .claude/skills/my-skill
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
2. **Create SKILL.md with frontmatter**
|
|
12
|
+
|
|
13
|
+
```markdown
|
|
14
|
+
---
|
|
15
|
+
name: my-skill
|
|
16
|
+
description: Brief description of what this skill does
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
# My Skill
|
|
20
|
+
|
|
21
|
+
Core instructions go here...
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
3. **Test in conversation**
|
|
25
|
+
- Invoke the skill using the Skill tool
|
|
26
|
+
- Verify it loads and provides correct guidance
|
|
27
|
+
|
|
28
|
+
4. **Iterate and expand**
|
|
29
|
+
- Add references/ directory for detailed documentation
|
|
30
|
+
- Add scripts/ for executable operations
|
|
31
|
+
- Add assets/ for templates and files
|
|
32
|
+
|
|
33
|
+
## Skill Structure Details
|
|
34
|
+
|
|
35
|
+
### Directory Layout
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
my-skill/
|
|
39
|
+
├── SKILL.md # Core instructions + YAML frontmatter
|
|
40
|
+
├── references/ # Detailed documentation (loaded as needed)
|
|
41
|
+
│ ├── guide.md
|
|
42
|
+
│ └── examples.md
|
|
43
|
+
├── scripts/ # Executable shell scripts or programs
|
|
44
|
+
│ └── setup.sh
|
|
45
|
+
└── assets/ # Templates, images, configuration files
|
|
46
|
+
└── template.yaml
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### SKILL.md Anatomy
|
|
50
|
+
|
|
51
|
+
```markdown
|
|
52
|
+
---
|
|
53
|
+
name: skill-name # Unique identifier
|
|
54
|
+
description: Short desc # <200 chars, shows in skill list
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
# Skill Title
|
|
58
|
+
|
|
59
|
+
Brief overview of what this skill does.
|
|
60
|
+
|
|
61
|
+
## Section 1
|
|
62
|
+
|
|
63
|
+
Core patterns and instructions...
|
|
64
|
+
|
|
65
|
+
## Section 2
|
|
66
|
+
|
|
67
|
+
More essential guidance...
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Progressive Disclosure Strategy
|
|
71
|
+
|
|
72
|
+
### Level 1: Metadata (Always Loaded)
|
|
73
|
+
|
|
74
|
+
- YAML frontmatter only
|
|
75
|
+
- Target: <200 chars, <30 tokens
|
|
76
|
+
- Used for: Skill discovery and triggering
|
|
77
|
+
|
|
78
|
+
### Level 2: Instructions (Loaded When Triggered)
|
|
79
|
+
|
|
80
|
+
- SKILL.md body content
|
|
81
|
+
- Target: <50 lines, <1000 words, <680 tokens
|
|
82
|
+
- Contains: Core patterns, essential rules, reference links
|
|
83
|
+
|
|
84
|
+
### Level 3: Resources (Loaded On Demand)
|
|
85
|
+
|
|
86
|
+
- references/ scripts/ assets/ directories
|
|
87
|
+
- Size: Unlimited
|
|
88
|
+
- Contains: Detailed docs, code, templates
|
|
89
|
+
|
|
90
|
+
## Tips for Effective Skills
|
|
91
|
+
|
|
92
|
+
- **Start minimal**: Begin with just SKILL.md
|
|
93
|
+
- **Iterate**: Add references/ as complexity grows
|
|
94
|
+
- **Link clearly**: Use relative links to reference files
|
|
95
|
+
- **Test often**: Validate with `pnpx claude-skills-cli validate`
|
|
96
|
+
- **Stay focused**: One skill = one clear purpose
|