vaults-diagram-tools

SVG/JPEGレンダリング、オフラインアセット、MCPワークフローに対応した、ポータブルなMermaidおよびソースコード図生成ツールキットです。

含まれるもの

• Vaultsツールチェーンから抽出されたMermaidレンダラー。

• ソースコードからMermaid図を生成するジェネレーター。

• 3つの明示的なツールを備えたMCP stdioサーバー。

• zipおよびコンテナ配布用のオフライン対応リリースアセット。

• Homebrew、deb/rpm、VS Code、CDN、Docker、Podman用のパッケージングテンプレート。

含まれないもの: OCR/ドキュメント変換、Claro vault監査、CPQインポート、クリッピング、Casa Conectada PDFツール。

インストール

GitHubからのnpmパッケージ

npm install github:malnati/vaults-diagram-tools

ローカルチェックアウト

git clone https://github.com/malnati/vaults-diagram-tools.git
cd vaults-diagram-tools
npm ci
npm test

コンテナ

docker build -f containers/Containerfile -t vaults-diagram-tools:local .
podman build -f containers/Containerfile -t vaults-diagram-tools:local .

リリースイメージはGitHub Container Registryの ghcr.io/malnati/vaults-diagram-tools として公開されています。

コマンドラインの使用方法

vaults-mermaid-render path/to/diagram.mmd --output-dir out --png --ascii --manifest out/manifest.json
vaults-source-diagrams --source-dir src --output-dir diagrams --langs auto --diagrams dependency,class
vaults-diagram-mcp

ローカルチェックアウトでの同等コマンド:

node packages/renderer/render-mermaid-assets.mjs examples/simple/flowchart.mmd --output-dir /tmp/vaults-diagram-tools
node packages/source-diagrams/source-diagrams.mjs --source-dir packages/source-diagrams/tests/fixtures/js-project --output-dir /tmp/source-diagrams
node packages/mcp/server.mjs

サポートされている公開CLIは上記の3つのコマンドです。その他のパッケージバイナリは、古いVaultsパスとの互換性を保つためのエントリーポイントであり、将来のメジャーリリースで非推奨になる可能性があります。

MCPツール

vaults-diagram-mcp は以下の3つのツールのみを公開します:

• render_mermaid_text

• render_mermaid_file

• generate_source_diagrams

Markdown図のポリシー

生成されたMarkdownは、アーティファクトへのリンクを含め、ソースを mermaid フェンスブロックで表示する必要があります:

#### Diagram title
- Links: [Mermaid source](assets/diagram.mmd) / [SVG](assets/diagram.svg) / [JPEG](assets/diagram.jpg)

```mermaid
flowchart TD
  A --> B
```

SVGおよびJPEGファイルは配布用アーティファクトです。Markdownでは、デフォルトで画像として埋め込むのではなく、それらへのリンクを記述してください。

オフラインベンダーランタイム

ソースツリーには node_modules はコミットされません。ビルドおよびリリースジョブは、以下を使用してオフラインベンダーアセットを作成します:

npm run vendor:refresh
npm run test:vendor:offline

レンダラーは、開発中は通常のnpm依存関係から実行でき、MMDC_VENDOR_ONLY=1 の場合は packages/renderer/vendor/node から実行できます。

配布状況

v1で動作するもの:

• npmパッケージのメタデータとGitHubインストールフロー

• Docker/Podmanイメージ

• MCPサーバー

• zipリリース

• GitHub Actions CI、リリース、CodeQL、およびPagesワークフロー

v1のテンプレート:

• Homebrewフォーミュラ

• nfpmによるdeb/rpm

• VS Code拡張機能シェル

• npm公開が有効になった後のnpm/jsDelivr/unpkg経由のCDNファサード

ドキュメント

• GitHub Pagesドキュメント

• Vaults互換性ノート

• 貢献ガイド

• セキュリティポリシー