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

Update commands/index.md (#580)

Browse Source 
* Update commands/index.md

* Update docs/commands/index.md

Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>

* Update index.md

Second pass.

* Updated refs to config file

Standardised naming ('the Redocly configuration file' or 'redocly.yaml' instead of '.redocly.yaml').

Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
Co-authored-by: Swapnil Ogale <swapnilogale@gmail.com>
This commit is contained in:
Jody Winter
2022-03-24 16:17:03 +13:00
committed by GitHub
parent 2a23035e96
commit a85ee452fe
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/commands/index.md
View File

@@ -1,7 +1,8 @@
---
tocMaxDepth: 2
---
# Redocly OpenAPI CLI commands
# OpenAPI CLI commands
Redocly OpenAPI CLI currently supports the following commands:
@@ -15,17 +16,17 @@ Redocly OpenAPI CLI currently supports the following commands:
* [split](split.md)
* [stats](stats.md)
To define the behavior of the commands, you can use configuration files:
OpenAPI 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).
- [Redocly configuration file](../configuration/configuration-file.mdx) - define the location of your root files, linting rules, and reference docs configuration information.
- `.redocly.lint-ignore.yaml` - ignore specific lint messages.
The Redocly configuration file must sit in your root directory (`openapi` by default unless you renamed it).
If OpenAPI 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 [configuration section](../configuration/index.mdx).
For more information, refer to the [Redocly configuration file](../configuration/configuration-file.mdx) docs.
:::attention Note
The CLI tool looks for configuration files in the current working directory. If it detects them, it will use the options set in those configuration files for the commands.
::: success Tip
When executing any of the commands, you can override the default configuration file by providing a path to another configuration file with the `--config` option.
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.
:::