# great-docs scan


Discover package exports and preview what can be documented.


``` bash
great-docs scan [OPTIONS]
```


This command analyzes your package to find public classes, functions, and other exports. Use this to see what's available before writing your reference config.


<span class="gd-details-chevron" aria-hidden="true"></span>Full --help output


    Usage: great-docs scan [OPTIONS]

      Discover package exports and preview what can be documented.

      This command analyzes your package to find public classes, functions, and
      other exports. Use this to see what's available before writing your
      reference config.

      Examples:
        great-docs scan                       # Show discovered exports
        great-docs scan --verbose             # Include method names for classes
        great-docs scan -v                    # Short form of --verbose

    Options:
      --project-path DIRECTORY  Path to your project root directory (default:
                                current directory)
      --docs-dir TEXT           Path to documentation directory relative to
                                project root
      -v, --verbose             Show method names for each class
      --help                    Show this message and exit.


# Options


`--project-path: DIRECTORY`  
Path to your project root directory (default: current directory)

`--docs-dir: TEXT`  
Path to documentation directory relative to project root

`-v, --verbose`  
Show method names for each class


# Examples

``` bash
  great-docs scan                       # Show discovered exports
  great-docs scan --verbose             # Include method names for classes
  great-docs scan -v                    # Short form of --verbose
```