redoc-cli

0.13.21 • Public • Published

redoc-cli

DEPRECATED: this package is deprecated. Use npx @redocly/cli build-docs <api> instead.

ReDoc's Command Line Interface

Installation

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

Usage

The two following commands are available:

  • redoc-cli serve [spec] - starts the server with spec rendered with ReDoc. Supports a server-side rendering mode (--ssr) and can watch the spec (--watch) to automatically reload the page whenever it changes.
    Deprecated. Use npx @redocly/cli preview-docs [spec]
  • redoc-cli bundle [spec] - bundles spec and Redoc into a zero-dependency HTML file.
    Deprecated. Use Use "build" command instead.
  • redoc-cli build [spec] - build spec and Redoc into a zero-dependency HTML file.

Some examples:

  • Bundle with the main color changed to orange:
    $ redoc-cli build [spec] --options.theme.colors.primary.main=orange
  • Serve with the nativeScrollbars option set to true:
    $ redoc-cli serve [spec] --options.nativeScrollbars
  • Bundle using a custom Handlebars template (check the default template for an example):
    $ redoc-cli build [spec] -t custom.hbs
  • Bundle using a custom template and add custom templateOptions:
    $ redoc-cli build [spec] -t custom.hbs --templateOptions.metaDescription "Page meta description"

With a Redocly configuration file (more info):

  1. Go to folder with your Redocly configuration file (.redocly.yaml or redocly.yaml) and your OpenAPI definition file.
  2. Build the site using the build command (options from the Redocly configuration file will be automatically fetched):
    redoc build openapi.yaml

For more details, run redoc-cli --help.

Readme

Keywords

none

Package Sidebar

Install

npm i redoc-cli

Weekly Downloads

88,179

Version

0.13.21

License

MIT

Unpacked Size

261 kB

Total Files

7

Last publish

Collaborators

  • romanhotsiy
  • alawar