skai 0.0.1 → 0.0.5
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 +151 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2258 -0
- package/dist/index.js.map +1 -0
- package/package.json +46 -4
- package/index.js +0 -1
package/README.md
CHANGED
|
@@ -1,3 +1,153 @@
|
|
|
1
1
|
# skai
|
|
2
2
|
|
|
3
|
-
The package manager for AI agent skills.
|
|
3
|
+
The package manager for AI agent skills. Install agent skills from Git repositories into your AI coding assistants.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g skai
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Or run directly with npx:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx skai pproenca/dot-skills
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
skai <source> [options]
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### Source Formats
|
|
24
|
+
|
|
25
|
+
- **GitHub shorthand**: `skai pproenca/dot-skills`
|
|
26
|
+
- **Full GitHub URL**: `skai https://github.com/org/repo`
|
|
27
|
+
- **Direct skill path**: `skai https://github.com/org/repo/tree/main/skills/my-skill`
|
|
28
|
+
- **GitLab URL**: `skai https://gitlab.com/org/repo`
|
|
29
|
+
- **Local path**: `skai ./path/to/skills`
|
|
30
|
+
- **Any git URL**: `skai git@github.com:org/repo.git`
|
|
31
|
+
|
|
32
|
+
### Options
|
|
33
|
+
|
|
34
|
+
| Flag | Description |
|
|
35
|
+
|------|-------------|
|
|
36
|
+
| `-g, --global` | Install to user directory instead of project |
|
|
37
|
+
| `-a, --agent <agents...>` | Target specific agents |
|
|
38
|
+
| `-s, --skill <skills...>` | Install specific skills by name |
|
|
39
|
+
| `-l, --list` | List available skills without installing |
|
|
40
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
41
|
+
| `--json` | Output results in JSON format (for CI/scripts) |
|
|
42
|
+
| `-V, --version` | Display version |
|
|
43
|
+
| `-h, --help` | Display help |
|
|
44
|
+
|
|
45
|
+
### Environment Variables
|
|
46
|
+
|
|
47
|
+
| Variable | Description |
|
|
48
|
+
|----------|-------------|
|
|
49
|
+
| `SKAI_PACKAGE_MANAGER` | Override package manager detection (npm, pnpm, yarn, bun) |
|
|
50
|
+
|
|
51
|
+
### Examples
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
# List skills in a repository
|
|
55
|
+
skai pproenca/dot-skills --list
|
|
56
|
+
|
|
57
|
+
# Install all skills to detected agents
|
|
58
|
+
skai pproenca/dot-skills
|
|
59
|
+
|
|
60
|
+
# Install specific skill
|
|
61
|
+
skai pproenca/dot-skills -s web-design-guidelines
|
|
62
|
+
|
|
63
|
+
# Install to specific agent
|
|
64
|
+
skai pproenca/dot-skills -a claude-code
|
|
65
|
+
|
|
66
|
+
# Install globally
|
|
67
|
+
skai pproenca/dot-skills -g
|
|
68
|
+
|
|
69
|
+
# Non-interactive install
|
|
70
|
+
skai pproenca/dot-skills -y
|
|
71
|
+
|
|
72
|
+
# Install from local directory
|
|
73
|
+
skai ./my-skills -a cursor -g
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Supported Agents
|
|
77
|
+
|
|
78
|
+
skai supports 14 AI coding assistants:
|
|
79
|
+
|
|
80
|
+
| Agent | Project Path | Global Path |
|
|
81
|
+
|-------|--------------|-------------|
|
|
82
|
+
| OpenCode | `.opencode/skill/` | `~/.config/opencode/skill/` |
|
|
83
|
+
| Claude Code | `.claude/skills/` | `~/.claude/skills/` |
|
|
84
|
+
| Codex | `.codex/skills/` | `~/.codex/skills/` |
|
|
85
|
+
| Cursor | `.cursor/skills/` | `~/.cursor/skills/` |
|
|
86
|
+
| Amp | `.agents/skills/` | `~/.config/agents/skills/` |
|
|
87
|
+
| Kilo Code | `.kilocode/skills/` | `~/.kilocode/skills/` |
|
|
88
|
+
| Roo Code | `.roo/skills/` | `~/.roo/skills/` |
|
|
89
|
+
| Goose | `.goose/skills/` | `~/.config/goose/skills/` |
|
|
90
|
+
| Gemini CLI | `.gemini/skills/` | `~/.gemini/skills/` |
|
|
91
|
+
| Antigravity | `.agent/skills/` | `~/.gemini/antigravity/skills/` |
|
|
92
|
+
| GitHub Copilot | `.github/skills/` | `~/.copilot/skills/` |
|
|
93
|
+
| Clawdbot | `skills/` | `~/.clawdbot/skills/` |
|
|
94
|
+
| Droid | `.factory/skills/` | `~/.factory/skills/` |
|
|
95
|
+
| Windsurf | `.windsurf/skills/` | `~/.codeium/windsurf/skills/` |
|
|
96
|
+
|
|
97
|
+
## Creating Skills
|
|
98
|
+
|
|
99
|
+
Skills are directories containing a `SKILL.md` file with YAML frontmatter:
|
|
100
|
+
|
|
101
|
+
```markdown
|
|
102
|
+
---
|
|
103
|
+
name: my-skill
|
|
104
|
+
description: Brief explanation of what this skill does
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
# Skill Content
|
|
108
|
+
|
|
109
|
+
Instructions and implementation details...
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Skill Dependencies
|
|
113
|
+
|
|
114
|
+
Skills can declare npm dependencies in a `package.json` file. When installing skills with dependencies, skai will:
|
|
115
|
+
|
|
116
|
+
1. Detect dependencies from each skill's `package.json`
|
|
117
|
+
2. Prompt you to install them (or auto-install with `-y`)
|
|
118
|
+
3. Use your project's detected package manager (pnpm, npm, yarn, or bun)
|
|
119
|
+
|
|
120
|
+
Example skill with dependencies:
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
my-skill/
|
|
124
|
+
├── SKILL.md
|
|
125
|
+
└── package.json
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
```json
|
|
129
|
+
{
|
|
130
|
+
"name": "my-skill",
|
|
131
|
+
"dependencies": {
|
|
132
|
+
"zod": "^3.0.0",
|
|
133
|
+
"openai": "^4.0.0"
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
Dependencies are installed to your project's `node_modules`, not the skill directory. Only `dependencies` are installed (not `devDependencies`).
|
|
139
|
+
|
|
140
|
+
### Repository Structure
|
|
141
|
+
|
|
142
|
+
Skills are discovered in these priority locations:
|
|
143
|
+
|
|
144
|
+
1. Repository root
|
|
145
|
+
2. `skills/`
|
|
146
|
+
3. `skills/.curated/`, `skills/.experimental/`, `skills/.system/`
|
|
147
|
+
4. Agent-specific directories (`.claude/skills/`, `.cursor/skills/`, etc.)
|
|
148
|
+
|
|
149
|
+
If no skills are found in priority directories, skai performs a recursive search (up to depth 5).
|
|
150
|
+
|
|
151
|
+
## License
|
|
152
|
+
|
|
153
|
+
MIT
|
package/dist/index.d.ts
ADDED