安装
环境要求
- Node.js：
>= 22.12.0（在包的engines字段中声明）。 - 包管理器：npm、yarn 或 pnpm。
包同时提供 ESM（dist/index.js）和 CommonJS（dist/index.cjs）构建，以及 TypeScript 类型声明（dist/index.d.ts），无需额 外安装 @types 包。
全局安装（推荐用于命令行）
全局安装后，可通过 PATH 找到 openapi-cli 可执行文件：
npm install -g @powerduck/openapi-cli
验证命令是否可用：
openapi-cli --help
项目内安装（推荐用于 CI）
在项目中固定版本，确保 CI 使用已知版本：
npm install --save-dev @powerduck/openapi-cli
然后通过包管理器执行命令：
npx openapi-cli --spec openapi.json
# or
pnpm exec openapi-cli --spec openapi.json
使用 npx 临时运行
无需预先安装：
npx @powerduck/openapi-cli --spec openapi.json
包结构
| 入口 | 路径 |
|---|---|
| ESM 入口 | dist/index.js |
| CommonJS 入口 | dist/index.cjs |
| 类型定义 | dist/index.d.ts |
| CLI 入口（bin） | dist/cli.js |
| 可执行文件名 | openapi-cli |
包声明了 "type": "module"，且仅导出 . 和 ./package.json 两个子路径。
在代码中导入
// ESM
import { runTests, resolveConfig } from "@powerduck/openapi-cli";
// CommonJS
const { runTests, resolveConfig } = require("@powerduck/openapi-cli");
运行时依赖
发布的包依赖以下库：
@powerduck/openapi-parser(^0.3.12) — 解析内部$ref引用。@powerduck/openapi-request(0.2.22) — 执行各协议的请求。commander(^12.1.0) — 解析命令行参数。https-proxy-agent(^5.0.1) — 为 HTTP 传输提供代理支持。