skillkit 1.1.0 → 1.3.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.
package/README.md DELETED
@@ -1,350 +0,0 @@
1
- # SkillKit
2
-
3
- [![npm version](https://img.shields.io/npm/v/skillkit.svg)](https://www.npmjs.com/package/skillkit)
4
- [![npm downloads](https://img.shields.io/npm/dm/skillkit.svg)](https://www.npmjs.com/package/skillkit)
5
- [![CI](https://github.com/rohitg00/skillkit/actions/workflows/ci.yml/badge.svg)](https://github.com/rohitg00/skillkit/actions/workflows/ci.yml)
6
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
-
8
- Universal skills loader for AI coding agents. Install, manage, and sync skills across your favorite AI tools.
9
-
10
- Skills follow the [Agent Skills](https://agentskills.io) open format—a simple, portable standard for giving agents new capabilities and expertise.
11
-
12
- ![SkillKit Demo](https://raw.githubusercontent.com/rohitg00/skillkit/main/skillkit.gif)
13
-
14
- ### Compatible With
15
-
16
- | Agent | Status |
17
- |-------|--------|
18
- | Claude Code | ✅ Native |
19
- | OpenAI Codex | ✅ Native |
20
- | Cursor | ✅ Native |
21
- | Gemini CLI | ✅ Native |
22
- | OpenCode | ✅ Native |
23
- | Antigravity | ✅ Native |
24
- | Amp | ✅ Native |
25
- | Clawdbot | ✅ Native |
26
- | Droid (Factory) | ✅ Native |
27
- | GitHub Copilot | ✅ Native |
28
- | Goose | ✅ Native |
29
- | Kilo Code | ✅ Native |
30
- | Kiro CLI | ✅ Native |
31
- | Roo Code | ✅ Native |
32
- | Trae | ✅ Native |
33
- | Windsurf | ✅ Native |
34
- | *Any markdown-config agent* | ✅ Universal |
35
-
36
- ## Features
37
-
38
- - **Multi-Agent Support**: Works with 17+ AI coding agents out of the box
39
- - **Multi-Platform Git**: GitHub, GitLab, Bitbucket, and local paths
40
- - **CI/CD Friendly**: Non-interactive flags for automation (`--skills`, `--all`, `--yes`)
41
- - **Skill Toggle**: Enable/disable skills without removing them
42
- - **Type-Safe**: Built with TypeScript and Zod validation
43
- - **Zero Config**: Auto-detects your agent and configures appropriately
44
-
45
- ## Installation
46
-
47
- ```bash
48
- npm install -g skillkit
49
- # or
50
- npx skillkit <command>
51
- ```
52
-
53
- ## Quick Start
54
-
55
- ```bash
56
- # Initialize in your project (auto-detects agent)
57
- skillkit init
58
-
59
- # Install skills from GitHub
60
- skillkit install owner/repo
61
-
62
- # Install from GitLab
63
- skillkit install gitlab:owner/repo
64
-
65
- # Install specific skills (CI/CD friendly)
66
- skillkit install owner/repo --skills=pdf,xlsx,docx
67
-
68
- # Create a new skill
69
- skillkit create my-skill
70
-
71
- # Sync skills to your agent config
72
- skillkit sync
73
-
74
- # Read a skill (for AI consumption)
75
- skillkit read pdf
76
- ```
77
-
78
- ## Popular Skill Repositories
79
-
80
- Install skills from these community repositories:
81
-
82
- ```bash
83
- # Anthropic's official skill marketplace
84
- skillkit install anthropics/skills
85
-
86
- # Vercel's React & Next.js best practices
87
- skillkit install vercel-labs/agent-skills/skills
88
- ```
89
-
90
- | Repository | Skills | Description |
91
- |------------|--------|-------------|
92
- | [anthropics/skills](https://github.com/anthropics/skills) | `pdf`, `xlsx`, `docx`, etc. | Official Claude Code skill marketplace |
93
- | [vercel-labs/agent-skills](https://github.com/vercel-labs/agent-skills) | `vercel-react-best-practices`, `web-design-guidelines` | React/Next.js optimization & UI review |
94
-
95
-
96
- ## Commands
97
-
98
- ### `skillkit install <source>`
99
-
100
- Install skills from various sources.
101
-
102
- ```bash
103
- # GitHub (default)
104
- skillkit install owner/repo
105
- skillkit install https://github.com/owner/repo
106
-
107
- # Install from a subdirectory
108
- skillkit install owner/repo/skills
109
-
110
- # GitLab
111
- skillkit install gitlab:owner/repo
112
- skillkit install https://gitlab.com/owner/repo
113
-
114
- # Bitbucket
115
- skillkit install bitbucket:owner/repo
116
-
117
- # Local path
118
- skillkit install ./my-skills
119
- skillkit install ~/dev/skills
120
-
121
- # Options
122
- --list # List available skills without installing
123
- --skills=pdf,xlsx # Install specific skills only (CI/CD)
124
- --all # Install all discovered skills
125
- --yes # Skip confirmation prompts
126
- --global # Install to global directory
127
- --force # Overwrite existing skills
128
- --provider=gitlab # Force specific provider
129
- --agent=cursor # Install to specific agent (can specify multiple)
130
- ```
131
-
132
- ### `skillkit sync`
133
-
134
- Sync installed skills to your agent's config file.
135
-
136
- ```bash
137
- skillkit sync
138
- skillkit sync --agent cursor
139
- skillkit sync --output AGENTS.md
140
- skillkit sync --enabled-only
141
- ```
142
-
143
- ### `skillkit read <skills>`
144
-
145
- Read skill content for AI agent consumption.
146
-
147
- ```bash
148
- skillkit read pdf
149
- skillkit read pdf,xlsx,docx # Multiple skills
150
- ```
151
-
152
- ### `skillkit list`
153
-
154
- List all installed skills.
155
-
156
- ```bash
157
- skillkit list
158
- skillkit list --enabled
159
- skillkit list --json
160
- ```
161
-
162
- ### `skillkit enable/disable <skills>`
163
-
164
- Toggle skills on/off without removing them.
165
-
166
- ```bash
167
- skillkit enable pdf xlsx
168
- skillkit disable docx
169
- ```
170
-
171
- ### `skillkit update [skills]`
172
-
173
- Update skills from their original sources.
174
-
175
- ```bash
176
- skillkit update # Update all
177
- skillkit update pdf xlsx # Update specific
178
- ```
179
-
180
- ### `skillkit remove <skills>`
181
-
182
- Remove installed skills.
183
-
184
- ```bash
185
- skillkit remove pdf xlsx
186
- ```
187
-
188
- ### `skillkit init`
189
-
190
- Initialize skillkit in a project.
191
-
192
- ```bash
193
- skillkit init
194
- skillkit init --agent cursor
195
- skillkit init --list # List supported agents
196
- ```
197
-
198
- ### `skillkit validate <path>`
199
-
200
- Validate skills against the [Agent Skills specification](https://agentskills.io/specification).
201
-
202
- ```bash
203
- skillkit validate ./my-skill # Validate single skill
204
- skillkit validate ./skills --all # Validate all skills in directory
205
- ```
206
-
207
- ### `skillkit create <skill-name>`
208
-
209
- Create a new skill with proper structure and template.
210
-
211
- ```bash
212
- skillkit create my-skill # Basic skill
213
- skillkit create my-skill --full # Include all directories (references, scripts, assets)
214
- skillkit create my-skill --scripts # Include scripts directory
215
- skillkit create my-skill --references # Include references directory
216
- skillkit create my-skill --assets # Include assets directory
217
- skillkit create my-skill --dir ./skills # Create in specific directory
218
- ```
219
-
220
- ## Supported Agents
221
-
222
- | Agent | Config File | Project Path | Global Path |
223
- |-------|-------------|--------------|-------------|
224
- | Claude Code | `AGENTS.md` | `.claude/skills/` | `~/.claude/skills/` |
225
- | Cursor | `.cursorrules` | `.cursor/skills/` | `~/.cursor/skills/` |
226
- | Codex | `AGENTS.md` | `.codex/skills/` | `~/.codex/skills/` |
227
- | Gemini CLI | `GEMINI.md` | `.gemini/skills/` | `~/.gemini/skills/` |
228
- | OpenCode | `AGENTS.md` | `.opencode/skills/` | `~/.config/opencode/skills/` |
229
- | Antigravity | `AGENTS.md` | `.antigravity/skills/` | `~/.gemini/antigravity/skills/` |
230
- | Amp | `AGENTS.md` | `.agents/skills/` | `~/.config/agents/skills/` |
231
- | Clawdbot | `AGENTS.md` | `skills/` | `~/.clawdbot/skills/` |
232
- | Droid (Factory) | `AGENTS.md` | `.factory/skills/` | `~/.factory/skills/` |
233
- | GitHub Copilot | `AGENTS.md` | `.github/skills/` | `~/.copilot/skills/` |
234
- | Goose | `AGENTS.md` | `.goose/skills/` | `~/.config/goose/skills/` |
235
- | Kilo Code | `AGENTS.md` | `.kilocode/skills/` | `~/.kilocode/skills/` |
236
- | Kiro CLI | `AGENTS.md` | `.kiro/skills/` | `~/.kiro/skills/` |
237
- | Roo Code | `AGENTS.md` | `.roo/skills/` | `~/.roo/skills/` |
238
- | Trae | `AGENTS.md` | `.trae/skills/` | `~/.trae/skills/` |
239
- | Windsurf | `AGENTS.md` | `.windsurf/skills/` | `~/.codeium/windsurf/skills/` |
240
- | Universal | `AGENTS.md` | `.agent/skills/` | `~/.agent/skills/` |
241
-
242
- ## Creating Skills
243
-
244
- Use `skillkit create <name>` to scaffold a new skill, or create manually:
245
-
246
- A skill is a directory with a `SKILL.md` file:
247
-
248
- ```
249
- my-skill/
250
- ├── SKILL.md # Required: Instructions for the AI
251
- ├── references/ # Optional: Documentation
252
- ├── scripts/ # Optional: Helper scripts
253
- └── assets/ # Optional: Templates, configs
254
- ```
255
-
256
- ### SKILL.md Format
257
-
258
- Follows the [Agent Skills specification](https://agentskills.io/specification):
259
-
260
- ```markdown
261
- ---
262
- name: my-skill
263
- description: What this skill does and when to use it. Include trigger keywords.
264
- license: MIT
265
- compatibility: Requires Node.js 18+
266
- metadata:
267
- author: your-org
268
- version: "1.0"
269
- ---
270
-
271
- # My Skill
272
-
273
- Instructions for the AI agent on how to use this skill.
274
-
275
- ## When to Use
276
-
277
- - Scenario 1
278
- - Scenario 2
279
-
280
- ## Steps
281
-
282
- 1. First step
283
- 2. Second step
284
- ```
285
-
286
- | Field | Required | Description |
287
- |-------|----------|-------------|
288
- | `name` | Yes | Lowercase alphanumeric with hyphens (max 64 chars) |
289
- | `description` | Yes | What it does and when to use it (max 1024 chars) |
290
- | `license` | No | License name or reference |
291
- | `compatibility` | No | Environment requirements |
292
- | `metadata` | No | Arbitrary key-value pairs |
293
-
294
- ## CI/CD Usage
295
-
296
- ```yaml
297
- # GitHub Actions example
298
- - name: Setup skills
299
- run: |
300
- npx skillkit install owner/skills --skills=lint,test,deploy --yes
301
- npx skillkit sync --yes
302
- ```
303
-
304
- ## Programmatic API
305
-
306
- ```typescript
307
- import {
308
- findAllSkills,
309
- discoverSkills,
310
- detectAgent,
311
- getAdapter,
312
- } from 'skillkit';
313
-
314
- // Find all installed skills
315
- const skills = findAllSkills(searchDirs);
316
-
317
- // Detect current agent
318
- const agent = await detectAgent();
319
-
320
- // Generate config
321
- const adapter = getAdapter(agent);
322
- const config = adapter.generateConfig(skills);
323
- ```
324
-
325
- ## Configuration
326
-
327
- Create `skillkit.yaml` in your project:
328
-
329
- ```yaml
330
- version: 1
331
- agent: cursor # Override auto-detection
332
- autoSync: true # Auto-sync on changes
333
- enabledSkills:
334
- - pdf
335
- - xlsx
336
- disabledSkills:
337
- - deprecated-skill
338
- ```
339
-
340
- ## License
341
-
342
- MIT License - see [LICENSE](LICENSE) for details.
343
-
344
- ## Contributing
345
-
346
- Contributions welcome! Please read our contributing guidelines.
347
-
348
- ## Acknowledgments
349
-
350
- Implements the [Agent Skills](https://agentskills.io) open format, originally developed by Anthropic and adopted by leading AI development tools.
@@ -1,62 +0,0 @@
1
- {
2
- "$schema": "http://json-schema.org/draft-07/schema#",
3
- "$id": "https://skillkit.dev/schemas/skill.schema.json",
4
- "title": "Skill Frontmatter",
5
- "description": "Schema for SKILL.md frontmatter validation (follows Agent Skills spec: https://agentskills.io/specification)",
6
- "type": "object",
7
- "required": ["name", "description"],
8
- "properties": {
9
- "name": {
10
- "type": "string",
11
- "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$",
12
- "minLength": 1,
13
- "maxLength": 64,
14
- "description": "Unique skill identifier. Lowercase alphanumeric with hyphens, no leading/trailing/consecutive hyphens."
15
- },
16
- "description": {
17
- "type": "string",
18
- "minLength": 1,
19
- "maxLength": 1024,
20
- "description": "What the skill does and when to use it."
21
- },
22
- "license": {
23
- "type": "string",
24
- "description": "License name or reference to bundled license file."
25
- },
26
- "compatibility": {
27
- "type": "string",
28
- "maxLength": 500,
29
- "description": "Environment requirements (intended product, system packages, network access, etc.)."
30
- },
31
- "metadata": {
32
- "type": "object",
33
- "additionalProperties": { "type": "string" },
34
- "description": "Arbitrary key-value mapping for additional metadata."
35
- },
36
- "allowed-tools": {
37
- "type": "string",
38
- "description": "Space-delimited list of pre-approved tools the skill may use (experimental)."
39
- },
40
- "version": {
41
- "type": "string",
42
- "description": "Semantic version (e.g., 1.0.0)"
43
- },
44
- "author": {
45
- "type": "string",
46
- "description": "Skill author name or organization"
47
- },
48
- "tags": {
49
- "type": "array",
50
- "items": { "type": "string" },
51
- "description": "Categorization tags"
52
- },
53
- "agents": {
54
- "type": "array",
55
- "items": {
56
- "type": "string",
57
- "enum": ["claude-code", "codex", "cursor", "antigravity", "opencode", "gemini-cli", "universal"]
58
- },
59
- "description": "Compatible AI agents (empty = all agents)"
60
- }
61
- }
62
- }