LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-07 20:57:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ab635d64d00b1bc6783d74fc7a03ba6475b8d433
redocly-cli/docs/commands/preview-docs.md
redocly-bot 2143028637 sync: Synced local 'docs/' with remote 'docs/cli/'
2021-08-05 01:36:10 +00:00

1.5 KiB
Raw Blame History

preview-docs

Preview the API reference docs on your local machine.

If you have a license key, you will have a preview of the premium Redocly API reference docs. The login command also generates a preview of the premium Redocly API reference docs.

Otherwise, you'll get a preview of Redoc community edition.

preview-docs usage

Positionals:
  entrypoint                                                 [string] [required]

Options:
  --version                Show version number.                        [boolean]
  --help                   Show help.                                  [boolean]
  --port, -p               Preview port.                [number] [default: 8080]
  --skip-preprocessor      Ignore certain preprocessors.                 [array]
  --skip-decorator         Ignore certain decorators.                    [array]
  --use-community-edition  Force using Redoc CE for docs preview.      [boolean]
  --force, -f              Produce bundle output even when errors occur.
                                                                       [boolean]
  --config                 Specify path to the config file.             [string]

How to preview the docs on a custom port

By default, without providing a port, the preview starts on port 8080, and can be accessed at http://localhost:8080.

This command starts a preview on port 8888, and you can access the docs at http://localhost:8888 after running it.

openapi preview-docs -p 8888 openapi/openapi.yaml