Choose the most appropriate installation method for your needs:
- Install locally, using
yarnto make the
redoclycommand available on your system.
npxto 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.
Make sure you have the newest version of
yarn before you begin.
npm i -g @redocly/cli@latest
redocly --version confirms that the installation was successful, and the currently-installed version of the tool.
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.
- Example with lint command
npx @redocly/cli <command> [options]
Install Docker if you don't have it already, then pull the image with the following command:
- Docker Hub
- GitHub Packages
docker pull redocly/cli
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 petstore.yaml