@anionzo/skill 1.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.
Files changed (80) hide show
  1. package/CONTRIBUTING.md +302 -0
  2. package/LICENSE +21 -0
  3. package/README.md +209 -0
  4. package/adapters/README.md +13 -0
  5. package/adapters/claude-code/README.md +32 -0
  6. package/adapters/copilot/README.md +32 -0
  7. package/adapters/gemini/README.md +32 -0
  8. package/adapters/generic/README.md +32 -0
  9. package/adapters/opencode/README.md +32 -0
  10. package/docs/adapter-guide.md +62 -0
  11. package/docs/authoring-guide.md +69 -0
  12. package/docs/design-brief.md +97 -0
  13. package/docs/knowledge-spec.md +78 -0
  14. package/docs/research-notes.md +99 -0
  15. package/docs/skill-spec.md +107 -0
  16. package/i18n/CONTRIBUTING.vi.md +302 -0
  17. package/i18n/README.vi.md +209 -0
  18. package/i18n/adapter-guide.vi.md +62 -0
  19. package/i18n/authoring-guide.vi.md +69 -0
  20. package/i18n/design-brief.vi.md +97 -0
  21. package/i18n/knowledge-spec.vi.md +78 -0
  22. package/i18n/research-notes.vi.md +99 -0
  23. package/i18n/skill-spec.vi.md +107 -0
  24. package/knowledge/README.md +7 -0
  25. package/knowledge/global/debugging-patterns.md +20 -0
  26. package/knowledge/global/engineering-principles.md +23 -0
  27. package/knowledge/global/evidence-before-claims.md +20 -0
  28. package/knowledge/global/review-heuristics.md +23 -0
  29. package/knowledge/global/skill-triggering-rules.md +24 -0
  30. package/knowledge/project/README.md +10 -0
  31. package/knowledge/working/README.md +10 -0
  32. package/package.json +43 -0
  33. package/scripts/sync-platform-files +73 -0
  34. package/scripts/validate-skills +103 -0
  35. package/skills/brainstorming/SKILL.md +45 -0
  36. package/skills/brainstorming/examples.md +61 -0
  37. package/skills/brainstorming/meta.yaml +23 -0
  38. package/skills/brainstorming/references/output-template.md +26 -0
  39. package/skills/bug-triage/SKILL.md +47 -0
  40. package/skills/bug-triage/examples.md +68 -0
  41. package/skills/bug-triage/meta.yaml +25 -0
  42. package/skills/bug-triage/references/output-template.md +26 -0
  43. package/skills/code-review/SKILL.md +41 -0
  44. package/skills/code-review/examples.md +77 -0
  45. package/skills/code-review/meta.yaml +24 -0
  46. package/skills/code-review/references/checklist.md +34 -0
  47. package/skills/code-review/references/output-template.md +12 -0
  48. package/skills/docs-writer/SKILL.md +42 -0
  49. package/skills/docs-writer/examples.md +108 -0
  50. package/skills/docs-writer/meta.yaml +22 -0
  51. package/skills/docs-writer/references/output-template.md +17 -0
  52. package/skills/feature-delivery/SKILL.md +39 -0
  53. package/skills/feature-delivery/examples.md +83 -0
  54. package/skills/feature-delivery/meta.yaml +26 -0
  55. package/skills/feature-delivery/references/output-template.md +26 -0
  56. package/skills/planning/SKILL.md +61 -0
  57. package/skills/planning/examples.md +124 -0
  58. package/skills/planning/meta.yaml +29 -0
  59. package/skills/planning/references/output-template.md +37 -0
  60. package/skills/refactor-safe/SKILL.md +53 -0
  61. package/skills/refactor-safe/examples.md +96 -0
  62. package/skills/refactor-safe/meta.yaml +28 -0
  63. package/skills/refactor-safe/references/output-template.md +37 -0
  64. package/skills/repo-onboarding/SKILL.md +52 -0
  65. package/skills/repo-onboarding/examples.md +115 -0
  66. package/skills/repo-onboarding/meta.yaml +23 -0
  67. package/skills/repo-onboarding/references/output-template.md +24 -0
  68. package/skills/using-skills/SKILL.md +108 -0
  69. package/skills/using-skills/examples.md +79 -0
  70. package/skills/using-skills/meta.yaml +29 -0
  71. package/skills/using-skills/references/output-template.md +14 -0
  72. package/skills/verification-before-completion/SKILL.md +46 -0
  73. package/skills/verification-before-completion/examples.md +83 -0
  74. package/skills/verification-before-completion/meta.yaml +26 -0
  75. package/skills/verification-before-completion/references/checklist.md +7 -0
  76. package/skills/verification-before-completion/references/output-template.md +16 -0
  77. package/templates/SKILL.md +29 -0
  78. package/templates/examples.md +13 -0
  79. package/templates/meta.yaml +14 -0
  80. package/templates/output-template.md +11 -0
