Dokugen is an open-source command-line tool that effortlessly generates high-quality README.md files for your projects. It intelligently analyzes your project structure and code to create a detailed, professional README—saving you time while ensuring clarity and consistency.
Features
Automated README Generation
Dokugen analyzes your project files and generates a well-structured README.md file.
Project Type Detection
Automatically detects the project type (e.g., JavaScript/TypeScript, Python, Go) based on the presence of specific files (e.g., `package.json`, `go.mod`).
Code Snippet Extraction
Extracts relevant code snippets from your project files to include in the README.
Interactive Configuration
Asks key questions about your project (e.g., API usage, database integration, Docker setup) to tailor the README content.
Customizable Output
Allows you to specify whether to include sections on API endpoints, database setup, and Docker integration.
Overwrite Protection
Prompts before overwriting an existing `README.md` file.
Error Handling
Provides informative error messages and gracefully handles interruptions.