# @block-ml/cli 中文文档

规范地址：https://npmcn.com/package/%40block-ml/cli/

版本：0\.4\.3
npm 元数据更新时间：2026-10-30T07:51:17.644Z
中文译文更新时间：2026-11-08T08:34:41.151Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40block-ml/cli
原文对照：https://npmcn.com/package/%40block-ml/cli/?lang=original
项目主页：https://github.com/Roiocam/blockml#readme
源码仓库：https://github.com/Roiocam/blockml

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：75.2 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2026-10-29T11:27:49.447Z
- 最新版本发布：2026-10-30T07:51:17.298Z
- 近 30 天下载量：1852（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

BlockML 命令行: 验证、 渲染、 fmt

## 安装

```sh
npm install @block-ml/cli
```

也可以使用：`pnpm add @block-ml/cli`、`yarn add @block-ml/cli`、`bun add @block-ml/cli`

## README

# @block-ml/cli

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

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

## 安装

```bash
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`。

## 示例

```bash
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](https://github.com/Roiocam/blockml/releases)

## 相关包

-   [`@block-ml/core`](https://www.npmjs.com/package/@block-ml/core)：解析与规范化
-   [`@block-ml/viewer`](https://www.npmjs.com/package/@block-ml/viewer)：交互画布

## License

MIT

## 常见问题

### @block-ml/cli 是什么？

BlockML 命令行: 验证、 渲染、 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 和提交记录判断。