# great-docs init


Initialize great-docs in your project (one-time bootstrap).


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


Creates a fresh `great-docs.yml` configuration file with discovered package exports and sensible defaults. Refuses to run if `great-docs.yml` already exists (use `--force` to reset).

- Creates `great-docs.yml` with discovered API exports
- Auto-detects your package name and public API
- Updates .gitignore to exclude the build directory
- Detects docstring style (numpy, google, sphinx)

After init, customize `great-docs.yml` then use `great-docs build` for all subsequent builds. You should never need to run `great-docs init` again unless you want to completely reset your configuration.


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


    Usage: great-docs init [OPTIONS]

      Initialize great-docs in your project (one-time bootstrap).

      Creates a fresh 'great-docs.yml' configuration file with discovered package
      exports and sensible defaults. Refuses to run if 'great-docs.yml' already
      exists (use '--force' to reset).

      • Creates 'great-docs.yml' with discovered API exports
      • Auto-detects your package name and public API
      • Updates .gitignore to exclude the build directory
      • Detects docstring style (numpy, google, sphinx)

      After init, customize 'great-docs.yml' then use 'great-docs build' for all
      subsequent builds. You should never need to run 'great-docs init' again
      unless you want to completely reset your configuration.

      Examples:
        great-docs init                       # Initialize in current directory
        great-docs init --force               # Reset config to defaults
        great-docs init --project-path ../pkg # Initialize in another project

    Options:
      --project-path DIRECTORY  Path to your project root directory (default:
                                current directory)
      --force                   Delete existing great-docs.yml and generate a
                                fresh default config
      --help                    Show this message and exit.


# Options


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

`--force`  
Delete existing great-docs.yml and generate a fresh default config


# Examples

``` bash
  great-docs init                       # Initialize in current directory
  great-docs init --force               # Reset config to defaults
  great-docs init --project-path ../pkg # Initialize in another project
```