Install Redocly CLI

March 11, 2026 · View on GitHub

Choose the most appropriate installation method for your needs:

Install locally

Before you begin, make sure you have the newest version of npm.

To install Redocly CLI locally:

  1. In your CLI, cd to your project's directory.
  2. Enter the following command:
npm i @redocly/cli@latest
  1. (Optional) Run redocly --version to confirm that the installation was successful and the currently-installed version of the tool.

Use the command at runtime

npx is npm's package runner. It installs and runs a command without installing it globally.

Use this approach where you can't install a new command, or in a CI context where the command is only used a handful of times.

To run Redocly CLI with npx:

  • Replace redocly with npx @redocly/cli@latest to prepend Redocly CLI commands.

    npx @redocly/cli@latest <command> [options]

For example, to run redocly lint on a file named openapi.yaml, use the following command:

npx @redocly/cli@latest lint openapi.yaml

Run commands inside Docker

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

Before you begin, make sure you have Docker installed.

To run Redocly CLI commands inside a docker container:

  1. Pull the image:

{% tabs %} {% tab label="Docker Hub" %}

docker pull redocly/cli

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

docker pull ghcr.io/redocly/cli

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

  1. To give a Docker container access to your OpenAPI description files, mount the containing directory as a volume:
docker run --rm -v $PWD:/spec redocly/cli lint openapi.yaml

This example assumes that the API description file is in your current working folder.

Run CLI behind a proxy

To run the CLI tool behind a proxy, you can use the HTTP_PROXY and HTTPS_PROXY environment variables to configure the proxy settings. These environment variables specify the proxy server for HTTP and HTTPS traffic, respectively.

Set up Proxy Environment Variables

To set the proxy environment variables:

  • Open a terminal and use the following command:

{% tabs %} {% tab label="HTTP proxy" %}

export HTTP_PROXY=http://your-http-proxy-server:port

{% /tab %} {% tab label="HTTPS proxy" %}

export HTTPS_PROXY=https://your-https-proxy-server:port

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

Bypass proxy for specific hosts

Use the NO_PROXY environment variable to specify hosts that should be accessed directly, without going through the proxy. The value is a comma-separated list of hostnames or domain suffixes:

  • localhost — exact hostname match.
  • .example.com — matches any subdomain of example.com (but not example.com itself).
  • example.com — matches example.com and any subdomain such as api.example.com.
  • * — bypasses the proxy for all requests.

Use Environment Variables with CLI Commands

To directly include the proxy environment variables in a Redocly CLI command:

  • Prepend the command with the environment variable and its value.

    For example:

    HTTPS_PROXY=https://your-https-proxy-server:port redocly lint --extends minimal openapi.yaml

Next steps