AI-assisted README generator for VS Code — accurate, deterministic, and instant.
AutoREADME automatically scans your codebase and generates a complete, beautifully-formatted README.md in under 30 seconds. Unlike generic AI prompting, AutoREADME uses deterministic static analysis to extract verified scripts, frameworks, and project structure before calling an LLM. The AI never invents commands — it only crafts clean prose around verified facts.
Quick Start
Install the AutoREADME extension in VS Code.
Open any project workspace in VS Code.
Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and run:
AutoREADME: Generate README
Review the generated README in the side-by-side preview, customize sections or templates in the sidebar, and save or copy your new README.
Key Features
GitHub URL Support: Run AutoREADME: Generate from GitHub URL to analyze and draft documentation for any public remote repository without manually cloning it.
3 Template Styles:
Minimal: Streamlined overview with installation and verified scripts.
Standard: Full-featured technical README with badges, features, usage notes, environment variables, and folder structure.
Enterprise: Comprehensive layout including contributing guidelines and sub-project documentation for monorepos.
Live Sidebar Customization: Toggle sections on or off in the sidebar; the preview re-assembles instantly without burning AI credits or API quota.
Supported AI Providers
AutoREADME works out of the box with zero configuration and supports bring-your-own-key (BYOK):
AutoREADME Cloud: Free bundled backend — no API key or setup required.
OpenAI: Use your own OpenAI API key (gpt-4o default).
Anthropic: Use your own Anthropic API key (claude-sonnet-4-6 default).
To configure your own key:
Open settings (Ctrl+, / Cmd+,) and search for autoreadme.ai.provider.
Select your provider (OpenAI or Anthropic).
Run AutoREADME: Set API Key from the Command Palette to save your key securely in VS Code Secrets.
Privacy & Security First
Your source code is never uploaded or sent to an LLM. AutoREADME inspects manifests, config files, and directory layouts locally to produce a high-level metadata summary (ProjectFacts). Only this structured summary is shared with the AI layer to generate descriptions and feature highlights.
