redocly-cli

(★ 1,503)

⚒️ Redocly CLI makes OpenAPI easy. Lint/validate to any standard, generate beautiful docs, and more.

File Explorer

Download Latest Version (.zip)

Showing a partial file list — download the zip above to see everything.

  • .dockerignore
  • .gitignore
  • .markdownlint.yaml
  • .mlc.toml
  • .oxfmtrc.json
  • .oxlintrc.json
  • .vale.ini
  • AGENTS.md
  • CLAUDE.md
  • CONTRIBUTING.md
  • Dockerfile
  • LICENSE.md
  • package-lock.json
  • package.json
  • README.md

🚀 Installation Guide

1. Get the code
git clone https://github.com/Redocly/redocly-cli

Downloads the entire project code from GitHub to your computer.

cd redocly-cli

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run --rm -v $PWD:/spec redocly/cli lint path-to-root-file.yaml

Runs the built image as an actual container.

docker build -t redocly/cli .

Builds a runnable image based on the Dockerfile.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install @redocly/cli -g

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

Today's picks

fucking-algorithm ★ 135,358

Crack LeetCode, not only how, but also why.

Markdown
graphify ★ 107,046

Turn any codebase, with its docs, SQL schemas, configs, and PDFs, into a queryable knowled

Python
hugo ★ 89,432

The world’s fastest framework for building websites.

Go
create-react-app ★ 103,294

Set up a modern web app by running one command.

JavaScript
markitdown ★ 174,077

Python tool for converting files and office documents to Markdown.

Python
LlamaFactory ★ 74,144

Unified Efficient Fine-Tuning of 100+ LLMs & VLMs (ACL 2024)

Python
// repository documentation