plantuml-stdlib/C4-PlantUML

Что это?

Ключевые возможности

• 01Макросы для диаграмм System, Container, Component, Dynamic, Deployment и Sequence в стиле C4.
• 02Типы элементов для людей, систем, контейнеров, баз данных, очередей и внешних объектов.
• 03Макросы для связей с указанием направления и группировки в границы.
• 04Спрайты иконок, ссылки на элементы и пользовательские теги с автоматически создаваемой легендой.
• 05Поддержка редакторов: сниппеты для VS Code и live templates для IntelliJ.

Сценарии использования

• Документирование архитектуры ПО на предварительных сессиях по проектированию.
• Хранение диаграмм архитектуры в одном репозитории с описываемым ими кодом.
• Представление контекста системы и структуры контейнеров заинтересованным сторонам без технической специализации.

Быстрый старт

1. 1

   Подключите библиотеку C4_Container в файле .puml

   !include <C4/C4_Container>
2. 2

   Запишите элементы и связи C4 обычным текстом между @startuml/@enduml

3. 3

   Визуализируйте диаграмму с помощью PlantUML, например используя jar-файл

   java -jar plantuml.jar -DRELATIVE_INCLUDE="." ...

Что важно знать

• !Для визуализации диаграмм требуется PlantUML, поэтому для их просмотра понадобится Java или сервер PlantUML.

Темы

Частые вопросы

Что такое C4-PlantUML?

Библиотека макросов модели C4 для PlantUML, позволяющая описывать диаграммы архитектуры ПО обычным текстом. C4-PlantUML — это набор макросов и стереотипов PlantUML для построения диаграмм архитектуры ПО по модели C4. Вместо того чтобы вручную рисовать блоки, вы описываете людей, системы, контейнеры, компоненты и узлы развёртывания в коротком текстовом файле, а PlantUML создаёт диаграмму. Такие диаграммы удобно хранить под контролем версий и обсуждать вместе с кодом.

C4-PlantUML можно использовать бесплатно? Какая у него лицензия?

C4-PlantUML распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.

C4-PlantUML всё ещё поддерживается?

Активно поддерживается. Последний коммит в C4-PlantUML — 13 окт. 2026 г..

Для чего можно использовать C4-PlantUML?

Документирование архитектуры ПО на предварительных сессиях по проектированию. Хранение диаграмм архитектуры в одном репозитории с описываемым ими кодом. Представление контекста системы и структуры контейнеров заинтересованным сторонам без технической специализации.

Как установить C4-PlantUML?

Подключите библиотеку C4_Container в файле .puml: !include <C4/C4_Container> Запишите элементы и связи C4 обычным текстом между @startuml/@enduml Визуализируйте диаграмму с помощью PlantUML, например используя jar-файл: java -jar plantuml.jar -DRELATIVE_INCLUDE="." ...

Где скачать C4-PlantUML?

Исходный код и инструкции по установке — на GitHub: https://github.com/plantuml-stdlib/C4-PlantUML