Skip to main content

Examples

Examples

Read Only

Analyze is inherently read-only. It may scan and calculate metadata, but it does not invoke the Markdown writer.

Commanddoc-gen structure analyze

Category

Project Structure

Quick Command

doc-gen structure analyze [OPTIONS]

1. Analyze current project​

Terminal
bash
doc-gen structure analyze .

Result: Displays analysis.

2. Override type​

Terminal
bash
doc-gen structure analyze . --project-type python

Result: Uses Python classification.

3. Smart analysis​

Terminal
bash
doc-gen structure analyze . --smart

Result: Applies automatic optimization decisions.

4. Dry-run​

Terminal
bash
doc-gen structure analyze . --dry-run

Result: Remains read-only.