AI README CLI

A command-line tool that generates professional README files for your projects using AI.

Features

• Local Analysis: Analyzes your project structure, dependencies, and code to understand your project
• AI-Powered Generation: Uses Google's Gemini AI to generate professional, comprehensive README files
• Customizable Sections: Choose which sections to include (Introduction, Installation, Usage, etc.)
• Multi-Language Support: Detects project language and provides relevant examples
• Interactive CLI: Guided prompts for easy configuration and use
• Existing README Refinement: Improve existing README files with AI feedback

Installation

Global Installation (Recommended)

npm install -g ai-readme-cli

Local Installation

npm install ai-readme-cli
npx ai-readme generate

Prerequisites

• Node.js 16.0.0 or higher
• Google Gemini API key (get one at Google AI Studio)

Usage

First Time Setup

Configure your Gemini API key:

ai-readme config --set-api-key YOUR_GEMINI_API_KEY

Generate README

Navigate to your project directory and run:

ai-readme generate

Or specify a different path:

ai-readme generate --path /path/to/your/project

Generate with Specific Sections

ai-readme generate --sections introduction features installation usage

Non-Interactive Mode

ai-readme generate --no-interactive --sections introduction installation usage

Refine Existing README

ai-readme refine

Or refine a specific file:

ai-readme refine --file EXISTING_README.md --output NEW_README.md

Available Sections

• introduction: Brief overview and project description
• features: List of key features and capabilities
• installation: Step-by-step installation instructions
• usage: Code examples and usage instructions
• contributing: Guidelines for contributors
• license: License information
• tech-stack: Technologies and frameworks used
• prerequisites: Required software and dependencies
• configuration: Configuration options and environment variables
• testing: Testing instructions and frameworks
• deployment: Deployment guides and instructions

View all available sections:

ai-readme sections

Configuration

Set Default Sections

ai-readme config --set-sections introduction features installation usage license

View Current Configuration

ai-readme config --get-sections
ai-readme config --get-api-key

Interactive Configuration

ai-readme config

How It Works

1. Project Analysis: The tool scans your project directory to understand:

   • Project structure and file organization
   • Primary programming language and dependencies
   • Package configuration (package.json, pyproject.toml, etc.)
   • Existing documentation and code samples

2. AI Generation: Uses Google's Gemini AI with carefully crafted prompts to generate:

   • Professional, technical writing
   • Language-specific examples and instructions
   • Proper markdown formatting and structure

3. Output: Generates a comprehensive README.md file tailored to your project

Examples

Basic Usage

# Generate README with default sections
ai-readme generate

# Generate README for a different project
ai-readme generate --path ../my-other-project

# Override existing README
ai-readme generate --overwrite

Advanced Usage

# Generate specific sections only
ai-readme generate --sections introduction installation usage --output CUSTOM_README.md

# Non-interactive mode with custom output
ai-readme generate --no-interactive --output docs/README.md

Contributing

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Make your changes and add tests
4. Commit your changes: git commit -m 'Add amazing feature'
5. Push to the branch: git push origin feature/amazing-feature
6. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

• Report issues on GitHub Issues
• For questions, open a GitHub Discussion

Built with ❤️ using TypeScript and Google Gemini AI