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

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

版本：2\.20\.0
npm 元数据更新时间：2026-10-14T14:23:38.072Z
中文译文更新时间：2026-11-11T00:29:59.585Z
软件包许可：SEE LICENSE IN LICENSE\.txt

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

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

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

- 包体积（解压后）：12.4 MB，464 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：13 个
- 首次发布：2022-08-22T11:40:29.313Z
- 最新版本发布：2026-10-14T14:23:37.842Z
- 近 30 天下载量：3779（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：34（近 12 个月 9 个）

## 中文简介

用于命令脚本的 CH5 Shell 公用事业 CLI

## 安装

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

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

## README

# CH5 壳牌公用事业

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

## 目录

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

## 背景情况

图书馆的目的是揭露 [ch5-壳-用途](https://github.com/Crestron/CH5ShellUtilitiesCli) 存档和分发功能.

## 设置

建设图书馆.

```
npm run build
```

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

```
npm link
```

## 图标

### npm 运行发布: 本地

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

## 开发者

### 配置( json)

{ "命令":"弦:这是终端中使用的命令. 例如:创建:项目等”, "名":"作"取":此为所司所取也. 在多数情况下与命令相同", "别名":"分层阵列:代表像 gen:p 生成:page等命令的可能别名",, "用":"\[可选, "叙事":"行:为命令提供说明",", "可选办法":\[ { "键":"相克", "描述":"创建项目所需的Config文件", "类型":"弦", "默认":"",", "价值"("Value If Not Found"):",",", "别名": \[ " - 装入" \[, "被承认的Values":\[\],, "阿列维德·阿里亚斯": \[\], "校正":"文件"AvaillableAtLocation","file", "问题":"CHECK PROMPT Q 问题. CONFIG FILE", "Is special Argument":"Boolean:指非通过参数如帮助或动词或配置的特殊参数" {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢 \[, "后卫·福德":"./dist/",", "附加帮助":是的, "自动化试验":{ "能说":是的, "可操作的兼容器在测试后删除":真实 {\\fn华文楷体\\fs16\\1cHE0E0E0}, "广电环境":\[ "德夫","德夫","德夫","德夫", "prod" (英语) \[ . \] {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢

### 测试脚本

请用用户名替换 ${USERNAME} 。 此路径应适用于Windows和Mac.

1.  创建工程

1.1 第2页

`rm -rf * && ch5-shell-cli create:project --projectName 'shell-template' && cd shell-template && npm install && npm run gen:p -- --name 'page-2' -m Y && cd .. && mkdir tt1 && cd tt1 && ch5-shell-cli create:project --config /Users/${USERNAME}/Downloads/tt/shell-template/app/project-config.json && cd ..`

1.2. 部件-2

`rm -rf * && ch5-shell-cli create:project --projectName 'shell-template' && cd shell-template && npm install && npm run gen:w -- --name 'widget-2' && cd .. && mkdir tt1 && cd tt1 && ch5-shell-cli create:project --config /Users/${USERNAME}/Downloads/tt/shell-template/app/project-config.json && cd ..`

2.  更新工程

2.1. 第2页

`rm -rf * && ch5-shell-cli create:project --projectName 'shell-template' && cd shell-template && npm install && npm run gen:p -- --name 'page-2' -m Y && cd .. && mkdir tt1 && cd tt1 && ch5-shell-cli create:project --projectName 'shell-template' && cd 'shell-template' && ch5-shell-cli update:project --config /Users/${USERNAME}/Downloads/tt/shell-template/app/project-config.json && cd ..`

2.2. 部件-2

`rm -rf * && ch5-shell-cli create:project --projectName 'shell-template' && cd shell-template && npm install && npm run gen:w -- --name 'widget-2' && cd .. && mkdir tt1 && cd tt1 && ch5-shell-cli create:project --projectName 'shell-template' && cd 'shell-template' && ch5-shell-cli update:project --config /Users/${USERNAME}/Downloads/tt/shell-template/app/project-config.json && cd ..`

### 运行一个用于测试的光谱文件

奔跑的冰雪 我们经常在测试代码中进行修改, 很容易调整你从这里运行的测试。 如果想要运行一个单一的描述()函数,我可以在函数调用中添加.只(),比如:

描述(功能 () { // 这些测试将被跳过 \* ; 描述. only(函数 () { // 这些测试将运行 \* ; 您可以将 . only( ) 粘贴在任意描述上, 不管它是在规格列表中的第一个还是最后一个 .

运行一个单曲测试 正如您可以描述的那样, 如果您在函数调用中附加了. only(), 测试可以指定为完全运行 .

it. only(函数 () { / 此测试将运行 \* ; 它( 函数 () { / 此测试将被跳过 \* ; 2015年10月12日更新:以下说明现已不适用. 在进行单项测试时,目前已核实会运行等钩.

注意 ! 将 . only( ) 放在测试上, 将会跳过 。 这意味着你之前,Each之前,Eh之后,以及Each之后的功能都不被调用. 有时很难记起这有什么关系 所以我通常会进行单一的测试 而不是单一的测试.

东西 如果您想要运行您拥有的切换到某些子集的所有光谱/测试, 并有效评论这些测试, 您可以添加. skip( ) 来描述或函数调用 .

记得要升级 在添加 . only() 或.skip() 后, 您正在更改您测试的实际代码 。 这对你的地方发展进程来说是巨大的。 你需要小心不要做出这样的改变-- 至少你通常不会想要。 否则,您的 CI 进程将运行您测试的一个子集, 就像您是本地的, 这不是bueno .

### 本地设置

`npm run setup:local`

## 常见问题

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

用于命令脚本的 CH5 Shell 公用事业 CLI

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

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

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

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

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

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

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

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

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

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

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

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