https://github.com/samueltuoyo15/dokugen
Lightweight README.md file Generator CLI. It simplifies the process of writing your README.md file from scratch by generating professional README.md files for your projects, saving you time. The idea behind Dokugen is simple but impactful, automate the most neglected part of a repo. The results cleaner projects and happier contributors
https://github.com/samueltuoyo15/dokugen
api-documentation readme-generator
Last synced: 6 months ago
JSON representation
Lightweight README.md file Generator CLI. It simplifies the process of writing your README.md file from scratch by generating professional README.md files for your projects, saving you time. The idea behind Dokugen is simple but impactful, automate the most neglected part of a repo. The results cleaner projects and happier contributors
- Host: GitHub
- URL: https://github.com/samueltuoyo15/dokugen
- Owner: samueltuoyo15
- License: mit
- Created: 2025-02-17T18:08:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-11-29T12:30:04.000Z (8 months ago)
- Last Synced: 2025-12-23T18:50:40.534Z (8 months ago)
- Topics: api-documentation, readme-generator
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/dokugen
- Size: 12.8 MB
- Stars: 253
- Watchers: 3
- Forks: 20
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
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 once, and use forever (Recommended)
```bash
npm install -g dokugen
# or
yarn global add dokugen
# or
pnpm install -g dokugen
```
### Or Download Standalone Binary (No Node.js Required)
Grab the executable for your OS from the [Releases page](https://github.com/samueltuoyo15/Dokugen/releases).
**Windows:**
Download `dokugen-windows-x64.exe` and run it from your command prompt.
**macOS / Linux:**
```bash
# Example for Linux
curl -L -o dokugen https://github.com/samueltuoyo15/Dokugen/releases/latest/download/dokugen-linux-x64
chmod +x dokugen
./dokugen --version
```
### Navigate to the project you want to work with
```bash
cd my-project
```
### Generate a new README interactively
```bash
dokugen generate
```
> This command launches an interactive prompt to guide you through creating a professional README file.
---
### Generate README with template
```bash
dokugen generate --template https://raw.githubusercontent.com/username/repo-name/blob/main/README.md
```
> Use a custom GitHub repo readme file as a template to generate a concise and strict readme for your project.
---
### Update Existing README (Smart Update)
```bash
dokugen update
```
> **NEW!** Intelligently updates only auto-generated sections of your README while preserving all your custom content. Perfect for keeping your README fresh as your project evolves without losing your personal touch.
**What gets updated:**
- Tech stack and dependencies
- API documentation
- Installation instructions
- Features list
**What stays safe:**
- Your custom introductions
- Personal badges and links
- Custom examples
- Manual sections you've added
---
### Check Version
```bash
dokugen --version
```
> Displays Current Version (3.11.0)
## Features
- **Auto-Update System**: Dokugen automatically checks for new versions and updates itself when you run any command. Always stay current!
- **Smart README Updates**: Update your README without losing custom content. Only auto-generated sections get refreshed.
- **Automated Generation**: Automatically analyzes your project and generates a comprehensive README.
- **Real-Time Streaming**: Watch your README populate in real-time as it's being generated.
- **Compression Technology**: Handles large codebases efficiently with 70-90% payload size reduction.
- **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
### Review from Github Projects Community
|
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributing
Contributions are welcome! [Read the contribution guide here.](https://github.com/samueltuoyo15/Dokugen/blob/main/CONTRIBUTION.md)
## Author
- **Samuel Tuoyo**
- [Twitter](https://x.com/TuoyoS26091)
- [LinkedIn](https://www.linkedin.com/in/samuel-tuoyo-8568b62b6)
## Badges
[](https://opensource.org/licenses/MIT)
[](https://opensource.org/)
[](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
[](https://www.npmjs.com/package/dokugen)
[](https://github.com/acekyd/made-in-nigeria)