概述 | Fern Documentation

Fern CLI 让您能够初始化项目、验证 API 定义、在本地预览更改，以及发布文档和 SDK。本页介绍安装和常用命令，帮助您快速入门。

安装

Fern CLI 需要 Node.js 版本 22 或更高版本，以及 npm 版本 10.0.0 或更高版本（随 Node.js 22 一起发布）。

$ node -v  # 必须是 v22.0.0 或更高版本

如果您的版本低于最低要求，请下载最新的 Node.js LTS，它包含兼容的 npm 版本。

运行以下命令从 npm 全局安装 Fern CLI：

$ npm install -g fern-api
$ fern -v  # 验证安装

如果您希望将 Fern 作为项目依赖项管理，或者在网络连接有限的环境中工作，可以本地安装 CLI：

$ npm install fern-api

在您的 fern.config.json 中，将版本设置为 * 以使用本地安装的版本：

fern.config.json

1 {
2   "organization": "your-org",
3   "version": "*"
4 }

有关更多详细信息，请参阅 fern.config.json 参考。

$ npm fern check
$ npm fern generate

Fern CLI 管理文档和 SDK 工作流程。以下是每个产品常用命令的简要概述。所有命令都支持全局选项，如用于调试的 --log-level。

有关完整的 CLI 文档，请参阅命令参考。

在使用 Fern Docs 时，您将使用这些 CLI 命令。有关完整说明，请参阅文档快速入门。

在使用 Fern SDK 时，您将使用这些 CLI 命令。有关完整说明，请参阅SDK 快速入门。