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.

Table of Contents

• Table of Contents
• GitHub Actions Configuration
• Command Topics

GitHub Actions Configuration

rdme has a thin wrapper that allows the CLI to be used as a proper action in a GitHub Actions workflow. For example, say you wanted to run rdme openapi validate petstore.json in a GitHub Actions environment. Here's what the corresponding steps would look like in a GitHub Actions workflow file:

## Required in order for the GitHub Action to access your repo's contents
- uses: actions/checkout@v6

## Runs the `rdme openapi validate petstore.json` command with the root directory being your repo
- uses: step-security/readmeio-rdme@v10
  with:
    rdme: openapi validate petstore.json

For more information on getting started with GitHub Actions, check out our docs.

Command Topics

• rdme autocomplete - Display autocomplete installation instructions.
• rdme changelog - Upload Markdown files to the Changelog section of your ReadMe project.
• rdme custompages - Upload Markdown or HTML files to the Custom Pages section of your ReadMe project.
• rdme docs - Upload Markdown files to the Guides section of your ReadMe project.
• rdme help - Display help for rdme.
• rdme login - Login to a ReadMe project.
• rdme logout - Logs the currently authenticated user out of ReadMe.
• rdme openapi - Manage your API definition (e.g., syncing, validation, analysis, conversion, etc.). Supports OpenAPI, Swagger, and Postman collections, in either JSON or YAML formats.
• rdme plugins - List installed plugins.
• rdme reference - Upload Markdown files to the Reference section of your ReadMe project.
• rdme whoami - Displays the current user and project authenticated with ReadMe.