readme-ai

Why we included this project

readme-ai is a command-line tool that builds a README from a repository URL or a local directory. It scans the code to pull out dependencies, project structure, and entry points, then hands those details to a language model to write the prose sections. You can point it at OpenAI, Anthropic, Gemini, or a local Ollama instance, and an offline mode produces a usable README without calling any API at all. Teams that maintain a lot of repositories will find it useful for keeping docs consistent across projects, and the template, badge, and header options let you match a house style. The result tends to stay close to what the code actually contains, which beats a hand-written guide that drifts out of date.