Saltar al contenido principal

Instalación

Requisitos​

  • Node.js: >= 22.12.0 (declarado en el campo engines del paquete).
  • Un gestor de paquetes: npm, yarn o pnpm.

El paquete incluye compilaciones ESM (dist/index.js) y CommonJS (dist/index.cjs), junto con declaraciones TypeScript (dist/index.d.ts). No hacen falta paquetes @types adicionales.

Instalación global (recomendada para la CLI)​

La instalación global añade el ejecutable openapi-cli a tu PATH:

npm install -g @powerduck/openapi-cli

Comprueba el ejecutable:

openapi-cli --help

Instalación en el proyecto (recomendada para CI)​

Fija la versión dentro del proyecto para que CI utilice una versión conocida:

npm install --save-dev @powerduck/openapi-cli

Después, ejecuta el comando mediante el gestor de paquetes:

npx openapi-cli --spec openapi.json
# or
pnpm exec openapi-cli --spec openapi.json

Ejecución puntual con npx​

Sin instalación previa:

npx @powerduck/openapi-cli --spec openapi.json

Estructura del paquete​

EntradaRuta
Entrada ESMdist/index.js
Entrada CommonJSdist/index.cjs
Definiciones de tiposdist/index.d.ts
Entrada CLI (bin)dist/cli.js
Nombre del ejecutableopenapi-cli

El paquete declara "type": "module" y solo expone las subrutas . y ./package.json.

Importación programática​

// ESM
import { runTests, resolveConfig } from "@powerduck/openapi-cli";

// CommonJS
const { runTests, resolveConfig } = require("@powerduck/openapi-cli");

Dependencias de ejecución​

El paquete publicado depende de:

  • @powerduck/openapi-parser (^0.3.12) — resolución de referencias $ref internas.
  • @powerduck/openapi-request (0.2.22) — ejecución de solicitudes de protocolo.
  • commander (^12.1.0) — análisis de argumentos de la CLI.
  • https-proxy-agent (^5.0.1) — soporte de proxy para el transporte HTTP.

Siguientes pasos​