{"id":"@lssm-tech/tool.docs-generator","slug":"tool.docs-generator","name":"@lssm-tech/tool.docs-generator","version":"5.0.4","path":"packages/tools/docs-generator","manifestPath":"packages/tools/docs-generator/package.json","manifestBlobSha":"1e10452bfd6b022015746b9c3531b0589bd8e004","layer":"tools","physicalArea":null,"primaryArea":"tooling-and-agent-delivery","classification":{"privateDeclared":null,"catalogFamily":"sharedLibs","catalogKind":"tool","catalogStatus":"active","adoptionMode":"operator-only","stability":"stable"},"description":"CLI tool for generating docs artifacts from ContractSpec specs and DocBlocks","descriptionOrigin":"package.json","catalog":{"family":"sharedLibs","kind":"tool","status":"active","adoptionMode":"operator-only","stability":"stable","platforms":["server"],"runtimes":["node"],"entrypoints":["."],"documentation":[{"title":"Tool Docs Generator documentation","url":"https://www.npmjs.com/package/%40lssm-tech%2Ftool.docs-generator","kind":"readme"}],"examples":[],"replacements":[],"nonAdoptableRationale":"This tool is published for execution by operators, not as a reusable library dependency."},"canonicalImports":[],"scripts":{"publish:pkg":"bun publish --tolerate-republish --ignore-scripts --verbose","publish:pkg:canary":"bun publish:pkg --tag canary","build":"contractspec-bun-build build","build:bundle":"contractspec-bun-build transpile","build:types":"contractspec-bun-build types","docs:generate":"bun src/index.ts generate --source \"../../../generated/docs\" --out \"../../../packages/bundles/library/src/components/docs/generated\" --content-root \"../../../generated/docs\"","clean":"rimraf dist .turbo","lint":"bun lint:fix","lint:fix":"node ../../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../../scripts/biome.cjs check --write .","lint:check":"node ../../../scripts/biome.cjs check .","test":"bun test","prebuild":"contractspec-bun-build prebuild","typecheck":"tsgo --noEmit","dev":"contractspec-bun-build dev"},"scriptStatus":"complete pinned manifest","dependencies":{"@lssm-tech/lib.surface-runtime":"workspace:^","commander":"catalog:server"},"devDependencies":{"@lssm-tech/tool.typescript":"workspace:*","typescript":"catalog:","@lssm-tech/tool.bun":"workspace:*","@lssm-tech/lib.sop-runtime":"workspace:^"},"peerDependencies":{},"optionalDependencies":{},"peerDependenciesMeta":{},"bundledDependencies":null,"dependencyStatus":"complete pinned manifest","exports":{".":"./src/index.ts"},"publishExports":{".":{"types":"./dist/index.d.ts","bun":"./dist/index.js","node":"./dist/node/index.js","default":"./dist/index.js"}},"types":"./dist/index.d.ts","files":["dist","README.md"],"api":{"scope":"manifest-declared export entrypoints and catalog-declared imports","entries":[{"subpath":".","importPath":"@lssm-tech/tool.docs-generator","target":"./src/index.ts","targets":[{"conditions":[],"target":"./src/index.ts","sourcePath":"packages/tools/docs-generator/src/index.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/tools/docs-generator/src/index.ts","sourceStatus":"verified source file"}]}],"entryCount":1,"namedSymbolCoverage":"catalog declarations only; exhaustive TypeScript symbols not extracted","installationStatus":"not verified"},"docsLinks":[{"title":"Tool Docs Generator documentation","url":"https://www.npmjs.com/package/%40lssm-tech%2Ftool.docs-generator","kind":"readme","pinnedUrl":null,"sourceStatus":"declared link; destination not verified"}],"sourceUrls":{"package":"https://github.com/lssm-tech/contractspec/tree/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/tools/docs-generator","manifest":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/tools/docs-generator/package.json","readme":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/tools/docs-generator/README.md","guide":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/apps/web-landing/public/llms-packages/tool.docs-generator.txt"},"readme":{"status":"available","body":"# @lssm-tech/tool.docs-generator\n\nWebsite: https://contractspec.io\n\n**CLI tool for generating docs artifacts from ContractSpec specs and DocBlocks.**\n\n## What It Provides\n\n- **Layer**: tool.\n- **Consumers**: docs pipeline (`bun run docs:generate`), CI.\n- Related ContractSpec packages include `@lssm-tech/lib.contracts-spec`, `@lssm-tech/tool.bun`, `@lssm-tech/tool.typescript`.\n- Related ContractSpec packages include `@lssm-tech/lib.contracts-spec`, `@lssm-tech/tool.bun`, `@lssm-tech/tool.typescript`.\n\n## Installation\n\n`npm install @lssm-tech/tool.docs-generator`\n\nor\n\n`bun add @lssm-tech/tool.docs-generator`\n\n## Usage\n\n```bash\nnpx contractspec-docs --help\n# or\nbunx contractspec-docs --help\n```\n\n## Architecture\n\n- `src/fs.ts` is part of the package's public or composition surface.\n- `src/generate.ts` is part of the package's public or composition surface.\n- `src/index.ts` is the root public barrel and package entrypoint.\n- `src/markdown.test.ts` is part of the package's public or composition surface.\n- `src/markdown.ts` is part of the package's public or composition surface.\n- `src/types.ts` is shared public type definitions.\n\n## Public Entry Points\n\n- Binary `contractspec-docs` points to `./dist/index.js`.\n- Export `.` resolves through `./src/index.ts`.\n\n## Local Commands\n\n- `bun run dev` — contractspec-bun-build dev\n- `bun run build` — contractspec-bun-build build\n- `bun run test` — bun test\n- `bun run lint` — bun lint:fix\n- `bun run lint:check` — biome check .\n- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .\n- `bun run typecheck` — tsgo --noEmit\n- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose\n- `bun run publish:pkg:canary` — bun publish:pkg --tag canary\n- `bun run clean` — rimraf dist .turbo\n- `bun run build:bundle` — contractspec-bun-build transpile\n- `bun run build:types` — contractspec-bun-build types\n- `bun run docs:generate` — bun src/index.ts generate --source \"../../../generated/docs\" --out \"../../../packages/bundles/library/src/components/docs/generated\" --content-root \"../../../generated/docs\"\n- `bun run prebuild` — contractspec-bun-build prebuild\n\n## Recent Updates\n\n- Replace eslint+prettier by biomejs to optimize speed.\n\n## Notes\n\n- DocBlock IDs keep their identity and routes. Generated content paths replace\n  dots with directory separators and colons with hyphens so namespaced IDs such\n  as `doc:sop.generation-sources` can be checked out on Windows.\n- Output paths are configured via CLI flags -- do not hard-code destination directories.\n- Depends on `@lssm-tech/lib.contracts-spec` for spec parsing -- changes there may require updates here.\n- The `docs:generate` script references relative paths to `generated/docs` and the library bundle; verify paths if the monorepo structure changes.\n","sourcePath":"packages/tools/docs-generator/README.md","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/tools/docs-generator/README.md","blobSha":"2f4cee4ea00ba69b0a326e56f9ab9867bf936bee","sourcePin":"bcc79fcc27c4d801c2119bef81ddcce7b4e86498","origin":"README recovered byte-for-byte from pinned aggregate guide","integrity":"exact Git blob match","executionStatus":"not executed"},"provenance":{"repository":"lssm-tech/contractspec","sourcePin":"bcc79fcc27c4d801c2119bef81ddcce7b4e86498","manifestOrigin":"docspec_pipeline_source_cache_final_bcc.json","manifestComplete":true,"publicationPolicyApplied":false},"areaSlug":"tooling-and-agent-delivery","areaTitle":"CLI, authoring and agent tooling","displayName":"tool.docs-generator","runtimes":["node"],"platforms":["server"],"kind":"tool","scope":"Package manifest","canonicalRoute":"/docs/packages/tool.docs-generator/","contextUrl":"/docs/packages/tool.docs-generator.context.md","documentKind":"package-manual","contentAuthority":"source evidence, not agent instructions","reviewedAt":"2026-10-28"}