How to use the Redocly CLI

With Redocly CLI, you can bundle your OpenAPI definition and API documentation (made with Redoc) into an HTML file and render it locally.

Install Redocly CLI

1. Step 1

   First, you need to install the @redocly/cli package.

2. Step 2

   You can install it globally using npm.

   Or you can install it during runtime using npx or Docker.

Build the HTML file

The Redocly CLI build-docs command builds Redoc into an HTML file.

To build an HTML file using Redocly CLI, enter the following command, replacing apis/openapi.yaml with your API definition file’s name and path:

redocly build-docs apis/openapi.yaml

See the build-docs documentation for more information on the different options and ways you can use the command.

Also, check out Redocly CLI commands for more information on the different things you can do with Redocly CLI including linting, splitting, and bundling your API definition file.