# @barmark/cli 中文文档

规范地址：https://npmcn.com/package/%40barmark/cli/

版本：0\.6\.4
npm 元数据更新时间：2026-11-07T18:16:45.277Z
中文译文更新时间：2026-11-07T17:41:51.457Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40barmark/cli
原文对照：https://npmcn.com/package/%40barmark/cli/?lang=original
项目主页：https://github.com/kevinpeckham/barmark/tree/main/packages/cli#readme
源码仓库：https://github.com/kevinpeckham/barmark

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

- 包体积（解压后）：42.5 kB，20 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20\.6
- 运行依赖：3 个
- 首次发布：2026-11-02T19:19:40.806Z
- 最新版本发布：2026-11-07T18:16:44.906Z
- 近 30 天下载量：3588（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：23（近 12 个月 23 个）

## 中文简介

条签命令:从终端和CI中检查,格式,渲染,转出并导出条签和弦图(.chart.md).

## 安装

```sh
npm install @barmark/cli
```

也可以使用：`pnpm add @barmark/cli`、`yarn add @barmark/cli`、`bun add @barmark/cli`

## README

# @ barmark/ cli (英语)

这个 `barmark` 命令:检查、格式、部件、渲染、转接、导出和导入 [标记](https://www.barmark.dev/) 和弦图`.chart.md` 文档) a 终端或CI。 运行一样 `barmark` 翻译和 `@barmark/render` 变形为barmark.dev `@barmark/musicxml` 用于MusicXML,精确 版本,所以一个图表在任何地方都意味着同样的东西.

## 安装

与节点20.6或后:

```sh
npx @barmark/cli check .          # run once
npm install --save-dev @barmark/cli   # or keep it in a project
```

没有节点,请从中下载您的系统的二进制 [GitHub 发布](https://github.com/kevinpeckham/barmark/releases?q=cli-v) (单位:千美元)`barmark-linux-x64`, (中文(简体) ), `barmark-linux-arm64`, (中文(简体) ), `barmark-darwin-x64`, (中文(简体) ), `barmark-darwin-arm64`, (中文(简体) ), `barmark-windows-x64.exe`) (中文(简体) ). 二进制不是 尚未签名; 在 macOS 上, 在第一次运行前清除下载标记 :

```sh
chmod +x barmark-darwin-arm64
xattr -d com.apple.quarantine barmark-darwin-arm64
```

## 图标

文件夹表示每个 `*.chart.md` 中文件, 跳过 `node_modules`, (中文(简体) ), 点字和相通. `-` 从stdin读取.

```sh
barmark check songs                      # errors and warnings, file:line
barmark export --musicxml song.chart.md --out song.musicxml   # for MuseScore, Dorico…
barmark import song.musicxml --out song.chart.md   # or a compressed song.mxl
barmark check --strict --format github songs   # warnings fail too; PR annotations
barmark format song.chart.md             # print it in standard form
barmark format --write songs             # rewrite the files that change
barmark format --check songs             # list them and fail, for CI
barmark part Bass song.chart.md          # one part of a chart of several
barmark render song.chart.md --out song.html   # a standalone page, font included
barmark transpose song.chart.md --to E   # or --semitones -2
```

`check --format json` 打印其他工具的诊断. `render` 以渲染器的选项为旗帜 : `--theme auto|light|dark`, (中文(简体) ), `--numerals nashville|roman`, (中文(简体) ), `--no-bar-numbers`, (中文(简体) ), `--rehearsal-letters`, (中文(简体) ), `--no-wrap`, (中文(简体) ), `--diagnostics`, (中文(简体) ), `--part <label>` 绘制一部分 `--font-url <url>` 链接字体 而不是嵌入它. `barmark <command> --help` 列出每个命令的 旗帜; `barmark --version` 打印 CLI 及其版本 图书馆.

`export --musicxml` 写 MusicXML 4.0 标记程序打开并 按图表顺序播放; `--part <label>` 出口一部分。 图表 不导出出出错。 无标题的图表取其文件名 .

`import` 读取 MusicXML 分数(`.musicxml`, (中文(简体) ), `.xml` 或压缩 `.mxl`(中文(简体) ) 作为图表。 图表不能结转的东西 列出在stderr,一行 各项,作为 `check` 打印其结论 : `song.mxl: measure 12 (Piano): warning: message` (该措施在电文列出 (b) 衡量标准本身. `--part <name>` 联合国 部分名称、缩写或 id, 忽略大小写和标出) 导入 仅此一部分,其注解为注解。 当一张图表出来时,它从0出口, 即使警告,或警告,或警告者 `.mxl` 情况很糟 没有 读取 stdin.

## 退出代码

| 代码 | 含义 |
| --- | --- |
| 0 个 | 完成(允许发出警告,除非 `--strict`(中文(简体) ) |
| 1个 | 图表有问题:错误,警告 `--strict`,或文件 `format --check` 将会改变 |
| 2个 | 命令被错误使用: 未知的旗帜、 缺失或无法读取的文件 |

## 在CI语中

```yaml
- uses: actions/setup-node@v4
  with:
    node-version: 22
- run: npx -y @barmark/cli@0.1.0 check --strict --format github songs
- run: npx -y @barmark/cli@0.1.0 format --check songs
```

键入版本:新版本可以不同读取图表,并被绑住 版本将它变成一个调取请求,你审查.

## 许可证

麻省理工学院. `render` 嵌入爱德温 `@barmark/render` sIL下的船只 打开字体许可证( O)`fonts/OFL.txt` 在那里;二进制的释放带它 作为 `Edwin-OFL.txt`) (中文(简体) ).

## 常见问题

### @barmark/cli 是什么？

条签命令:从终端和CI中检查,格式,渲染,转出并导出条签和弦图\(\.chart\.md\)\.

### 如何安装 @barmark/cli？

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

### @barmark/cli 支持 TypeScript 吗？

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

### @barmark/cli 支持 ESM 还是 CommonJS？

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

### @barmark/cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.6。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @barmark/cli 可以商用吗？

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

### @barmark/cli 的下载量有多少？

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

### @barmark/cli 还在维护吗？

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