agdex 0.3.0 → 0.4.0

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
@@ -77,7 +112,7 @@ npx agdex --provider nextjs --description "Project uses App Router only"
 ```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: AGENTS.md)
+-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/)
 ```
@@ -236,6 +271,10 @@ This format:
 | Convex         | ✓      | get-convex/convex-backend |
 | Polars         | ✓      | pola-rs/polars |
 | delta-rs       | ✓      | delta-io/delta-rs |
+| Obsidian       | ✓      | obsidianmd/obsidian-developer-docs |
+| Obsidian Excalidraw | ✓ | zsviczian/obsidian-excalidraw-plugin |
+| FFmpeg         | ✓      | FFmpeg/FFmpeg |
+| Manim          | ✓      | ManimCommunity/manim |
 | Vue            | ○      | Coming soon |
 | Astro          | ○      | Coming soon |
 

package/dist/cli/index.js

@@ -13,7 +13,9 @@ import {
   deltaRsProvider,
   embed,
   embedSkills,
+  ffmpegProvider,
   generateIndex,
+  getDefaultOutput,
   getDefaultSkillSources,
   getProvider,
   hasExistingIndex,
@@ -21,7 +23,10 @@ import {
   injectIndex,
   isProviderAvailable,
   listProviders,
+  manimProvider,
   nextjsProvider,
+  obsidianExcalidrawProvider,
+  obsidianProvider,
   pixiProvider,
   polarsProvider,
   rattlerBuildProvider,
@@ -32,7 +37,7 @@ import {
   tailwindProvider,
   tauriProvider,
   tyProvider
-} from "../index-4shp3mqh.js";
+} from "../index-pkx4s2ef.js";
 
 // node_modules/commander/lib/error.js
 var require_error = __commonJS((exports) => {
@@ -6937,7 +6942,7 @@ async function runEmbed(options) {
     await executeEmbed(cwd, provider, version, output, options.global, result.description);
     return;
   }
-  output = options.output || "AGENTS.md";
+  output = options.output || getDefaultOutput();
   if (!version && !provider.detectVersion) {
     console.error(import_picocolors.default.red(`Provider ${provider.displayName} requires --version flag since auto-detection is not supported.`));
     process.exit(1);
@@ -6978,7 +6983,7 @@ Downloading ${import_picocolors.default.cyan(provider.displayName)} ${import_pic
   console.log("");
 }
 function autoDetectProvider(cwd) {
-  const providers = [nextjsProvider, pixiProvider, rattlerBuildProvider, tauriProvider, bunProvider, svelteProvider, tailwindProvider, ruffProvider, tyProvider, basedpyrightProvider, convexProvider, polarsProvider, deltaRsProvider];
+  const providers = [nextjsProvider, pixiProvider, rattlerBuildProvider, tauriProvider, bunProvider, svelteProvider, tailwindProvider, ruffProvider, tyProvider, basedpyrightProvider, convexProvider, polarsProvider, deltaRsProvider, obsidianProvider, obsidianExcalidrawProvider, ffmpegProvider, manimProvider];
   for (const provider of providers) {
     if (provider.detectVersion) {
       const result = provider.detectVersion(cwd);
@@ -7179,23 +7184,27 @@ agdex - Documentation Index for AI Coding Agents
   };
 }
 async function promptForOutputFile() {
+  const defaultOutput = getDefaultOutput();
+  const choices = [
+    { title: "AGENTS.md", value: "AGENTS.md" },
+    { title: "CLAUDE.md", value: "CLAUDE.md" },
+    { title: "Custom...", value: "__custom__" }
+  ];
+  const defaultIndex = choices.findIndex((c) => c.value === defaultOutput);
+  const initial = defaultIndex >= 0 ? defaultIndex : 0;
   const response = await import_prompts.default({
     type: "select",
     name: "output",
     message: "Target file",
-    choices: [
-      { title: "AGENTS.md", value: "AGENTS.md" },
-      { title: "CLAUDE.md", value: "CLAUDE.md" },
-      { title: "Custom...", value: "__custom__" }
-    ],
-    initial: 0
+    choices,
+    initial
   }, { onCancel });
   if (response.output === "__custom__") {
     const customOutput = await import_prompts.default({
       type: "text",
       name: "file",
       message: "Custom file path",
-      initial: "AGENTS.md",
+      initial: defaultOutput,
       validate: (v) => v.trim() ? true : "Please enter a file path"
     }, { onCancel });
     return customOutput.file;
@@ -7360,7 +7369,7 @@ async function runLocal(docsPath, options) {
     process.exit(1);
   }
   const name = options.name || path.basename(docsPath);
-  const output = options.output || "AGENTS.md";
+  const output = options.output || getDefaultOutput();
   const extensions = options.extensions?.split(",") || [".md", ".mdx"];
   console.log(`
 Building index from ${import_picocolors.default.cyan(docsPath)}...`);
@@ -7432,12 +7441,12 @@ Sources you can index:
   • Claude Code skills
 
 Run 'agdex' without arguments for interactive mode.`).version("0.2.0");
-program2.command("embed", { isDefault: true }).description("Embed documentation index into AGENTS.md/CLAUDE.md").option("-p, --provider <name>", "Documentation provider (nextjs, react, etc.)").option("--fw-version <version>", "Framework version (auto-detected if not provided)").option("-o, --output <file>", "Target file (default: AGENTS.md)").option("--repo <owner/repo>", "Custom GitHub repository").option("--docs-path <path>", "Path to docs folder in repository").option("-g, --global", "Store docs in global cache (~/.cache/agdex/) instead of local .agdex/").option("-d, --description <text>", "Additional description to include in the index").action(runEmbed);
-program2.command("local <docs-path>").description("Build index from local documentation directory").option("-n, --name <name>", "Display name for the documentation").option("-o, --output <file>", "Target file (default: AGENTS.md)").option("-e, --extensions <exts>", "File extensions to include (comma-separated, default: .md,.mdx)").action(runLocal);
+program2.command("embed", { isDefault: true }).description("Embed documentation index into AGENTS.md/CLAUDE.md").option("-p, --provider <name>", "Documentation provider (nextjs, react, etc.)").option("--fw-version <version>", "Framework version (auto-detected if not provided)").option("-o, --output <file>", "Target file (default: from config or CLAUDE.md)").option("--repo <owner/repo>", "Custom GitHub repository").option("--docs-path <path>", "Path to docs folder in repository").option("-g, --global", "Store docs in global cache (~/.cache/agdex/) instead of local .agdex/").option("-d, --description <text>", "Additional description to include in the index").action(runEmbed);
+program2.command("local <docs-path>").description("Build index from local documentation directory").option("-n, --name <name>", "Display name for the documentation").option("-o, --output <file>", "Target file (default: from config or CLAUDE.md)").option("-e, --extensions <exts>", "File extensions to include (comma-separated, default: .md,.mdx)").action(runLocal);
 program2.command("list").description("List available documentation providers").action(runList);
 function runRemove(options) {
   const cwd = process.cwd();
-  const output = options.output || "AGENTS.md";
+  const output = options.output || getDefaultOutput();
   const targetPath = path.join(cwd, output);
   if (!fs.existsSync(targetPath)) {
     console.error(import_picocolors.default.red(`File not found: ${output}`));
@@ -7477,11 +7486,11 @@ No indices found to remove.
   console.log(import_picocolors.default.gray(`  (${formatSize(sizeBefore)} → ${formatSize(sizeAfter)})`));
   console.log("");
 }
-program2.command("remove").description("Remove embedded indices from AGENTS.md/CLAUDE.md").option("-o, --output <file>", "Target file (default: AGENTS.md)").option("--docs", "Remove only docs index").option("--skills", "Remove only skills index").option("-p, --provider <name>", "Remove only a specific provider's docs index").action(runRemove);
+program2.command("remove").description("Remove embedded indices from AGENTS.md/CLAUDE.md").option("-o, --output <file>", "Target file (default: from config or CLAUDE.md)").option("--docs", "Remove only docs index").option("--skills", "Remove only skills index").option("-p, --provider <name>", "Remove only a specific provider's docs index").action(runRemove);
 var skillsCommand = program2.command("skills").description("Manage Claude Code skills indexing");
 async function runSkillsEmbed(options) {
   const cwd = process.cwd();
-  const output = options.output || "AGENTS.md";
+  const output = options.output || getDefaultOutput();
   const sources = getDefaultSkillSources(cwd, {
     includeUser: options.user !== false,
     includeProject: options.project !== false,
@@ -7561,7 +7570,7 @@ async function runSkillsLocal(skillsPath, options) {
     console.error(import_picocolors.default.red(`Skills directory not found: ${skillsPath}`));
     process.exit(1);
   }
-  const output = options.output || "AGENTS.md";
+  const output = options.output || getDefaultOutput();
   const label = options.name || path.basename(skillsPath);
   const hasPluginsDir = fs.existsSync(path.join(absolutePath, "plugins"));
   const sources = [{
@@ -7582,7 +7591,7 @@ Discovering skills from ${import_picocolors.default.cyan(skillsPath)}...`);
   console.log(`${import_picocolors.default.green("✓")} Indexed ${import_picocolors.default.bold(result.skillCount.toString())} skills`);
   console.log("");
 }
-skillsCommand.command("embed").description("Embed skills index into AGENTS.md").option("-o, --output <file>", "Target file (default: AGENTS.md)").option("--plugin <path...>", "Additional plugin repo paths (with plugins/ structure)").option("--plugins", "Include enabled plugins from settings.json (default: true)").option("--no-plugins", "Exclude enabled plugins from settings.json").option("--user", "Include ~/.claude/skills (default: true)").option("--no-user", "Exclude ~/.claude/skills").option("--project", "Include .claude/skills (default: true)").option("--no-project", "Exclude .claude/skills").action(runSkillsEmbed);
+skillsCommand.command("embed").description("Embed skills index into AGENTS.md").option("-o, --output <file>", "Target file (default: from config or CLAUDE.md)").option("--plugin <path...>", "Additional plugin repo paths (with plugins/ structure)").option("--plugins", "Include enabled plugins from settings.json (default: true)").option("--no-plugins", "Exclude enabled plugins from settings.json").option("--user", "Include ~/.claude/skills (default: true)").option("--no-user", "Exclude ~/.claude/skills").option("--project", "Include .claude/skills (default: true)").option("--no-project", "Exclude .claude/skills").action(runSkillsEmbed);
 skillsCommand.command("list").description("List discovered skills").option("--plugin <path...>", "Additional plugin repo paths (with plugins/ structure)").option("--plugins", "Include enabled plugins from settings.json (default: true)").option("--no-plugins", "Exclude enabled plugins from settings.json").option("--user", "Include ~/.claude/skills (default: true)").option("--no-user", "Exclude ~/.claude/skills").option("--project", "Include .claude/skills (default: true)").option("--no-project", "Exclude .claude/skills").action(runSkillsList);
-skillsCommand.command("local <skills-path>").description("Index skills from a local path").option("-o, --output <file>", "Target file (default: AGENTS.md)").option("-n, --name <name>", "Label for this skill source").action(runSkillsLocal);
+skillsCommand.command("local <skills-path>").description("Index skills from a local path").option("-o, --output <file>", "Target file (default: from config or CLAUDE.md)").option("-n, --name <name>", "Label for this skill source").action(runSkillsLocal);
 program2.parse();