README Generator Agent - VSCode Extension

AI-powered VSCode extension that generates comprehensive README documentation for your projects.

Features

• 🏪 Marketplace Integration: Browse and connect to the README Generator Agent from a dedicated sidebar
• 📝 AI-Powered Generation: Automatic README creation using GPT-4
• 🎨 Live Preview: Split-view editor with real-time markdown preview
• 📋 Multiple Templates: Choose from Standard, Library, API, CLI, or Monorepo templates
• 🔍 Smart Analysis: Automatically detects language, framework, and dependencies
• ⚡ Section Regeneration: Regenerate individual sections without starting over
• 🌍 Multi-Language: Supports JavaScript, TypeScript, Python, Java, Go, Rust, C#, and more

Installation

1. Install the extension from VSCode Marketplace (or install .vsix file)

2. Start the backend service:

   cd ../backend
   npm install
   npm run dev
   

3. Configure connection:

   • Open Command Palette (Cmd+Shift+P or Ctrl+Shift+P)
   • Run README Agent: Configure Agent Settings
   • Set endpoint: http://localhost:3000
   • Add API key (if required)

Usage

Method 1: Marketplace Sidebar

1. Click the Walgreens Marketplace icon in the Activity Bar
2. View README Generator Agent details
3. Click "Connect to Agent"
4. Browse your projects and click "Generate README"

Method 2: Command Palette

1. Open Command Palette (Cmd+Shift+P or Ctrl+Shift+P)
2. Run README Agent: Generate README
3. Select template
4. Wait for generation
5. Review in split-view editor
6. Save to your project

Method 3: Context Menu

1. Right-click on a folder in Explorer
2. Select "Generate README" or "Generate README (Python Generators)"

Method 4: Python Generators

The extension now supports Python-based README generators with multiple strategies:

1. Start the Python service:

   cd backend/readme_generator/src
   python main.py
   

   The service will start on port 8000.

2. Generate README:

   • Open Command Palette (Cmd+Shift+P or Ctrl+Shift+P)
   • Run README Agent: Generate README (Python Generators)
   • Select generator type:
     • Simple Generator: Fast, single-pass generation
     • Multi-Draft Generator: Generates 5 drafts and compiles the best
     • Chunked Generator: For large repositories with intelligent chunking
     • Hybrid Generator: GPT-4.1 for drafts + GPT-5-mini for compilation
     • GPT-5 Mini Generator: Fast and cost-effective using GPT-5-mini

3. View results: The generated README will be saved to your project directory

Commands

Configuration

Access settings via Cmd+, (or Ctrl+,) and search for "README Agent":

Templates

Standard

Comprehensive README for typical projects

• Title, Description, Badges
• Installation, Usage
• Tests, Contributing, License

Library/Package

For npm packages, pip packages, etc.

• Includes API Reference
• Configuration options
• Publishing instructions

API Service

For REST APIs and backend services

• API endpoints documentation
• Deployment instructions
• Environment configuration

CLI Tool

For command-line applications

• Usage examples
• Commands reference
• Options and flags

Monorepo

For multi-package repositories

• Package structure
• Workspace management
• Cross-package dependencies

Development

Setup

npm install

Run Extension

1. Open in VSCode
2. Press F5 to launch Extension Development Host
3. Test commands in the new window

Build

npm run compile

Package

npm run package

This creates a .vsix file you can distribute or install manually.

Troubleshooting

"Agent service not connected"

• Ensure backend service is running (npm run dev in backend folder)
• Check endpoint configuration matches backend port
• Verify firewall/network settings

"Python README Generator service is not available"

• Start the Python service: cd backend/readme_generator/src && python main.py
• Verify the service is running on port 8000
• Check readmeAgent.pythonGeneratorEndpoint configuration
• Ensure Python dependencies are installed: pip install -r requirements.txt

"Failed to generate README"

• Check Azure OpenAI credentials in backend .env
• Verify project path is accessible
• Check backend logs for errors
• For Python generators, check the console output from python main.py

Extension not activating

• Reload VSCode window (Cmd+R or Ctrl+R)
• Check Output panel for errors (View → Output → README Generator Agent)

Contributing

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

License

MIT