{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"redocly-cli-commands","__idx":0},"children":["Redocly CLI commands"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API authoring commands:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/lint"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lint"]}]}," Lint an API description."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/split"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["split"]}]}," Split an API description into a multi-file structure."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/introspect-mcp"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["introspect-mcp"]}]}," Introspect an MCP server and record its capabilities in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-mcp"]}," extension of an OpenAPI description [experimental feature]."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Docs rendering commands:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/build-docs"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["build-docs"]}]}," Build an API description into an HTML file."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/preview"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["preview"]}]}," Start a local preview of a Redocly project with one of the product NPM packages."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/translate"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["translate"]}]}," Generate translation keys for a Redocly Realm, Reef, or Revel project."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/eject"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eject"]}]}," Eject and modify components from the core theme in a Redocly Realm, Reef, or Revel project."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Docs linting commands:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/recheck"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck"]}]}," Lint Markdown prose and structure from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck"]}," block."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["CI and delivery commands:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/bundle"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bundle"]}]}," Bundle an API description."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/join"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["join"]}]}," Join API descriptions [experimental feature]."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API testing and drift commands:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/commands/respect"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["respect"]}]}," Execute API tests described in an Arazzo description."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/commands/generate-arazzo"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["generate-arazzo"]}]}," Generate an Arazzo description from an OpenAPI description."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/proxy"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["proxy"]}]}," Capture live HTTP traffic through a reverse proxy into a HAR file [experimental feature]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/drift"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drift"]}]}," Detect drift between recorded HTTP traffic and an OpenAPI description [experimental feature]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/generate-spec"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["generate-spec"]}]}," Infer an OpenAPI description from recorded HTTP traffic [experimental feature]."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Quality report commands:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/stats"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["stats"]}]}," Gather statistics for a document."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/score"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["score"]}]}," Score an API for integration simplicity and AI agent readiness [experimental feature]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/scorecard-classic"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scorecard-classic"]}]}," Evaluate an API against the scorecard configuration of a Redocly project."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["SDK generation commands:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/generate-client"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["generate-client"]}]}," Generate a typed TypeScript client from an OpenAPI description [experimental feature]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/eject-generator"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eject-generator"]}]}," Copy a built-in client generator into your repository as an editable file [experimental feature]."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Redocly configuration commands:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/check-config"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["check-config"]}]}," Lint the Redocly configuration file."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/inspect-node-types"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inspect-node-types"]}]}," Show the node type the linter assigns to a location in an API description [experimental feature]."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reunite platform commands:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/login"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["login"]}]}," Log in to Reunite."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/logout"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["logout"]}]}," Clear your stored credentials."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/push"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}]}," Push an API description to Reunite."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/push-status"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push-status"]}]}," Track an in-progress push operation to Reunite."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Shell setup commands:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/completion"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["completion"]}]}," Generate autocomplete commands (includes install instructions)."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"additional-options","__idx":1},"children":["Additional options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All commands support these parameters:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--version"]}," displays the current version of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--help"]}," displays the help for the command."," ","If you used a subcommand, it displays the help for that subcommand."," ","For example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"npx @redocly/cli@latest lint --help\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Try these with any of the other commands."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"config-file","__idx":2},"children":["Config file"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Redocly CLI has one primary configuration file (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]},"), also called the Redocly configuration file."," ","This file defines all of the configuration options available to you."," ","These options include the location of your files (for unbundling and bundling) and the linting rules (for validation against the OpenAPI Specification)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Redocly configuration file must be in your root directory."," ","If Redocly CLI finds ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," in the root directory, it uses the options set in that file when it executes commands."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For most commands, you can also specify a configuration file with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--config myconfig.yaml"]}," as part of the command."," ","For example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"npx @redocly/cli@latest lint --config redocly-official.yaml openapi.yaml\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information, refer to the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/configuration"},"children":["Redocly configuration file"]}," docs."]}]},"frontmatter":{"tocMaxDepth":2},"tagList":[],"title":"Redocly CLI commands","lastModified":"2026-10-02T14:40:08.000Z"}