{"_id":"@asdsadw12312dwd2112xz/api-doc-cli","name":"@asdsadw12312dwd2112xz/api-doc-cli","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@asdsadw12312dwd2112xz/api-doc-cli","version":"1.0.0","description":"Generate API documentation from Express/Fastify route files","type":"module","bin":{"api-doc":"dist/index.js"},"scripts":{"build":"tsup","prepublishOnly":"npm run build"},"repository":{"type":"git","url":"git+https://github.com/okirmio-create/api-doc-cli.git"},"keywords":["api","documentation","express","fastify","routes","cli"],"license":"MIT","dependencies":{"chalk":"^5.3.0","commander":"^12.1.0","glob":"^11.0.0"},"devDependencies":{"@types/node":"^20.14.0","tsup":"^8.1.0","typescript":"^5.5.0"},"gitHead":"ef365346b754b383f1d267ef0e80c24475959c2f","_id":"@asdsadw12312dwd2112xz/api-doc-cli@1.0.0","bugs":{"url":"https://github.com/okirmio-create/api-doc-cli/issues"},"homepage":"https://github.com/okirmio-create/api-doc-cli#readme","_nodeVersion":"25.9.0","_npmVersion":"11.12.1","dist":{"integrity":"sha512-OB81GPGFwEW1UerAnc7TL+W09/OQq31wXpRCezU8OxY/4EGWnqbKSeqB7cb5TlY2865F5X6Ao95jd2N1iDfEqw==","shasum":"389419017dc37788ea70aca4b08608a76d0d21b7","tarball":"https://registry.npmjs.org/@asdsadw12312dwd2112xz/api-doc-cli/-/api-doc-cli-1.0.0.tgz","fileCount":6,"unpackedSize":12715,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIBDfrXWU5fZf2cmUSOS+zmS9ruX9Vk7YejSMRV0MHFTuAiEA8w/RC/SWKpRKBE0rd+EBMICHiQAWIJYkSeN2IdO4wvU="}]},"_npmUser":{"name":"asdsadw12312dwd2112xz","email":"okirmio@gmail.com"},"directories":{},"maintainers":[{"name":"asdsadw12312dwd2112xz","email":"okirmio@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/api-doc-cli_1.0.0_1775436156765_0.019726527138382632"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-06T00:42:36.693Z","1.0.0":"2026-04-06T00:42:36.899Z","modified":"2026-04-06T00:42:37.088Z"},"maintainers":[{"name":"asdsadw12312dwd2112xz","email":"okirmio@gmail.com"}],"description":"Generate API documentation from Express/Fastify route files","homepage":"https://github.com/okirmio-create/api-doc-cli#readme","keywords":["api","documentation","express","fastify","routes","cli"],"repository":{"type":"git","url":"git+https://github.com/okirmio-create/api-doc-cli.git"},"bugs":{"url":"https://github.com/okirmio-create/api-doc-cli/issues"},"license":"MIT","readme":"# api-doc-cli\n\nGenerate API documentation from Express/Fastify route files.\n\nScans your source code for route definitions (`app.get`, `router.post`, `fastify.delete`, etc.), extracts HTTP methods, paths, and JSDoc descriptions, then outputs a Markdown or JSON document.\n\n## Install\n\n```bash\nnpm install -g api-doc-cli\n```\n\n## Usage\n\n```bash\napi-doc [options]\n```\n\n### Options\n\n| Flag | Description | Default |\n|------|-------------|---------|\n| `-d, --dir <path>` | Source directory to scan | `.` |\n| `-o, --output <file>` | Output file path | `API.md` |\n| `-p, --pattern <glob>` | Glob pattern for route files | `**/*route*.{ts,js}` |\n| `--json` | Output as JSON instead of Markdown | |\n| `--group-by-file` | Group endpoints by source file | |\n\n### Examples\n\n```bash\n# Scan current directory with defaults\napi-doc\n\n# Scan a specific directory\napi-doc -d src/routes\n\n# Custom pattern and output\napi-doc -p \"**/*.controller.ts\" -o docs/endpoints.md\n\n# JSON output grouped by file\napi-doc --json --group-by-file\n```\n\n## Supported Patterns\n\nThe tool detects route registrations on these objects:\n- `app` (Express)\n- `router` (Express Router)\n- `server` / `fastify` (Fastify)\n\nHTTP methods: `GET`, `POST`, `PUT`, `DELETE`, `PATCH`.\n\nJSDoc comments (`/** ... */`) directly above the route call are extracted as descriptions.\n\n## License\n\nMIT\n","readmeFilename":"README.md","_rev":"1-862cf3fb199eaa4d6897771d0b541946"}