让开源，少一点语言距离。
npm包中文文档

@block-ml/cli

中文文档
0.4.3发布于 2026/10/30MITES Module构建来源已验证近 30 天下载 1852

BlockML command line: validate, render, fmt

原始使用文档
中文原文
文档目录6 节
  1. 安装
  2. 命令
  3. 示例
  4. 桌面版
  5. 相关包
  6. License

@block-ml/cli

BlockML 命令行：校验、渲染单文件阅读器、格式化、算法重排、结构摘要。

BlockML 是 diagram-as-code 语言：作者只写语义，布局与渲染质量由平台负责； 编辑器拖动后的坐标回写到同一个 .blockml 文件。

安装

npm i -g @block-ml/cli
blockml --help

命令

命令作用
blockml validate <file...>校验语法与引用，输出诊断
blockml render <file> [-o out.html] [--route curve|orthogonal]生成可双击的单文件阅读器（viewer 内联，无外部依赖；默认演示态；--route 只设初始走线，可在工具条切换）
blockml fmt <file> [--write]规范化格式（会丢弃注释，加 --write 才落盘）
blockml layout <file> [--algo <name>] [--write]破坏性整体重排并回写 at 坐标
blockml inspect <file>打印结构摘要

--algo 可选 layered、pipeline、snowflake、compact。

示例

blockml validate examples/order-platform.blockml
# ✓ examples/order-platform.blockml  12 nodes · 16 edges · 4 groups

blockml render examples/order-platform.blockml -o out/order-platform.html
blockml render examples/order-platform.blockml -o out/order-platform-ortho.html --route orthogonal

blockml layout order.blockml --algo layered --write

render 选项：-o/--out、--title、--theme light|dark、--readonly、--route curve|orthogonal。 走线风格是查看器预设，不需要写进 .blockml。

桌面版

同一份 viewer 的桌面安装包（macOS / Windows / Linux）： Releases

相关包

License

MIT

版本与发布记录

@block-ml/cli 共发布 11 个版本，首次发布于 2026/10/29；过去 12 个月发布了 11 个版本。最新版本附带 npm provenance 构建来源证明，可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.3latest2026/10/309 天前
0.4.22026/10/309 天前
0.4.12026/10/309 天前
0.4.02026/10/309 天前
0.3.12026/10/309 天前
0.3.02026/10/309 天前

关于 @block-ml/cli 的常见问题

@block-ml/cli 是什么？

BlockML command line: validate, render, fmt

如何安装 @block-ml/cli？

在项目目录运行 npm install @block-ml/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 blockml，可以用 npx blockml 直接运行。

@block-ml/cli 支持 TypeScript 吗？

该包的 package.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/block-ml__cli 是否存在。

@block-ml/cli 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。

@block-ml/cli 可以商用吗？

@block-ml/cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

@block-ml/cli 的下载量有多少？

根据 npm 官方下载统计，@block-ml/cli 在 2026/10/09 – 2026/11/07 这 30 天内被下载 1,852 次，日均约 62 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

@block-ml/cli 还在维护吗？

最新版本 0.4.3 发布于 2026/10/30（9 天前）；至今共发布 11 个版本，其中过去 12 个月发布了 11 个；首次发布于 2026/10/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。