# @adobe/helix-cli 中文文档

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

版本：14\.26\.0
npm 元数据更新时间：2026-10-01T01:33:49.655Z
中文译文更新时间：2026-11-06T03:40:09.195Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：359 kB，34 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=14
- 运行依赖：35 个
- 首次发布：2018-06-05T16:35:21.945Z
- 最新版本发布：2023-09-15T14:16:52.930Z
- 近 30 天下载量：5407（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：1213（近 12 个月 0 个）

## 中文简介

Helix CLI项目

## 安装

```sh
npm install @adobe/helix-cli
```

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

## README

# 螺旋/ AEM 命令行接口 (`hlx` 或者说 `aem`(中文(简体) )

## 状态

[![codecov](https://img.shields.io/codecov/c/github/adobe/helix-cli.svg)](https://codecov.io/gh/adobe/helix-cli) [![CircleCI](https://img.shields.io/circleci/project/github/adobe/helix-cli/main.svg)](https://circleci.com/gh/adobe/helix-cli/tree/main) [![GitHub license](https://img.shields.io/github/license/adobe/helix-cli.svg)](https://github.com/adobe/helix-cli/blob/master/LICENSE.txt) [![GitHub issues](https://img.shields.io/github/issues/adobe/helix-cli.svg)](https://github.com/adobe/helix-cli/issues) [![LGTM Code Quality Grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/adobe/helix-cli.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/adobe/helix-cli)

Helix 命令行接口允许网络开发人员使用 Adobe 体验管理器网站“ Edge Services” f.k.a“Project Helix”创建、开发并部署数字体验

## 安装

安装 `hlx` 或者说 `aem` 作为全球指令。 你需要节点12.11或更新.

```bash
$ npm install -g @adobe/helix-cli
```

## 快速启动

您可以互换 `hlx` 财务报告和审定财务报表 `aem` 在下文列举的例子中.

```
$ hlx --help
Usage: hlx <command> [options]

Commands:
  hlx up  Run a Helix development server

Options:
  --version                Show version number                         [boolean]
  --log-file, --logFile    Log file (use "-" for stdout)  [array] [default: "-"]
  --log-level, --logLevel  Log level
        [string] [choices: "silly", "debug", "verbose", "info", "warn", "error"]
                                                               [default: "info"]
  --tls-key, --tlsKey      Path to .key file (for enabling TLS)        [string]
  --tls-cert, --tlsCert    Path to .pem file (for enabling TLS)        [string]
  --help                   Show help                                   [boolean]

use <command> --help to get command specific details.

for more information, find our manual at https://github.com/adobe/helix-cli
```

## 开始发展

```
$ cd <my-cool-project>
$ hlx up
```

### 自动打开浏览器

这个 `--open` 参数选择路径, eg `--open=/products/`,将会使浏览器打开 在具体地点。 禁用为 `--no-open'.`

### 设置使用 https 的自签名证书

1.  创建证书

```
$ openssl req -new -newkey rsa:4096 -x509 -sha256 -days 365 -nodes -out server.crt -keyout server.key -subj "/CN=localhost"
```

这将创建两个文件 : `server.crt` 财务报告和审定财务报表 `server.key`

2.  以 tls 支持启动 hlx

```
$ hlx up --tls-cert server.crt --tls-key server.key
    ____              __    ___   v14.21.4
   / __/______ ____  / /__ / (_)__
  / _// __/ _ `/ _ \/  '_// / / _ \
 /_/ /_/  \_,_/_//_/_/\_\/_/_/_//_/

info: Starting Franklin dev server v14.21.4
info: Local Franklin dev server up and running: https://localhost:3000/
```

3.  (可选) 将参数添加到.env文件 :

```
$ echo -e "HLX_TLS_CERT=server.crt\nHLX_TLS_KEY=server.key" >> .env
```

### 环境

所有命令参数也可以通过环境变量指定. 页:1 `.env` 文件为 自动装入 .

示例:

`.env`

```dotenv
HLX_OPEN=/products
HLX_PORT=8080
HLX_PAGES_URL=https://stage.myproject.com
```

#### HTTP 代理服务器

为了使用 HTTP 代理( 如公司防火墙 ) , 您可以设置相应的环境变量 :

`NO_PROXY` 是一个主机名列表(可选择带有端口)。 如果输入的 URL 匹配其中的任何条目 `NO_PROXY`,然后输入 URL 应通过直接请求获取(即没有代理).

匹配遵循以下规则: 1

`NO_PROXY=*` 禁用所有代理人. 空格和逗号可用于分隔 `NO_PROXY` 列表中选择一个选项. 若为 `NO_PROXY` 不包含任何条目,则代理从不禁用. 如果在主机名后添加一个端口,则端口必须匹配. 如果URL没有明确的端口名称,则使用协议的默认端口. 一般来说,只有在主机名与条目完全匹配时,代理机才会被禁用 `NO_PROXY` 列表中选择一个选项。 唯一的例外是以点开头或以通配符开头的条目;如果主机名以条目结尾,则代理机被禁用. 见test.js 关于什么应该匹配什么不匹配的例子.

`*_PROXY` 用于代理的环境变量取决于URL的协议. 譬如说, [https://example.com (中文(简体) )](https://example.com/) 使用“ https” 协议, 因此要使用的代理是 `HTTPS_PROXY` (无) `HTTP_PROXY`,仅用于http:-URLs).

如果现在, `ALL_PROXY` 如果没有其他匹配,则用作倒置.

#### 全球

| 选项 | 变量 | 默认 | 说明 |
| --- | --- | --- | --- |
| `--log-file` | `HLX_LOG_FILE` | `-` | 日志文件 。 使用情况 `-` 登录到 stdout |
| `--log-level` | `HLX_LOG_LEVEL` | `info` | 日志级别 |

#### 上调命令

| 选项 | 变量 | 默认 | 说明 |
| --- | --- | --- | --- |
| `--port` | `HLX_PORT` | `3000` | 开发服务器端口 |
| `--addr` | `HLX_ADDR` | `127.0.0.1` | 开发服务器绑定地址 |
| `--livereload` | `HLX_LIVERELOAD` | `true` | 在浏览器中允许自动重新装入修改过的源 . |
| `--no-livereload` | `HLX_NO_LIVERELOAD` | `false` | 禁用活装 . |
| `--open` | `HLX_OPEN` | `/` | 服务器启动后在指定路径打开浏览器窗口 . |
| `--no-open` | `HLX_NO_OPEN` | `false` | 禁用自动打开浏览器窗口 . |
| `--tls-key` | `HLX_TLS_KEY` | 未定义 | .key文件路径( 用于启用 TLS) |
| `--tls-cert` | `HLX_TLS_CERT` | 未定义 | .pem 文件路径( 用于启用 TLS) |

# 开发 Helix CLI

## 测试

你用得着 `npm run check` 运行测试并检查您的代码是否遵守 到螺旋-cli编码样式.

## 常见问题

### @adobe/helix-cli 是什么？

Helix CLI项目

### 如何安装 @adobe/helix-cli？

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

### @adobe/helix-cli 支持 TypeScript 吗？

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

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

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

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

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

### @adobe/helix-cli 可以商用吗？

@adobe/helix-cli 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

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

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

### @adobe/helix-cli 还在维护吗？

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