A selection of guides to common tasks with Redocly CLI.
Redocly CLI quickstart
Take your first steps with Redocly CLI.
OpenAPI starter project
Get started with OpenAPI and Redocly, using this sample project.
Enforce response contents
Create a custom rule to enforce response contents.
Lint and bundle in one command
Combine lint and bundle commands, and check each command succeeds.
Hide internal APIs
Prevent APIs from being viewed by external audiences.
Replace the server URL
Replace the server URL in different environments.
Lint AsyncAPI descriptions
API governance for async and streaming API applications.
Lint Arazzo descriptions
Check the validity of Arazzo descriptions for workflows.
Lint Open-RPC descriptions
Check the validity of Open-RPC descriptions.
Change the OAuth2 token URL
How to change the OAuth2 token URL.
Hide OpenAPI specification extensions
How to create a custom decorator to hide OpenAPI specification extensions.
Configure API linting rules
Combine built-in and custom rules to match your API's standards.
Set up tab completion
Generate shell completions for the redocly command.
Update Redocly CLI
Keep your Redocly CLI installation current with the latest features and fixes.
Migrate to Redocly CLI v2
Essential changes when upgrading from v1.x to v2.x.
Migrate from openapi-cli
Upgrade from the deprecated openapi-cli by replacing it with redocly.
Migrate from redoc-cli
Replace the legacy redoc-cli commands with Redocly CLI equivalents.
Migrate from Spectral
Switch from Spectral to Redocly CLI's linting and tooling.
Migrate from swagger-cli
Replace the deprecated swagger-cli package with Redocly CLI.