rdme is the CLI wrapper for ReadMe's RESTful API. It allows you to upload and edit Swagger and OAS files associated with projects you create on ReadMe. Additionally, you can sync documentation with your project, and manage project versions.
npm install rdmeIf you authenticate rdme to your ReadMe project, we will save your API key to a local configuration file (~/.config/configstore/rdme-production.json) so you will not have to provide the --key option to commands that require it.
rdme loginrdme whoami is also available to you to determine who you are logged in as, and to what project, as well as rdme logout for logging out of that account.
If you wish to get more information about any command within rdme, you can execute rdme help <command> or rdme <command> --help. You an also execute rdme help to see a global list of commands that rdme offers.
--key <string>: The API key associated with your ReadMe project. You can obtain this from your dashboard, or alternatively if you log in withrdme login, we will save your API key to a local configuration file (~/.config/configstore/rdme-production.json), saving you the hassle of having to supply this argument on commands that have it.--version <string>: Your project version.
ReadMe supports both Swagger 2.0 and OpenAPI 3.0.
This will upload path-to-swagger.json to your project and return an ID and URL for you to later update your file, and view it in the client.
rdme swagger [path-to-file.json]This will edit (resync) an existing API description (identified by --id) within your ReadMe project.
rdme swagger [path-to-file.json] --id={existing-id}You can additional include a version flag, specifying the target version for your file's destination
rdme swagger [path-to-file.json] --version={project-version}rdme swagger [path-to-file.json] --id={existing-id} --version={project-version}If you run rdme within a directory that contains your Swagger or OAS file, you can omit the file path. We will then look for a file with the following names, and upload that: swagger.json, swagger.yaml, openapi.json, and openapi.yaml
rdme swaggerrdme docs path-to-markdown-files --version={project-version}rdme docs:edit <slug> --version={project-version}rdme versionsIf you wish to see the raw output from our API in this response, supply the --raw flag.
rdme versions --version={project-version}If you wish to see the raw output from our API in this response, supply the --raw flag.
rdme versions:create <version> | --version={project-version}If you wish to automate the process of creating a new project version, and not have the CLI prompt you for input, you can do so by supplying the necessary flags to versions:create.
For example:
rdme versions:create <version> | --version={project-version} --fork={version-fork} --main={boolean} --beta={boolean} --isPublic={boolean}See rdme versions:create --help for a full list of flags.
rdme versions:update --version={project-version}Like versions:create, if you wish to automate this process and not be blocked by CLI input, you can supply the necessary flags to this command. See rdme versions:update --help or automating this process for more information.
You can remove a specific version from your project, as well as all of the attached specs
rdme versions:delete --version={project-version}If you are logged in, this will open the project in your browser:
rdme openWe are continually expanding and improving the offerings of this application as we expand our public API and are able. Some interactions may change over time, but we will do our best to retain backwards compatibility.