Redocly CLI commands

Redocly CLI currently supports the following commands:

build-docs
bundle
join
lint
login
logout
preview-docs
push
split
stats

Redocly CLI comes with one primary configuration file (redocly.yaml), also known as the Redocly configuration file. This file defines all of the config options available to you, including the location of your files (for unbundling and bundling), and linting rules (for validation against the OpenAPI Specification).

The Redocly configuration file must sit in your root directory (openapi by default unless you renamed it). If Redocly CLI finds redocly.yaml in the root directory, it will use the options set in that file when executing commands.

For more information, refer to the Redocly configuration file docs.

Tip

If you want to use a different config file with a specific command (and override redocly.yaml), use the --config option and provide the path to the file.