readme-doctor

Audit CLI help text and generate accurate project README documentation.

Updated Feb 22, 2026

Search Tags:#documentation #validation #cli #readme #help text #code congruence

Ready to run

npx skills add https://github.com/rahulrajaram/rahulskills --skill readme-doctor

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: readme-doctor
Source: https://github.com/rahulrajaram/rahulskills/tree/main/skills/readme-doctor
Command: npx skills add https://github.com/rahulrajaram/rahulskills --skill readme-doctor

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that your project's README file is accurate, comprehensive, and up-to-date, and that all command-line interface (CLI) help text is consistent and correct.

Core Features & Use Cases

README Generation: Creates a detailed README with required sections like Title, What is this?, Features, Installation, Quick Start, CLI Reference, and more.
CLI Help-Text Audit: Verifies that CLI command names, flags, descriptions, and default values are consistent across the entire CLI and accurately reflect the code.
Use Case: After updating a CLI tool with new features, use this Skill to automatically generate an updated README and audit all --help outputs for accuracy and consistency.

Quick Start

Run /readme-doctor to audit all CLI help text for consistency and generate a comprehensive README.

Frequently Asked Questions about readme-doctor

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I validate my CLI help text against the actual code definitions?▼

To validate CLI help text, this Skill audits command names, flags, descriptions, and default values for consistency and verifies them against your code. It checks for accuracy and congruence across your entire command-line interface.

How do I generate a comprehensive README from my CLI tool?▼

To generate a comprehensive README, this Skill builds a detailed document with required sections like Title, Features, Installation, Quick Start, and CLI Reference. It ensures usage examples accurately reflect your current codebase.

What is the best way to keep documentation accurate after updating my CLI?▼

Keeping documentation accurate after CLI updates is best handled by auditing help text and regenerating the README. This Skill verifies documentation against code and generates updated usage examples to ensure congruence.

Does this documentation validation tool require approval before changing files?▼

Yes, this documentation validation tool requires explicit user approval before making any changes. It will not automatically modify your documentation or code definitions without your confirmation.

Can I use this to audit CLI command flags and default values for consistency?▼

Yes, you can use this to audit CLI command flags and default values for consistency. It verifies that all help text outputs accurately reflect the underlying code and remain uniform across the interface.

What sections are required when generating a README for a CLI project?▼

Required sections for generating a README include Title, What is this?, Features, Installation, Quick Start, and CLI Reference. The generated document provides comprehensive coverage of your project's usage.