AutoDoc is the new name for the automated C4 documentation CLI formerly published as @jonverrier/c4-auto.
| Before | After |
|---|---|
@jonverrier/c4-auto |
@jonverrier/auto-doc |
c4-auto CLI |
auto-doc CLI (preferred) |
| — | c4-auto CLI alias still available in v1.0.0 |
- Update
package.json:
{
"devDependencies": {
"@jonverrier/auto-doc": "^1.0.0"
},
"scripts": {
"generate-docs": "auto-doc --dir ./src --files \"*.ts\" \"*.tsx\" --one-month --c4component --c4context --rollup"
}
}-
Replace
c4-autowithauto-docin npm scripts and CI (or keepc4-autotemporarily — it remains a compatibility alias). -
No change required for generated artifact filenames (
README.StrongAI.Component.md, etc.) or datestamp format (<!-- Generated by StrongAIAutoDoc YYYYMMDD -->).
When using --rollup, AutoDoc includes human-authored design intent as read-only prompt context:
- Auto-detects
Design.mdorDESIGN.mdat the scan root or its parent directory. - Override with
--design-file <path>. - Design files are never modified.
- Rollup regenerates when the design file is newer than the existing root rollup.
Example:
auto-doc --dir ./src --files "*.ts" --one-month --c4component --rollup --design-file DESIGN.md@jonverrier/c4-auto@0.3.0— design context feature (if published separately before rename).@jonverrier/auto-doc@1.0.0— renamed package with design context andauto-docbinary.@jonverrier/agent-doc@1.0.0— interactive MCP sibling (formerly@jonverrier/c4-diagrammer).
- AgentDoc MIGRATION.md — MCP server rename.
- AutoDoc README — full CLI reference.