# Redocly/redocly-cli

⚒️ Redocly CLI makes OpenAPI easy. Lint/validate to any standard, generate beautiful docs, and more.

Repository: https://github.com/Redocly/redocly-cli
Canonical: https://ross.abutalabs.com/products/redocly-cli
Homepage: https://redocly.com/docs/cli/
Language: TypeScript
License: MIT
License Family: permissive
Topics: openapi-cli, openapi, openapi3, openapi31, redoc, redocly, api-governance, cicd, linter, swagger2, arazzo, asyncapi, contract-testing
Last push: 2026-08-26T15:36:55+00:00

## Health v2 (maintenance only)
Score: 95/100 (v2, computed 2026-09-03T02:39:23.370411+00:00)
- activity 99, release rhythm 87, longevity 100
- inputs: {"age_days": 2549, "days_push": 7, "days_rel": 7, "gap_med": 0, "n_releases_24m": 564}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1504, forks 228 (observed 2026-08-28T04:04:54.722844+00:00)

## What it is
Redocly CLI is an open-source command-line tool for working with OpenAPI, AsyncAPI, and Arazzo descriptions. It lints and validates API descriptions against configurable rulesets, bundles and splits multi-file specs, builds static API reference documentation with Redoc, and generates typed SDK clients.

## Use cases
- lint and validate my OpenAPI spec against our API guidelines
- generate HTML API reference documentation from an OpenAPI file
- bundle a multi-file OpenAPI description into a single file
- split a large OpenAPI spec into manageable chunks
- enforce API design standards in CI/CD
- generate a TypeScript client from an OpenAPI description
- run contract tests described in Arazzo workflows
- migrate from Spectral or swagger-cli to a maintained linter

## When to choose
- you need OpenAPI/AsyncAPI linting with custom rulesets and governance in CI
- you want to build static API reference docs from OpenAPI without hosting a service
- you need to bundle, split, or join OpenAPI files that use $ref across documents
- you want contract testing or drift detection based on Arazzo descriptions

## When to avoid
- you need a hosted developer portal with collaboration and analytics (use Redocly's commercial platform instead)
- you only need a lightweight OpenAPI parser library to embed in your own code rather than a CLI
- you work with API formats outside OpenAPI, AsyncAPI, Arazzo, or GraphQL

## Facets
- artifact type: cli-tool
- maturity: active
- function: linter, documentation, cli, code-review, testing, sdk
- domain: apis, developer-tools, documentation
- platform: cli, cross-platform
- tags: openapi, swagger, asyncapi, arazzo, api-linting, api-docs, redoc, contract-testing, client-generation, spec-bundling, api-governance, command-line, nodejs, docker

## Member repositories
- Redocly/redocly-cli (main) score 95

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:04:54.722844+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T04:32:44.367779+00:00, confidence not recorded.
  - readme: https://github.com/Redocly/redocly-cli (fetched 2026-08-28T04:04:54.722844+00:00, sha 5ced4273798e)
  - homepage: https://redocly.com/docs/cli/ (fetched 2026-08-29T11:37:43.058412+00:00, sha b81697f8297b)
  - site_page: https://redocly.com/docs (fetched 2026-08-29T11:37:43.069459+00:00, sha 064c74f2ec55)
  - site_page: https://redocly.com/docs/cli/installation (fetched 2026-08-29T11:37:43.072895+00:00, sha c5d01eeb510c)
  - site_page: https://redocly.com/docs/cli/changelog (fetched 2026-08-29T11:37:43.074559+00:00, sha 0a225faaee4e)
  - site_page: https://redocly.com/docs/cli/commands (fetched 2026-08-29T11:37:43.076341+00:00, sha b80051fad5e6)
  - site_page: https://redocly.com/docs/cli/guides (fetched 2026-08-29T11:37:43.078297+00:00, sha d59c0a64a7fb)
  - site_page: https://redocly.com/docs/cli/api-docs (fetched 2026-08-29T11:37:43.080107+00:00, sha 24eb4bec6d95)
  - site_page: https://redocly.com/reunite (fetched 2026-08-29T11:37:43.067445+00:00, sha ac22f4c0f4dc)
  - site_page: https://redocly.com/pricing (fetched 2026-08-29T11:37:43.071202+00:00, sha fb5bca7da923)
- Data as of 2026-08-30T08:39:29.467469+00:00.