Examples

🚀Workflow Examples

Inspect Before Generate

Inspect a repository, preview a rendered document, and write only the selected output after review.

Commanddoc-gen

📦Category

Examples

🚀Quick Command

doc-gen structure COMMAND [TARGET] [OPTIONS]

---

Read-only inspection

Terminal

bash

doc-gen structure print . --max-depth 3
doc-gen structure analyze . --smart

# Show directories only

doc-gen structure print . --hide-files

Preview, then generate

Terminal

bash

# Render in memory and show the resolved plan
doc-gen structure generate . --profile detailed --output docs/project_structure.md --dry-run

# Write the selected output only after review

doc-gen structure generate . --profile detailed --output docs/project_structure.md

⚠️Dry-run creates no output path

Generation dry-run may scan and render, but it does not create the output directory or file. print and analyze are read-only in both modes.

🚀Related Commands

Commands commonly used together with this command.

Generate Examples

Explore profiles, targets, and output paths.

Print Examples

Tune terminal tree visibility.

Analyze Examples

Inspect repository summaries without writes.