Overview
AutoREADME is an autonomous documentation engine for open-source and enterprise repositories. It operates as a sidecar that listens for scheduled cron triggers or explicit API events, analyzes source code structures through read-only static analysis, and synthesizes up-to-date documentation using multi-provider LLM chains. It generates Markdown READMEs and streams live telemetry to an interactive dashboard.
The system includes a multi-tier LLM failover chain with providers such as Groq, GitHub Models, OpenRouter, Google Gemini, and a deterministic timestamp backup. A read-only AST and regex parser extracts class definitions, public methods, function signatures, API endpoints, environment variable requirements, CLI arguments, dependencies, and Docker configurations. A SHA-256 hashing optimizer skips redundant LLM requests when documentation content is up to date.
AutoREADME is designed as a zero-secret public architecture. Credentials are dynamically loaded from environment variables or GitHub Secrets, and RPC functions enforce secure password verification for remote database modifications. It also provides a React 19, Vite, Recharts, and Lucide Icons dashboard for tracking token consumption, runner latency, commit heatmaps, manual triggers, maintenance mode, and a kill-switch.
Pricing
Free
Detailed plans have not been confirmed in our catalog. Check the official website for current limits and billing terms.
Visit WebsitePrices and limits may change. Confirm the currency, billing period, seat minimum and usage caps on the official website.
Use Cases
- Teams use AutoREADME to automatically generate and update Markdown READMEs for repositories.
- Teams use AutoREADME to discover undocumented features by analyzing source code.
- Teams use AutoREADME to avoid API rate limits and single-provider outages through a multi-tier fallback chain.
- Teams use AutoREADME to extract API endpoints and web routes from code.
- Teams use AutoREADME to skip redundant LLM requests when README content is unchanged.
- Teams use AutoREADME to monitor token consumption and runner latency in a dashboard.
- Teams use AutoREADME to trigger manual runs or toggle maintenance mode.
- Teams use AutoREADME to keep credentials out of repository files.
Features
Scan codebases for documentation gaps
Discover undocumented code features
Update README files automatically
Switch between supported LLM providers
Use Groq, GitHub Models, OpenRouter or Gemini
Monitor activity with real-time telemetry
Reviews
No reviews yet. Be the first to share your experience!