LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-09 20:57:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
36b09f11d54c6f386965f5f21e2e4ca8b9be674a
redocly-cli/docs/commands/index.md
dianacheung 4c3d8cf84f docs: update commands documentation (issue 1429) and minor corrections (#1560) 
* docs: updated commands documentation per issue 1429 and minor corrections, ran prettier

* docs: updated commands documentation per issue 1429 and included pr 1560 feedback

* docs: minor formatting and copyedits

---------

Co-authored-by: Diana Cheung <18452752+dianacheung@users.noreply.github.com>
Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
2024-07-05 20:59:59 +01:00

2.2 KiB
Raw Blame History

tocMaxDepth
tocMaxDepth
2

Redocly CLI commands

Documentation commands:

  • preview-docs Preview API reference docs for the specified API description.
  • build-docs Build API description into an HTML file.
  • preview Start a local preview of a Redocly project with one of the product NPM packages.

API management commands:

  • stats Gather statistics for a document.
  • bundle Bundle API description.
  • split Split API description into a multi-file structure.
  • join Join API descriptions [experimental feature].

Linting commands:

Redocly platform commands:

  • login Login to the Redocly API registry with an access token.
  • logout Clear your stored credentials for the Redocly API registry.
  • push Push an API description to the Redocly API registry.

Supporting commands:

  • completion Generate autocomplete commands (includes install instructions).

Additional options

There are some parameters supported by all commands:

--version display the current version of redocly.

--help display the command help, or the help for the subcommand if you used one. For example:

redocly lint --help

Try these with any of the other commands.

Config file

Redocly CLI comes with one primary configuration file (redocly.yaml), also known as the Redocly configuration file. This file defines all of the config options available to you, including the location of your files (for unbundling and bundling), and linting rules (for validation against the OpenAPI Specification).

The Redocly configuration file must sit in your root directory. If Redocly CLI finds redocly.yaml in the root directory, it uses the options set in that file when executing commands.

You can also specify a config file to most commands using --config myconfig.yaml as part of the command. For example:

redocly lint --config redocly-official.yaml openapi.yaml

For more information, refer to the Redocly configuration file docs.