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
Last release today
28 Sep 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
771 releases · first in 2020
One column per quarter.
Added return values for the push and push-status commands.
push and push-status commands.Removed additional operations from the join command; use lint and/or bundle for operations such as lint and decorate.
join command; use lint and/or bundle for operations such as lint and decorate.github-actions output format for the lint command to annotate reported problems on files when used in a GitHub Actions workflow.no-invalid-media-type-examples rule externalValue example validation.Added check-config command to validate a Redocly configuration file.
check-config command to validate a Redocly configuration file.Updated license text for date and organization naming accuracy.
Fixed a problem with the preview command crashing on Windows by adding operating system detection for the correct npx executable to use.
preview command crashing on Windows by adding operating system detection for the correct npx executable to use.Reverted "Users can run the CLI tool behind a proxy by using HTTP_PROXY or HTTPS_PROXY environment variables to configure the proxy settings" temporar
Users can run the CLI tool behind a proxy by using HTTP_PROXY or HTTPS_PROXY environment variables to configure the proxy settings.
HTTP_PROXY or HTTPS_PROXY environment variables to configure the proxy settings.Updated @redocly/openapi-core to v1.10.1.
Users can run the CLI tool behind a proxy by using HTTP_PROXY or HTTPS_PROXY environment variables to configure the proxy settings.
HTTP_PROXY or HTTPS_PROXY environment variables to configure the proxy settings.join command so that --prefix-components-with-info-prop replaces spaces with underscores to create less confusing $refs.Adds support for using logical AND for the security schema so that the join command generates the correct schema.
join command generates the correct schema.join command did not process schemas containing null values when the --prefix-components-with-info-prop option was used.'- Removed descriptions adding for x-tagGroups for the join command. Descriptions in x-tagGroups are not supported and cause errors on linting.
join command. Descriptions in x-tagGroups are not supported and cause errors on linting.info.title to be used as a name in x-tagGroups instead of a file name for the join command, so you can now join files with the same names.no-required-schema-properties-undefined rule to check if each required schema property is defined.--prefix-components-with-info-prop option with the join command caused $refs to include duplicated prefixes.$refs ending in # (instead of #/) would break the application.Added markdown format option to stats command for use with GitHub job summaries.
push command, when destination option does not work without specifying it in redocly.yaml.Added git to the docker image, so the push command can use git metadata.
Added a push and push-status command for use with future Redocly products.
push and push-status command for use with future Redocly products.Added a preview command that starts a local preview server for Redocly projects that use products that are currently in a pre-release stage.
preview command that starts a local preview server for Redocly projects that use products that are currently in a pre-release stage.x-codeSamples languages.Deprecated --lint option in the join command. The options are marked for removal in a future release. Use the lint command separately to lint your API…
$ref in the Redocly config file. This ability allows users to split up big config files and maintain their constituent parts independently.--lint option in the join command. The options are marked for removal in a future release. Use the lint command separately to lint your APIs.Deprecated lint-related options in the bundle command. The options are marked for removal in a future release. Use the lint command separately to lint…
array-parameter-serialization to require that serialization parameters style and explode are present on array parameters.bundle command. The options are marked for removal in a future release.
Use the lint command separately to lint your APIs before bundling.Fixed an issue with resolving the node-fetch package by explicitly adding the missing dependency.
node-fetch package by explicitly adding the missing dependency.Added recommended-strict ruleset which uses the same rules as recommended but with the severity level set to error for all rules.
recommended-strict ruleset which uses the same rules as recommended but with the severity level set to error for all rules.split and join commands.--host/-h argument in the preview-docs command is now also used by the WebSocket server for hot reloading.Added the possibility to configure the linting severity level of the configuration file for all CLI commands. Redocly CLI exits with an error if there
error.Fixed an issue with nested refs in the join command.
join command.pattern and notPattern assertions to be more precise.unevaluatedItems type definition to resolve either boolean or object schema per JSON Schema 2019-09 specification.Added support for linting AsyncAPI v2 files, so that a wider range of API descriptions can use the Redocly linting workflow.
Updated minimum required version of Node.js to v14.19.0, NPM to v7.0.0, and removed deprecated packages.
ignoreCase option for tags-alphabetical rule.join support for OAS 3.1 descriptions.--remove-unused-components option removed used components that were referenced as child objects.no-path-trailing-slash rule.Updated @redocly/openapi-core to v1.0.2.
Fixed the build-docs command failing when running outside the root folder.
This release marks the stable version 1.0. There are no changes from previous releases.
This release marks the stable version 1.0. There are no changes from previous releases.
Fixed issue with publishing to Docker Hub (no code changes).
Update package publishing process (no code changes).
No code changes.
No code changes.
Handled aborted request in the docker and removed a redundant call.
cdn option from the build-docs command as it was not functional.Added new rule component-name-unique to check for unique component names (kudos to @pboos 🎉).
component-name-unique to check for unique component names (kudos to @pboos 🎉).--files option of the push command did not upload extra files.Added product metrics collection.
push command interface. The previous syntax also continues to work.The assert/ prefix continues to work with a warning of the deprecated syntax.
$refs in preprocessors.spec-strict-refs rule to ensure $ref usage is in accordance with the OpenAPI specification.^[a-zA-Z0-9\.\-_]+$, only to fixed fields under components.assert/ to rule/ as a prefix for configurable rules. The assert/ prefix continues to work with a warning of the deprecated syntax.Inform the user if a new version is available.
--skip-rule rule1 --skip-rule rule2 instead of --skip-rule rule1 rule2.Added new options for the join command: --decorate and --preprocess.
join command: --decorate and --preprocess.x-) specification extensions that contain an array.push command not recognizing API descriptions with spaces.allowedValues in the all ruleset for mime-type rules.lint command are not provided.join command.bundle and join commands.Added the required-min-length-string-type-property rule that requires required properties in the API description with type string to have a minLength.
string to have a minLength.$ref in path parameters during the join command.location object, assertion custom functions include a ctx object. See Custom functions.Fixed an issue with remote file inside the lint ignore file.
Fixed the push command when organization is provided in the redocly.yaml configuration file.
push command when organization is provided in the redocly.yaml configuration file.Fixed an issue with the push command not working with a valid organizationId.
push command not working with a valid organizationId.Added custom output file option to the join command.
join command./ as a separator which puts paths into subdirectories for each path segment with the split command.lang property.features.openapi and features.mockServer into the theme object with the names openapi and mockServer.Before:
features.openapi: {}
features.mockServer: {}
After:
theme:
openapi: {}
mockServer: {}
Fixed an issue where $refs weren't resolved inside specification extensions.
$refs weren't resolved inside specification extensions.Fixed an issue where the spec rule showed an error for x-logo properties in the 3.1 OpenAPI description.
spec rule showed an error for x-logo properties in the 3.1 OpenAPI description.Enabled removing unused components in the config to use within the bundle command.
VendorExtension.media-type-examples-override decorator.Nothing published for this version
Fixed an issue with scalar assertion failing when an object is of invalid type.
Added support for `any` type in assertions.
any type in assertions.public_api_docs.Added a new assertion `notPattern` to the custom rules.
notPattern to the custom rules.Removed automatically adding the recommended configuration when there is a config defined without an extends list.
recommended configuration when there is a config defined without an extends list.process.cwd in browser environment.$anchors in OpenAPI documents are not properly parsed.spec rule not reporting on nullable in Schema object that don't have a type sibling.allOf keyword.Removed deprecated fields suggestions in Redocly config file.
info-description rule.Renamed four type names for alignment with the OpenAPI specification.
PathsMap to PathsResponsesMap to ResponsesEncodingsMap to EncodingMapSecuritySchemeFlows to OAuth2Flows--keep-url-references to the bundle command that disables bundling of absolute URL $ref-s.security-defined rule.response-contains-header being case-sensitive.path-params-defined rule that was not accounting for params defined on the operation level.type not being validated if it is an array.apis overrides not picking up some base values from the root config.apis list if used as a file name.Added the build-docs command which builds Redoc API docs into a zero-dependency HTML file.
build-docs command which builds Redoc API docs into a zero-dependency HTML file.push command.no-invalid-media-type-examples rule in combination with the allOf keyword.Added rfc7807 problem details rule.
referenced from information.spec-components-invalid-map-name rule for component map names validation.--format option: summary.content or schema.operation-4xx-response rule.paths not being correctly handled by the join command.operation-security-defined rule to check the security on the root and in each operation.styleguide object from the configuration file.operation-security-defined rule to security-defined.Renamed no-servers-empty-enum to no-server-variables-empty-enum and fixed incorrect docs of no-empty-enum-servers.
no-servers-empty-enum to no-server-variables-empty-enum and fixed incorrect docs of no-empty-enum-servers.openapi-core.config field in subclasses extending BaseResolver class.redocly.yaml) from string or object.no-server-example.com.Add allowAdditionalProperties to built-in rules and mark disallowAdditionalProperties as deprecated.
allowAdditionalProperties to built-in rules and mark disallowAdditionalProperties as deprecated.off for assertions.Now errors exit with return code 1.
1.lint into styleguide in Redocly configuration.Fixed bug with an invalid path to the configuration file causing issues with the ignore file.
Fixed incorrect boolean filtering in filter-out rule.
filter-out rule.join command.Added new property ref to assertation object.
ref to assertation object.--lint-config option for the lint command. Use it to validate the configuration file with appropriate severity level.filter-in and filter-out.--run-id option for the push command. The --run-id option renamed to the --batch-id, added the --batch-size option.The join command supports a new option --without-x-tag-groups. Use it to skip the creation and population of x-tagGroups.
join command supports a new option --without-x-tag-groups. Use it to skip the creation and population of x-tagGroups.requireAny to assertation object.showSecuritySchemeType and disableTryItRequestUrlEncoding configuration options.additionalItems array type.Broken release.
Broken release.
Your coding agent can read these notes before it upgrades. Set up the MCP server →