vaults-diagram-tools

Портативный набор инструментов для создания диаграмм Mermaid и диаграмм из исходного кода с поддержкой рендеринга в SVG/JPEG, автономных ресурсов и рабочих процессов MCP.

Что включено

• Рендерер Mermaid, извлеченный из инструментария Vaults.

• Генератор диаграмм Mermaid из исходного кода.

• MCP stdio-сервер с тремя явными инструментами.

• Автономные релизные сборки для распространения в виде zip-архивов и контейнеров.

• Шаблоны пакетов для Homebrew, deb/rpm, VS Code, CDN, Docker и Podman.

Не включено: OCR/конвертация документов, аудит хранилищ Claro, импорт CPQ, вырезки или инструменты для работы с PDF Casa Conectada.

Установка

npm-пакет из GitHub

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 — это три команды, указанные выше. Дополнительные бинарные файлы пакетов являются точками входа для обеспечения совместимости со старыми путями Vaults и могут быть признаны устаревшими в будущих мажорных релизах.

Инструменты MCP

vaults-diagram-mcp предоставляет ровно три инструмента:

• 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 должен ссылаться на них, а не встраивать их как изображения по умолчанию.

Автономная среда выполнения (vendor)

Дерево исходного кода не содержит node_modules. Сборка и релизные задания создают автономные ресурсы с помощью:

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

Рендерер может работать как с обычными npm-зависимостями во время разработки, так и из packages/renderer/vendor/node, если установлен MMDC_VENDOR_ONLY=1.

Статус распространения

Работает в v1:

• Метаданные npm-пакета и процесс установки через GitHub

• Образ Docker/Podman

• MCP-сервер

• zip-релиз

• GitHub Actions CI, релиз, CodeQL и рабочие процессы Pages

Шаблоны в v1:

• Формула Homebrew

• deb/rpm через nfpm

• Оболочка расширения VS Code

• CDN-фасад через npm/jsDelivr/unpkg после включения публикации в npm

Документация

• Документация GitHub Pages

• Заметки о совместимости с Vaults

• Руководство по внесению вклада

• Политика безопасности