{"repo":"Redocly/redocly-cli","free":true,"listed":false,"github":"https://github.com/Redocly/redocly-cli","clone":"git clone https://github.com/Redocly/redocly-cli.git","description":"⚒️ Redocly CLI makes OpenAPI easy. Lint/validate to any standard, generate beautiful docs, and more.","language":"TypeScript","stars":1500,"topics":["openapi-cli","openapi","openapi3","openapi31","redoc","redocly","api-governance","cicd","linter","swagger2"],"license":"MIT","category":"deployment-docker-iac","readme_excerpt":"Redocly CLI @Redocly CLI is your all-in-one API documentation utility. It builds, manages, improves, and quality-checks your API descriptions, all of which comes in handy for various phases of the API Lifecycle. Create your own rulesets to make API governance easy, publish beautiful API reference documentation, and more. Supports OpenAPI 3.2, 3.1, 3.0 and OpenAPI 2.0 (legacy Swagger), AsyncAPI 3.0 and 2.6, Arazzo 1.0. Migration Migrating from Redocly CLI v1 to v2? Here's the guide to make the transition smoother. Usage Node Alternatively, install it globally with npm : Then you can use it as redocly [command] [options] , for example: The minimum required versions of Node.js and NPM are 22.12.0 and 10.9.2 respectively. Docker To give the Docker container access to the OpenAPI description files, you need to mount the containing directory as a volume. Assuming the API description is rooted in the current working directory, you need the following command: To build and run with a local image, run the following from the project root: Common tasks Generate API reference documentation Redocly CLI is a great way to render API reference documentation. It uses open source Redoc to build your documentation. Use a command like this: Your API reference docs are in redoc-static.html by default. You can customize this in many ways. Read the main docs for more information. :bulb: Redocly also has hosted API management solution, a (commercial) alternative to Redoc. Redoc, Revel, Reef, and Real","default_branch":null,"files":null,"tree":[],"storefront":"/r/Redocly","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Redocly/redocly-cli/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}