The ReadMe CLI Tool
Blog post from ReadMe
ReadMe has introduced the open-source @readme/cli to support Git-backed documentation repositories by validating their file and folder structure locally and in CI workflows. Its lint command checks issues including broken links, invalid frontmatter, malformed YAML or MDX, duplicate slugs, sidebar and ordering problems, missing components, and outdated OpenAPI-derived reference pages, while the --fix option resolves deterministic errors automatically. The CLI can synchronize Markdown reference pages with OpenAPI specifications, provide setup commands for CI services such as GitHub, GitLab, Bitbucket, CircleCI, and RWX, and post linting results on pull requests. A beta dev server offers hot-reloading local previews, and the tool is designed to work with AI coding agents such as Claude Code and Codex by providing format-aware validation and feedback for drafting or repairing documentation. The earlier rdme upload-focused CLI remains available for existing users, while the new tool reflects ReadMe’s shift to bidirectional Git synchronization.
No tracked trend matches for this post yet.
Use this post, company, and trend context to find content marketing opportunities, perform competitive analysis, or address product feature gaps via the Plushcap MCP server or the Plushcap API.