# @frontify/frontify-cli 中文文档

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

版本：6\.4\.3
npm 元数据更新时间：2026-10-26T13:42:13.701Z
中文译文更新时间：2026-11-15T15:49:28.513Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：186 kB，85 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：14 个
- 首次发布：2021-07-08T09:00:31.023Z
- 最新版本发布：2026-10-26T13:42:12.872Z
- 近 30 天下载量：2970（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：143（近 12 个月 28 个）

## 中文简介

[![Continuous Integration](https://github.com/Frontify/frontify-cli/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/Frontify/frontify-cli/actions/workflows/continuous-integration.yml)

## 安装

```sh
npm install @frontify/frontify-cli
```

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

## README

# 格式化 CLI

[![Continuous Integration](https://github.com/Frontify/frontify-cli/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/Frontify/frontify-cli/actions/workflows/continuous-integration.yml)

## 先决条件

-   节点 22

## 安装

```bash
npm install -g @frontify/frontify-cli
# Or
yarn global add @frontify/frontify-cli
```

## 内容块

### 创建

```bash
npx @frontify/frontify-cli block create <app name>
```

内容块名称需要小写, 不允许空格, 但您可以使用下划线 .

示例 `my_custom_content_block`

### 服务

```bash
frontify-cli block serve
```

参数 :

| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| 条目Path | 导出条目文件的路径 `block` 财务报告和审定财务报表 `settings` | 字符串 | `src/index.tsx` |
| 端口 | 本地开发服务器的端口 | 编号 | 第5600条 |

### 部署

```bash
frontify-cli block deploy --instance=<Frontify URL>
```

Frontify URL 代表您的实例 URL .

示例 `weare.frontify.com` 或者说 `https://weare.frontify.com`

## 认证

### 登录

```bash
frontify-cli login --instance=<Frontify URL>
```

Frontify URL 代表您的实例 URL .

示例 `weare.frontify.com` 或者说 `https://weare.frontify.com`

如果您正在使用带有自签名证书的域, 您需要设置 `NODE_TLS_REJECT_UNAUTHORIZED=0` 在命令日志之前

### 注销

```bash
frontify-cli logout
```

## 配置

马可斯: `~/Library/Preferences/frontify-cli-nodejs`

## 常见问题

### 如何安装 @frontify/frontify-cli？

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

### @frontify/frontify-cli 支持 TypeScript 吗？

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

### @frontify/frontify-cli 支持 ESM 还是 CommonJS？

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

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

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

### @frontify/frontify-cli 可以商用吗？

@frontify/frontify-cli 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

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

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

### @frontify/frontify-cli 还在维护吗？

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