Redocly CLI

Redocly's `lint` command identifies and reports problems in OpenAPI, AsyncAPI, Arazzo, or Open-RPC descriptions, helping teams "avoid bugs and make API or Arazzo descriptions more consistent." Rules and assertions are configured through `redocly.yaml` with four preset severity profiles — minimal, recommended, recommended-strict, and spec.

API entry from apis.yml

apis.yml Raw ↑
aid: linting:redocly-cli
name: Redocly CLI
description: Redocly's `lint` command identifies and reports problems in OpenAPI, AsyncAPI, Arazzo, or
  Open-RPC descriptions, helping teams "avoid bugs and make API or Arazzo descriptions more consistent."
  Rules and assertions are configured through `redocly.yaml` with four preset severity profiles — minimal,
  recommended, recommended-strict, and spec.
humanURL: https://redocly.com/docs/cli/
baseURL: https://github.com/Redocly/redocly-cli
tags:
- API Linting
- Arazzo
- AsyncAPI
- Open-RPC
- OpenAPI
- Redocly
properties:
- type: Documentation
  url: https://redocly.com/docs/cli/commands/lint/
- type: BuiltInRules
  url: https://redocly.com/docs/cli/rules/built-in-rules/
- type: ConfigurableRules
  url: https://redocly.com/docs/cli/rules/configurable-rules/
- type: CustomPlugins
  url: https://redocly.com/docs/cli/custom-plugins/
- type: GitHubRepository
  url: https://github.com/Redocly/redocly-cli
- type: NPMPackage
  url: https://www.npmjs.com/package/@redocly/cli
- type: License
  url: https://github.com/Redocly/redocly-cli/blob/main/LICENSE
  x-license: MIT
- type: APIEvangelistRepository
  url: https://github.com/api-evangelist/redocly
x-rules-format: redocly-yaml
x-rules-engine: typescript
x-integration-points:
- cli
- ci
- github-actions
x-supported-formats:
- openapi-2.0
- openapi-3.0
- openapi-3.1
- asyncapi-2.x
- asyncapi-3.0
- arazzo-1.0
- open-rpc