@apivexa/cli

Command-line tool for ApiVexa — generate, analyse, validate, and compare API documentation.

Part of ApiVexa — AI-powered API User Guide Generator.

Install

npm install -g @apivexa/cli

Requires Node.js 20+

Commands

generate — create an API User Guide

apivexa generate openapi.yaml
apivexa generate openapi.json --format html
apivexa generate https://petstore3.swagger.io/api/v3/openapi.json

Options

| Flag | Description | |------|-------------| | -o, --output <path> | Output file path | | -f, --format <fmt> | md (default) · html · pdf · docx | | -l, --language <lang...> | Code example languages (default: all 8) | | --base-url <url> | Override base URL in code examples | | --config <path> | Path to apivexa.config.yaml |

Language examples

apivexa generate openapi.yaml --language python
apivexa generate openapi.yaml -l curl javascript python go

analyze — print API intelligence

apivexa analyze openapi.yaml

validate — validate docs against spec

apivexa validate ./docs/api-guide.md --spec openapi.yaml

compare — diff two API versions

apivexa compare openapi-v1.yaml openapi-v2.yaml

Configuration file

Create apivexa.config.yaml in your project root:

ai:
  provider: anthropic
  model: claude-opus-5
output:
  format: markdown
  dir: ./docs
languages:
  - curl
  - python
  - javascript

AI enrichment

Set an API key to enable AI-powered prose generation:

ANTHROPIC_API_KEY=sk-ant-... apivexa generate openapi.yaml
OPENAI_API_KEY=sk-...        apivexa generate openapi.yaml

Without a key, ApiVexa generates a complete, structured guide from the OpenAPI spec alone — zero AI calls, zero cost.

Full documentation