# Redocly CLI commands

Documentation commands:

- [`preview`](/docs/cli/commands/preview) Start a local preview of a Redocly project with one of the product NPM packages.
- [`translate`](/docs/cli/commands/translate) Generate translation keys for a Redocly Realm, Reef, or Revel project.
- [`eject`](/docs/cli/commands/eject) Eject and modify components from the core theme in a Redocly Realm, Reef, or Revel project.
- [`build-docs`](/docs/cli/commands/build-docs) Build API description into an HTML file.


API management commands:

- [`stats`](/docs/cli/commands/stats) Gather statistics for a document.
- [`bundle`](/docs/cli/commands/bundle) Bundle API description.
- [`split`](/docs/cli/commands/split) Split API description into a multi-file structure.
- [`join`](/docs/cli/commands/join) Join API descriptions [experimental feature].


Linting commands:

- [`lint`](/docs/cli/commands/lint) Lint API description.
- [`check-config`](/docs/cli/commands/check-config) Lint Redocly configuration file.


Testing commands:

- [`respect`](/docs/cli/commands/respect) Execute API tests described in an Arazzo description.
- [`generate-arazzo`](/docs/cli/commands/generate-arazzo) Generate an Arazzo description from an OpenAPI description.


Redocly platform commands:

- [`login`](/docs/cli/commands/login) Log in to Reunite.
- [`logout`](/docs/cli/commands/logout) Clear your stored credentials.
- [`push`](/docs/cli/commands/push) Push an API description to Reunite.
- [`push-status`](/docs/cli/commands/push-status) Track an in-progress push operation to Reunite.


Supporting commands:

- [`completion`](/docs/cli/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:


```bash
npx @redocly/cli@latest 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:


```bash
npx @redocly/cli@latest lint --config redocly-official.yaml openapi.yaml
```

For more information, refer to the [Redocly configuration file](/docs/cli/configuration) docs.