# @axway/amplify-cli-utils 中文文档

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

版本：7\.0\.0
npm 元数据更新时间：2026-11-16T18:47:30.575Z
中文译文更新时间：2026-11-16T18:48:14.648Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：68.4 kB，21 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.22\.2
- 运行依赖：10 个
- 首次发布：2018-06-26T16:55:42.965Z
- 最新版本发布：2026-11-16T18:47:30.428Z
- 近 30 天下载量：8747（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：87（近 12 个月 3 个）

## 中文简介

Axway CLI 套件的常见使用费

## 安装

```sh
npm install @axway/amplify-cli-utils
```

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

## README

# Axway CLI 用户

Axway CLI 和相关软件包常用的 utils 库.

## 安装

```
npm i @axway/amplify-cli-utils --save
```

## API 密码

### `buildAuthParams(opts, config)`

基于所供应的 Amplify SDK 或 Amplify SDK Auth 构造器选项对象 `opts` 和 Axway CLI 数据 `config` 对象。 若为 `config` 未定义,配置是从磁盘上加载的.

```js
import { buildAuthParams } from '@axway/amplify-cli-utils';

const opts = buildAuthParams({
    baseUrl: 'foo',
    clientId: 'bar'
});
```

### `createNPMRequestArgs(opts, config)`

如果你正在产卵 `npm`,则以下内容可能有用:

```js
import { createNPMRequestArgs } from '@axway/amplify-cli-utils';
import { spawnSync } from 'child_process';

spawnSync('npm', [ 'view', 'axway', ...createNPMRequestArgs() ]);
```

### `createRequestClient(opts, config)`

创建一个 `got` 配置 Axway CLI 网络设置的 HTTP 客户端 .

```js
import { createRequestClient } from '@axway/amplify-cli-utils';

const got = createRequestClient();
const response = await got('https://www.axway.com/');
```

### `createRequestOptions(opts, config)`

装入 Axway 的 CLI 配置文件并构建各种节点.js HTTP 客户端的选项 包括 `pacote`, (中文(简体) ), `npm-registry-fetch`, (中文(简体) ), `make-fetch-happen`,以及 `request`。 。 。 .

```js
import { createRequestOptions } from '@axway/amplify-cli-utils';

const opts = createRequestOptions();
console.log({
    ca:        opts.ca,
    cert:      opts.cert,
    key:       opts.key,
    proxy:     opts.proxy,
    strictSSL: opts.strictSSL
});
```

### `createTable(heading1, heading2, heading3, ...)`

创建一个 `cli-table3` 使用普通桌垫和样式.

```js
import { createTable } from '@axway/amplify-cli-utils';

const table = createTable('Name', 'Version');
table.push([ 'foo', '1.0.0' ]);
table.push([ 'bar', '2.0.0' ]);
console.log(table.toString());
```

### `environments.resolve(env)`

返回环境特定设置.

```js
import { environments } from '@axway/amplify-cli-utils';

console.log(environments.resolve());
console.log(environments.resolve('prod'));
console.log(environments.resolve('production'));
```

### `locations`

包含 `axwayHome` 财务报告和审定财务报表 `configFile` 路径.

```js
import { locations } from '@axway/amplify-cli-utils';

console.log('Axway Home Directory:', locations.axwayHome);
console.log('Axway CLI Config Path:', locations.configFile);
```

### `initSDK(opts, config)`

装入 Axway CLI 配置并初始化一个 Amplify SDK 实例 .

#### 需要时获取默认账户或登录 :

```js
import { initSDK } from '@axway/amplify-cli-utils';

async function getAccount(opts) {
    try {
        return await initSDK(opts).sdk.auth.login();
    } catch (err) {
        if (err.code === 'EAUTHENTICATED') {
            return err.account;
        }
        throw err;
    }
}

(async () => {
    const account = await getAccount({ clientId: 'foo' });
    if (!account) {
        console.error('Please login in by running: amplify auth login');
        process.exit(1);
    }
}());
```

#### 通过登录参数查找账户

```js
import { initSDK } from '@axway/amplify-cli-utils';

(async () => {
    const { sdk, config } = initSDK({
        baseUrl:      '',
        clientId:     '',
        clientSecret: '',
        env:          '',
        password:     '',
        realm:        '',
        secretFile:   '',
        username:     ''
    });

    const account = await sdk.auth.find('foo');

    if (account && !account.expired) {
        console.log('Found a valid access token!');
        console.log(account);
        return;
    }

    console.error('No valid authentication token found. Please login in again by running:');
    console.error('  amplify auth login');
    process.exit(1);
}());
```

