# @ama-openapi/cli 中文文档

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

版本：15\.2\.4
npm 元数据更新时间：2026-11-05T10:47:50.416Z
中文译文更新时间：2026-11-06T10:45:08.737Z
软件包许可：BSD-3-Clause

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

原始 npm 页面：https://www.npmjs.com/package/%40ama-openapi/cli
原文对照：https://npmcn.com/package/%40ama-openapi/cli/?lang=original
项目主页：https://amadeusitgroup.github.io/otter/
源码仓库：https://github.com/AmadeusITGroup/otter

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

- 包体积（解压后）：18.8 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^22\.22\.3 \|\| ^24\.15\.0 \|\| ^26\.0\.0
- 运行依赖：4 个
- peer 依赖：chokidar ^4\.0\.0 \|\| ^5\.0\.0
- 首次发布：2025-11-01T02:21:46.658Z
- 最新版本发布：2026-11-05T10:47:50.067Z
- 近 30 天下载量：3446（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：501（近 12 个月 493 个）

## 中文简介

用于管理 OpenAPI 模型的 CLI

## 安装

```sh
npm install @ama-openapi/cli
```

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

## README

# @ama-openapi/ cli (英语)

> \[尖叫声\] [实验](https://github.com/AmadeusITGroup/otter/blob/main/README.md#experimental):此包可提前访问,最终版本将发布于v15.

[![Stable Version](https://img.shields.io/npm/v/@ama-openapi/cli?style=for-the-badge)](https://www.npmjs.com/package/@ama-openapi/cli) [![Bundle Size](https://img.shields.io/bundlephobia/min/@ama-openapi/cli?color=green&style=for-the-badge)](https://www.npmjs.com/package/@ama-openapi/cli)

一个命令行界面(CLI)工具,通过显示文件管理OpenAPI规格及其依赖性.

## 说明

这个 `@ama-openapi/cli` 软件包提供了一个CLI工具,用于自动化安装和管理 [OpenAPI 规格](https://redocly.com/) 基于 [显示文件](https://www.npmjs.com/package/@ama-openapi/core)。 。 。 .  
这是其中的一部分 [AMA OpenAPI 生态系统](https://github.com/AmadeusITGroup/otter/tree/main/packages/@ama-openapi) 帮助管理您的项目中的 OpenAPI 依赖性.

## 安装

### 全球安装

```bash
npm install @ama-openapi/cli
```

> \[!INFO\] 软件包需要安装为 `dependency` 允许 [模式共享](https://github.com/AmadeusITGroup/otter/tree/main/docs/openapi/SHAREABLE_SPECIFICATION.md)。 。 。 .

## 使用量

CLI通过下列途径提供: `ama-openapi` 命令并提供以下功能:

```bash
ama-openapi <command> [options]
```

以下全局选项可用任何命令 :

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `--log-level`, (中文(简体) ), `-l` | `"silent" | "error" | "warning" | "info" | "debug"` | `error` | 定义要在控制台中显示的日志的具体级别 |
| `--help`, (中文(简体) ), `-h` |  |  | 显示帮助信息 |

## 可用命令

### `install` 命令

此命令扫描用于 [显示文件](https://github.com/AmadeusITGroup/otter/tree/main/docs/openapi/MANIFEST_CONFIGURATION.md) 安装全部 [OpenAPI 规格](https://www.openapis.org/) 在这些文件中指明。 安装过程会根据您的运单中的配置下载和处理 OpenAPI 规格 .

```bash
ama-openapi install [options]
```

**实例:**

```bash
# Install dependencies from manifest files
ama-openapi install

# Install with debug output
ama-openapi install --debug

# Install silently
ama-openapi install --silent
```

### `watch` 命令

此命令启动一个文件监视器, 用于监视显示文件的更改 。 当表单文件被修改时,它会自动触发安装过程,确保您 [OpenAPI 规格](https://www.openapis.org/) 在发展过程中始终是最新的.

```bash
ama-openapi watch [options]
```

**实例:**

```bash
# Start watching manifest files
ama-openapi watch

# Watch with debug output
ama-openapi watch --debug
```

### `generate-schema` 命令

生成 [JSON 谢马斯](https://json-schema.org/) 用于配置自动补全.

```shell
npm exec @ama-openapi/cli generate-schema -- [options]
```

#### 选项

| 选项 | 别名 | 说明 | 默认值 |
| --- | --- | --- | --- |
| `--output` | `-o` | 输出目录以在哪里生成计划 | `'./schemas'` |
| `--keywords` | `-k` | 用于设计时要考虑的文物的关键词列表 | `['openapi']` |

## 展示可共享模式

要从OpenAPI软件包中曝光模型,需要以下设置: 1

-   这个 `models/` (或任何可共享的文件夹)应列在 [packet.json 导出](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#exports) 字段.
-   这个 `models_external/` 应列在 [软件包.json 已曝光](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#exports) 文件夹.
-   **这个 `models_external/` 包含内容的文件夹必须在已安装的软件包中存在**

为确保根据最后规格要求的版本正确解决依赖关系问题,应具备 `models_external/` 只能通过 [后置进程](https://www.npmjs.com/package/postinstall)。 。 。 .

```json5
// package.json file
{
  "name": "@my/spec",
  "scripts": {
    "postinstall": "ama-openapi install"
  }
}

```

> \[注\] 查找更多关于模型依赖分辨率的信息 [@ama-openapi/ 核心文件](https://github.com/AmadeusITGroup/otter/tree/main/packages/@ama-openapi/core)。 。 。 .

> \[TIP\] 仓库生成器来自 [@ ama- openapi/ 创建](https://www.npmjs.com/package/@ama-openapi/create) 配置软件包,允许模型默认展开.

## 一体化

这一CLI工具旨在与下列机构无缝地工作:

-   [@ ama- openapi/ 核心](https://www.npmjs.com/package/@ama-openapi/core): 核心依赖管理功能
-   [@ama-openapi/ redocly-plugin (英语)](https://www.npmjs.com/package/@ama-openapi/redocly-plugin) - Redocly CLI一体化
-   [@ ama- openapi/ 创建](https://www.npmjs.com/package/@ama-openapi/create) - 项目脚手架工具

## 常见问题

### @ama-openapi/cli 是什么？

用于管理 OpenAPI 模型的 CLI

### 如何安装 @ama-openapi/cli？

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

### @ama-openapi/cli 支持 TypeScript 吗？

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

### @ama-openapi/cli 支持 ESM 还是 CommonJS？

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

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

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

### @ama-openapi/cli 可以商用吗？

@ama-openapi/cli 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### @ama-openapi/cli 的下载量有多少？

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

### @ama-openapi/cli 还在维护吗？

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