# @formepdf/cli 中文文档

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

版本：0\.31\.0
npm 元数据更新时间：2026-11-05T16:58:21.016Z
中文译文更新时间：2026-11-15T08:39:06.474Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：102 kB，13 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：4 个
- 首次发布：2026-02-19T19:55:04.237Z
- 最新版本发布：2026-11-05T16:58:20.854Z
- 近 30 天下载量：3219（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：67（近 12 个月 67 个）

## 中文简介

Forme PDF 渲染引擎的 CLI — Dev 服务器, 带有活的预览并构建命令

## 安装

```sh
npm install @formepdf/cli
```

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

## README

# @formepdf/cli (英语)

Dev 服务器和构建工具 [福尔米](https://github.com/formepdf/forme) PDF生成.

## 安装

```bash
npm install -D @formepdf/cli
```

## 图标

### `forme dev`

现场预览 Dev 服务器,有元素检查员,组件树,点击到源头,以及响应的页面大小切换.

```bash
forme dev invoice.tsx --data invoice-data.json
```

打开 `http://localhost:4242` 可以在编辑时实时看到您的 PDF 更新.

### `forme build`

将 PDF 格式化为文件 .

```bash
forme build invoice.tsx --data invoice-data.json -o invoice.pdf
```

## Dev 服务器特性

-   **现场预览** 在文件更改中热重装
-   **元素检查员** 和面包屑导航
-   **组件树** 显示文档结构
-   **点击到来源** 以精确行打开编辑器( VS 代码、 光标、 WebStorm、 Zed)
-   **响应预览** 与页面大小切换(信件、 A4、 法律、 标签、 自定义)
-   **数据编辑器** 用于使用时的活 JSON 编辑 `--data`
-   **调试重叠** 边距、 铺设和元素界限

## 选项

```
forme dev <template>         Start dev server
  --data <file>              Load JSON data file
  --port <number>            Server port (default: 4242)

forme build <template>       Render PDF
  --data <file>              Load JSON data file
  -o, --output <file>        Output file path
```

## 文档

页:1 [文件:formepdf.com](https://docs.formepdf.com/)

## 常见问题

### @formepdf/cli 是什么？

Forme PDF 渲染引擎的 CLI — Dev 服务器, 带有活的预览并构建命令

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

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

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

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

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

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

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

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

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

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

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

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