The easiest way to generate
beautiful and accurate READMEs
Writing READMEs is a chore, and keeping them updated is even worse. Dokugen takes that pain away by scanning your codebase to generate a beautiful, detailed README in seconds. It lets you update it instantly as your code changes, so you can spend your time building, not formatting markdown.
Getting Started
Method 1: Node.js
Install globally via npm, yarn, or pnpm if you have Node.js installed.
or: pnpm add -g dokugen@latest
Method 2: Python
Install via uv (recommended) or pip. The Python client is fully featured and production-ready.
or: pip install dokugen
3. Navigate to Project
Open your terminal and navigate to your project directory:
4. Launch Interactive Menu
Run the CLI command without arguments to open the interactive assistant:
5. Customize
Edit the generated README.md file to check the final output.
Features
System Design Diagrams
Developers love visuals, but manual diagrams go stale the second you push code. Dokugen automatically renders interactive, color-coded architecture flowcharts directly inside your README. Show off your system design instantly, build trust with users, and make your repo look 10x more professional without touching Figma.
Smart Updates
Never worry about losing your custom descriptions, notes, or badges. Smart Updates intelligently target only the auto-generated elements of your README, preserving your hand-written text perfectly. Keep your docs fresh and accurate without repeating your hard work.
Quality Commit Messages
Unprofessional git logs hurt your credibility. Boost your project's reputation with clean, Conventional Commit messages generated instantly from your actual file diffs. Save mental energy and push your changes with a single keystroke.
License Generation
Unlicensed code is dead code, companies won't touch it, and developers won't contribute. Protect your intellectual property and welcome contributors in seconds. Automatically detect the author and year, generate a compliant LICENSE, and get a human-readable summary so everyone feels safe using your work.
Zero-Config Experience
No login, no API keys to copy, and zero setup friction. We believe you should experience value in less than 30 seconds. Just run Dokugen in your project and see the magic immediately, with no strings attached.
Incremental Scanning
Don't waste time waiting for slow documentation builds. Our intelligent caching engine only rescans the files you modified, delivering lightning-fast updates in milliseconds. High performance that respects your development flow.
Custom Templates
Success leaves clues. If you admire a popular repository's layout, simply point Dokugen to it. We will replicate its exact structure and fill it with your project's details automatically, giving you the layout of top-tier projects instantly.
Interactive Prompt
Say goodbye to memorizing complex CLI arguments. Type a single command and let our friendly interactive guide walk you through README generation, licensing, and commits step-by-step. Smooth, effortless, and simple.
Language Agnostic
Dokugen works with any codebase! Whether your project is built in React, Node, Python, Go, Rust, Java, PHP, C++, or Django, it doesn't matter. Just install Dokugen globally on your machine using npm or Python, and run it in any directory.
FAQs
How do I install Dokugen?
Dokugen installs in seconds on any system. For Node.js users, run npm install -g dokugen or pnpm add -g dokugen. For Python, run uv tool install dokugen or pip install dokugen. You're just one command away from clean documentation.
Can I use custom templates?
Absolutely. Stand out from the crowd by matching the layout of your favorite repositories. Simply use the --template flag and provide any public README URL to instantly model your documentation after the best in the industry.
How does the AI Commit subcommand work?
Writing commits is tedious, but clean history is crucial for team projects. Running dokugen aic stages your files, reads the git diff, and writes Conventional Commits using Gemini, then commits and optionally pushes with one confirmation. Look professional without the cognitive load.
Does Dokugen read my .env files or sensitive API keys?
Your trust is our top priority. Dokugen has built-in security filters that strictly ignore sensitive files like .env, credentials, bytecode, and lockfiles. None of your private keys or secrets are ever read or transmitted. Your intellectual property and credentials remain 100% secure.
Does Dokugen require my own API keys?
No API keys or payment required to start. We provide a fully managed backend with shared API keys so you can experience Dokugen instantly. If you have extremely large projects or hit rate limits, you can easily plug in your own API key for unlimited use.
Which languages and frameworks does Dokugen support?
Dokugen is 100% language and framework agnostic! It supports all types of frameworks and programming languages (Node.js, React, Python, Django, Go, Rust, Java, PHP, C++, and more). You do not need Node.js or Python to be the main language of your project. You simply install Dokugen globally on your machine using npm/pnpm/yarn or Python (pip/uv), and run it in any repository.
What is the license generation feature?
Did you know that without a LICENSE file, other developers legally cannot use, modify, or distribute your code? Unlicensed repositories scare away contributors and companies alike. Protect your work and open the door to collaboration by running dokugen license. It auto-detects git details and generates a compliant LICENSE along with a human-readable summary that builds trust.
How do the colorized flowcharts work?
A picture is worth a thousand words. Dokugen automatically maps your project's structure and renders clean, color-coded architecture flowcharts inside your README. It assigns distinct colors to each service (like database, cache, or queue) and optimizes layout directions so your project structure is instantly readable.
What is the smart update command?
Most generators completely overwrite your manual edits, forcing you to copy-paste. Using dokugen update is different: it updates the technical directories and dependencies while leaving your carefully written descriptions, tutorials, and badges untouched. Keep your docs in sync with your code effortlessly.
Dokugen in Action
Dokugen is free and open-source. If it's saved you time, a star or a contribution goes a long way in keeping it alive and growing.
Support the Project
Dokugen is completely free. Consider sponsoring or tipping the developers!
GitHub Sponsors
Support Samuel Tuoyo directly on GitHub Sponsors to help fund Dokugen development if you are outside Africa.
Support Dokugen
Sponsor Samuel Tuoyo on GitHub Sponsors
Myhappr Tip Card
Support Samuel Tuoyo directly on Myhappr Tip Card to help fund Dokugen development if you are in Africa.
© 2026 Dokugen. All rights reserved.