Dokugen Docs

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

Getting Started

Method 1: Node.js

Install via npm, yarn, or pnpm if you have Node.js installed.

npm install -g dokugen

Method 2: Python

NEW

Install via uv (recommended) or pip. The Python client is fully featured and production-ready.

uv tool install dokugen

or: pip install 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. Launch Interactive Menu

Run the CLI command without arguments to open the interactive assistant:

dokugen

5. Customize

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

Features

Instant AI READMEs

Dokugen parses your project structure, config files, and code. It automatically spots your tech stack, dependencies, and APIs, drafting a professional README complete with badges, descriptions, and setups in seconds.

FEATURE_01 // CORE_GENERATOR

Smart Updates

Regenerate your README without losing manual changes. We only refresh the auto-detected parts (tech stack, files, features), keeping your custom paragraphs and badges untouched.

FEATURE_02 // SYNC_SYSTEM

AI Commit Messages

Type dokugen aic to scan your staged git diff and instantly draft clean Conventional Commit messages. You can even auto-push!

FEATURE_03 // GIT_WORKFLOW

Safety Reverts

Every time you run a change, we save a backup of your original file. If you don't like the new result, run dokugen revert to restore it instantly.

FEATURE_04 // BACKUP_SHIELD

Interactive Prompt

Forget syntax flags and subcommands! Just type dokugen to launch a gorgeous step-by-step interactive menu in your console.

FEATURE_05 // CLI_MENU

FAQs

How do I install Dokugen?

Node.js: Run npm install -g dokugen to install Dokugen globally.
Python NEW: Run pip install dokugen or uv tool install dokugen.

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