NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
npm, #3910 most downloaded on npm
See https://github.com/Redocly/redocly-cli
Latest stable
2.77.0
Last release 12 days ago
10 Nov 2026
Ships on a steady schedule
a new release about every 8 days
Nearly every release is documented
notes for 58 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
6 years old
867 releases · first in 2020
Drag across the ruler to compare, or tap a release to open it.
Added the remove-x-internal built-in decorator.
remove-x-internal built-in decorator.--remove-unused-components option to the bundle command.Fixed an issue with backslashes in $refs to paths with the split command in a Windows environment.
$refs to paths with the split command in a Windows environment.Exported mapTypeToComponent function.
Your coding agent can read these notes before it upgrades. Set up the MCP server →
mapTypeToComponent function.Added the --host option to the preview-docs CLI command.
--host option to the preview-docs CLI command.Fixed an issue with const not handled correctly by the lint command.
const not handled correctly by the lint command.Resolved another backward compatibility issue with older versions of portal.
Fixed another backward compatibility issue with regions: save old config key to support old portal versions.
Fixed a backward compatibility issue with REDOCLY_DOMAIN in the EU region introduced in the previous release.
REDOCLY_DOMAIN in the EU region introduced in the previous release.Added support for the region option with the login, push, and other commands.
login, push, and other commands.paths-kebab-case rule that disallowed paths with trailing slashes.example property when the schema is an array.Implemented new --extends and --metafile options for the bundle command.
Fixed an issue with hot reloading when running a preview of reference docs with openapi preview-docs.
openapi preview-docs.item or section.no-server-trailing-slash when server url is a root.Added a new built-in rule: operation-4xx-response.
Fixed an issue with OAS 3.1 meta keywords reported as not expected.
info-license-url rule.no-invalid-media-type-examples.Added three built-in decorators - info-description-override, tag-description-override, operation-description-override - that let you modify your API d
info-description-override, tag-description-override, operation-description-override - that let you modify your API descriptions during the bundling process. Use these decorators in the lint section of your redocly.yaml file to point OpenAPI CLI to Markdown files with custom content. That custom content replaces any existing content in the info.description field, and in tags.description and operation.description fields for specified tag names and operation IDs.The following examples show how to add the decorators to the redocly.yaml file:
lint:
decorators:
info-description-override:
filePath: ./my-custom-description.md
lint:
decorators:
tag-description-override:
tagNames:
pet: ./my-custom-description.md
lint:
decorators:
operation-description-override:
operationIds:
updatePet: ./my-custom-description.md
bundle command to return a non-zero code when it detects an error when used with the --lint option.Fixed an issue with the --format option not working with the bundle command.
Fixed an issue with the --format option not working with the bundle command.
Fixed a validation issue with the non-string openapi value in API descriptions. The lint command now warns if the value is not string instead of crashing.
Upgraded the js-yaml package from v.3 to v.4 with YAML 1.2 support. This resolves issues with parsing timestamps and example strings with leading zero
js-yaml package from v.3 to v.4 with YAML 1.2 support. This resolves issues with parsing timestamps and example strings with leading zeros in YAML.Resolved an issue with the --max-problems option that was not working with the bundle command.
--max-problems option that was not working with the bundle command.Improved validation of values for the following fields in the Schema Object: multipleOf, maxLength, minLength, maxItems, minItems, maxProperties, minP
multipleOf, maxLength, minLength, maxItems, minItems, maxProperties, minProperties.Fixed an issue with the join command crashing when trying to resolve $ref.
join command crashing when trying to resolve $ref.Resolved an issue with the preview-docs command not working when running openapi-cli in a Docker container.
Resolved an issue with the preview-docs command not working when running openapi-cli in a Docker container.
Improved the security of local documentation previews by removing query parameters from the request URL.
Internal improvements to configuration types.
Simplified the login check query to improve performance.
Added a function for linting the redocly.yaml configuration file.
Added a function for linting the redocly.yaml configuration file.
Published the OpenAPI CLI quickstart guide as part of our Google Season of Docs 2021 project.
Updated and improved the introductory content and installation instructions for OpenAPI CLI as part of our Google Season of Docs 2021 project.
Updated and improved the introductory content and installation instructions for OpenAPI CLI as part of our Google Season of Docs 2021 project.
Implemented improvements to the internal CD process.
- Internal changes. ---
Resolved an issue with transitive $ref resolution in the JSON schema validator.
Resolved an issue with transitive $ref resolution in the JSON schema validator.
If the JSON schema validator crashes, OpenAPI CLI reports the problem in the output instead of crashing itself.
The operation-operationId rule no longer triggers a warning when one or more operations in the callbacks object don't have operationId defined.
operation-operationId rule no longer triggers a warning when one or more operations in the callbacks object don't have operationId defined.Our official OpenAPI CLI documentation is now open-source! 🥳 You can find the source of all pages published on our website in the docs folder of the o
Our official OpenAPI CLI documentation is now open-source! 🥳 You can find the source of all pages published on our website in the docs folder of the openapi-cli repository. We invite you to help us improve the documentation and make it more usable for everyone. Please make sure to always follow our Code of conduct in all your contributions.
Implemented support for OpenAPI 3.1 in typeExtension plugins.
Resolved a crash caused when processing properties with the null value.
Resolved a "Maximum call stack size exceeded" issue in the JSON schema validator caused by recursive oneOf.
Implemented improvements to the openapi-cli package to reduce the size of the browser bundle.
openapi-cli package to reduce the size of the browser bundle.Removed unused keywords in OpenAPI 3.1.
Removed unused keywords in OpenAPI 3.1.
Resolved an issue with the openapi bundle command failing because of the missing js-yaml dependency.
Resolved an issue with the plugin ID being prefixed to all rules, preprocessors and decorators multiple times (for example, when using the preview-doc
preview-docs command and changing configuration files).The bundle command now supports an optional --lint parameter.
bundle command now supports an optional --lint parameter.Improved the error messages for kebab-case and implemented detection of snake_case usage in paths.
The join command does not overwrite an existing x-displayName of a tag with the tag's name property.
Implemented support for OpenAPI 3.1. You can now lint, validate, and bundle your OAS 3.1 descriptions with OpenAPI CLI.
Resolved a validation issue for enum items with the nullable property. Validation errors are no longer reported when nullable: true for enum items tha
enum items with the nullable property. Validation errors are no longer reported when nullable: true for enum items that contain a null value.The browser field in package.json is now set to simplify using openapi-core in browser-based builds.
browser field in package.json is now set to simplify using openapi-core in browser-based builds.The root API description document is now parsed in all cases, even if it doesn't report the correct MIME type or doesn't use any of the supported file
Improved openapi-core so that it can be used within our other projects including Redoc, Reference docs, and Developer portal.
openapi-core so that it can be used within our other projects including Redoc, Reference docs, and Developer portal.Resolved an issue with the --dereferenced CLI option not functioning properly.
--dereferenced CLI option not functioning properly.Resolved an issue where transitive $refs that span multiple files would crash the validation in some cases.
Resolved a hot-reloading issue with the preview-docs command. It now automatically reloads the docs in the browser when you make live changes to an Op
preview-docs command. It now automatically reloads the docs in the browser when you make live changes to an OpenAPI description.Exported a helper function from openapi-core and implemented defaults for some functions to improve integration with the Developer portal.
openapi-core and implemented defaults for some functions to improve integration with the Developer portal.Implemented error handling for failed file uploads when using the push command. The command now displays success/failure messages in the output.
push command. The command now displays success/failure messages in the output.Source type was changed from FILE to CICD to support integration with the new CI/CD source in Workflows.
FILE to CICD to support integration with the new CI/CD source in Workflows.OpenAPI CLI now has tab completion for global installations. Run openapi completion for instructions to set it up in your environment.
openapi completion for instructions to set it up in your environment.OpenAPI CLI now has an official Docker image! You can get it from Docker Hub.
You can now use the --verbose parameter with the login command to show a detailed error trace (if any). Detailed error output is not displayed by defa
--verbose parameter with the login command to show a detailed error trace (if any). Detailed error output is not displayed by default for this command.The "access token" has been renamed to "API key" in the output of relevant OpenAPI CLI commands (login, push) to make it clearer what information the
The "access token" has been renamed to "API key" in the output of relevant OpenAPI CLI commands (login, push) to make it clearer what information the users must provide.
For improved security, the API key is now hidden (masked) when the user provides it in the terminal, and it's not logged in the user's history.
The bundle method is now able to accept Document directly in openapi-core.
bundle method is now able to accept Document directly in openapi-core.OpenAPI CLI now automatically resolves all $refs by default, even in places where they are not allowed by the specification ("incorrect $refs"). This
doNotResolveExamples to true in redocly.yaml.Fixed an issue with incorrect base directory when resolving transitive $refs.
$refs.Resolved an issue with nested filepaths that caused the push command to upload files to the wrong path when used on Windows systems.
push command to upload files to the wrong path when used on Windows systems.A new command called push is now supported by OpenAPI CLI. With this command, you can upload your API descriptions and associated files, and set up yo
push is now supported by OpenAPI CLI. With this command, you can upload your API descriptions and associated files, and set up your own CI pipeline for updating API descriptions without granting Redocly Workflows access to your repositories.. (dot) symbol in version names with the push command.Nothing published for this version
Resolved an issue with assert-node-version using the wrong path.
Resolved an issue with assert-node-version using the wrong path.
OpenAPI CLI bundles the API description before gathering stats.
Nothing published for this version
Resolved issues with tag logic and tag display names for the join command.
Resolved issues with tag logic and tag display names for the join command.
Refactored CLI command handlers.
A new command called join is now available in OpenAPI CLI. Use it to combine two or more API description files into one. The resulting file optionally
join is now available in OpenAPI CLI. Use it to combine two or more API description files into one. The resulting file optionally helps distinguish the origin of OpenAPI objects and properties by appending custom prefixes to them. Note that this command is considered experimental; meaning, it's still a work in progress.Nothing published for this version
Nothing published for this version
The previously single OpenAPI CLI package has been split into two: openapi-cli and openapi-core.
openapi-cli and openapi-core.One column per quarter.