redoc/cli/README.md

redoc-cli

ReDoc's Command Line Interface

Installation

You can use redoc cli by installing redoc-cli globally or using npx.

Usage

Twe following commans are available:

• redoc-cli serve [spec] - starts the server with spec rendered with ReDoc. Supports SSR mode (--ssr) and can watch the spec (--watch)
• redoc-cli bundle [spec] - bundles spec and ReDoc into zero-dependency HTML file.

Some examples:

• Bundle with main color changed to orange:

  $ redoc-cli bundle [spec] --options.theme.colors.main=orange

• Serve with nativeScrollbars option set to true:

  $ redoc-cli serve [spec] --options.nativeScrollbars

• Bundle using custom template (check default template for reference):

  $ redoc-cli bundle [spec] -t custom.hbs

For more details run redoc-cli --help.