skilldex 0.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.
- package/LICENSE +21 -0
- package/README.md +77 -0
- package/dist/cli/index.js +701 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/index.cjs +510 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +148 -0
- package/dist/index.d.ts +148 -0
- package/dist/index.js +458 -0
- package/dist/index.js.map +1 -0
- package/package.json +74 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Nafis Azizi Riza
|
|
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,77 @@
|
|
|
1
|
+
# skilldex
|
|
2
|
+
|
|
3
|
+
CLI tool that indexes AI agent skills into passive context (AGENTS.md).
|
|
4
|
+
|
|
5
|
+
## Why passive context?
|
|
6
|
+
|
|
7
|
+
Vercel's research found that AI agents achieve **100% pass rate** when skills are included as passive context, compared to **53% with active retrieval** (RAG, tool-based lookup). skilldex manages a compact index of your installed skills directly in your agent context file, so the agent always knows what's available.
|
|
8
|
+
|
|
9
|
+
See [Vercel's "`AGENTS.md` outperforms skills in our agent evals"](https://vercel.com/blog/agents-md-outperforms-skills-in-our-agent-evals) for the full research.
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# Interactive setup (recommended)
|
|
15
|
+
npx skilldex init
|
|
16
|
+
|
|
17
|
+
# Or install globally
|
|
18
|
+
npm install -g skilldex
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Quick start
|
|
22
|
+
|
|
23
|
+
Run `npx skilldex init` in your project root. skilldex will:
|
|
24
|
+
|
|
25
|
+
1. Scan for installed skills (`.agents/skills/`, `.claude/`, `.cursor/`, etc.)
|
|
26
|
+
2. Let you pick which skills to index
|
|
27
|
+
3. Choose target files (AGENTS.md, CLAUDE.md, or custom)
|
|
28
|
+
4. Generate a managed skills index
|
|
29
|
+
|
|
30
|
+
Your target file will include a managed section like this:
|
|
31
|
+
|
|
32
|
+
```markdown
|
|
33
|
+
<!-- skilldex:start (auto-generated, do not edit) -->
|
|
34
|
+
[Skills Index]|IMPORTANT: Prefer retrieval-led reasoning over pre-training-led reasoning for any tasks covered by indexed skills.|[web-design-guidelines]|root:./.cursor/skills/web-design-guidelines|desc:Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "check accessibility", "audit design", "review UX", or "check my site against best practices".
|
|
35
|
+
<!-- skilldex:end -->
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
The index is compact (~tokens) but gives the agent enough context to find and read full skill docs from disk when needed.
|
|
39
|
+
|
|
40
|
+
## Commands
|
|
41
|
+
|
|
42
|
+
| Command | Description |
|
|
43
|
+
|---|---|
|
|
44
|
+
| `skilldex init` | Interactive setup. scan for skills, pick targets, generate index |
|
|
45
|
+
| `skilldex add <name>` | Add a skill to the index |
|
|
46
|
+
| `skilldex remove <name>` | Remove a skill from the index |
|
|
47
|
+
| `skilldex list` | List all indexed skills |
|
|
48
|
+
| `skilldex sync` | Re-scan disk and regenerate index |
|
|
49
|
+
|
|
50
|
+
## How it works
|
|
51
|
+
|
|
52
|
+
skilldex uses a two-part system:
|
|
53
|
+
|
|
54
|
+
1. **Compact index** — A managed section in your agent context file (AGENTS.md, CLAUDE.md, etc.) that lists skill names, paths, and file structure. This is always visible to the agent as passive context.
|
|
55
|
+
|
|
56
|
+
2. **Full docs on disk** — The actual skill files (markdown docs, examples, patterns) stay in their original locations. When the agent needs details, it reads the specific files referenced in the index.
|
|
57
|
+
|
|
58
|
+
The managed section is delimited by `<!-- skilldex:start -->` / `<!-- skilldex:end -->` tags. skilldex only modifies content between these tags — your own content in the file is never touched.
|
|
59
|
+
|
|
60
|
+
### Multi-target support
|
|
61
|
+
|
|
62
|
+
skilldex can write to multiple target files simultaneously. Configure targets in `skilldex.config.json`:
|
|
63
|
+
|
|
64
|
+
```json
|
|
65
|
+
{
|
|
66
|
+
"targets": ["AGENTS.md", "CLAUDE.md"],
|
|
67
|
+
"skills": [...]
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Complementary to Vercel Skills
|
|
72
|
+
|
|
73
|
+
[Vercel's Skills CLI](https://github.com/vercel-labs/skills) (`npx skills`) handles skill **installation**: downloading and organizing skill files from a registry of 35+ agent-compatible skills. skilldex handles skill **indexing**: scanning your installed skills and generating a compact index in your agent's context file. They work great together: install skills with `npx skills`, then index them with `npx skilldex init`.
|
|
74
|
+
|
|
75
|
+
## License
|
|
76
|
+
|
|
77
|
+
[MIT](LICENSE)
|