archidoc
v0.3.4
Published
Architecture documentation compiler — C4 diagrams from source annotations. Downloads the native archidoc binary and includes the TypeScript adapter.
Maintainers
Readme
archidoc
Architecture documentation compiler. Generates C4 diagrams (Mermaid, PlantUML, draw.io) from source code annotations.
This npm package downloads the native archidoc binary and includes the TypeScript adapter (archidoc-ts). One install gives you full polyglot support for Rust + TypeScript projects.
Install
npm install -D archidocUsage
# Generate ARCHITECTURE.md from source annotations
npx archidoc .
# Check for documentation drift (CI gate)
npx archidoc --check .
# Architecture health report
npx archidoc --health .
# Validate file tables
npx archidoc --validate .For polyglot projects (Rust + TypeScript), archidoc auto-detects both languages, runs the appropriate adapters, and merges the results. No manual steps needed.
How It Works
- On
npm install, the postinstall script downloads the prebuilt native binary for your platform from GitHub Releases - The
archidoc-tsTypeScript adapter is included as a dependency - When you run
archidoc ., it auto-detects TypeScript sources (viapackage.json) and runsarchidoc-tsinternally - Results from all language adapters are merged into unified architecture documentation
Supported Platforms
| OS | Architecture | |----|-------------| | Linux | x64 | | macOS | x64, arm64 | | Windows | x64 |
Alternative Install Methods
# From crates.io (requires Rust toolchain)
cargo install archidoc-cli
# From source
git clone https://github.com/GitSmart86/archidoc
cd archidoc && cargo install --path core/archidoc-cliDocumentation
See the archidoc repository for the full annotation convention, CLI reference, and language adapter details.
License
MIT
