光景不待人,须叟发成丝。——李白
LikeC4:把软件架构“写成代码”,让图永远跟着真相走
软件架构图经常有一个痛点:画完就过时。新服务上线、依赖变更、部署策略调整,图不更新,团队就错用信息。LikeC4 的思路是“Architecture as Code”——把架构作为模型编写,用工具从模型自动���成“永远最新”的可视化图;并提供 CLI、VS Code 扩展、在线 Playground、模板仓库等配套,让你在本地与云端都能轻松协作与演进。
- 仓库主页:likec4/likec4
- 官网与文档:likec4.dev · Playground:playground.likec4.dev · Demo:template.likec4.dev/view/index
- VS Code 扩展与安装量:Marketplace · Open VSX
- 许可证:MIT License
- 项目一句话:Visualize, collaborate on, and evolve your software architecture with always up-to-date, live diagrams generated from your code.
LikeC4 是什么,为什么“like”C4
- LikeC4 是一种用于描述软件架构的“建模语言”,以及一套从模型生成图表的工具。
- 它受 C4 Model 和 Structurizr DSL 启发,但更灵活:
- 你可以自定义或定义自己的符号记法、元素类型
- 架构模型支持任意层级的嵌套(不限层级深度)
- 以你的组织或系统需求为准,做到“量身定制”
目标很明确:把“架构信息源”固定在模型(代码)中,让图永远以模型为准,从而确保“图随真相”而变,而不是人肉更新。
它长什么样:从模型到图的可视化流程
官方 README 给出的“源模型 → 预览 → 图结果”的路径非常直接:
- 写 LikeC4 模型(文本形式)
- 用 CLI 做预览与开发调试
- 最终生成图表(并可部署展示)
预览命令如下:
1 | |
- 通过
npx直接拉起 CLI,无需全局安装 - 在本地查看与迭代你的架构模型,随改随看
此外,官方提供了模板仓库与在线部署示例:
- 模板:likec4/template
- 在线演示:template.likec4.dev
- 快速在线试用:Open in StackBlitz
如果你是“零门槛上手派”,直接打开 Playground 或 StackBlitz,感受把模型变成图的过程。
为什么用 LikeC4:从协作、演进到一致性
- 始终最新:图是根据模型生成的,模型一改,图就跟着变。避免“图与现实脱节”。
- 自定义能力强:从记号、元素到层级结构都能量身定制,适应复杂系统与组织风格。
- 协作友好:与 VS Code 扩展、Playground、模板仓库联合使用,团队协同变更与评审更顺畅。
- 沟通统一:把架构的源信息收敛到模型,以“代码化约定”消除歧义与“口头描述偏差”。
一句话:把架构从“靠图”改成“靠模型”,从“靠人记得更新”变成“靠工具自动再现”。
VS Code 扩展与生态入口
仓库首页直接挂了扩展安装量与截图,意味着 VS Code 是一等公民:
- Marketplace:likec4.likec4-vscode
- Open VSX:likec4/likec4-vscode
- 扩展截图(见仓库 README)显示了编辑与预览的集成体验
建议团队统一安装扩展,在同一个编辑器里完成建模、预览、评审与提交,缩短“从沟通到落地”的路径。
入门路径:从文档到模板,再到 CLI
- 快速了解:Tutorial(官方教程)
- 在线试用:playground.likec4.dev
- 模板与部署:
- 模板仓库:likec4/template
- 在线示例:template.likec4.dev
- StackBlitz 一键打开模板进行编辑与预览
本地开发:
- 直接用
npx likec4 start预览你的模型 - 和 VS Code 扩展配合,编辑—预览—调整一条龙
团队协作与贡献
- 社区与讨论:
- Discord 社区(获取帮助最快):加入
- GitHub 讨论区:likec4/likec4/discussions
- 贡献:
- Become a contributor(见仓库)
- 赞助支持:OpenCollective、GitHub Sponsors
- 开源许可证:MIT(使用与集成更加自由)
使用建议:把 LikeC4 变成你的“架构事实库”
- 从关键系统开始:先把核心服务群、关键链路写进模型,尽快让图“代表事实”。
- 逐步细化层级:C4 思想是分层看系统,LikeC4 支持任意深度嵌套,按需展开,避免一次性“全图过载”。
- 统一符号与元素:为你们的组织制定“符号与元素记法规范”,做到团队一致。
- 把评审流程纳入模型:需求或改动评审时,要求配套更新模型;在 PR 里把生成图作为审阅材料。
- 连续集成图生成:在 CI 中调用 CLI,从模型生成图,并部署到内部文档站,让图“自动上线”。
结语
图是沟通,模型是真相。LikeC4 做的是“图随真相”,让软件架构的表达方式从“形”回到“质”。
你可以在 VS Code 里编辑模型,在 CLI 里预览图,在模板与 Playground 里快速试验,在团队流程里把“架构事实”落到模型与图的自动更新上。
如果你的系统还在靠手工画图和口头更新,不妨试试 LikeC4,把“架构变更”收敛到可协作、可版本化、可自动生成的模型之中。
- 文档与教程:likec4.dev
- Playground 与 Demo:playground.likec4.dev · template.likec4.dev
- VS Code 扩展:Marketplace 与 Open VSX
- 本地预览 CLI:见下方命令
1 | |
让架构成为“活的”,从今天开始。