mirror of
https://github.com/Redocly/redoc.git
synced 2024-11-23 00:56:33 +03:00
22 lines
1013 B
Markdown
22 lines
1013 B
Markdown
# redoc-cli
|
|
|
|
**[ReDoc](https://github.com/Rebilly/ReDoc)'s Command Line Interface**
|
|
|
|
## Installation
|
|
You can use redoc cli by installing `redoc-cli` globally or using [npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b).
|
|
|
|
## Usage
|
|
|
|
Two following commands 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`: <br> `$ redoc-cli bundle [spec] --options.theme.colors.primary.main=orange`
|
|
- Serve with `nativeScrollbars` option set to true: <br> `$ redoc-cli serve [spec] --options.nativeScrollbars`
|
|
- Bundle using custom template (check [default template](https://github.com/Rebilly/ReDoc/blob/master/cli/template.hbs) for reference): <br> `$ redoc-cli bundle [spec] -t custom.hbs`
|
|
|
|
For more details run `redoc-cli --help`.
|