The preview command starts a local preview server for a Redocly project. Use the preview server to develop your project locally before deployment.
redocly preview
redocly preview --product=revel
redocly preview --product=reef --plan=pro
redocly preview --product=reef --plan=pro --project-dir=./my-docs-project --port=4001| Option | Type | Description |
|---|---|---|
| --help | boolean | Show help. |
| --plan | string | Product plan to use in preview. Possible values: pro, enterprise. The default value is enterprise. For more details, see plans. |
| --product | string | Name of a product to preview the project with. Possible values: redoc, revel, reef, realm, redoc-revel, redoc-reef, revel-reef. redoc is the flagship product for generating API documentation from OpenAPI specifications. revel is a specialized product designed for external API applications. reef is a specialized product designed for internal API needs. realm is a balanced product combining redoc, revel, and reef. redoc-revel is a blended product combining redoc and revel. redoc-reef is a blended product combining redoc and reef. revel-reef is a blended product combining revel and reef. The default value is autodetected from the project's package.json or realm is used. |
| --project-dir, -d | string | Path to the project directory. The default value is . (current directory). |
| --port, -p | number | The port to run the preview server on. The default value is 4000. |
| --version | boolean | Show version number. |
Specify the product package to use by setting the --product option. If this setting is not supplied, the preview command tries to guess which package to use from the project's package.json or use realm by default.
redocly preview --product=revelBy default, previews are run in enterprise plan mode. This mode makes all of the enterprise features available. Switch the preview to pro plan mode by setting the --plan option to pro:
redocly preview --plan=proBy default, the preview command uses the current directory. To specify another directory, provide a path relative to the current directory using the --project-dir option:
redocly preview --project-dir=./path/to/my/docs/By default, the preview starts on port 4000, so you can access the docs at http://localhost:4000 or http://127.0.0.1:4000.
To specify a custom port for the preview, pass the desired value using the port option:
redocly preview --port=8888This command starts the preview on port 8888, so you can access the docs at http://localhost:8888 or http://127.0.0.1:8888.