# @apex-actions/cli 中文文档

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

版本：0\.98\.1
npm 元数据更新时间：2026-11-07T04:01:49.899Z
中文译文更新时间：2026-11-06T23:36:39.599Z
软件包许可：SEE LICENSE IN LICENSE

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

原始 npm 页面：https://www.npmjs.com/package/%40apex-actions/cli
原文对照：https://npmcn.com/package/%40apex-actions/cli/?lang=original
源码仓库：https://github.com/Apex-Actions/apex-actions

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

- 包体积（解压后）：491 kB，97 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=24
- 运行依赖：3 个
- 首次发布：2026-09-26T22:37:07.920Z
- 最新版本发布：2026-11-07T04:01:49.736Z
- 近 30 天下载量：2164（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：42（近 12 个月 42 个）

## 中文简介

apex 高级动作开发者和操作者 CLI

## 安装

```sh
npm install @apex-actions/cli
```

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

## README

# 语气

`apex` 开发者和操作者 CLI(TypeScript,指揮官).

工作空间 [顶级动作](https://npmcn.com/package/README.md) 仓库。 里面的东西: [`docs/architecture/components/cli.md`](https://npmcn.com/package/docs/architecture/components/cli.md)公约: [`docs/conventions/`](https://npmcn.com/package/docs/conventions/README.md)。 。 。 .

## 图标

| 命令 | 范围 | 需求 |
| --- | --- | --- |
| `apex run` | 运行二进制, 本地 | `apex-runner` 打开 `PATH` |
| `apex validate` | 本地引擎二进制 | `apex-engine` 打开 `PATH` |
| `apex migrate scan` | 引擎二进制 + GitHub REST API | `apex-engine` 打开 `PATH`· ; `GITHUB_TOKEN` 除非 `--path` |
| `apex logs` | 控制飞机 REST API | 客户代号: `actions:read` (单位:千美元)`logs delete`数字 : `actions:write`),或机器符号 |
| `apex dispatch` | 控制飞机 REST API | 客户代号: `actions:write`,或机器符号 |
| `apex login` • 妇女 `logout` • 妇女 `whoami` | 浏览器和控制平面 REST API | 没什么.. `login` 薄荷证书 |
| `apex token create` | 浏览器和控制平面 REST API | 登记到仪表盘的人,谁批准它 |
| `apex token edit` | 控制平面 REST API; 扩展的浏览器 | 客户代币缩小; 个人在仪表板上签字扩大 |
| `apex token list` • 妇女 `revoke` | 控制飞机 REST API | 客户代币(`APEX_TOKEN` 或者说 `apex login`(中文(简体) ) |
| `apex secret` • 妇女 `apex variable` | 控制飞机 REST API | 客户代号: `secrets:*` 编号 : `variables:*` (单位:千美元)`APEX_TOKEN` 或者说 `apex login`(中文(简体) ) |
| `apex login --console` • 妇女 `logout --console` | 浏览器中的管理控制台,以及控制平面 REST API | 接线员签到行政控制台,由行政控制台批准 |
| `apex grant list` • 妇女 `apex tenant installations` | 控制飞机管理员API | 运算符( e)`apex login --console`),或机器符号 |
| `apex grant create` • 妇女 `update` • 妇女 `revoke` | 控制飞机管理员API | 运算符( e)`apex login --console`——从不给机器代币(`api` ADR-0056 (英语), `api` ADR-0079 (英语) |

其它客户命令 `cli/reference.ts` 名称它需要的许可; 公众参考显示它.

生成的引用 : `docs/features/cli-commands.md` (单位:千美元)`pnpm docs:cli` 从 `packages/tooling`),以及 公共网站所建的结构, `apps/cli/cli-reference.json` (单位:千美元)`pnpm docs:reference`· ; 只有客户命令, 分类于 `cli/reference.ts`) (中文(简体) ).

