{"repo":"readmeio/rdme","free":true,"listed":false,"github":"https://github.com/readmeio/rdme","clone":"git clone https://github.com/readmeio/rdme.git","description":"ReadMe's official command-line interface (CLI) and GitHub Action 🌊","language":"JavaScript","stars":145,"topics":["readme","swagger","docs","openapi","sync"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"ReadMe 's official command-line interface (CLI) and GitHub Action 🌊 With rdme , you can manage your API definition (we support OpenAPI, Swagger, and Postman) and sync it to your API reference docs on ReadMe. Not using ReadMe for your docs? No worries. rdme has a variety of tools to help you identify issues with your API definition — no ReadMe account required. [!NOTE] If you're using ReadMe Refactored, you'll want to use rdme@10 or later. If you're not using ReadMe Refactored, you'll want to use rdme@9 . More info can be found in our migration guide. Table of Contents Table of Contents Quick Start CLI Configuration GitHub Actions Configuration Command Topics Quick Start Install the CLI (see here for more setup options): Validate an OpenAPI file in your working directory or any subdirectories (see here for all command topics): Every command has a help page, which you can access in our docs or via the CLI: To view the current version of rdme (helpful for troubleshooting and bug reports): CLI Configuration Setup [!NOTE] These setup instructions are for CLI usage only. For usage in GitHub Actions, see GitHub Actions Configuration below. To install the rdme CLI, you'll need to have Node.js installed. Node.js comes bundled with the npm CLI, which you'll need to install rdme . You can see our current Node.js version requirements in the green badge on the right. Installing rdme to Your Local Machine The simplest way to use rdme is to install it globally: With a global installation, ","default_branch":null,"files":null,"tree":[],"storefront":"/r/readmeio","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/readmeio/rdme/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."}