Examples

🚀Examples

Recommended

Dry-run never creates directories, writes files, replaces content, or prompts.

Commanddoc-gen init

📦Category

Initialization

🚀Quick Command

doc-gen init [OPTIONS]

---

1. Preview

Terminal

bash

doc-gen init --dry-run

Result: Shows plan.

2. Initialize

Terminal

bash

doc-gen init

Result: Creates .config/doc_gen/config.toml when it does not exist.

3. Configuration only

Terminal

bash

doc-gen init --mode config

Result: Creates the same configuration file through the explicit config mode.

4. Force

Terminal

bash

doc-gen init --mode all --force

Result: Replaces the existing configuration file without prompting.