```bash
export APEX_API_URL=https://apex.example
export APEX_ADMIN_TOKEN=…                       # the machine token, not a person's session

apex dispatch .github/workflows/deploy.yml --repo octo/app --ref main --input environment=production
apex logs latest --repo octo/app --follow  # exits non-zero if the run failed
apex logs '#42' --job test                 # one job, clean enough to pipe
```

`apex migrate scan` 回答"会运行我的工作流程" 在任何东西移动之前。 每个判决都来了 从发动机与证明它的固定装置的相符合性(`cli` ADR-0002, (英语), `engine` ADR-0013) - (英语) 这里没有关于兼容性的第二个意见。 它进口秘密和可变 **名称** 财务报告和审定财务报表 永远没有价值,和 `--path` 扫描此机器上的一次检出, 没有符号和网络 :

```bash
apex migrate scan --path .                      # this repository, no credentials
apex migrate scan acme --repo acme/api --json   # one repository of an organization
```

### 全权证书

CLI决定一个证书, 依此顺序(`api` ADR-0064,经 [ADR-0005 (英语)](https://npmcn.com/package/docs/adrs/cli/0005-an-exported-token-outranks-a-saved-login.md)(b) —— **环境排行榜 文件**数字 :

1.  `APEX_TOKEN` - 在仪表板上铸造一个标志(`/settings/tokens`),用于CI和脚本;
2.  `APEX_ADMIN_TOKEN` ——接线员的机器代号,不变:没有被扫描,所以将其视为根 证书。 输出变量是故意选择,因为 `GH_TOKEN` 排行 `gh`存储 登录; 一个保存的登录用来取胜, 所以操作员 shell 充当上次运行的客户 `apex login` 在机器上;
3.  符号 `apex login` 保存在 `$XDG_CONFIG_HOME/apex/credentials` (默认) `~/.config`, (中文(简体) ), 模式 `0600` 在一个 `0700` 目录——按组或其他内容可读的文件 **拒绝**,作为 `ssh` 拒绝私钥;
4.  否则命令随出口2而停止,命名 `APEX_TOKEN` 财务报告和审定财务报表 `apex login`。 。 。 .

**运算符命令** —— 说 `apex grant` 财务报告和审定财务报表 `apex tenant installations` - 先找找 - 找找看 - look first for the **运算符 符号** `apex login --console` 保存在 `$XDG_CONFIG_HOME/apex/console-credentials` (相同的模式规则),何时 未过期,由控制平面制造 `APEX_API_URL` 名称,或者使用以上顺序 (单位:千美元)`api` ADR-0079 (英语). 运营符在行政控制台上获得批准(`APEX_CONSOLE_URL`,或 API的软件 `app.` 主机读取为 `admin.`由操作员进行,仅通过回回;最多一周,并达到 只有捐赠路线和安装清单,并且每笔捐赠都写上其经营者的名字。 那个机器 符号可以列出赠款并被拒绝每次写作. `apex logout --console` 撤销并忘记它.

`APEX_API_URL` 选择控制平面( 默认) `https://app.apexactions.com`; 保存的登录是 只是被送到了发布它的控制飞机上. `apex login` 在网络上打开同意页面 应用 - `APEX_WEB_URL`,或者 API 的起源——并听 `127.0.0.1` 循环回调 (RFC 8252, PKCE); 代码被赎回后, 它把标签交给网络应用的裸体 `/cli/done` 页 次`api` ADR-0075 (英语). 在该机器上无法打开浏览器的地方—— SSH会话 (单位:千美元)`SSH_CONNECTION`编号 :`SSH_TTY`),编码空间,dev容器, `/.dockerenv`,或 Linux 没有 `DISPLAY` 也没有 `WAYLAND_DISPLAY` ——或与 `--device` (或 `--no-browser`,它使用 **设备流动** 相反(RFC 8628, 由 Apex 运行 : 它打印一个代码和 `…/cli/device`在任何设备上输入密码 包括电话, 和CLI民意测验——荣誉 `interval` 财务报告和审定财务报表 `slow_down` ——直到批准,拒绝或代码的十 几分钟结束. `--browser` 坚持回转. `apex token create` 以及扩大 `apex token edit` 带 同为三旗. 客户代币 **权限** (单位:千美元)`resource:read|write`,写作暗示 已读; 资源 `actions`, (中文(简体) ), `approvals`, (中文(简体) ), `deployments`, (中文(简体) ), `secrets`, (中文(简体) ), `variables`, (中文(简体) ), `environments`, (中文(简体) ), `notifications`, (中文(简体) ), `administration`)属于 **一个账户** (单位:千美元)`api` ADR-0071 (英语). 它到达存储器的路线 赠款包括个人作用范围内的赠款和账户所有者的象征性政策; `apex login` 拿着保险单 在账户中默认某人的角色(所有者:一切) `--account` 名称,如果有超过 一个 一条路,它缺乏 资助答案403 `this token needs <permission>`,而CLI则与 `apex token edit <id> --add-permission <permission>` 这会增加它. `apex whoami` 名称、使用证书、发现地点和任何其他证书 排名超过. `apex logout` 取消服务器上保存的令牌, 然后删除文件。 没有命令打印一个符号——除了 `apex token create`他们的全部工作是: 印出一个新的,一次.

```bash
apex login                                                   # once per machine
apex login --device                                          # over SSH: approve from a phone with the printed code
printf %s "$TOKEN" | apex secret set ETS_PACKAGES_TOKEN --repo acme/api --repo acme/web
apex secret set DEPLOY_KEY --repo acme/api --from-file ./deploy.key
apex variable set AWS_REGION --value eu-west-1 --repo acme/api
apex secret list --repo acme/api --json                      # names only
```

管道会得到它自己的象征。 它像登录一样在浏览器中被批准, 印出一次Stdout, 并且从未保存( n)`api` ADR-0064:一个从未铸造过标志:

```bash
apex token create ci-deploy --permission actions:write --permission secrets:write \
  --repo acme/api --expires-in-days 30                             # token on stdout, details on stderr
apex token edit <id> --remove-permission secrets:write             # narrowing: applies at once
apex token edit <id> --add-permission deployments:write            # widening: approved in the browser
apex token list                                                    # by Account, with grants; * marks the one in use
apex token revoke 0b6f1c2e-9d4a-4f7e-8a31-5c2d9e7b1a40              # or --all
```

`apex secret set` 永远不会从命令行中取出值 —— argv 可见于 `ps` 保存在 外壳历史(BUG-0157)——如此 `--value` 以2号出口拒绝。 退出代码: 0 完成 : 1 API 拒绝 ^ 2 个用法或配置 ^ 3 未在 `delete`。 。 。 .

## 版式

-   `cli/<command>/main.ts` - 每个命令一个指挥官叶子(§7)
-   `src/domain/` ——纯决定:运行和职务选择,输入解析,退出代码
-   `src/application/` - 港口上使用个案
-   `src/infrastructure/` ——适配器:引擎和跑道二进制,REST API
-   文档是根源: `docs/adrs/cli/`,其余按类别分列 `docs/` (TASK-0526) (韩语)
-   `VERSION` ——发布版本,其中 `version:sync` 从根( ADR- 0048) 写出; 从未手工编辑

## 许可证

`@apex-actions/cli` 专有软件,根据 [Apex 动作软件许可证](https://apexactions.com/legal/software-licence/) 看到了吗 `LICENSE`。 。 。 . 它所谈的主办服务由 [服务条件](https://apexactions.com/legal/terms/)。 。 。 .

## 常见问题

### @apex-actions/cli 是什么？

apex 高级动作开发者和操作者 CLI

### 如何安装 @apex-actions/cli？

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

### @apex-actions/cli 支持 TypeScript 吗？

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

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

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

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

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

### @apex-actions/cli 可以商用吗？

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

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

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

### @apex-actions/cli 还在维护吗？

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