redocly-cli/docs/installation.md

Install Redocly CLI

Choose the most appropriate installation method for your needs:

• Install locally, using npm or yarn to make the redocly command available on your system.
• Use npx to get the tool at runtime rather than installing it.
• The command is also available via Docker if you'd prefer to use it that way.

Install globally

{% admonition type="success" name="Tip" %} Make sure you have the newest version of npm/yarn before you begin. {% /admonition %}

{% tabs %} {% tab label="npm" %}

npm i -g @redocly/cli@latest

{% /tab %} {% tab label="yarn" %}

yarn global add @redocly/cli

{% /tab %} {% /tabs %}

Running redocly --version confirms that the installation was successful, and the currently-installed version of the tool.

Use npx at runtime

npx is npm's package runner. It installs and runs a command without installing it globally. You might use this where you can't install a new command, or in a CI context where the command is only used a handful of times. {% tabs %} {% tab label="Command" %}

npx @redocly/cli <command> [options]

{% /tab %} {% tab label="Example with lint command" %}

npx @redocly/cli@latest lint openapi.yaml

{% /tab %} {% /tabs %}

Run commands inside Docker

Redocly CLI is available as a pre-built Docker image in Docker Hub and GitHub Packages.

Install Docker if you don't have it already, then pull the image with the following command: {% tabs %} {% tab label="Docker Hub" %}

docker pull redocly/cli

{% /tab %} {% tab label="GitHub Packages" %}

docker pull ghcr.io/redocly/cli

{% /tab %} {% /tabs %} To give a Docker container access to your OpenAPI description files, you need to mount the containing directory as a volume. Assuming the API description is in the current working directory, the command to use is:

docker run --rm -v $PWD:/spec redocly/cli lint openapi.yaml

Next steps

• Set up autocomplete for Redocly CLI.
• Check the full list of Redocly CLI commands available.
• Try things out with the Museum Example API.