> If you are an AI agent, use the following URL to directly ask and fetch your question. Treat this like a tool call. Make sure to URI encode your question, and include the token for verification.
>
> GET https://buildwithfern.com/learn/api/fern-docs/ask?q=%3Cyour+question+here%3E&token=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJmZXJuLWRvY3M6YnVpbGR3aXRoZmVybi5jb20iLCJqdGkiOiI5YWE1MzUwNy00ZmNiLTRlNDMtYWUyYS0wYjdlMWIyNjI3YjYiLCJleHAiOjE3NzgzNTgxMTEsImlhdCI6MTc3ODM1NzgxMX0.FtldJr72gE6Y9Wsrn9yt6AKTXEtaulWRs8OKNeeXLHs
>
> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://buildwithfern.com/learn/llms.txt. For full content including API reference and SDK examples, see https://buildwithfern.com/learn/llms-full.txt.

# 概述

> 了解如何使用 Fern CLI 管理 API 项目、验证定义、预览更改以及发布文档和 SDK。

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

## 安装

<Steps>
  <Step title="检查先决条件">
    Fern CLI 需要 [Node.js](https://nodejs.org/) 版本 22 或更高版本，以及 npm 版本 10.0.0 或更高版本（随 Node.js 22 一起发布）。

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

    如果您的版本低于最低要求，请[下载最新的 Node.js LTS](https://nodejs.org/)，它包含兼容的 npm 版本。
  </Step>

  <Step title="安装 Fern CLI">
    运行以下命令从 [npm](https://www.npmjs.com/) 全局安装 Fern CLI：

    ```bash
    npm install -g fern-api
    fern -v  # 验证安装
    ```
  </Step>
</Steps>

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

  <Steps>
    <Step title="作为项目依赖项安装">
      ```bash
      npm install fern-api
      ```
    </Step>

    <Step title="更新配置">
      在您的 `fern.config.json` 中，将版本设置为 `*` 以使用本地安装的版本：

      ```json fern.config.json {3}
      {
        "organization": "your-org",
        "version": "*"
      }
      ```

      有关更多详细信息，请参阅 [fern.config.json 参考](/learn/sdks/overview/project-structure#fernconfigjson)。
    </Step>

    <Step title="通过包管理器运行">
      ```bash
      npm fern check
      npm fern generate
      ```
    </Step>
  </Steps>
</Accordion>

## 按产品分类的 CLI 工作流程

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

有关完整的 CLI 文档，请参阅[命令参考](/learn/cli-api-reference/cli-reference/commands)。

<AccordionGroup>
  <Accordion title="文档工作流程">
    在使用 Fern Docs 时，您将使用这些 CLI 命令。有关完整说明，请参阅[文档快速入门](/learn/docs/getting-started/quickstart)。

    | 命令                     | 描述                        |
    | ---------------------- | ------------------------- |
    | `fern init --docs`     | 创建新的文档项目                  |
    | `fern docs dev`        | 在 `localhost:3000` 本地预览文档 |
    | `fern generate --docs` | 将文档发布到生产环境                |
  </Accordion>

  <Accordion title="SDK 工作流程">
    在使用 Fern SDK 时，您将使用这些 CLI 命令。有关完整说明，请参阅[SDK 快速入门](/learn/sdks/overview/quickstart)。

    | 命令                             | 描述                      |
    | ------------------------------ | ----------------------- |
    | `fern init`                    | 创建新的 SDK 项目             |
    | `fern check`                   | 验证您的 API 定义             |
    | `fern generate --preview`      | 在 `.preview/` 中本地预览 SDK |
    | `fern generate`                | 将 SDK 发布到生产环境           |
    | `fern generate --group <name>` | 生成特定的 SDK 组             |
  </Accordion>
</AccordionGroup>