Overview

🚀Getting Started

v1.0.2

Install the CLI, initialize project configuration, and run a safe first workflow.

CommandDoc Gen

📦Category

Getting Started

🚀Quick Command

doc-gen structure generate . --dry-run

Requirements

• Python 3.9+ compatibility; Python 3.14 standard runtime
• A dedicated virtual environment
• A reviewed source checkout, trusted artifact, or authorized private GitLab package
• Write permission only for workflows that intentionally persist output

💡Safe first run

Start with Installation and First Workflow.

ℹ️Private package distribution

Reviewed releases can be installed from the project's private GitLab PyPI registry. The package and command name are both doc-gen.