### 通过 id 查找账户

```js
const accountName = '<client_id>:<email_address>';
const account = await sdk.auth.getAccount(accountName);
```

### 获取所有认证账户

```js
const accounts = await sdk.auth.list();
console.log(accounts);
```

### `loadConfig()`

使用懒惰装入的 Amplify 配置包装入 Axway CLI 配置文件.

```js
import { loadConfig } from '@axway/amplify-cli-utils';

const config = loadConfig();
console.log(config);
```

## 遥测

如果您想要在 Axway CLI 扩展名中添加遥测功能, 您需要创建一个应用程序 用于生成 app guid 的平台。 然后需要复制并粘贴以下锅炉板. API的设计是灵活的,其代价是做更多的工作来整合.

```js
import {
    createRequestOptions,
    environments,
    loadConfig,
    locations,
    Telemetry
} from '@axway/amplify-cli-utils';

const appGuid = '<GUID>';
const appVersion = 'x.y.z';
const telemetryCacheDir = path.join(locations.axwayHome, '<PRODUCT_NAME>', 'telemetry');

function initTelemetry(opts = {}) {
    const config = opts.config || loadConfig();
    if (!config.get('telemetry.enabled')) {
        return;
    }

    const env = environments.resolve(opts.env || config.get('env'));

    const telemetryInst = new Telemetry({
        appGuid,
        appVersion,
        cacheDir,
        environment: env === 'preprod' ? 'preproduction' : 'production',
        requestOptions: createRequestOptions(opts, config)
    });

    process.on('exit', () => {
        try {
            telemetryInst.send();
        } catch (err) {
            warn(err);
        }
    });

    return telemetryInst;
}

const telemetry = initTelemetry();
telemetry.addEvent({
    event: 'my.event',
    some: 'data'
});
```

## 从1.x版本升级

在v2,整个 `auth` API被移除是为了利用新的Amplified SDK,它现在 包含认证 API.

```js
// Find account by login parameters

// v1
import { auth } from '@axway/amplify-cli-utils';
const { account, client, config } = await auth.getAccount({ /* auth options */ });

// v2
import { initSDK } from '@axway/amplify-cli-utils';
const { config, sdk } = initSDK({ /* auth options */ });
const account = await sdk.auth.find();
```

```js
// Find account by id

// v1
import { auth } from '@axway/amplify-cli-utils';
const { account, client, config } = await auth.getAccount('<CLIENT_ID>:<EMAIL>');

// v2
import { initSDK } from '@axway/amplify-cli-utils';
const { config, sdk } = initSDK({ /* auth options */ });
const account = await sdk.auth.find('<CLIENT_ID>:<EMAIL>');
```

```js
// Get all credentialed accounts

// v1
import { auth } from '@axway/amplify-cli-utils';
const accounts = await auth.list();

// v2
import { initSDK } from '@axway/amplify-cli-utils';
const { config, sdk } = initSDK({ /* auth options */ });
const accounts = await sdk.auth.list();
```

## 法律

此工程在 : [Apache 公共许可证 v2](https://github.com/appcelerator/amplify-tooling/blob/master/packages/amplify-cli-utils/LICENSE) 开发者 [阿克斯韦公司](http://www.axway.com/) 与社区。 请读一下 [`LICENSE`](https://github.com/appcelerator/amplify-tooling/blob/master/packages/amplify-cli-utils/LICENSE) 包含文件 在此分发更多信息.

## 常见问题

### @axway/amplify-cli-utils 是什么？

Axway CLI 套件的常见使用费

### 如何安装 @axway/amplify-cli-utils？

在项目目录运行 npm install @axway/amplify-cli-utils，或使用 pnpm add / yarn add / bun add。

### @axway/amplify-cli-utils 支持 TypeScript 吗？

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

### @axway/amplify-cli-utils 支持 ESM 还是 CommonJS？

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

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

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

### @axway/amplify-cli-utils 可以商用吗？

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

### @axway/amplify-cli-utils 的下载量有多少？

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

### @axway/amplify-cli-utils 还在维护吗？

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

