Dokugen Docs

Everything you need to know about Dokugen. From installation to advanced CLI usage.

Getting Started

1. Prerequisites

Dokugen works with any programming language or framework (Python, Go, Rust, PHP, etc.).

To get started, you simply need Node.js installed once on your machine.

$node -v

Check if installed

Alternative: Standalone Binary

No Node.js

Avoid installing Node.js entirely. Download the single executable file for your OS:

Windows.exe (x64)macOSSilicon (M1/M2)macOSIntel (x64)Linuxx64

# Linux/macOS Quick Install:

curl -L -o dokugen https://github.com/samueltuoyo15/Dokugen/releases/latest/download/dokugen-linux-x64 && chmod +x dokugen

2. Install Globally

Install Dokugen globally once, and use it forever across any project on your machine:

npm install -g dokugen

3. Navigate to Project

Open your terminal and navigate to your project directory:

cd your-project

4. Generate README

Run the CLI command to interactively generate your README:

dokugen generate

5. Customize

Edit the generated README.md file to check the final output.

Features

Modern READMEs

Generate professional READMEs with emojis, badges, and modern formatting standards automatically.

Cross-Platform

Built to work on any OS and supports any programming language or framework.

Easy Integration

Designed for seamless integration with GitHub, GitLab, and VS Code workflows.

Intelligent Updates

Smartly updates only the auto-generated parts of your README, keeping your custom edits safe.

FAQs

How do I install Dokugen?

Run npm install -g dokugen to install Dokugen globally.

Can I use custom templates?

Yes. Use the --template flag to specify a custom template URL.
Example: dokugen --template https://raw.github.../README.md

Can I auto generate my readme using the --live flag?

Coming Soon. You will be able to use the --live flag to watch and auto-generate your README in upcoming Dokugen versions.

Dokugen in Action

Loading metrics...

Need help? Check out our GitHub or support page.

Terms of ServicePrivacy Policy