{"_id":"@askchiefleo/agents-md","_rev":"3-e72fe555c2eacb8a56ef178da3fa002a","name":"@askchiefleo/agents-md","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@askchiefleo/agents-md","version":"1.0.0","keywords":["agents","claude","ai","docs","vue","uniapp","cli"],"author":{"name":"Kipper"},"license":"MIT","_id":"@askchiefleo/agents-md@1.0.0","maintainers":[{"name":"askchiefleo","email":"askchiefleo@gmail.com"}],"homepage":"https://github.com/kipper/agents-md#readme","bugs":{"url":"https://github.com/kipper/agents-md/issues"},"bin":{"agents-md":"bin/agents-md.js"},"dist":{"shasum":"b1bbfe832192b79247d918502ae5361ab7b6eb87","tarball":"https://registry.npmjs.org/@askchiefleo/agents-md/-/agents-md-1.0.0.tgz","fileCount":16,"integrity":"sha512-ttpNZ58B/ASKslR0lZzFiv+7G7Kwu+HRQ1+CDB1poB+6/fk3JZ8IfaJm4AdHkAgzH9gyEo2/+fd73GTEiE2Hgw==","signatures":[{"sig":"MEUCIFDETry5qAtZE9Xik6USkDIVx8JMjjbJidJee+4Gpt5OAiEAxswIUCA297MRg8pSfuwxL9FMlwHje8I7sXtyBeyryVQ=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":110348},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","engines":{"node":">=18.0.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.js"}},"gitHead":"5d5c2dd0351ded989a3dadc47fd0920626130f4f","scripts":{"dev":"tsup src/index.ts src/cli.ts --format cjs,esm --dts --watch","lint":"tsc --noEmit","test":"vitest","build":"tsup src/index.ts src/cli.ts --format cjs,esm --dts --clean","test:run":"vitest run","prepublishOnly":"npm run build"},"_npmUser":{"name":"askchiefleo","email":"askchiefleo@gmail.com"},"repository":{"url":"git+https://github.com/kipper/agents-md.git","type":"git"},"_npmVersion":"10.9.0","description":"Generate compressed docs index for AGENTS.md (Vue, uni-app, etc.)","directories":{},"_nodeVersion":"22.12.0","dependencies":{"chalk":"^5.3.0","execa":"^9.0.0","fs-extra":"^11.0.0","commander":"^12.0.0","minimatch":"^10.1.2"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.0.0","vitest":"^2.0.0","typescript":"^5.6.0","@types/node":"^22.0.0","@types/fs-extra":"^11.0.0"},"_npmOperationalInternal":{"tmp":"tmp/agents-md_1.0.0_1770364443741_0.7407510060638711","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@askchiefleo/agents-md","version":"1.0.1","keywords":["agents","claude","ai","docs","vue","uniapp","cli"],"author":{"name":"Kipper"},"license":"MIT","_id":"@askchiefleo/agents-md@1.0.1","maintainers":[{"name":"askchiefleo","email":"askchiefleo@gmail.com"}],"homepage":"https://github.com/kipper/agents-md#readme","bugs":{"url":"https://github.com/kipper/agents-md/issues"},"bin":{"agents-md":"bin/agents-md.js"},"dist":{"shasum":"3ca274edc359fad2c2ad78ff465bd58b197d7c46","tarball":"https://registry.npmjs.org/@askchiefleo/agents-md/-/agents-md-1.0.1.tgz","fileCount":16,"integrity":"sha512-Pu+N8CULyl11PbJimcMmnyWhiukpBfc3N0DHdVt76oA/h9nhSPPMw5htbuD2Jt2xRFJaLaH4QS1rP7iFGLyt+A==","signatures":[{"sig":"MEYCIQDw1ftSbELO3ag27FATdU5ifCGf/1IHD/jhRxrBlG//PAIhAIANX9OR99AOvxQ7Z+iuWofUiBv3+E5RsT5dreuSf3pO","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":110413},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","engines":{"node":">=18.0.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.js"}},"gitHead":"41680ab0e11d9d0e099813ea92b316acb7e3cd02","scripts":{"dev":"tsup src/index.ts src/cli.ts --format cjs,esm --dts --watch","lint":"tsc --noEmit","test":"vitest","build":"tsup src/index.ts src/cli.ts --format cjs,esm --dts --clean","test:run":"vitest run","prepublishOnly":"npm run build"},"_npmUser":{"name":"askchiefleo","email":"askchiefleo@gmail.com"},"repository":{"url":"git+https://github.com/kipper/agents-md.git","type":"git"},"_npmVersion":"10.9.0","description":"Generate compressed docs index for AGENTS.md (Vue, uni-app, etc.)","directories":{},"_nodeVersion":"22.12.0","dependencies":{"chalk":"^5.3.0","execa":"^9.0.0","fs-extra":"^11.0.0","commander":"^12.0.0","minimatch":"^10.1.2"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.0.0","vitest":"^2.0.0","typescript":"^5.6.0","@types/node":"^22.0.0","@types/fs-extra":"^11.0.0"},"_npmOperationalInternal":{"tmp":"tmp/agents-md_1.0.1_1770364613491_0.21312498690796855","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@askchiefleo/agents-md","version":"1.0.2","description":"Generate compressed docs index for AGENTS.md (Vue, uni-app, etc.)","bin":{"agents-md":"bin/agents-md.js"},"main":"./dist/index.js","module":"./dist/index.mjs","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.js"}},"scripts":{"build":"tsup src/index.ts src/cli.ts --format cjs,esm --dts --clean","dev":"tsup src/index.ts src/cli.ts --format cjs,esm --dts --watch","test":"vitest","test:run":"vitest run","lint":"tsc --noEmit","prepublishOnly":"npm run build"},"dependencies":{"chalk":"^5.3.0","commander":"^12.0.0","execa":"^9.0.0","fs-extra":"^11.0.0","minimatch":"^10.1.2"},"devDependencies":{"@types/fs-extra":"^11.0.0","@types/node":"^22.0.0","tsup":"^8.0.0","typescript":"^5.6.0","vitest":"^2.0.0"},"engines":{"node":">=18.0.0"},"keywords":["agents","claude","ai","docs","vue","uniapp","cli"],"repository":{"type":"git","url":"git+https://github.com/tibelf/agents-md.git"},"license":"MIT","author":{"name":"askchiefleo"},"_id":"@askchiefleo/agents-md@1.0.2","gitHead":"ef4ae907230d2ec389c949d8ac651593e19410db","bugs":{"url":"https://github.com/tibelf/agents-md/issues"},"homepage":"https://github.com/tibelf/agents-md#readme","_nodeVersion":"22.12.0","_npmVersion":"10.9.0","dist":{"integrity":"sha512-IzXrWSQjDtxT8QiKUiGLDgXf1DjFTZb3ceAMk98C8uWPv/YINCQ+D/4hTjNZ1kGYjzzG7Ed10y/J7UKRhF62NA==","shasum":"caf3188d9f64b16d23567dcc54b3d6c8a8b74bdf","tarball":"https://registry.npmjs.org/@askchiefleo/agents-md/-/agents-md-1.0.2.tgz","fileCount":16,"unpackedSize":110418,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDGTNPE0jnAXJbHQpiV0rE4q8cepdUSF/D7oq5sWb2v1AIgC2dW/wyImb1+L11geGirDRcMDcWm7RcJ1Be1Mm/V060="}]},"_npmUser":{"name":"askchiefleo","email":"askchiefleo@gmail.com"},"directories":{},"maintainers":[{"name":"askchiefleo","email":"askchiefleo@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/agents-md_1.0.2_1770364685022_0.9266043934912496"},"_hasShrinkwrap":false}},"time":{"created":"2026-02-06T07:54:03.674Z","modified":"2026-02-06T07:58:05.284Z","1.0.0":"2026-02-06T07:54:03.898Z","1.0.1":"2026-02-06T07:56:53.625Z","1.0.2":"2026-02-06T07:58:05.167Z"},"bugs":{"url":"https://github.com/tibelf/agents-md/issues"},"author":{"name":"askchiefleo"},"license":"MIT","homepage":"https://github.com/tibelf/agents-md#readme","keywords":["agents","claude","ai","docs","vue","uniapp","cli"],"repository":{"type":"git","url":"git+https://github.com/tibelf/agents-md.git"},"description":"Generate compressed docs index for AGENTS.md (Vue, uni-app, etc.)","maintainers":[{"name":"askchiefleo","email":"askchiefleo@gmail.com"}],"readme":"# @askchiefleo/agents-md\n\nGenerate compressed documentation index for AGENTS.md / CLAUDE.md supporting Vue, uni-app, and more frameworks.\n\n## Installation\n\n```bash\n# Use directly with npx\nnpx @askchiefleo/agents-md\n\n# Or install globally\nnpm install -g @askchiefleo/agents-md\n```\n\n## Usage\n\n```bash\n# Auto-detect project type and generate index\nnpx @askchiefleo/agents-md\n\n# Specify framework manually\nnpx @askchiefleo/agents-md --framework vue\nnpx @askchiefleo/agents-md --framework uniapp\n\n# Preview without writing files\nnpx @askchiefleo/agents-md --dry-run\n\n# Force re-pull documentation\nnpx @askchiefleo/agents-md --force\n\n# Also generate CLAUDE.md\nnpx @askchiefleo/agents-md --claude\n\n# Use cached docs (offline mode)\nnpx @askchiefleo/agents-md --offline\n\n# Verbose output\nnpx @askchiefleo/agents-md --verbose\n\n# List supported frameworks\nnpx @askchiefleo/agents-md list-frameworks\n```\n\n## What it does\n\n1. **Detects** your project type (Vue / uni-app / etc.)\n2. **Pulls** official documentation using git sparse-checkout to `.{framework}-docs/`\n3. **Generates** a compressed documentation index\n4. **Injects** the index into AGENTS.md (or CLAUDE.md) with markers for easy updates\n5. **Updates** .gitignore to exclude the docs directory\n\n## Output Format\n\nThe generated index uses a compressed format:\n\n```\n[Vue Docs Index]|root:.vue-docs|STOP. What you remember about Vue may be outdated...|guide:{introduction,essentials,scaling-up}|api:{reactivity,composition}\n```\n\nThis format is optimized for AI agents to quickly locate relevant documentation.\n\n## Supported Frameworks\n\n- **Vue** - Vue.js 3.x\n- **uni-app** - uni-app 3.x (coming soon)\n\n## Configuration\n\nEach framework has its own configuration in the `rules/` directory:\n\n```\nrules/\n├── vue/\n│   ├── config.json       # Framework detection & docs source\n│   └── important-rules.md # AI instructions\n└── uniapp/\n    ├── config.json\n    └── important-rules.md\n```\n\n## Programmatic API\n\n```typescript\nimport { agentsMd, detectFramework, generateDocsIndex } from '@askchiefleo/agents-md';\n\n// Run the full process\nawait agentsMd({\n  cwd: '/path/to/project',\n  framework: 'vue',\n  output: 'AGENTS.md',\n});\n\n// Detect framework only\nconst info = await detectFramework('/path/to/project');\n\n// Generate index from existing docs\nconst index = generateDocsIndex('.vue-docs', config);\n```\n\n## License\n\nMIT\n","readmeFilename":"README.md"}