LikeC4 / likec4

Architecture as a code 代码即架构

Visualize, collaborate on, and evolve your software architecture with always up-to-date, live diagrams generated from your code. 通过从代码生成的实时、始终保持更新的图表，可视化、协作并演进您的软件架构。

docs - playground - demo 文档 - 在线演练场 - 演示

What is LikeC4? 什么是 LikeC4？

Why “like”? LikeC4 is a modeling language for describing software architecture and tools to generate diagrams from the model. LikeC4 is inspired by C4 Model and Structurizr DSL, but provides some flexibility. You customize or define your own notation, element types, and any number of nested levels in architecture model. Perfectly tailored to your needs. 为什么叫 “like”？LikeC4 是一种用于描述软件架构的建模语言，以及从该模型生成图表的工具。LikeC4 受 C4 模型和 Structurizr DSL 的启发，但提供了更高的灵活性。您可以自定义或定义自己的符号、元素类型以及架构模型中任意数量的嵌套层级，完美契合您的需求。

What does LikeC4 look like? LikeC4 长什么样？

LikeC4 source: LikeC4 源码：

Run CLI to preview: npx likec4 start 运行 CLI 进行预览：npx likec4 start

And result: 结果如下：

Template repository - likec4/template 模板仓库 - likec4/template

Deployed - https://template.likec4.dev 部署地址 - https://template.likec4.dev

Check Tutorial - for a quick overview of LikeC4. 查看 教程 - 快速了解 LikeC4。

Getting help 获取帮助

We are always happy to help you get started: 我们随时乐意帮助您上手：

Join Discord community – it is the easiest way to get help 加入 Discord 社区 – 这是获取帮助最简单的方式

GitHub Discussions – ask anything about the project or give feedback GitHub Discussions – 询问有关项目的任何问题或提供反馈

Contributors 贡献者

Become a contributor 成为贡献者

Support development 支持开发

LikeC4 is a MIT-licensed open source project with its ongoing development made possible entirely by your support. If you like the project, please consider contributing financially to help grow and improve it. You can support us via OpenCollective or GitHub Sponsors. LikeC4 是一个采用 MIT 许可的开源项目，其持续开发完全依赖于您的支持。如果您喜欢这个项目，请考虑通过经济资助来帮助它成长和改进。您可以通过 OpenCollective 或 GitHub Sponsors 支持我们。

License 许可协议

This project is released under the MIT License. 本项目基于 MIT 许可协议发布。