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.
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.
Your coding agent can read these notes before it upgrades. Set up the MCP server →
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.
Fixed types for Callback and NamedCallbacks.
Callback and NamedCallbacks.scalar-property-missing-example built-in rule that didn't work on examples containing falsy values.Added three new built-in rules: response-contains-header, response-contains-property, scalar-property-missing-example.
response-contains-header, response-contains-property, scalar-property-missing-example.bundle command supports a new option --keep-url-references. Use it to prevent Redocly CLI from resolving external URL references during bundling.addinionalItems, minContains and maxContains array types.lang value in the x-codeSamples specification extension).Updated types. Added hideTryItPanel, schemaDefinitionsTagName configuration options and x-hideTryItPanel, x-tags OpenAPI specification extensions.
hideTryItPanel, schemaDefinitionsTagName configuration options and x-hideTryItPanel, x-tags OpenAPI specification extensions.Added the --public option to the push command. With this option, you can upload OpenAPI descriptions and make them publicly accessible.
--public option to the push command. With this option, you can upload OpenAPI descriptions and make them publicly accessible.assert/{assert name}process.* in core package that caused crashes in client-side builds.preview-docs hot reload.Technical release for changing the package name from @redocly/openapi-cli to @redocly/cli.
Technical release for changing the package name from @redocly/openapi-cli to @redocly/cli.
This change is reflected in all Redocly product documentation, in the npm package name (more on that in the "Deprecated" section), and in the official…
{% admonition type="warning" name="Product name change" %} The product name has changed from OpenAPI CLI to Redocly CLI.
This change is reflected in all Redocly product documentation, in the npm package name (more on that in the "Deprecated" section), and in the official project GitHub repository.
The change also affects the CLI commands. The legacy name openapi is supported for now, but we strongly recommend you use the new name redocly.
(To illustrate, if you previously used openapi lint, now you should use redocly lint).
If you encounter any issues and suspect they may be related to this change, let us know by reporting an issue.
{% /admonition %}
lint.extends section in the Redocly configuration file supports file paths and URLs as values. This means you can define your own lint rulesets in local or remote files, and list those files in the extends section. The following example shows how to do it:extends:
- recommended
- ./path/to/local/lint-ruleset.yaml
- https://url-to-remote/lint-ruleset.yaml
The contents of those referenced files must correspond to the standard format used in the rules object to configure the rules. Here is an example lint-ruleset.yaml file referenced above:
rules:
tags-alphabetical: error
lint command supports a new output formatting option called codeclimate that you can use with the --format argument.@redocly/openapi-cli npm package. From this version forward, use @redocly/cli instead.The lint command supports using unevaluatedProperties as boolean in OAS 3.1.x and no longer reports this as an error.
lint command supports using unevaluatedProperties as boolean in OAS 3.1.x and no longer reports this as an error.Resolved an issue with the push command skipping dependencies.
push command skipping dependencies.Introduced configurable rules - a new, powerful lint feature, which helps you enforce API design standards without coding (named assertions at the tim
assertions at the time of the release).push command supports a new --skip-decorator option.openapi preview-docs failing during authorization.Nothing published for this version
Updated types to support validation of the Redocly configuration file according to the new file structure.
Internal changes of redocly.yaml config structure - add new mock server options to redocly.yaml schema.
redocly.yaml config structure - add new mock server options to redocly.yaml schema.redocly.yaml file.Internal changes of redocly.yaml config structure.
redocly.yaml config structure.lint command highlighting the entire file when servers are missing in OAS3. Now it highlights only the openapi field, indicating an incorrect OpenAPI description.lint command highlighting all parent values when one of the child fields has an empty value instead of highlighting the field itself.Fixed an issue with process.env assignment that caused crashes in client-side builds.
process.env assignment that caused crashes in client-side builds.no-path-parameter rule reporting false-positives.Allowed to name the config file either .redocly.yaml (deprecated) or redocly.yaml.
.redocly.yaml (deprecated) or redocly.yaml.spec rule triggers an error when a parameter is missing schema or content fields.- Internal improvements ---
Fixed an issue with the lint command crashing when the servers.url field is empty in the OpenAPI description.
lint command crashing when the servers.url field is empty in the OpenAPI description.lint command crashing when an enum value is invalid.Added the webhooks and x-webhooks support to the split command.
Removed support for using OpenAPI CLI behind a proxy server.
Added support for using OpenAPI CLI behind a proxy server.
lint command not reporting errors when securityDefinitions.basic contains the unsupported additionalProperty in OAS2.no-invalid-media-type-examples built-in rule that didn't work on examples containing a $ref.lint command incorrectly reporting boolean schemas for array items as invalid.isPathParameter failing because of an incorrect brace.Fixed an issue with date-time conversion in YAML files.
oauth2-redirect.html file being absent when served by preview-docs command.Fixed the remove-x-internal decorator to remove references to removed x-internal components.
remove-x-internal decorator to remove references to removed x-internal components.remove-unused-components decorator that strips remotely referenced components.One column per quarter.