alxx-agent-skill 1.0.0 → 1.0.2
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 +53 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# alxx-agent-skill
|
|
2
|
+
|
|
3
|
+
A CLI tool to scaffold new Agent Skills with a standardized directory structure.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g alxx-agent-skill
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
alxx-agent-skill <skill-name>
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
This creates a new skill directory with the following structure:
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
<skill-name>/
|
|
21
|
+
├── SKILL.md # Skill definition with instructions
|
|
22
|
+
├── README.md # Documentation
|
|
23
|
+
├── scripts/ # Executable scripts
|
|
24
|
+
├── references/ # Reference materials
|
|
25
|
+
└── assets/ # Static assets
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
alxx-agent-skill my-custom-skill
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## SKILL.md
|
|
35
|
+
|
|
36
|
+
The generated `SKILL.md` includes frontmatter metadata and a placeholder for your workflow instructions:
|
|
37
|
+
|
|
38
|
+
```markdown
|
|
39
|
+
---
|
|
40
|
+
name: my-custom-skill
|
|
41
|
+
description: Describe what this skill does.
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
# my-custom-skill
|
|
45
|
+
|
|
46
|
+
## Instructions
|
|
47
|
+
|
|
48
|
+
Replace these instructions with your workflow.
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## License
|
|
52
|
+
|
|
53
|
+
ISC
|