{"_id":"@bydeusz/agent-md-docs","_rev":"9-17316e006200fb4665d4ae05691b5fe9","name":"@bydeusz/agent-md-docs","dist-tags":{"latest":"1.1.0"},"versions":{"0.1.1":{"name":"@bydeusz/agent-md-docs","version":"0.1.1","keywords":["agents","claude","copilot","cursor","docs","documentation","cli","react","nextjs","nestjs","django","fastapi","django-rest-framework","express","agents-md","claude-md"],"license":"MIT","_id":"@bydeusz/agent-md-docs@0.1.1","maintainers":[{"name":"bydeusz","email":"hello@bydeusz.com"}],"bin":{"agent-md-docs":"dist/index.js"},"dist":{"shasum":"d40c7aab9130de9309a1adb73da410ccb21bbf8b","tarball":"https://registry.npmjs.org/@bydeusz/agent-md-docs/-/agent-md-docs-0.1.1.tgz","fileCount":59,"integrity":"sha512-c46qW31svBTwA2JbHvkSc2QwZa2783yd/EiCwQKqDeykzkLcd5K2yXGuKcZOhcr00FfCg/8iGykL5R92ErBgdA==","signatures":[{"sig":"MEQCIHDnjqC4YHxcOF20uBDUy6x09+ZPe1b5A5pRK5iLTcSCAiALmL620YeQQ+e4bNq05sLZz6cXK4e2jTwPAGDwSnzEMA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":67166},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"c1dbaa245163b11b81cd0d11aa82823f03e46f53","scripts":{"build":"tsc","start":"node dist/index.js","prepublishOnly":"npm run build"},"_npmUser":{"name":"bydeusz","email":"hello@bydeusz.com"},"_npmVersion":"11.2.0","description":"A CLI tool that downloads framework documentation and generates a minified docs index for AGENTS.md or CLAUDE.md","directories":{},"_nodeVersion":"22.12.0","dependencies":{"@inquirer/prompts":"^7.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.21.0","typescript":"^5.0.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/agent-md-docs_0.1.1_1770908185744_0.5258347292230718","host":"s3://npm-registry-packages-npm-production"}},"1.0.0":{"name":"@bydeusz/agent-md-docs","version":"1.0.0","keywords":["agents","claude","copilot","cursor","docs","documentation","cli","react","nextjs","nestjs","django","fastapi","django-rest-framework","express","agents-md","claude-md"],"license":"MIT","_id":"@bydeusz/agent-md-docs@1.0.0","maintainers":[{"name":"bydeusz","email":"hello@bydeusz.com"}],"bin":{"agent-md-docs":"dist/index.js"},"dist":{"shasum":"5e7bea845d36e5df415d4114778298d1ec4f745e","tarball":"https://registry.npmjs.org/@bydeusz/agent-md-docs/-/agent-md-docs-1.0.0.tgz","fileCount":79,"integrity":"sha512-vg60dr3mWqTLPGrLaJVFUcH+QHMY7DZyzkAFwgIfWBlTW7zTVcWzTJMjec2q375qYGLOMphun6SY5HXYSdetPw==","signatures":[{"sig":"MEYCIQDtmWt+NB/DVIylOfgw1xSiArmmOHrdE9Mp7LTA0MxhxwIhAON99oTF9F6JICLcGajMUCecsWNbzeme0A3Rqqu5poNd","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":75721},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"e1cd5bcbba1aefab635f0381dbd9800c0485f2a5","scripts":{"build":"tsc","start":"npm run build && node dist/index.js","publish":"npm run build && npm publish","prepublishOnly":"npm run build"},"_npmUser":{"name":"bydeusz","email":"hello@bydeusz.com"},"_npmVersion":"11.2.0","description":"A CLI tool that downloads framework documentation and generates a minified docs index for AGENTS.md or CLAUDE.md","directories":{},"_nodeVersion":"22.12.0","dependencies":{"@inquirer/prompts":"^7.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.21.0","typescript":"^5.0.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/agent-md-docs_1.0.0_1770971451792_0.7537032491171902","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@bydeusz/agent-md-docs","version":"1.0.1","keywords":["agents","claude","copilot","cursor","docs","documentation","cli","react","nextjs","nestjs","django","fastapi","django-rest-framework","express","agents-md","claude-md"],"license":"MIT","_id":"@bydeusz/agent-md-docs@1.0.1","maintainers":[{"name":"bydeusz","email":"hello@bydeusz.com"}],"bin":{"agent-md-docs":"dist/index.js"},"dist":{"shasum":"27c507cd627d56047e500cb97fcfd9ae91dc9bc4","tarball":"https://registry.npmjs.org/@bydeusz/agent-md-docs/-/agent-md-docs-1.0.1.tgz","fileCount":79,"integrity":"sha512-c9tsToXrWx5/mv3CybFvhZ/tzhtWvMYXTzUi2DGnkzXAB3o4+6tZCh8V+w/07/yuk3WHaVbfqUPEGwoecxfFxQ==","signatures":[{"sig":"MEQCIGGDK6YiEgbCIgVy+VH7r5WNywezxeGaUcTIIbUd7jUbAiB8E83xcfluvFfkBejPEMJNlr858pQfwzD7A3wPtFwJMQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":75721},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"e1cd5bcbba1aefab635f0381dbd9800c0485f2a5","scripts":{"build":"tsc","start":"npm run build && node dist/index.js","publish":"npm run build && npm publish","prepublishOnly":"npm run build"},"_npmUser":{"name":"bydeusz","email":"hello@bydeusz.com"},"_npmVersion":"11.2.0","description":"A CLI tool that downloads framework documentation and generates a minified docs index for AGENTS.md or CLAUDE.md","directories":{},"_nodeVersion":"22.12.0","dependencies":{"@inquirer/prompts":"^7.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.21.0","typescript":"^5.0.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/agent-md-docs_1.0.1_1770971555159_0.37336891997522215","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@bydeusz/agent-md-docs","version":"1.0.2","keywords":["agents","claude","copilot","cursor","docs","documentation","cli","react","nextjs","nestjs","django","fastapi","django-rest-framework","express","agents-md","claude-md"],"license":"MIT","_id":"@bydeusz/agent-md-docs@1.0.2","maintainers":[{"name":"bydeusz","email":"hello@bydeusz.com"}],"bin":{"agent-md-docs":"dist/index.js"},"dist":{"shasum":"2cc8e5099ab4420e3abd5f6fe1200717d1c92bf4","tarball":"https://registry.npmjs.org/@bydeusz/agent-md-docs/-/agent-md-docs-1.0.2.tgz","fileCount":79,"integrity":"sha512-6GY5NfcvJXoC7y5qUwuAqlWBNHNa9y55CWriBeZs/WY0z5gkMImSt0PhpvJZXrxGVEulNb0NGIVXO0ha9C8D4w==","signatures":[{"sig":"MEUCIQDrwPeGVX5K7pnbvw1k/9E/TJfqZJUIPqWGZONwZLOT0gIgFs2NcD2rFw7KcUDl5bkrHdl1JZL2Yim4yQbWNWRAHFE=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":76566},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"63b718432780e7973346a10f08a19b2de0388c68","scripts":{"build":"tsc","start":"npm run build && node dist/index.js","prepublishOnly":"npm run build"},"_npmUser":{"name":"bydeusz","email":"hello@bydeusz.com"},"_npmVersion":"11.2.0","description":"A CLI tool that downloads framework documentation and generates a minified docs index for AGENTS.md or CLAUDE.md","directories":{},"_nodeVersion":"22.12.0","dependencies":{"@inquirer/prompts":"^7.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.21.0","typescript":"^5.0.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/agent-md-docs_1.0.2_1770973737395_0.5947144093705283","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"@bydeusz/agent-md-docs","version":"1.0.3","keywords":["agents","claude","copilot","cursor","docs","documentation","cli","react","nextjs","nestjs","django","fastapi","django-rest-framework","express","agents-md","claude-md"],"license":"MIT","_id":"@bydeusz/agent-md-docs@1.0.3","maintainers":[{"name":"bydeusz","email":"hello@bydeusz.com"}],"bin":{"agent-md-docs":"dist/index.js"},"dist":{"shasum":"78a1758f165c8c08a9aa1eb765d1a219710c28a0","tarball":"https://registry.npmjs.org/@bydeusz/agent-md-docs/-/agent-md-docs-1.0.3.tgz","fileCount":87,"integrity":"sha512-ML01Rjcj+ytb53rP/hIyUm88B8nsKETs020+6uXgKW0hBU76Uv0Wd+cMBgEui9mxTTKASURk+x8+MvRNdc34pA==","signatures":[{"sig":"MEQCIBSobh0GHGNaFOn4bz1PBHNIakWg3xj2JlrfIjFycCcjAiAlJBPVUiuwAi43j1kKGtJwVzD5bKr1wcf4eO6t5iXhYA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":77408},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"564ee0d40e8afa2c558be9acc6b1725214e5c8e8","scripts":{"build":"tsc","start":"npm run build && node dist/index.js","upgrade":"npm run build && node dist/index.js --upgrade","prepublishOnly":"npm run build"},"_npmUser":{"name":"bydeusz","email":"hello@bydeusz.com"},"_npmVersion":"11.2.0","description":"A CLI tool that downloads framework documentation and generates a minified docs index for AGENTS.md or CLAUDE.md","directories":{},"_nodeVersion":"22.12.0","dependencies":{"@inquirer/prompts":"^7.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.21.0","typescript":"^5.0.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/agent-md-docs_1.0.3_1770981097957_0.07539001285302982","host":"s3://npm-registry-packages-npm-production"}},"1.0.4":{"name":"@bydeusz/agent-md-docs","version":"1.0.4","keywords":["agents","claude","copilot","cursor","docs","documentation","cli","react","nextjs","nestjs","django","fastapi","django-rest-framework","express","bun","nodejs","agents-md","claude-md"],"license":"MIT","_id":"@bydeusz/agent-md-docs@1.0.4","maintainers":[{"name":"bydeusz","email":"hello@bydeusz.com"}],"bin":{"agent-md-docs":"dist/index.js"},"dist":{"shasum":"290fccc75262c3ed2efb8467eb4a196cd613eb96","tarball":"https://registry.npmjs.org/@bydeusz/agent-md-docs/-/agent-md-docs-1.0.4.tgz","fileCount":95,"integrity":"sha512-2FfkEncsWdsgPue1tzm3xFBdPqTm6Mobcct0ryjvcebbtc6e7b/M4K/hjr8xwV0XW8o/J2zCe05z2XAqWP8lLw==","signatures":[{"sig":"MEUCIQDTFGQsmctiEdBP+OV+t2prCO24DtcPNufBRAzx95EO5wIgO2lJ3J3ZtNPk3MTd/3g3GkEHLWzpdKDDZloQ8JJoLVU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":80130},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"a404bc371e95bc2cd75df3e5d8aae7a2538897d0","scripts":{"build":"tsc","start":"npm run build && node dist/index.js","upgrade":"npm run build && node dist/index.js --upgrade"},"_npmUser":{"name":"bydeusz","email":"hello@bydeusz.com"},"_npmVersion":"11.9.0","description":"A CLI tool that downloads framework documentation and generates a minified docs index for AGENTS.md or CLAUDE.md","directories":{},"_nodeVersion":"24.14.0","dependencies":{"@inquirer/prompts":"^7.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.21.0","typescript":"^5.0.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/agent-md-docs_1.0.4_1772533873764_0.663616881733829","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@bydeusz/agent-md-docs","version":"1.1.0","description":"A CLI tool that downloads framework documentation and generates a minified docs index for AGENTS.md or CLAUDE.md","type":"module","main":"dist/index.js","bin":{"agent-md-docs":"dist/index.js"},"scripts":{"build":"tsc","start":"npm run build && node dist/index.js","upgrade":"npm run build && node dist/index.js --upgrade"},"keywords":["agents","claude","copilot","cursor","docs","documentation","cli","react","nextjs","nestjs","django","fastapi","django-rest-framework","express","bun","nodejs","agents-md","claude-md"],"publishConfig":{"access":"public"},"license":"MIT","dependencies":{"@inquirer/prompts":"^7.0.0"},"devDependencies":{"@types/node":"^22.0.0","tsx":"^4.21.0","typescript":"^5.0.0"},"gitHead":"4dd47ed88dda133e904beb494b145263080057de","types":"./dist/index.d.ts","_id":"@bydeusz/agent-md-docs@1.1.0","_nodeVersion":"24.14.0","_npmVersion":"11.9.0","dist":{"integrity":"sha512-YBreMu27xXFGg69LLsO5/DpcbrQHgTJgUk8XwMs00YwTqOxxqgLCffq2UeEzKD4MwEt8H4ugFkDn+IBW3S+t/w==","shasum":"2efde87083ec38fb7e63b9c032a674a52e475f5d","tarball":"https://registry.npmjs.org/@bydeusz/agent-md-docs/-/agent-md-docs-1.1.0.tgz","fileCount":107,"unpackedSize":85352,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIFHrZP6XzcOw9e4MymaI+raHgqeDmtMNmlmyQIE+dZ28AiEApByj7Zzkj47RMC4WpoPFnKjLwKh8FT5LFRzie27Z6FU="}]},"_npmUser":{"name":"bydeusz","email":"hello@bydeusz.com"},"directories":{},"maintainers":[{"name":"bydeusz","email":"hello@bydeusz.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/agent-md-docs_1.1.0_1776953515700_0.6063495189474675"},"_hasShrinkwrap":false}},"time":{"created":"2026-02-12T14:56:25.600Z","modified":"2026-04-23T14:11:55.937Z","0.1.0":"2026-02-12T14:54:24.464Z","0.1.1":"2026-02-12T14:56:25.916Z","1.0.0":"2026-02-13T08:30:51.961Z","1.0.1":"2026-02-13T08:32:35.307Z","1.0.2":"2026-02-13T09:08:57.540Z","1.0.3":"2026-02-13T11:11:38.136Z","1.0.4":"2026-03-03T10:31:13.896Z","1.1.0":"2026-04-23T14:11:55.840Z"},"license":"MIT","keywords":["agents","claude","copilot","cursor","docs","documentation","cli","react","nextjs","nestjs","django","fastapi","django-rest-framework","express","bun","nodejs","agents-md","claude-md"],"description":"A CLI tool that downloads framework documentation and generates a minified docs index for AGENTS.md or CLAUDE.md","maintainers":[{"name":"bydeusz","email":"hello@bydeusz.com"}],"readme":"# byDeusz agent MD docs\n\nA CLI tool that downloads up-to-date framework documentation and generates a minified docs index for your `AGENTS.md` or `CLAUDE.md` file -- so AI coding agents always know where to find the right docs.\n\n## Inspiration\n\nThis project was inspired by Vercel's research showing that a compressed docs index in `AGENTS.md` achieved a **100% pass rate** on their agent evals, outperforming skill-based approaches. The key insight: passive context (always available in `AGENTS.md`) beats active retrieval (skills the agent must decide to invoke).\n\nRead the full article: [AGENTS.md outperforms skills in our agent evals](https://vercel.com/blog/agents-md-outperforms-skills-in-our-agent-evals)\n\nThis tool extends that approach beyond Next.js to **19 frameworks** across multiple categories, so any project can benefit from retrieval-led reasoning.\n\n## Supported Frameworks\n\n### Frontend\n- **React** - Full documentation from [reactjs/react.dev](https://github.com/reactjs/react.dev/tree/main/src/content)\n- **Next.js** - Full documentation from [vercel/next.js](https://github.com/vercel/next.js/tree/canary/docs)\n- **Vue** - Full documentation from [vuejs/docs](https://github.com/vuejs/docs/tree/main/src)\n- **Nuxt** - Full documentation from [nuxt/nuxt](https://github.com/nuxt/nuxt/tree/main/docs)\n\n### Backend\n- **NestJS** - Full documentation from [nestjs/docs.nestjs.com](https://github.com/nestjs/docs.nestjs.com/tree/master/content)\n- **Django** - Full documentation from [django/django](https://github.com/django/django/tree/main/docs)\n- **FastAPI** - Full documentation from [fastapi/fastapi](https://github.com/fastapi/fastapi/tree/master/docs/en/docs)\n- **Django REST Framework** - Full documentation from [encode/django-rest-framework](https://github.com/encode/django-rest-framework/tree/main/docs)\n- **Express** - Full documentation from [expressjs/expressjs.com](https://github.com/expressjs/expressjs.com/tree/gh-pages/en)\n\n### Runtime\n- **Bun** - Full documentation from [oven-sh/bun](https://github.com/oven-sh/bun/tree/main/docs)\n- **Node.js** - API documentation from [nodejs/node](https://github.com/nodejs/node/tree/main/doc/api)\n\n### Bundlers\n- **Vite** - Full documentation from [vitejs/vite](https://github.com/vitejs/vite/tree/main/docs)\n- **Turborepo** - Full documentation from [vercel/turborepo](https://github.com/vercel/turborepo/tree/main/apps/docs/content/docs)\n\n### ORMs\n- **Prisma** - Full documentation from [prisma/docs](https://github.com/prisma/docs/tree/main/apps/docs/content)\n- **TypeORM** - Full documentation from [typeorm/typeorm](https://github.com/typeorm/typeorm/tree/master/docs/docs)\n- **Drizzle ORM** - Full documentation from [drizzle-team/drizzle-orm-docs](https://github.com/drizzle-team/drizzle-orm-docs/tree/main/src/content/docs)\n\n### TanStack\n- **TanStack Query** - Full documentation from [TanStack/query](https://github.com/TanStack/query/tree/main/docs)\n\n### Mobile\n- **React Native** - Full documentation from [facebook/react-native-website](https://github.com/facebook/react-native-website/tree/main/docs)\n\n### Styling\n- **Tailwind CSS** - Full documentation from [tailwindlabs/tailwindcss.com](https://github.com/tailwindlabs/tailwindcss.com/tree/main/src/docs)\n\n## Usage\n\nThe CLI will:\n1. Ask which AI tool you use (GitHub Copilot, Cursor, or Claude Code)\n2. Ask which framework documentation to download (frontend / backend / runtime / bundler / ORM / TanStack / mobile / styling)\n3. Clear the `.docs/` folder and download fresh docs\n4. Generate a minified index and insert it into `AGENTS.md` or `CLAUDE.md`\n5. Save a manifest (`.docs/manifest.json`) to track installed docs\n\n### Via npx\n\n```bash\nnpx @bydeusz/agent-md-docs\n```\n\n### Upgrade existing docs\n\nTo re-download and update all previously installed docs without going through the prompts:\n\n```bash\nnpx @bydeusz/agent-md-docs --upgrade\n```\n\nThis reads the manifest and re-downloads everything in one go.\n\n### Local development\n\n```bash\nnpm install\nnpm run build\nnode dist/index.js\n```\n\n## What it does\n\nThe tool downloads markdown documentation from a framework's GitHub repository and saves it locally in a `.docs/` folder. It then scans the downloaded docs and generates a compact, single-line index wrapped in HTML comment markers, like:\n\n```\n<!-- NESTJS-AGENTS-MD-START -->[NestJS Docs Index]|root: ./.docs/nestjs|...|cli:{libraries.md,overview.md,...}|...<!-- NESTJS-AGENTS-MD-END -->\n```\n\nThis index is inserted into your `AGENTS.md` or `CLAUDE.md` file. AI agents can use this index to quickly locate and read the relevant documentation for the framework being used in the project.\n\n## Adding more frameworks\n\nTo add a new framework, create a config file in `src/frameworks/` and register it in `src/frameworks/registry.ts`. Each framework config specifies:\n\n- Category (`frontend`, `backend`, `runtime`, `bundler`, `orm`, `tanstack`, `mobile`, or `styling`)\n- GitHub repository and branch\n- Path to the documentation content\n- File extensions to download (`.md`, `.mdx`, etc.)\n- Optional extension conversion (e.g. `.txt` → `.md` for Django)\n- Comment markers for the index block\n","readmeFilename":"README.md"}