mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-09 20:57:44 +00:00
33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
---
|
|
tocMaxDepth: 2
|
|
---
|
|
|
|
# Redocly CLI commands
|
|
|
|
Redocly CLI currently supports the following commands:
|
|
|
|
* [build-docs](build-docs.md)
|
|
* [bundle](bundle.md)
|
|
* [join](join.md)
|
|
* [lint](lint.md)
|
|
* [login](login.md)
|
|
* [logout](logout.md)
|
|
* [preview-docs](preview-docs.md)
|
|
* [push](push.md)
|
|
* [split](split.md)
|
|
* [stats](stats.md)
|
|
|
|
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 (`openapi` by default unless you renamed it).
|
|
If Redocly CLI finds `redocly.yaml` in the root directory, it will use the options set in that file when executing commands.
|
|
|
|
For more information, refer to the [Redocly configuration file](../configuration/index.mdx) docs.
|
|
|
|
:::success Tip
|
|
|
|
If you want to use a different config file with a specific command (and override `redocly.yaml`), use the `--config` option and provide the path to the file.
|
|
|
|
:::
|