rdme - ReadMe's API CLIThis is a CLI wrapper around ReadMe's HTTP API.
npm install rdme
If you login to a project, you will not have to provide the --key option because we save it locally:
rdme login
rdme swagger {path-to-swagger.json} --key={api-key}
rdme swagger {path-to-swagger.json} --key={api-key} --id={existing-id}
rdme docs path-to-markdown-files --key={api-key} --version={project-version}
rdme docs:edit <slug> --key={api-key} --version={project-version}
If you are logged in, this will open the project in your browser:
rdme open
We will be expanding and modifying the feature set of this program as/when we expand our public API. Some things will be changed.
FAQs
ReadMe's official CLI and GitHub Action.
The npm package rdme receives a total of 1,670 weekly downloads. As such, rdme popularity was classified as popular.
We found that rdme demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 14 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.