port-nuker 1.0.0 → 1.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.
@@ -1,605 +0,0 @@
1
- # Anatomy of a Skill - Understanding the Structure
2
-
3
- **Want to understand how skills work under the hood?** This guide breaks down every part of a skill file.
4
-
5
- ---
6
-
7
- ## 📁 Basic Folder Structure
8
-
9
- ```
10
- skills/
11
- └── my-skill-name/
12
- ├── SKILL.md ← Required: The main skill definition
13
- ├── examples/ ← Optional: Example files
14
- │ ├── example1.js
15
- │ └── example2.py
16
- ├── scripts/ ← Optional: Helper scripts
17
- │ └── helper.sh
18
- ├── templates/ ← Optional: Code templates
19
- │ └── template.tsx
20
- ├── references/ ← Optional: Reference documentation
21
- │ └── api-docs.md
22
- └── README.md ← Optional: Additional documentation
23
- ```
24
-
25
- **Key Rule:** Only `SKILL.md` is required. Everything else is optional!
26
-
27
- ---
28
-
29
- ## SKILL.md Structure
30
-
31
- Every `SKILL.md` file has two main parts:
32
-
33
- ### 1. Frontmatter (Metadata)
34
-
35
- ### 2. Content (Instructions)
36
-
37
- Let's break down each part:
38
-
39
- ---
40
-
41
- ## Part 1: Frontmatter
42
-
43
- The frontmatter is at the very top, wrapped in `---`:
44
-
45
- ```markdown
46
- ---
47
- name: my-skill-name
48
- description: "Brief description of what this skill does"
49
- ---
50
- ```
51
-
52
- ### Required Fields
53
-
54
- #### `name`
55
-
56
- - **What it is:** The skill's identifier
57
- - **Format:** lowercase-with-hyphens
58
- - **Must match:** The folder name exactly
59
- - **Example:** `stripe-integration`
60
-
61
- #### `description`
62
-
63
- - **What it is:** One-sentence summary
64
- - **Format:** String in quotes
65
- - **Length:** Keep it under 150 characters
66
- - **Example:** `"Stripe payment integration patterns including checkout, subscriptions, and webhooks"`
67
-
68
- ### Optional Fields
69
-
70
- Some skills include additional metadata:
71
-
72
- ```markdown
73
- ---
74
- name: my-skill-name
75
- description: "Brief description"
76
- risk: "safe" # safe | risk | official
77
- source: "community"
78
- tags: ["react", "typescript"]
79
- ---
80
- ```
81
-
82
- ---
83
-
84
- ## Part 2: Content
85
-
86
- After the frontmatter comes the actual skill content. Here's the recommended structure:
87
-
88
- ### Recommended Sections
89
-
90
- #### 1. Title (H1)
91
-
92
- ```markdown
93
- # Skill Title
94
- ```
95
-
96
- - Use a clear, descriptive title
97
- - Usually matches or expands on the skill name
98
-
99
- #### 2. Overview
100
-
101
- ```markdown
102
- ## Overview
103
-
104
- A brief explanation of what this skill does and why it exists.
105
- 2-4 sentences is perfect.
106
- ```
107
-
108
- #### 3. When to Use
109
-
110
- ```markdown
111
- ## When to Use This Skill
112
-
113
- - Use when you need to [scenario 1]
114
- - Use when working with [scenario 2]
115
- - Use when the user asks about [scenario 3]
116
- ```
117
-
118
- **Why this matters:** Helps the AI know when to activate this skill
119
-
120
- #### 4. Core Instructions
121
-
122
- ```markdown
123
- ## How It Works
124
-
125
- ### Step 1: [Action]
126
-
127
- Detailed instructions...
128
-
129
- ### Step 2: [Action]
130
-
131
- More instructions...
132
- ```
133
-
134
- **This is the heart of your skill** - clear, actionable steps
135
-
136
- #### 5. Examples
137
-
138
- ```markdown
139
- ## Examples
140
-
141
- ### Example 1: [Use Case]
142
-
143
- \`\`\`javascript
144
- // Example code
145
- \`\`\`
146
-
147
- ### Example 2: [Another Use Case]
148
-
149
- \`\`\`javascript
150
- // More code
151
- \`\`\`
152
- ```
153
-
154
- **Why examples matter:** They show the AI exactly what good output looks like
155
-
156
- #### 6. Best Practices
157
-
158
- ```markdown
159
- ## Best Practices
160
-
161
- - ✅ Do this
162
- - ✅ Also do this
163
- - ❌ Don't do this
164
- - ❌ Avoid this
165
- ```
166
-
167
- #### 7. Common Pitfalls
168
-
169
- ```markdown
170
- ## Common Pitfalls
171
-
172
- - **Problem:** Description
173
- **Solution:** How to fix it
174
- ```
175
-
176
- #### 8. Related Skills
177
-
178
- ```markdown
179
- ## Related Skills
180
-
181
- - `@other-skill` - When to use this instead
182
- - `@complementary-skill` - How this works together
183
- ```
184
-
185
- ---
186
-
187
- ## Writing Effective Instructions
188
-
189
- ### Use Clear, Direct Language
190
-
191
- **❌ Bad:**
192
-
193
- ```markdown
194
- You might want to consider possibly checking if the user has authentication.
195
- ```
196
-
197
- **✅ Good:**
198
-
199
- ```markdown
200
- Check if the user is authenticated before proceeding.
201
- ```
202
-
203
- ### Use Action Verbs
204
-
205
- **❌ Bad:**
206
-
207
- ```markdown
208
- The file should be created...
209
- ```
210
-
211
- **✅ Good:**
212
-
213
- ```markdown
214
- Create the file...
215
- ```
216
-
217
- ### Be Specific
218
-
219
- **❌ Bad:**
220
-
221
- ```markdown
222
- Set up the database properly.
223
- ```
224
-
225
- **✅ Good:**
226
-
227
- ```markdown
228
- 1. Create a PostgreSQL database
229
- 2. Run migrations: `npm run migrate`
230
- 3. Seed initial data: `npm run seed`
231
- ```
232
-
233
- ---
234
-
235
- ## Optional Components
236
-
237
- ### Scripts Directory
238
-
239
- If your skill needs helper scripts:
240
-
241
- ```
242
- scripts/
243
- ├── setup.sh ← Setup automation
244
- ├── validate.py ← Validation tools
245
- └── generate.js ← Code generators
246
- ```
247
-
248
- **Reference them in SKILL.md:**
249
-
250
- ```markdown
251
- Run the setup script:
252
- \`\`\`bash
253
- bash scripts/setup.sh
254
- \`\`\`
255
- ```
256
-
257
- ### Examples Directory
258
-
259
- Real-world examples that demonstrate the skill:
260
-
261
- ```
262
- examples/
263
- ├── basic-usage.js
264
- ├── advanced-pattern.ts
265
- └── full-implementation/
266
- ├── index.js
267
- └── config.json
268
- ```
269
-
270
- ### Templates Directory
271
-
272
- Reusable code templates:
273
-
274
- ```
275
- templates/
276
- ├── component.tsx
277
- ├── test.spec.ts
278
- └── config.json
279
- ```
280
-
281
- **Reference in SKILL.md:**
282
-
283
- ```markdown
284
- Use this template as a starting point:
285
- \`\`\`typescript
286
- {{#include templates/component.tsx}}
287
- \`\`\`
288
- ```
289
-
290
- ### References Directory
291
-
292
- External documentation or API references:
293
-
294
- ```
295
- references/
296
- ├── api-docs.md
297
- ├── best-practices.md
298
- └── troubleshooting.md
299
- ```
300
-
301
- ---
302
-
303
- ## Skill Size Guidelines
304
-
305
- ### Minimum Viable Skill
306
-
307
- - **Frontmatter:** name + description
308
- - **Content:** 100-200 words
309
- - **Sections:** Overview + Instructions
310
-
311
- ### Standard Skill
312
-
313
- - **Frontmatter:** name + description
314
- - **Content:** 300-800 words
315
- - **Sections:** Overview + When to Use + Instructions + Examples
316
-
317
- ### Comprehensive Skill
318
-
319
- - **Frontmatter:** name + description + optional fields
320
- - **Content:** 800-2000 words
321
- - **Sections:** All recommended sections
322
- - **Extras:** Scripts, examples, templates
323
-
324
- **Rule of thumb:** Start small, expand based on feedback
325
-
326
- ---
327
-
328
- ## Formatting Best Practices
329
-
330
- ### Use Markdown Effectively
331
-
332
- #### Code Blocks
333
-
334
- Always specify the language:
335
-
336
- ```markdown
337
- \`\`\`javascript
338
- const example = "code";
339
- \`\`\`
340
- ```
341
-
342
- #### Lists
343
-
344
- Use consistent formatting:
345
-
346
- ```markdown
347
- - Item 1
348
- - Item 2
349
- - Sub-item 2.1
350
- - Sub-item 2.2
351
- ```
352
-
353
- #### Emphasis
354
-
355
- - **Bold** for important terms: `**important**`
356
- - _Italic_ for emphasis: `*emphasis*`
357
- - `Code` for commands/code: `` `code` ``
358
-
359
- #### Links
360
-
361
- ```markdown
362
- [Link text](https://example.com)
363
- ```
364
-
365
- ---
366
-
367
- ## ✅ Quality Checklist
368
-
369
- Before finalizing your skill:
370
-
371
- ### Content Quality
372
-
373
- - [ ] Instructions are clear and actionable
374
- - [ ] Examples are realistic and helpful
375
- - [ ] No typos or grammar errors
376
- - [ ] Technical accuracy verified
377
-
378
- ### Structure
379
-
380
- - [ ] Frontmatter is valid YAML
381
- - [ ] Name matches folder name
382
- - [ ] Sections are logically organized
383
- - [ ] Headings follow hierarchy (H1 → H2 → H3)
384
-
385
- ### Completeness
386
-
387
- - [ ] Overview explains the "why"
388
- - [ ] Instructions explain the "how"
389
- - [ ] Examples show the "what"
390
- - [ ] Edge cases are addressed
391
-
392
- ### Usability
393
-
394
- - [ ] A beginner could follow this
395
- - [ ] An expert would find it useful
396
- - [ ] The AI can parse it correctly
397
- - [ ] It solves a real problem
398
-
399
- ---
400
-
401
- ## 🔍 Real-World Example Analysis
402
-
403
- Let's analyze a real skill: `brainstorming`
404
-
405
- ```markdown
406
- ---
407
- name: brainstorming
408
- description: "You MUST use this before any creative work..."
409
- ---
410
- ```
411
-
412
- **Analysis:**
413
-
414
- - ✅ Clear name
415
- - ✅ Strong description with urgency ("MUST use")
416
- - ✅ Explains when to use it
417
-
418
- ```markdown
419
- # Brainstorming Ideas Into Designs
420
-
421
- ## Overview
422
-
423
- Help turn ideas into fully formed designs...
424
- ```
425
-
426
- **Analysis:**
427
-
428
- - ✅ Clear title
429
- - ✅ Concise overview
430
- - ✅ Explains the value proposition
431
-
432
- ```markdown
433
- ## The Process
434
-
435
- **Understanding the idea:**
436
-
437
- - Check out the current project state first
438
- - Ask questions one at a time
439
- ```
440
-
441
- **Analysis:**
442
-
443
- - ✅ Broken into clear phases
444
- - ✅ Specific, actionable steps
445
- - ✅ Easy to follow
446
-
447
- ---
448
-
449
- ## Advanced Patterns
450
-
451
- ### Conditional Logic
452
-
453
- ```markdown
454
- ## Instructions
455
-
456
- If the user is working with React:
457
-
458
- - Use functional components
459
- - Prefer hooks over class components
460
-
461
- If the user is working with Vue:
462
-
463
- - Use Composition API
464
- - Follow Vue 3 patterns
465
- ```
466
-
467
- ### Progressive Disclosure
468
-
469
- ```markdown
470
- ## Basic Usage
471
-
472
- [Simple instructions for common cases]
473
-
474
- ## Advanced Usage
475
-
476
- [Complex patterns for power users]
477
- ```
478
-
479
- ### Cross-References
480
-
481
- ```markdown
482
- ## Related Workflows
483
-
484
- 1. First, use `@brainstorming` to design
485
- 2. Then, use `@writing-plans` to plan
486
- 3. Finally, use `@test-driven-development` to implement
487
- ```
488
-
489
- ---
490
-
491
- ## Skill Effectiveness Metrics
492
-
493
- How to know if your skill is good:
494
-
495
- ### Clarity Test
496
-
497
- - Can someone unfamiliar with the topic follow it?
498
- - Are there any ambiguous instructions?
499
-
500
- ### Completeness Test
501
-
502
- - Does it cover the happy path?
503
- - Does it handle edge cases?
504
- - Are error scenarios addressed?
505
-
506
- ### Usefulness Test
507
-
508
- - Does it solve a real problem?
509
- - Would you use this yourself?
510
- - Does it save time or improve quality?
511
-
512
- ---
513
-
514
- ## Learning from Existing Skills
515
-
516
- ### Study These Examples
517
-
518
- **For Beginners:**
519
-
520
- - `skills/brainstorming/SKILL.md` - Clear structure
521
- - `skills/git-pushing/SKILL.md` - Simple and focused
522
- - `skills/copywriting/SKILL.md` - Good examples
523
-
524
- **For Advanced:**
525
-
526
- - `skills/systematic-debugging/SKILL.md` - Comprehensive
527
- - `skills/react-best-practices/SKILL.md` - Multiple files
528
- - `skills/loki-mode/SKILL.md` - Complex workflows
529
-
530
- ---
531
-
532
- ## 💡 Pro Tips
533
-
534
- 1. **Start with the "When to Use" section** - This clarifies the skill's purpose
535
- 2. **Write examples first** - They help you understand what you're teaching
536
- 3. **Test with an AI** - See if it actually works before submitting
537
- 4. **Get feedback** - Ask others to review your skill
538
- 5. **Iterate** - Skills improve over time based on usage
539
-
540
- ---
541
-
542
- ## Common Mistakes to Avoid
543
-
544
- ### ❌ Mistake 1: Too Vague
545
-
546
- ```markdown
547
- ## Instructions
548
-
549
- Make the code better.
550
- ```
551
-
552
- **✅ Fix:**
553
-
554
- ```markdown
555
- ## Instructions
556
-
557
- 1. Extract repeated logic into functions
558
- 2. Add error handling for edge cases
559
- 3. Write unit tests for core functionality
560
- ```
561
-
562
- ### ❌ Mistake 2: Too Complex
563
-
564
- ```markdown
565
- ## Instructions
566
-
567
- [5000 words of dense technical jargon]
568
- ```
569
-
570
- **✅ Fix:**
571
- Break into multiple skills or use progressive disclosure
572
-
573
- ### ❌ Mistake 3: No Examples
574
-
575
- ```markdown
576
- ## Instructions
577
-
578
- [Instructions without any code examples]
579
- ```
580
-
581
- **✅ Fix:**
582
- Add at least 2-3 realistic examples
583
-
584
- ### ❌ Mistake 4: Outdated Information
585
-
586
- ```markdown
587
- Use React class components...
588
- ```
589
-
590
- **✅ Fix:**
591
- Keep skills updated with current best practices
592
-
593
- ---
594
-
595
- ## 🎯 Next Steps
596
-
597
- 1. **Read 3-5 existing skills** to see different styles
598
- 2. **Try the skill template** from CONTRIBUTING.md
599
- 3. **Create a simple skill** for something you know well
600
- 4. **Test it** with your AI assistant
601
- 5. **Share it** via Pull Request
602
-
603
- ---
604
-
605
- **Remember:** Every expert was once a beginner. Start simple, learn from feedback, and improve over time! 🚀
@@ -1,21 +0,0 @@
1
- # 📜 Sources & Attributions
2
-
3
- We believe in giving credit where credit is due.
4
- If you recognize your work here and it is not properly attributed, please open an Issue.
5
-
6
- | Skill / Category | Original Source | License | Notes |
7
- | :-------------------------- | :----------------------------------------------------- | :------------- | :---------------------------- |
8
- | `cloud-penetration-testing` | [HackTricks](https://book.hacktricks.xyz/) | MIT / CC-BY-SA | Adapted for agentic use. |
9
- | `active-directory-attacks` | [HackTricks](https://book.hacktricks.xyz/) | MIT / CC-BY-SA | Adapted for agentic use. |
10
- | `owasp-top-10` | [OWASP](https://owasp.org/) | CC-BY-SA | Methodology adapted. |
11
- | `burp-suite-testing` | [PortSwigger](https://portswigger.net/burp) | N/A | Usage guide only (no binary). |
12
- | `crewai` | [CrewAI](https://github.com/joaomdmoura/crewAI) | MIT | Framework guides. |
13
- | `langgraph` | [LangGraph](https://github.com/langchain-ai/langgraph) | MIT | Framework guides. |
14
- | `react-patterns` | [React Docs](https://react.dev/) | CC-BY | Official patterns. |
15
- | **All Official Skills** | [Anthropic / Google / OpenAI] | Proprietary | Usage encouraged by vendors. |
16
-
17
- ## License Policy
18
-
19
- - **Code**: All original code in this repository is **MIT**.
20
- - **Content**: Documentation is **CC-BY-4.0**.
21
- - **Third Party**: We respect the upstream licenses. If an imported skill is GPL, it will be marked clearly or excluded (we aim for MIT/Apache compatibility).