Redocly-cli
by Redocly
Enterprise-Grade OpenAPI Toolkit for API Development
Validate, lint, and document OpenAPI specs with powerful CLI tooling designed for modern API workflows and CI/CD integration.
- 1,342+ GitHub stars
- Built with TypeScript
- Multi-format support for OpenAPI 2.0/3.0/3.1, Arazzo, and AsyncAPI specifications
- MIT License license
About This Project
Redocly CLI is a comprehensive command-line toolkit that transforms how development teams work with API specifications. Built for TypeScript environments, it provides robust validation, linting, and documentation generation capabilities that ensure your OpenAPI, Arazzo, and AsyncAPI definitions meet quality standards before deployment.
The tool excels at enforcing API governance policies across organizations, allowing teams to define custom rules that match their architectural standards. Whether you're maintaining a single API or orchestrating dozens of microservices, Redocly CLI integrates seamlessly into CI/CD pipelines to catch specification errors early in the development cycle.
Beyond validation, the CLI generates production-ready API documentation using the popular Redoc renderer, transforming technical specifications into beautiful, interactive documentation that developers actually want to use. It supports multiple OpenAPI versions including the latest 3.1 standard, as well as legacy Swagger 2.0 projects.
With contract testing capabilities and flexible configuration options, this tool bridges the gap between API design and implementation, helping teams maintain consistency across their entire API ecosystem while reducing manual review overhead.
Key Features
- Multi-format support for OpenAPI 2.0/3.0/3.1, Arazzo, and AsyncAPI specifications
- Customizable linting rules with built-in and extensible rulesets for API governance
- Automated documentation generation with Redoc integration for beautiful API docs
- CI/CD-ready CLI interface with exit codes and reporting for pipeline integration
- Bundle and split commands for managing large multi-file API specifications
How You Can Use It
Automated OpenAPI validation in GitHub Actions or GitLab CI pipelines
Enforcing company-wide API design standards across multiple teams
Generating interactive API documentation for developer portals
Contract testing between API providers and consumers
Migrating legacy Swagger 2.0 specs to modern OpenAPI 3.x standards
Pre-commit hooks to catch specification errors before code review
Who Is This For?
API developers, DevOps engineers, technical writers, and platform teams managing API governance in organizations with multiple services