Redocly CLI OpenAPI Linter and Documentation Generator

Redocly CLI OpenAPI Linter and Documentation Generator

Redocly CLI is an all-in-one OpenAPI utility that lints, validates, bundles, and generates documentation from API descriptions. It supports OpenAPI 3.2, 3.1, 3.0, Swagger 2.0, AsyncAPI 3.0, and Arazzo 1.0 with customizable rulesets for API governance.

Installation

Use the upstream install or setup path that matches your environment:

• npx @redocly/cli@latest lint path-to-root-file.yaml
• npm install @redocly/cli -g
• docker run --rm -v $PWD:/spec redocly/cli lint path-to-root-file.yaml
• docker build -t redocly/cli .

Requirements and caveats from upstream:

• Node

• The minimum required versions of Node.js and NPM are 22.12.0 and 10.9.2 respectively.

• Docker

Basic usage or getting-started notes:

• sh

• Alternatively, install it globally with npm:

• Then you can use it as redocly [command] [options], for example:

• Source: https://github.com/Redocly/redocly-cli

• Extracted from upstream docs: https://raw.githubusercontent.com/Redocly/redocly-cli/HEAD/README.md

Source

• Agent Skill Exchange