dokugen
v3.9.0
Published
Readme generator command line tool.
Maintainers
Readme
Dokugen

Dokugen is a lightweight README.md file Generator Command Line Interface Tool. It simplifies the process of writing your README.md file from scratch by generating professional README.md files for your projects, saving you time and ensuring consistency using AI. The idea behind Dokugen is simple but impactful, automate the most neglected part of a repo. The results cleaner projects and happier contributors
Usage
Install Dokugen globally (Recommended)
npm install -g dokugen #or yarn global add dokugen Navigate to the project you want to work with
cd my-projectGenerate a new README interactively
dokugen generateThis command launches an interactive prompt to guide you through creating a professional README file.
Generate README with template
dokugen generate --template https://raw.githubusercontent.com/username/repo-name/blob/main/README.mdUse a custom GitHub repo readme file as a template to generate a concise and strict readme for your project.
Check Version
dokugen --versionDisplays Current Version (3.9.0)
Features
- Automated Generation: Automatically analyzes your project and generates a comprehensive README.
- Easy to Use: Simple command-line interface for quick and easy README creation.
- Cross-Platform: Works seamlessly on Windows, macOS, and Linux.
- Programming Language and Framework Agnostic: Works with any language (e.g., Python, JavaScript, Go, C#, C, Rust, etc.)
- Options & Flags: Supports flags and options like generating from a template, overwriting existing files, etc.
Programming Language & Framework Compatibility

Technologies Used
| Technology | Description | Link | | :----------- | :---------------------------------------------------- | :----------------------------------------------------------------------------------- | | Node.js | JavaScript runtime environment | https://nodejs.org/ | | TypeScript | Typed superset of JavaScript | https://www.typescriptlang.org/ | | Commander.js | Node.js command-line interfaces | https://github.com/tj/commander.js | | Inquirer.js | Interactive command line prompt toolkit | https://github.com/SBoudrias/Inquirer.js | | Axios | Promise-based HTTP client for the browser and Node.js | https://github.com/axios/axios | | Chalk | Terminal string styling done right | https://github.com/chalk/chalk | | Esbuild | An extremely fast JavaScript bundler and minifier | https://github.com/evanw/esbuild |
License
This project is licensed under the MIT License - see the LICENSE file for details.
Contributing
Contributions are welcome! Please first open an issue with your feature request before submitting a pull request. Read the contribution guide here.
