# @crestron/ch5-utilities-cli 中文文档

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

版本：2\.19\.0
npm 元数据更新时间：2026-08-25T12:57:42.355Z
中文译文更新时间：2026-11-11T00:26:22.544Z
软件包许可：SEE LICENSE IN LICENSE\.txt

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

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

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

- 包体积（解压后）：37 kB，16 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2019-06-04T22:49:13.826Z
- 最新版本发布：2026-08-25T12:57:42.185Z
- 近 30 天下载量：5580（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：512（近 12 个月 1 个）

## 中文简介

CH5 用于存档和分发的公用事业CLI

## 安装

```sh
npm install @crestron/ch5-utilities-cli
```

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

## README

# CH5 公用事业

> 以CLI命令包裹的ch5-用量库的存档和分发公用事业.

## 目录

-   [背景情况](https://npmcn.com/package/%40crestron/ch5-utilities-cli/#readme-background)
-   [设置](https://npmcn.com/package/%40crestron/ch5-utilities-cli/#readme-setup)
-   [图标](https://npmcn.com/package/%40crestron/ch5-utilities-cli/#readme-commands)
-   [使用量](https://npmcn.com/package/%40crestron/ch5-utilities-cli/#readme-usage)
-   [许可证](https://npmcn.com/package/%40crestron/ch5-utilities-cli/#readme-license)

## 背景情况

图书馆的目的是揭露 [ch5 用途](https://npmcn.com/package/%40crestron/CH5Utilities/readme.md) 将功能存档并作为两个命令分发: `archive` 财务报告和审定财务报表 `deploy`。 。 。 .

## 设置

在通过这些步骤之前,请确保您已完成设置部分 [ch5 用途](https://npmcn.com/package/%40crestron/CH5Utilities/readme.md)因为它是一个依赖.

安装所需的软件包 .

```
npm install
```

增加ch5-用量库.

```
npm link @crestron/ch5-utilities
```

建设图书馆.

```
npm run build
```

出版ch5-用地-cli库供本地使用.

```
npm run link
```

## 图标

### npm 运行发布: 本地

初始设置后,您可以使用此命令重建并发布库中的更改.

## 使用量

Cli包含两个命令:归档和部署. 跟着上面的台阶,就写 `ch5-cli` 在终端中,点击输入 - 它将显示选项和命令的默认消息. 对于如何使用命令的细节,您可以写入 `ch5-cli archive --help` 或者说 `ch5-cli deploy --help` - 这将显示选项和它们的意思.

首先您需要运行归档命令以生成 ch5z 文件, 然后您需要运行配置命令给出归档路径( 相对或绝对 ) . 部署命令会提示您使用 SFTP 用户和密码,

## 认证到控制系统

用户可以通过多种方式向ch5-cli提供证书:

-   默认值
-   环境变量(`CH5CLI_DEPLOY_USER` 财务报告和审定财务报表 `CH5CLI_DEPLOY_PW`(中文(简体) )
-   a 公用/私用钥匙配对

以下的真相表根据所传递的参数显示行为:

| `-u` 身份用户 | `-i` 身份文件 | `-p` 立即递交全权证书 | 环境 vars | 认证 |
| --- | --- | --- | --- | --- |
| 0 个 | 0 个 | 0 个 | 0 个 | 默认值 |
| 0 个 | 0 个 | 0 个 | 1个 | 环境变量 |
| 0 个 | 0 个 | 1个 | 页:1 | 用户和密码来自用户提示 |
| 0 个 | 1个 | 0 个 | 0 个 | 系统用户名( N)`$USER` 在unix上, `%USERNAME%` 窗口) |
| 0 个 | 1个 | 0 个 | 1个 | 来自环境变量的用户和密码句 |
| 0 个 | 1个 | 1个 | 页:1 | 来自用户的用户和密码句提示 |
| 1个 | 0 个 | 页:1 | 页:1 | 无效的组合 。 将显示错误消息 |
| 1个 | 1个 | 0 个 | 0 个 | 提供身份用户和身份文件。 如果需要密码句,则显示错误消息 |
| 1个 | 1个 | 0 个 | 1个 | 如果需要, 来自环境变量的密码句 |
| 1个 | 1个 | 1个 | 页:1 | 用户提示的密码句 |

### 实例

```
> ch5-cli archive --project-name angular-demo-app --directory-name dist/NgIseCh5Demo --output-directory output-test
>
> ch5-cli archive -p my-project-v1.0.0 -d ./ -o /Users/${USERNAME}o/git/CH5UtilitiesCli -s shell-template.ch5z
>
> ch5-cli deploy output-test/angular-demo-app.ch5z --deviceHost 192.168.2.44 --deviceDirectory display --deviceType touchscreen
```

## 许可证

版权(C)2018至今 Crestron Electronics, Inc. 版权所有. 不得以任何形式、机器复制本软件的任何部分 或自然的,未经克列斯特龙电子公司的明示书面同意. 使用此源代码必须遵守 Crestron 软件的条款 开发工具许可协议, 您根据该协议为此源代码发放许可 .

如果你不接受许可协议的条款, 您无权使用此软件。 就许可证而言, 请看您和Crestron的许可协议 [http://www.crestron.com/sla (中文(简体) )](http://www.crestron.com/sla)。 。 。 .

## 常见问题

### @crestron/ch5-utilities-cli 是什么？

CH5 用于存档和分发的公用事业CLI

### 如何安装 @crestron/ch5-utilities-cli？

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

### @crestron/ch5-utilities-cli 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @crestron/ch5-utilities-cli 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @crestron/ch5-utilities-cli 可以商用吗？

@crestron/ch5-utilities-cli 使用 SEE LICENSE IN LICENSE\.txt 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @crestron/ch5-utilities-cli 的下载量有多少？

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

### @crestron/ch5-utilities-cli 还在维护吗？

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