@@ -0,0 +1,302 @@
1
+ <div align="center">
2
+
3
+ # 🤝 Contributing Guide
4
+
5
+ **How to contribute skills, knowledge, and improvements to this library**
6
+
7
+ [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen?style=flat-square&logo=github)](https://github.com/anionzo/skill/pulls)
8
+ [![Skill Spec](https://img.shields.io/badge/read-skill_spec-blue?style=flat-square&logo=bookstack)](docs/skill-spec.md)
9
+ [![Authoring Guide](https://img.shields.io/badge/read-authoring_guide-purple?style=flat-square&logo=pencil)](docs/authoring-guide.md)
10
+
11
+ ---
12
+
13
+ 🇻🇳 **[Tiếng Việt](i18n/CONTRIBUTING.vi.md)**
14
+
15
+ </div>
16
+
17
+ ---
18
+
19
+ > 🎯 Thank you for your interest in contributing! This guide covers everything you need to add or improve skills, knowledge files, and tooling in this repo.
20
+
21
+ ### 📋 Table of Contents
22
+
23
+ | | Section |
24
+ |---|---|
25
+ | 🏁 | [Quick Start](#-quick-start) |
26
+ | ➕ | [Adding a New Skill](#-adding-a-new-skill) |
27
+ | ✏️ | [Editing an Existing Skill](#️-editing-an-existing-skill) |
28
+ | 📚 | [Contributing Knowledge](#-contributing-knowledge) |
29
+ | 🔌 | [Updating Adapters](#-updating-adapters) |
30
+ | ✅ | [Validation & Quality](#-validation--quality) |
31
+ | 📐 | [Style & Conventions](#-style--conventions) |
32
+ | 🔄 | [Pull Request Process](#-pull-request-process) |
33
+ | 🚫 | [What Not to Do](#-what-not-to-do) |
34
+
35
+ ---
36
+
37
+ ### 🏁 Quick Start
38
+
39
+ ```bash
40
+ # 1. Fork and clone the repo
41
+ git clone https://github.com/<your-username>/skill.git
42
+ cd skill
43
+
44
+ # 2. Create a feature branch
45
+ git branch feat/my-new-skill
46
+ git checkout feat/my-new-skill
47
+
48
+ # 3. Make your changes (see sections below)
49
+
50
+ # 4. Validate
51
+ bash scripts/validate-skills
52
+
53
+ # 5. Generate platform files
54
+ bash scripts/sync-platform-files
55
+
56
+ # 6. Commit and push
57
+ git add .
58
+ git commit -m "add skill: <skill-name>"
59
+ git push origin feat/my-new-skill
60
+
61
+ # 7. Open a Pull Request on GitHub
62
+ ```
63
+
64
+ ---
65
+
66
+ ### ➕ Adding a New Skill
67
+
68
+ Every skill lives in its own directory under `skills/`. Follow these steps:
69
+
70
+ #### Step 1 — Scaffold from template
71
+
72
+ ```bash
73
+ cp -r templates/ skills/<your-skill-name>/
74
+ ```
75
+
76
+ #### Step 2 — Fill in `meta.yaml`
77
+
78
+ | Key | Required | Description |
79
+ |---|---|---|
80
+ | `name` | ✅ | Skill identifier (kebab-case) |
81
+ | `version` | ✅ | Semantic version (`1.0.0`) |
82
+ | `category` | ✅ | One of: `routing`, `discovery`, `planning`, `implementation`, `debugging`, `review`, `documentation`, `verification` |
83
+ | `summary` | ✅ | One-line English description |
84
+ | `summary_vi` | 🟡 | One-line Vietnamese description |
85
+ | `triggers` | 🟡 | When to activate this skill |
86
+ | `inputs` | 🟡 | What the skill needs |
87
+ | `outputs` | 🟡 | What the skill produces |
88
+ | `constraints` | 🟡 | Guardrails and limits |
89
+ | `related_skills` | 🟡 | Connected skills in the graph |
90
+
91
+ > ✅ = required &nbsp; 🟡 = recommended
92
+
93
+ #### Step 3 — Write `SKILL.md`
94
+
95
+ Follow the structure from the [Skill Spec](docs/skill-spec.md):
96
+
97
+ ```markdown
98
+ # <Skill Name>
99
+
100
+ ## 🎯 Purpose
101
+ ## ⏰ When to Use
102
+ ## 🔄 Workflow
103
+ ## 📋 Output Format
104
+ ## 🚩 Red Flags
105
+ ## ✅ Done Criteria
106
+ ## ➡️ Handoff
107
+ ```
108
+
109
+ > 💡 Keep it **operational** — concrete steps, not abstract theory. See the [Authoring Guide](docs/authoring-guide.md) for detailed writing rules.
110
+
111
+ #### Step 4 — Add `examples.md`
112
+
113
+ Include at least one realistic example with:
114
+
115
+ - 🗣️ A representative user request
116
+ - 📋 The intended response shape or workflow
117
+ - ✅ A completed output example
118
+
119
+ #### Step 5 — Add references (optional)
120
+
121
+ Place supporting files in `references/`:
122
+
123
+ - 📋 Output templates
124
+ - ☑️ Checklists
125
+ - 📊 Rubrics
126
+ - 🌳 Decision trees
127
+
128
+ #### Step 6 — Wire into the skill graph
129
+
130
+ Update the `related_skills` field in relevant existing skills' `meta.yaml` files so the router (`using-skills`) can discover your new skill.
131
+
132
+ #### Step 7 — Validate
133
+
134
+ ```bash
135
+ bash scripts/validate-skills
136
+ ```
137
+
138
+ All skills must pass with **0 FAIL** and **0 WARN**.
139
+
140
+ ---
141
+
142
+ ### ✏️ Editing an Existing Skill
143
+
144
+ | | Guideline |
145
+ |---|---|
146
+ | 🔹 | Prefer **tightening scope** over adding more branches |
147
+ | 🔹 | If a skill handles too many cases, **split it** into two |
148
+ | 🔹 | Keep the output format stable — downstream skills depend on it |
149
+ | 🔹 | Update `examples.md` if the workflow changes |
150
+ | 🔹 | Bump the `version` in `meta.yaml` |
151
+
152
+ ---
153
+
154
+ ### 📚 Contributing Knowledge
155
+
156
+ Knowledge files live in `knowledge/global/`. They contain principles, heuristics, and patterns — **not** step-by-step workflows (those belong in skills).
157
+
158
+ | File | Purpose |
159
+ |---|---|
160
+ | 📐 `engineering-principles.md` | Core coding values |
161
+ | 🔍 `review-heuristics.md` | Code review rules |
162
+ | 🐛 `debugging-patterns.md` | Systematic debugging approaches |
163
+ | 🧠 `skill-triggering-rules.md` | When to load which skill |
164
+
165
+ When adding or editing knowledge:
166
+
167
+ - 🔹 Keep entries concise and actionable
168
+ - 🔹 Avoid project-specific details — knowledge should be portable
169
+ - 🔹 Each entry should help an AI agent make better decisions
170
+
171
+ ---
172
+
173
+ ### 🔌 Updating Adapters
174
+
175
+ Adapter skeletons in `adapters/` define how platform-specific files are generated. If you change the skill catalog or knowledge structure:
176
+
177
+ ```bash
178
+ # Regenerate all platform files
179
+ bash scripts/sync-platform-files
180
+ ```
181
+
182
+ > ⚠️ Never edit files in `generated/` directly — they are overwritten on every sync.
183
+
184
+ ---
185
+
186
+ ### ✅ Validation & Quality
187
+
188
+ Before submitting any change, run:
189
+
190
+ ```bash
191
+ # 1. Validate all skills
192
+ bash scripts/validate-skills
193
+
194
+ # 2. Regenerate platform files
195
+ bash scripts/sync-platform-files
196
+ ```
197
+
198
+ #### Quality Checklist
199
+
200
+ | | Check |
201
+ |---|---|
202
+ | 🏷️ | Skill name is specific and descriptive |
203
+ | 📝 | Summary is one sentence and still useful |
204
+ | 🔄 | Workflow can be followed without private context |
205
+ | 📋 | Output format is consistent |
206
+ | 💡 | Example is realistic and includes completed output |
207
+ | ✅ | Done criteria require evidence, not wishful language |
208
+ | 🔗 | `related_skills` graph is consistent (bidirectional links) |
209
+ | ⚙️ | `validate-skills` passes with 0 FAIL, 0 WARN |
210
+ | 📦 | `sync-platform-files` runs without errors |
211
+
212
+ ---
213
+
214
+ ### 📐 Style & Conventions
215
+
216
+ | | Convention |
217
+ |---|---|
218
+ | 📁 | Skill directories use **kebab-case** (`feature-delivery`, not `FeatureDelivery`) |
219
+ | 📄 | Skill files: `meta.yaml`, `SKILL.md`, `examples.md`, `references/` |
220
+ | 🌐 | Documentation must be **bilingual** — English in main file, Vietnamese in `i18n/` |
221
+ | 📂 | Vietnamese translations go in `i18n/<filename>.vi.md` |
222
+ | 🔗 | Main file links to `i18n/` translation; translation links back to main file |
223
+ | 🎨 | Use emoji icons, tables, and badges — no plain-text walls |
224
+ | 🔗 | All source repos must be **clickable links** to GitHub |
225
+ | 💬 | Commit messages in **English**, clear and descriptive |
226
+ | 📏 | Keep `SKILL.md` under ~200 lines — split if larger |
227
+
228
+ ---
229
+
230
+ ### 🔄 Pull Request Process
231
+
232
+ ```
233
+ ┌──────────────┐ ┌─────────────┐ ┌──────────────┐
234
+ │ Fork & Code │────▶│ Validate │────▶│ Open PR │
235
+ │ │ │ & Sync │ │ │
236
+ └──────────────┘ └─────────────┘ └──────┬───────┘
237
+
238
+ ┌──────▼───────┐
239
+ │ Review │
240
+ │ & Merge │
241
+ └──────────────┘
242
+ ```
243
+
244
+ #### PR Requirements
245
+
246
+ | | Requirement |
247
+ |---|---|
248
+ | 1️⃣ | Branch from `main`, target `main` |
249
+ | 2️⃣ | `bash scripts/validate-skills` passes with 0 errors |
250
+ | 3️⃣ | `bash scripts/sync-platform-files` runs cleanly |
251
+ | 4️⃣ | PR title follows format: `add skill: <name>`, `fix: <description>`, or `update: <description>` |
252
+ | 5️⃣ | PR description explains **what** changed and **why** |
253
+ | 6️⃣ | No secrets, tokens, or machine-specific paths |
254
+ | 7️⃣ | No changes to `generated/` (it is gitignored) |
255
+
256
+ ---
257
+
258
+ ### 📦 Publishing a Release
259
+
260
+ The package is published to [npm](https://www.npmjs.com/package/@anionzo/skill) via a GitHub Actions workflow.
261
+
262
+ #### To publish a new version:
263
+
264
+ ```bash
265
+ # 1. Bump the version in package.json
266
+ npm version patch # 1.0.0 → 1.0.1
267
+ # or
268
+ npm version minor # 1.0.0 → 1.1.0
269
+ # or
270
+ npm version major # 1.0.0 → 2.0.0
271
+
272
+ # 2. Push the version tag
273
+ git push origin main --tags
274
+
275
+ # 3. Create a GitHub Release (triggers publish workflow)
276
+ gh release create v1.0.1 --generate-notes
277
+ ```
278
+
279
+ > 💡 The workflow (`.github/workflows/publish.yml`) runs validation, generates platform files, and publishes to npm automatically.
280
+
281
+ ---
282
+
283
+ ### 🚫 What Not to Do
284
+
285
+ | | Anti-Pattern |
286
+ |---|---|
287
+ | ❌ | Commit files in `generated/` — they are auto-generated |
288
+ | ❌ | Create skills that try to handle every possible case |
289
+ | ❌ | Write vague prompts like "be a great engineer" |
290
+ | ❌ | Embed secrets, tokens, or local file paths |
291
+ | ❌ | Hard-code assumptions about a specific AI agent |
292
+ | ❌ | Edit platform files directly instead of editing adapters |
293
+ | ❌ | Skip validation before opening a PR |
294
+ | ❌ | Write English-only docs (bilingual is required) |
295
+
296
+ ---
297
+
298
+ <div align="center">
299
+
300
+ **Built with 🤝 for collaborative AI skill development**
301
+
302
+ </div>
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Mai Trung Tiến
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,209 @@
1
+ <div align="center">
2
+
3
+ # 🧠 Personal AI Skill Library
4
+
5
+ **A vendor-neutral, multi-agent skill library for AI-powered software engineering**
6
+
7
+ [![Skills](https://img.shields.io/badge/skills-10-blue?style=flat-square&logo=bookstack)](skills/)
8
+ [![Knowledge](https://img.shields.io/badge/knowledge-5_files-green?style=flat-square&logo=readme)](knowledge/)
9
+ [![Platforms](https://img.shields.io/badge/platforms-5_agents-purple?style=flat-square&logo=robot-framework)](adapters/)
10
+ [![License](https://img.shields.io/badge/license-MIT-yellow?style=flat-square)](LICENSE)
11
+ [![Contributing](https://img.shields.io/badge/PRs-welcome-brightgreen?style=flat-square&logo=github)](CONTRIBUTING.md)
12
+ [![npm](https://img.shields.io/npm/v/@anionzo/skill?style=flat-square&logo=npm&color=crimson)](https://www.npmjs.com/package/@anionzo/skill)
13
+
14
+ ---
15
+
16
+ 🇻🇳 **[Tiếng Việt](i18n/README.vi.md)**
17
+
18
+ </div>
19
+
20
+ ---
21
+
22
+ > 🎯 Keep repeatable AI workflows in one place. Separate skills from knowledge. Work across any agent.
23
+
24
+ This repo is intentionally lighter than a full workflow product. It borrows the **workflow-first** mindset from `hoangnb24/skills`, the **plan-first** behavior from modern coding agents like OpenCode, and the **multi-platform** approach from `knowns-dev/knowns` — then turns them into a practical personal library.
25
+
26
+ ### 🏗️ Design Goals
27
+
28
+ | | Goal |
29
+ |---|---|
30
+ | 🔹 | Skills are small, specific, and reusable |
31
+ | 🔹 | Knowledge is stored separately from skills |
32
+ | 🔹 | Adapters are generated from one source — not hand-maintained |
33
+ | 🔹 | Works without any custom plugin runtime |
34
+
35
+ ### 📁 Repository Layout
36
+
37
+ ```
38
+ .
39
+ ├─ 📄 docs/ → Specs, authoring rules, design decisions
40
+ ├─ 🎯 skills/ → Reusable skill definitions
41
+ ├─ 📚 knowledge/ → Global, project, and working knowledge
42
+ ├─ 📋 templates/ → Starting points for new skills
43
+ ├─ 🔌 adapters/ → Platform-specific guidance
44
+ ├─ ⚙️ scripts/ → Validation and sync helpers
45
+ ├─ 🌐 i18n/ → Vietnamese translations
46
+ └─ 📦 generated/ → Auto-generated output (gitignored)
47
+ ```
48
+
49
+ ### 🎯 Skill Catalog
50
+
51
+ | | Skill | Purpose |
52
+ |---|---|---|
53
+ | 🧭 | `using-skills` | Route a request to the right skill and working mode |
54
+ | 💡 | `brainstorming` | Refine rough ideas into a concrete direction before planning |
55
+ | 🗺️ | `repo-onboarding` | Understand an unfamiliar codebase before acting |
56
+ | 📐 | `planning` | Turn a request into an execution-ready plan |
57
+ | 🚀 | `feature-delivery` | Implement a feature with minimal, repo-aligned change |
58
+ | 🐛 | `bug-triage` | Investigate errors, regressions, and unclear failures |
59
+ | ♻️ | `refactor-safe` | Restructure code without changing behavior |
60
+ | ✅ | `verification-before-completion` | Require fresh evidence before claiming done |
61
+ | 🔍 | `code-review` | Review diffs — bugs, regressions, test gaps first |
62
+ | 📝 | `docs-writer` | Update docs from verified source behavior |
63
+
64
+ ### 🔄 Default Workflow
65
+
66
+ ```
67
+ ┌─────────────┐ ┌───────────────┐ ┌─────────────────┐
68
+ │ using-skills │────▶│ brainstorming │────▶│ repo-onboarding │
69
+ │ (router) │ │ (if vague) │ │ (if new repo) │
70
+ └──────┬───────┘ └───────┬───────┘ └────────┬────────┘
71
+ │ │ │
72
+ │ ▼ │
73
+ │ ┌──────────┐ │
74
+ └─────────────▶│ planning │◀─────────────────┘
75
+ └────┬─────┘
76
+
77
+ ┌────────────┼────────────┐
78
+ ▼ ▼ ▼
79
+ ┌────────────┐ ┌───────────┐ ┌──────────────┐
80
+ │ feature- │ │ bug-triage│ │ refactor-safe│
81
+ │ delivery │ │ │ │ │
82
+ └─────┬──────┘ └─────┬─────┘ └──────┬───────┘
83
+ │ │ │
84
+ ▼ ▼ ▼
85
+ ┌─────────────────────────────────────────┐
86
+ │ verification-before-completion │
87
+ └────────────────────┬────────────────────┘
88
+
89
+ ┌─────────────┐
90
+ │ code-review │
91
+ └─────────────┘
92
+ ```
93
+
94
+ ### 📖 Research Highlights
95
+
96
+ This scaffold distills patterns from strong public repos:
97
+
98
+ | Source | Key Pattern |
99
+ |---|---|
100
+ | 🏛️ [`anthropics/skills`](https://github.com/anthropics/skills) | Minimal, portable skill packaging |
101
+ | ⚡ [`obra/superpowers`](https://github.com/obra/superpowers) | Brainstorm → plan → execute → verify workflow |
102
+ | 🧩 [`affaan-m/everything-claude-code`](https://github.com/affaan-m/everything-claude-code) | Layered model: skills, rules, memory, adapters |
103
+ | 🗃️ [`knowns-dev/knowns`](https://github.com/knowns-dev/knowns) | Separate skills from knowledge; generate platform files |
104
+ | 📦 [`hoangnb24/skills`](https://github.com/hoangnb24/skills) | Workflow-first skill design with router and output contracts |
105
+
106
+ ### 🚀 Quick Start
107
+
108
+ ```bash
109
+ # 1. Understand the repo shape
110
+ cat docs/design-brief.md
111
+
112
+ # 2. Customize knowledge to your preferences
113
+ vim knowledge/global/engineering-principles.md
114
+
115
+ # 3. Start working — the router picks the right skill
116
+ cat skills/using-skills/SKILL.md
117
+
118
+ # 4. Validate your skills
119
+ bash scripts/validate-skills
120
+
121
+ # 5. Generate platform files
122
+ bash scripts/sync-platform-files
123
+ ```
124
+
125
+ ### 📦 Install via npm
126
+
127
+ > Available on [npm](https://www.npmjs.com/package/@anionzo/skill) — no authentication required
128
+
129
+ ```bash
130
+ # 1. Install the package
131
+ npm install @anionzo/skill
132
+
133
+ # 2. Copy skills/knowledge to your project
134
+ cp -r node_modules/@anionzo/skill/skills/ ./
135
+ cp -r node_modules/@anionzo/skill/knowledge/ ./
136
+
137
+ # 3. Generate platform files
138
+ bash node_modules/@anionzo/skill/scripts/sync-platform-files
139
+
140
+ # 4. Copy the output to your agent
141
+ cp generated/CLAUDE.md ./ # or OPENCODE.md, GEMINI.md, etc.
142
+ ```
143
+
144
+ > 💡 Or clone the repo directly if you prefer editing skills in place.
145
+
146
+ ### 🔌 Agent Integration
147
+
148
+ > This repo is the **source of truth**. Generated files are delivery artifacts only.
149
+
150
+ | Agent | Copy from | Copy to |
151
+ |---|---|---|
152
+ | 🤖 Claude Code | `generated/CLAUDE.md` | `CLAUDE.md` |
153
+ | ⚡ OpenCode | `generated/OPENCODE.md` | `OPENCODE.md` |
154
+ | 💎 Gemini CLI | `generated/GEMINI.md` | `GEMINI.md` |
155
+ | 🔧 Generic | `generated/AGENTS.md` | `AGENTS.md` |
156
+ | 🐙 GitHub Copilot | `generated/copilot-instructions.md` | `.github/copilot-instructions.md` |
157
+
158
+ ### ➕ Create A New Skill
159
+
160
+ ```bash
161
+ # 1. Scaffold from template
162
+ cp -r templates/ skills/<new-skill>/
163
+
164
+ # 2. Edit the files
165
+ vim skills/<new-skill>/meta.yaml
166
+ vim skills/<new-skill>/SKILL.md
167
+ vim skills/<new-skill>/examples.md
168
+
169
+ # 3. Validate
170
+ bash scripts/validate-skills
171
+ ```
172
+
173
+ ### ⚙️ Commands
174
+
175
+ | Command | Purpose |
176
+ |---|---|
177
+ | `bash scripts/validate-skills` | Check all skills have required files and keys |
178
+ | `bash scripts/sync-platform-files` | Generate platform instruction files |
179
+
180
+ ### 📋 Recommended Customization Order
181
+
182
+ 1. 🥇 `knowledge/global/engineering-principles.md`
183
+ 2. 🥈 `knowledge/global/review-heuristics.md`
184
+ 3. 🥉 `knowledge/global/debugging-patterns.md`
185
+ 4. 🎯 The skill files you use weekly
186
+ 5. 🔌 Adapter output for your two most-used agents
187
+
188
+ ### 🤝 Contributing
189
+
190
+ We welcome contributions! See **[CONTRIBUTING.md](CONTRIBUTING.md)** for:
191
+
192
+ - ➕ How to add a new skill
193
+ - ✏️ How to edit existing skills
194
+ - 📚 How to contribute knowledge
195
+ - 🔄 Pull request process and conventions
196
+
197
+ ### 📌 Notes
198
+
199
+ - `generated/` is gitignored — regenerate anytime
200
+ - No plugin runtime or MCP server shipped (yet)
201
+ - Next step: machine-readable manifest or MCP bridge
202
+
203
+ ---
204
+
205
+ <div align="center">
206
+
207
+ **Built with ❤️ for AI-assisted software engineering**
208
+
209
+ </div>
@@ -0,0 +1,13 @@
1
+ # Adapters
2
+
3
+ This directory describes where generated instruction files should land for each target platform.
4
+
5
+ The actual generated files are written to `generated/` by `bash scripts/sync-platform-files`.
6
+
7
+ Current targets:
8
+
9
+ - `claude-code/` -> `CLAUDE.md`
10
+ - `opencode/` -> `OPENCODE.md`
11
+ - `gemini/` -> `GEMINI.md`
12
+ - `generic/` -> `AGENTS.md`
13
+ - `copilot/` -> `.github/copilot-instructions.md`
@@ -0,0 +1,32 @@
1
+ # Claude Code Adapter
2
+
3
+ ## Purpose
4
+
5
+ This adapter generates platform-specific instruction files for Claude Code.
6
+
7
+ ## How It Works
8
+
9
+ 1. Run `bash scripts/sync-platform-files` to generate `generated/CLAUDE.md`
10
+ 2. Copy the generated file to your project root as `CLAUDE.md`
11
+ 3. The agent will automatically read this file and apply the skill library
12
+
13
+ ## Copy Flow
14
+
15
+ ```bash
16
+ # Generate
17
+ bash scripts/sync-platform-files
18
+
19
+ # Copy to your project
20
+ cp generated/CLAUDE.md CLAUDE.md
21
+ ```
22
+
23
+ ## Platform Notes
24
+
25
+ - Claude Code reads `CLAUDE.md` from the project root automatically
26
+ - Place the file at the root of your repository for best results
27
+ - Claude Code will reference this file at the start of each session
28
+
29
+ ## Source
30
+
31
+ - Generated from: `generated/CLAUDE.md`
32
+ - Core skill library: `skills/` and `knowledge/`
@@ -0,0 +1,32 @@
1
+ # GitHub Copilot Adapter
2
+
3
+ ## Purpose
4
+
5
+ This adapter generates platform-specific instruction files for GitHub Copilot.
6
+
7
+ ## How It Works
8
+
9
+ 1. Run `bash scripts/sync-platform-files` to generate `generated/copilot-instructions.md`
10
+ 2. Copy the generated file to your project as `.github/copilot-instructions.md`
11
+ 3. The agent will automatically read this file and apply the skill library
12
+
13
+ ## Copy Flow
14
+
15
+ ```bash
16
+ # Generate
17
+ bash scripts/sync-platform-files
18
+
19
+ # Copy to your project
20
+ cp generated/copilot-instructions.md .github/copilot-instructions.md
21
+ ```
22
+
23
+ ## Platform Notes
24
+
25
+ - GitHub Copilot reads `.github/copilot-instructions.md` from the repository
26
+ - The `.github/` directory must exist before copying the file
27
+ - Works with both Copilot Chat and Copilot Workspace
28
+
29
+ ## Source
30
+
31
+ - Generated from: `generated/copilot-instructions.md`
32
+ - Core skill library: `skills/` and `knowledge/`
@@ -0,0 +1,32 @@
1
+ # Gemini CLI Adapter
2
+
3
+ ## Purpose
4
+
5
+ This adapter generates platform-specific instruction files for Gemini CLI.
6
+
7
+ ## How It Works
8
+
9
+ 1. Run `bash scripts/sync-platform-files` to generate `generated/GEMINI.md`
10
+ 2. Copy the generated file to your project root as `GEMINI.md`
11
+ 3. The agent will automatically read this file and apply the skill library
12
+
13
+ ## Copy Flow
14
+
15
+ ```bash
16
+ # Generate
17
+ bash scripts/sync-platform-files
18
+
19
+ # Copy to your project
20
+ cp generated/GEMINI.md GEMINI.md
21
+ ```
22
+
23
+ ## Platform Notes
24
+
25
+ - Gemini CLI reads `GEMINI.md` from the project root automatically
26
+ - Place the file at the root of your repository for best results
27
+ - Gemini CLI will reference this file at the start of each session
28
+
29
+ ## Source
30
+
31
+ - Generated from: `generated/GEMINI.md`
32
+ - Core skill library: `skills/` and `knowledge/`
@@ -0,0 +1,32 @@
1
+ # Generic Adapter
2
+
3
+ ## Purpose
4
+
5
+ This adapter generates platform-specific instruction files for generic AI agents and tooling.
6
+
7
+ ## How It Works
8
+
9
+ 1. Run `bash scripts/sync-platform-files` to generate `generated/AGENTS.md`
10
+ 2. Copy the generated file to your project root as `AGENTS.md`
11
+ 3. The agent will automatically read this file and apply the skill library
12
+
13
+ ## Copy Flow
14
+
15
+ ```bash
16
+ # Generate
17
+ bash scripts/sync-platform-files
18
+
19
+ # Copy to your project
20
+ cp generated/AGENTS.md AGENTS.md
21
+ ```
22
+
23
+ ## Platform Notes
24
+
25
+ - `AGENTS.md` is a convention used by various AI agents and tools
26
+ - This adapter is useful for any agent that reads a general repository instruction file
27
+ - Works with custom agents, internal tooling, or any platform without a dedicated adapter
28
+
29
+ ## Source
30
+
31
+ - Generated from: `generated/AGENTS.md`
32
+ - Core skill library: `skills/` and `knowledge/`