aiknowsys 0.0.1
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/AGENTS.template.md +207 -0
- package/CODEBASE_CHANGELOG.template.md +145 -0
- package/CODEBASE_ESSENTIALS.template.md +382 -0
- package/LICENSE +21 -0
- package/README.md +714 -0
- package/bin/cli.js +81 -0
- package/lib/commands/init.js +227 -0
- package/lib/commands/install-agents.js +100 -0
- package/lib/commands/install-skills.js +92 -0
- package/lib/commands/migrate.js +161 -0
- package/lib/commands/scan.js +418 -0
- package/lib/utils.js +93 -0
- package/package.json +53 -0
- package/scripts/migrate-existing.sh +222 -0
- package/scripts/scan-codebase.sh +379 -0
- package/scripts/setup.sh +273 -0
- package/templates/agents/README.md +270 -0
- package/templates/agents/architect.agent.template.md +58 -0
- package/templates/agents/developer.agent.template.md +27 -0
- package/templates/agents/setup-agents.sh +65 -0
- package/templates/skills/code-refactoring/SKILL.md +662 -0
- package/templates/skills/dependency-updates/SKILL.md +561 -0
- package/templates/skills/documentation-management/SKILL.md +744 -0
- package/templates/skills/skill-creator/SKILL.md +252 -0
- package/templates/skills/skill-creator/template.md +89 -0
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: skill-creator
|
|
3
|
+
description: Create new Agent Skills from existing project guides and documentation. Use when the user wants to create a skill, turn documentation into a skill, or make a guide into a reusable capability. Converts guides from docs/ into portable .github/skills/ format following VS Code Agent Skills standard.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill Creator - Turn Guides into Agent Skills
|
|
7
|
+
|
|
8
|
+
This skill helps you create new Agent Skills from existing project documentation, making specialized knowledge reusable and portable across GitHub Copilot, Copilot CLI, and Copilot coding agent.
|
|
9
|
+
|
|
10
|
+
## When to Use This Skill
|
|
11
|
+
|
|
12
|
+
Use this skill when:
|
|
13
|
+
- User asks to "create a skill" or "make a skill"
|
|
14
|
+
- User wants to convert a guide/doc into a reusable capability
|
|
15
|
+
- User mentions making documentation more accessible to Copilot
|
|
16
|
+
- User wants to teach Copilot a specialized workflow from project docs
|
|
17
|
+
|
|
18
|
+
## Agent Skills Format
|
|
19
|
+
|
|
20
|
+
Skills are stored in `.github/skills/<skill-name>/SKILL.md` with this structure:
|
|
21
|
+
|
|
22
|
+
```markdown
|
|
23
|
+
---
|
|
24
|
+
name: skill-name
|
|
25
|
+
description: What the skill does and when to use it (max 1024 chars)
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
# Skill Title
|
|
29
|
+
|
|
30
|
+
Detailed instructions, guidelines, and examples...
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Required YAML Frontmatter
|
|
34
|
+
|
|
35
|
+
- **name**: Lowercase, hyphens for spaces, max 64 chars (e.g., `testing-strategy`)
|
|
36
|
+
- **description**: Specific about capabilities AND use cases to help Copilot decide when to load the skill (max 1024 chars)
|
|
37
|
+
|
|
38
|
+
### Body Content Should Include
|
|
39
|
+
|
|
40
|
+
1. **What** the skill helps accomplish
|
|
41
|
+
2. **When** to use the skill (specific triggers)
|
|
42
|
+
3. **Step-by-step** procedures
|
|
43
|
+
4. **Examples** of input/output
|
|
44
|
+
5. **References** to included scripts/resources (if any)
|
|
45
|
+
|
|
46
|
+
## How to Create a Skill
|
|
47
|
+
|
|
48
|
+
### Step 1: Identify Source Material
|
|
49
|
+
|
|
50
|
+
Look for guides in:
|
|
51
|
+
- `docs/guides/` - Developer guides and workflows
|
|
52
|
+
- `docs/planning/` - Planning documents and decision records
|
|
53
|
+
- `docs/patterns/` - Reusable patterns and best practices
|
|
54
|
+
- `CODEBASE_ESSENTIALS.md` - Core patterns and invariants
|
|
55
|
+
- `CONTRIBUTING.md` - Contribution guidelines
|
|
56
|
+
- Project root `.md` files - Key documentation
|
|
57
|
+
|
|
58
|
+
### Step 2: Extract Key Information
|
|
59
|
+
|
|
60
|
+
From the source document, identify:
|
|
61
|
+
- **Core purpose**: What specialized task does this teach?
|
|
62
|
+
- **Trigger phrases**: What would a user say to need this skill?
|
|
63
|
+
- **Essential steps**: What are the must-follow procedures?
|
|
64
|
+
- **Common pitfalls**: What mistakes should be avoided?
|
|
65
|
+
- **Examples**: What are concrete use cases?
|
|
66
|
+
|
|
67
|
+
### Step 3: Craft the Description
|
|
68
|
+
|
|
69
|
+
Write a description that includes:
|
|
70
|
+
1. What the skill does (capabilities)
|
|
71
|
+
2. When to use it (use cases and triggers)
|
|
72
|
+
3. Be specific - vague descriptions won't load at the right time
|
|
73
|
+
|
|
74
|
+
**Good example:**
|
|
75
|
+
```
|
|
76
|
+
description: Guide Django REST Framework API development following project patterns. Use when creating views, serializers, viewsets, or implementing filters, pagination, authentication. Includes testing requirements and common pitfalls from DEVELOPER_CHECKLIST.md.
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
**Bad example:**
|
|
80
|
+
```
|
|
81
|
+
description: Helps with backend development
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### Step 4: Structure the Body
|
|
85
|
+
|
|
86
|
+
Organize content with clear sections:
|
|
87
|
+
|
|
88
|
+
```markdown
|
|
89
|
+
# Skill Title
|
|
90
|
+
|
|
91
|
+
Brief overview of what this skill teaches.
|
|
92
|
+
|
|
93
|
+
## When to Use This Skill
|
|
94
|
+
|
|
95
|
+
- Specific scenario 1
|
|
96
|
+
- Specific scenario 2
|
|
97
|
+
- Keywords that trigger this skill
|
|
98
|
+
|
|
99
|
+
## Core Principles
|
|
100
|
+
|
|
101
|
+
Key concepts to always follow...
|
|
102
|
+
|
|
103
|
+
## Step-by-Step Guide
|
|
104
|
+
|
|
105
|
+
1. First step with details
|
|
106
|
+
2. Second step with examples
|
|
107
|
+
3. Third step with common mistakes to avoid
|
|
108
|
+
|
|
109
|
+
## Examples
|
|
110
|
+
|
|
111
|
+
### Example 1: [Scenario]
|
|
112
|
+
```
|
|
113
|
+
Code or procedure example
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Example 2: [Scenario]
|
|
117
|
+
```
|
|
118
|
+
Another example
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## Common Pitfalls
|
|
122
|
+
|
|
123
|
+
- ❌ Don't do this: explanation
|
|
124
|
+
- ✅ Do this instead: explanation
|
|
125
|
+
|
|
126
|
+
## Related Files
|
|
127
|
+
|
|
128
|
+
Reference project files when relevant:
|
|
129
|
+
- [Pattern documentation](../../../docs/patterns/example.md)
|
|
130
|
+
- [Test examples](../../../backend/tests/example.py)
|
|
131
|
+
|
|
132
|
+
## Checklist
|
|
133
|
+
|
|
134
|
+
- [ ] Key requirement 1
|
|
135
|
+
- [ ] Key requirement 2
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Step 5: Create the Skill Directory
|
|
139
|
+
|
|
140
|
+
1. Create directory: `.github/skills/<skill-name>/`
|
|
141
|
+
2. Create file: `SKILL.md` with frontmatter + body
|
|
142
|
+
3. Add supporting files if needed (examples, scripts, templates)
|
|
143
|
+
|
|
144
|
+
## Naming Conventions
|
|
145
|
+
|
|
146
|
+
### Skill Names (YAML `name` field)
|
|
147
|
+
- Use lowercase with hyphens: `testing-strategy`, `api-design`, `frontend-patterns`
|
|
148
|
+
- Be specific: `django-api-development` not just `api`
|
|
149
|
+
- Include domain: `backend-testing`, `frontend-testing` (not just `testing`)
|
|
150
|
+
- Max 64 characters
|
|
151
|
+
|
|
152
|
+
### Directory Names
|
|
153
|
+
Match the skill name: `.github/skills/testing-strategy/`
|
|
154
|
+
|
|
155
|
+
## Example Transformations
|
|
156
|
+
|
|
157
|
+
### From Developer Checklist to Skill
|
|
158
|
+
|
|
159
|
+
**Source**: `docs/guides/DEVELOPER_CHECKLIST.md`
|
|
160
|
+
**Skill name**: `pre-commit-checklist`
|
|
161
|
+
**Description**: Pre-commit validation checklist for gnwebsite project. Use before committing code, creating PRs, or when user asks about testing requirements. Ensures API tests pass, frontend tests pass, types validate, and code follows project patterns.
|
|
162
|
+
|
|
163
|
+
### From Testing Guide to Skill
|
|
164
|
+
|
|
165
|
+
**Source**: `docs/guides/TESTING_STRATEGY.md`
|
|
166
|
+
**Skill name**: `testing-strategy`
|
|
167
|
+
**Description**: Guide for writing tests in gnwebsite fullstack Django/Vue application. Use when writing tests, debugging test failures, or implementing new features. Covers backend Django tests, frontend Vitest tests, integration tests, and test-driven development workflow.
|
|
168
|
+
|
|
169
|
+
### From Pattern Doc to Skill
|
|
170
|
+
|
|
171
|
+
**Source**: `docs/patterns/NEW_FEATURE_GUIDE.md`
|
|
172
|
+
**Skill name**: `feature-implementation`
|
|
173
|
+
**Description**: Step-by-step guide for implementing new features in gnwebsite. Use when planning features, making API changes, or adding frontend components. Covers API-first development, OpenAPI schema updates, testing requirements, and knowledge system updates.
|
|
174
|
+
|
|
175
|
+
## Progressive Disclosure
|
|
176
|
+
|
|
177
|
+
Remember Agent Skills use 3-level loading:
|
|
178
|
+
1. **Level 1**: Name + description always loaded (lightweight metadata)
|
|
179
|
+
2. **Level 2**: SKILL.md body loaded when description matches request
|
|
180
|
+
3. **Level 3**: Supporting files loaded only when referenced
|
|
181
|
+
|
|
182
|
+
This means:
|
|
183
|
+
- Keep descriptions specific so Copilot loads the right skill
|
|
184
|
+
- Put detailed instructions in the body
|
|
185
|
+
- Reference large examples/scripts as separate files
|
|
186
|
+
|
|
187
|
+
## Quality Checklist
|
|
188
|
+
|
|
189
|
+
Before finalizing a skill:
|
|
190
|
+
|
|
191
|
+
- [ ] Name is lowercase with hyphens, max 64 chars
|
|
192
|
+
- [ ] Description is specific about BOTH capabilities AND use cases
|
|
193
|
+
- [ ] Description mentions trigger phrases users might say
|
|
194
|
+
- [ ] Description is under 1024 characters
|
|
195
|
+
- [ ] Body has clear sections with examples
|
|
196
|
+
- [ ] References to project files use relative paths
|
|
197
|
+
- [ ] Common pitfalls are documented
|
|
198
|
+
- [ ] Examples show expected input/output
|
|
199
|
+
- [ ] No duplicate content from other skills
|
|
200
|
+
|
|
201
|
+
## Common Patterns in Our Project
|
|
202
|
+
|
|
203
|
+
When creating skills for this codebase, note:
|
|
204
|
+
- Backend is Django 5.2 + DRF
|
|
205
|
+
- Frontend is Vue 3 + TypeScript + Vite
|
|
206
|
+
- API uses OpenAPI/Spectacular for schema
|
|
207
|
+
- Testing uses pytest (backend) and Vitest (frontend)
|
|
208
|
+
- Knowledge system: CODEBASE_ESSENTIALS.md, CODEBASE_CHANGELOG.md
|
|
209
|
+
- Guides in: docs/guides/, docs/patterns/, docs/planning/
|
|
210
|
+
|
|
211
|
+
## Example: Creating a Skill Right Now
|
|
212
|
+
|
|
213
|
+
If asked to "create a skill for the testing strategy", do this:
|
|
214
|
+
|
|
215
|
+
1. Read `docs/guides/TESTING_STRATEGY.md`
|
|
216
|
+
2. Create `.github/skills/testing-strategy/SKILL.md`:
|
|
217
|
+
|
|
218
|
+
```markdown
|
|
219
|
+
---
|
|
220
|
+
name: testing-strategy
|
|
221
|
+
description: Guide for writing tests in gnwebsite fullstack Django/Vue application. Use when writing tests, debugging test failures, implementing features, or user asks about testing requirements. Covers Django pytest, Vitest, integration tests, mocking, and test-driven development patterns.
|
|
222
|
+
---
|
|
223
|
+
|
|
224
|
+
# Testing Strategy
|
|
225
|
+
|
|
226
|
+
This skill teaches the testing patterns and requirements for gnwebsite...
|
|
227
|
+
|
|
228
|
+
[Extract and structure key content from TESTING_STRATEGY.md]
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
## Anti-Patterns to Avoid
|
|
232
|
+
|
|
233
|
+
❌ **Don't**:
|
|
234
|
+
- Create overly broad skills ("development" or "coding")
|
|
235
|
+
- Write vague descriptions ("helps with testing")
|
|
236
|
+
- Duplicate content across multiple skills
|
|
237
|
+
- Include outdated information from guides
|
|
238
|
+
- Reference files that don't exist
|
|
239
|
+
|
|
240
|
+
✅ **Do**:
|
|
241
|
+
- Create focused, specific skills
|
|
242
|
+
- Write descriptions with clear triggers
|
|
243
|
+
- Extract unique, essential knowledge
|
|
244
|
+
- Keep content current with source guides
|
|
245
|
+
- Verify all file references work
|
|
246
|
+
|
|
247
|
+
## Related Resources
|
|
248
|
+
|
|
249
|
+
- [Agent Skills standard](https://agentskills.io/)
|
|
250
|
+
- [VS Code Agent Skills docs](https://code.visualstudio.com/docs/copilot/customization/agent-skills)
|
|
251
|
+
- [GitHub awesome-copilot](https://github.com/github/awesome-copilot)
|
|
252
|
+
- [Anthropic skills repo](https://github.com/anthropics/skills)
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: CHANGE-THIS-NAME
|
|
3
|
+
description: Write a specific description (max 1024 chars) that includes BOTH what the skill does AND when to use it. Mention trigger phrases users might say.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill Title
|
|
7
|
+
|
|
8
|
+
Brief 1-2 sentence overview of what this skill teaches.
|
|
9
|
+
|
|
10
|
+
## When to Use This Skill
|
|
11
|
+
|
|
12
|
+
List specific scenarios when this skill should be loaded:
|
|
13
|
+
- When user mentions [specific keywords]
|
|
14
|
+
- When working on [specific task type]
|
|
15
|
+
- When encountering [specific problem]
|
|
16
|
+
|
|
17
|
+
## Core Principles
|
|
18
|
+
|
|
19
|
+
Key concepts, patterns, or rules to always follow when using this skill.
|
|
20
|
+
|
|
21
|
+
## Step-by-Step Guide
|
|
22
|
+
|
|
23
|
+
### Step 1: [Action]
|
|
24
|
+
Detailed explanation with examples.
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
Code example or command
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Step 2: [Action]
|
|
31
|
+
More details...
|
|
32
|
+
|
|
33
|
+
### Step 3: [Action]
|
|
34
|
+
More details...
|
|
35
|
+
|
|
36
|
+
## Examples
|
|
37
|
+
|
|
38
|
+
### Example 1: [Scenario Name]
|
|
39
|
+
**Context**: When you need to...
|
|
40
|
+
|
|
41
|
+
**Input**:
|
|
42
|
+
```
|
|
43
|
+
Show what the user might ask or provide
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
**Output**:
|
|
47
|
+
```
|
|
48
|
+
Show expected result or code
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Example 2: [Another Scenario]
|
|
52
|
+
**Context**: When you need to...
|
|
53
|
+
|
|
54
|
+
**Input**:
|
|
55
|
+
```
|
|
56
|
+
Another example
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
**Output**:
|
|
60
|
+
```
|
|
61
|
+
Expected result
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Common Pitfalls
|
|
65
|
+
|
|
66
|
+
### ❌ Don't do this
|
|
67
|
+
Explanation of what to avoid and why.
|
|
68
|
+
|
|
69
|
+
### ✅ Do this instead
|
|
70
|
+
Correct approach with explanation.
|
|
71
|
+
|
|
72
|
+
## Related Files
|
|
73
|
+
|
|
74
|
+
Link to relevant project files when applicable:
|
|
75
|
+
- [Guide name](../../../docs/guides/example.md)
|
|
76
|
+
- [Pattern doc](../../../docs/patterns/example.md)
|
|
77
|
+
- [Example code](../../../backend/path/to/example.py)
|
|
78
|
+
|
|
79
|
+
## Validation Checklist
|
|
80
|
+
|
|
81
|
+
- [ ] Key requirement 1
|
|
82
|
+
- [ ] Key requirement 2
|
|
83
|
+
- [ ] Key requirement 3
|
|
84
|
+
|
|
85
|
+
## References
|
|
86
|
+
|
|
87
|
+
- External documentation links
|
|
88
|
+
- Related skills
|
|
89
|
+
- Useful resources
|