agdex 0.2.0 → 0.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 +73 -2
- package/dist/cli/index.js +380 -83
- package/dist/index-4shp3mqh.js +1871 -0
- package/dist/index-57bfejpe.js +1357 -0
- package/dist/index-5h59833k.js +1270 -0
- package/dist/index-9gy9s47s.js +1366 -0
- package/dist/index-p0xjkwcp.js +1283 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -1
- package/dist/lib/agents-md.d.ts.map +1 -1
- package/dist/lib/providers/basedpyright.d.ts +3 -0
- package/dist/lib/providers/basedpyright.d.ts.map +1 -0
- package/dist/lib/providers/convex.d.ts +3 -0
- package/dist/lib/providers/convex.d.ts.map +1 -0
- package/dist/lib/providers/delta-rs.d.ts +3 -0
- package/dist/lib/providers/delta-rs.d.ts.map +1 -0
- package/dist/lib/providers/index.d.ts +8 -0
- package/dist/lib/providers/index.d.ts.map +1 -1
- package/dist/lib/providers/polars.d.ts +3 -0
- package/dist/lib/providers/polars.d.ts.map +1 -0
- package/dist/lib/providers/ruff.d.ts +3 -0
- package/dist/lib/providers/ruff.d.ts.map +1 -0
- package/dist/lib/providers/svelte.d.ts +3 -0
- package/dist/lib/providers/svelte.d.ts.map +1 -0
- package/dist/lib/providers/tailwind.d.ts +3 -0
- package/dist/lib/providers/tailwind.d.ts.map +1 -0
- package/dist/lib/providers/ty.d.ts +3 -0
- package/dist/lib/providers/ty.d.ts.map +1 -0
- package/dist/lib/skills.d.ts +5 -0
- package/dist/lib/skills.d.ts.map +1 -1
- package/dist/lib/types.d.ts +5 -1
- package/dist/lib/types.d.ts.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -36,7 +36,17 @@ npx agdex
|
|
|
36
36
|
npx agdex
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
Prompts you
|
|
39
|
+
Prompts you with options to:
|
|
40
|
+
- Use a detected provider (if one is found in your project)
|
|
41
|
+
- Select a built-in provider
|
|
42
|
+
- Enter a GitHub repository URL or `owner/repo`
|
|
43
|
+
- Index a local directory
|
|
44
|
+
- Index Claude Code skills
|
|
45
|
+
|
|
46
|
+
When entering a GitHub URL, you can use various formats:
|
|
47
|
+
- `owner/repo` - indexes the detected docs directory
|
|
48
|
+
- `https://github.com/owner/repo` - same as above
|
|
49
|
+
- `https://github.com/owner/repo/tree/main/docs` - indexes a specific path
|
|
40
50
|
|
|
41
51
|
### Built-in Providers
|
|
42
52
|
|
|
@@ -58,6 +68,18 @@ npx agdex --provider pixi --fw-version 0.63.2 --output AGENTS.md
|
|
|
58
68
|
|
|
59
69
|
# Bun (auto-detects from bun.lockb or bunfig.toml)
|
|
60
70
|
npx agdex --provider bun --output AGENTS.md
|
|
71
|
+
|
|
72
|
+
# Add custom description to the index
|
|
73
|
+
npx agdex --provider nextjs --description "Project uses App Router only"
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
**Options:**
|
|
77
|
+
```bash
|
|
78
|
+
-p, --provider <name> Documentation provider (nextjs, react, etc.)
|
|
79
|
+
--fw-version <version> Framework version (auto-detected if not provided)
|
|
80
|
+
-o, --output <file> Target file (default: AGENTS.md)
|
|
81
|
+
-d, --description <text> Additional description to include in the index
|
|
82
|
+
-g, --global Store docs in global cache (~/.cache/agdex/)
|
|
61
83
|
```
|
|
62
84
|
|
|
63
85
|
### Custom GitHub Repository
|
|
@@ -74,6 +96,48 @@ Build an index from an existing local docs directory:
|
|
|
74
96
|
npx agdex local ./docs --name "My Framework" --output AGENTS.md
|
|
75
97
|
```
|
|
76
98
|
|
|
99
|
+
### Skills Indexing
|
|
100
|
+
|
|
101
|
+
Index Claude Code skills from your `.claude` directories and enabled plugins:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
# Index skills (auto-detects from all sources)
|
|
105
|
+
npx agdex skills embed
|
|
106
|
+
|
|
107
|
+
# List discovered skills
|
|
108
|
+
npx agdex skills list
|
|
109
|
+
|
|
110
|
+
# Index from a specific local path
|
|
111
|
+
npx agdex skills local ./my-skills --name "My Skills"
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
**Auto-detection sources:**
|
|
115
|
+
- **Enabled plugins** - Reads `~/.claude/settings.json` and `.claude/settings.json` to find enabled plugins, then indexes their skills from the plugin cache
|
|
116
|
+
- **User skills** - `~/.claude/skills` (shared across projects)
|
|
117
|
+
- **Project skills** - `.claude/skills` (project-specific)
|
|
118
|
+
|
|
119
|
+
**Options:**
|
|
120
|
+
```bash
|
|
121
|
+
--plugins Include enabled plugins from settings.json (default: true)
|
|
122
|
+
--no-plugins Exclude enabled plugins
|
|
123
|
+
--user Include ~/.claude/skills (default: true)
|
|
124
|
+
--no-user Exclude ~/.claude/skills
|
|
125
|
+
--project Include .claude/skills (default: true)
|
|
126
|
+
--no-project Exclude .claude/skills
|
|
127
|
+
--plugin <path> Additional plugin repo paths (with plugins/ structure)
|
|
128
|
+
-o, --output Target file (default: AGENTS.md)
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
Skills are discovered by looking for `SKILL.md` files with YAML frontmatter:
|
|
132
|
+
```yaml
|
|
133
|
+
---
|
|
134
|
+
name: My Skill
|
|
135
|
+
description: What this skill does
|
|
136
|
+
---
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
The index includes skill names, descriptions, and all sibling files (recursively).
|
|
140
|
+
|
|
77
141
|
### List Available Providers
|
|
78
142
|
|
|
79
143
|
```bash
|
|
@@ -164,8 +228,15 @@ This format:
|
|
|
164
228
|
| Tauri | ✓ | tauri-apps/tauri-docs |
|
|
165
229
|
| conda-forge | ✓ | conda-forge/conda-forge.github.io |
|
|
166
230
|
| Bun | ✓ | oven-sh/bun |
|
|
231
|
+
| Svelte | ✓ | sveltejs/svelte |
|
|
232
|
+
| Tailwind CSS | ✓ | tailwindlabs/tailwindcss.com |
|
|
233
|
+
| Ruff | ✓ | astral-sh/ruff |
|
|
234
|
+
| ty | ✓ | astral-sh/ty |
|
|
235
|
+
| basedpyright | ✓ | DetachHead/basedpyright |
|
|
236
|
+
| Convex | ✓ | get-convex/convex-backend |
|
|
237
|
+
| Polars | ✓ | pola-rs/polars |
|
|
238
|
+
| delta-rs | ✓ | delta-io/delta-rs |
|
|
167
239
|
| Vue | ○ | Coming soon |
|
|
168
|
-
| Svelte | ○ | Coming soon |
|
|
169
240
|
| Astro | ○ | Coming soon |
|
|
170
241
|
|
|
171
242
|
## How It Works
|