Examples

🚀Examples

Writes Selected Output

This is the only structure command that writes output. --dry-run renders in memory but creates neither the output directory nor file.

Commanddoc-gen structure generate

📦Category

Project Structure

🚀Quick Command

doc-gen structure generate [OPTIONS]

---

1. Preview

Terminal

bash

doc-gen structure generate . --dry-run

Result: Renders without writing.

2. Default output

Terminal

bash

doc-gen structure generate .

Result: Writes configured output.

3. Custom output

Terminal

bash

doc-gen structure generate . --output docs/PROJECT_STRUCTURE.md

Result: Writes selected file.

4. Detailed smart

Terminal

bash

doc-gen structure generate . --profile detailed --smart

Result: Uses detailed profile with optimization.