agdex 0.2.0 → 0.3.1

package/README.md

@@ -28,6 +28,41 @@ npm install -D agdex
 npx agdex
 ```
 
+## Configuration
+
+You can configure agdex defaults using either `.agdexrc.json` or the `agdex` field in `package.json`.
+
+### Using .agdexrc.json
+
+Create a `.agdexrc.json` file in your project root:
+
+```json
+{
+  "output": "CLAUDE.md"
+}
+```
+
+### Using package.json
+
+Add an `agdex` field to your `package.json`:
+
+```json
+{
+  "name": "my-project",
+  "agdex": {
+    "output": "CLAUDE.md"
+  }
+}
+```
+
+**Note:** `.agdexrc.json` takes priority over `package.json` if both are present.
+
+### Configuration Options
+
+| Option   | Type   | Default     | Description |
+|----------|--------|-------------|-------------|
+| `output` | string | `CLAUDE.md` | Default output file for indexes |
+
 ## CLI Usage
 
 ### Interactive Mode
@@ -36,7 +71,17 @@ npx agdex
 npx agdex
 ```
 
-Prompts you to select a provider, version, and output file.
+Prompts you with options to:
+- Use a detected provider (if one is found in your project)
+- Select a built-in provider
+- Enter a GitHub repository URL or `owner/repo`
+- Index a local directory
+- Index Claude Code skills
+
+When entering a GitHub URL, you can use various formats:
+- `owner/repo` - indexes the detected docs directory
+- `https://github.com/owner/repo` - same as above
+- `https://github.com/owner/repo/tree/main/docs` - indexes a specific path
 
 ### Built-in Providers
 
@@ -58,6 +103,18 @@ npx agdex --provider pixi --fw-version 0.63.2 --output AGENTS.md
 
 # Bun (auto-detects from bun.lockb or bunfig.toml)
 npx agdex --provider bun --output AGENTS.md
+
+# Add custom description to the index
+npx agdex --provider nextjs --description "Project uses App Router only"
+```
+
+**Options:**
+```bash
+-p, --provider <name>     Documentation provider (nextjs, react, etc.)
+--fw-version <version>    Framework version (auto-detected if not provided)
+-o, --output <file>       Target file (default: from config or CLAUDE.md)
+-d, --description <text>  Additional description to include in the index
+-g, --global              Store docs in global cache (~/.cache/agdex/)
 ```
 
 ### Custom GitHub Repository
@@ -74,6 +131,48 @@ Build an index from an existing local docs directory:
 npx agdex local ./docs --name "My Framework" --output AGENTS.md
 ```
 
+### Skills Indexing
+
+Index Claude Code skills from your `.claude` directories and enabled plugins:
+
+```bash
+# Index skills (auto-detects from all sources)
+npx agdex skills embed
+
+# List discovered skills
+npx agdex skills list
+
+# Index from a specific local path
+npx agdex skills local ./my-skills --name "My Skills"
+```
+
+**Auto-detection sources:**
+- **Enabled plugins** - Reads `~/.claude/settings.json` and `.claude/settings.json` to find enabled plugins, then indexes their skills from the plugin cache
+- **User skills** - `~/.claude/skills` (shared across projects)
+- **Project skills** - `.claude/skills` (project-specific)
+
+**Options:**
+```bash
+--plugins       Include enabled plugins from settings.json (default: true)
+--no-plugins    Exclude enabled plugins
+--user          Include ~/.claude/skills (default: true)
+--no-user       Exclude ~/.claude/skills
+--project       Include .claude/skills (default: true)
+--no-project    Exclude .claude/skills
+--plugin <path> Additional plugin repo paths (with plugins/ structure)
+-o, --output    Target file (default: AGENTS.md)
+```
+
+Skills are discovered by looking for `SKILL.md` files with YAML frontmatter:
+```yaml
+---
+name: My Skill
+description: What this skill does
+---
+```
+
+The index includes skill names, descriptions, and all sibling files (recursively).
+
 ### List Available Providers
 
 ```bash
@@ -164,8 +263,15 @@ This format:
 | Tauri          | ✓      | tauri-apps/tauri-docs |
 | conda-forge    | ✓      | conda-forge/conda-forge.github.io |
 | Bun            | ✓      | oven-sh/bun |
+| Svelte         | ✓      | sveltejs/svelte |
+| Tailwind CSS   | ✓      | tailwindlabs/tailwindcss.com |
+| Ruff           | ✓      | astral-sh/ruff |
+| ty             | ✓      | astral-sh/ty |
+| basedpyright   | ✓      | DetachHead/basedpyright |
+| Convex         | ✓      | get-convex/convex-backend |
+| Polars         | ✓      | pola-rs/polars |
+| delta-rs       | ✓      | delta-io/delta-rs |
 | Vue            | ○      | Coming soon |
-| Svelte         | ○      | Coming soon |
 | Astro          | ○      | Coming soon |
 
 ## How It Works