# great-docs config


Generate a great-docs.yml configuration file.


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


Creates a `great-docs.yml` file with all available options documented. The generated file contains commented examples for each setting.


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


    Usage: great-docs config [OPTIONS]

      Generate a great-docs.yml configuration file.

      Creates a 'great-docs.yml' file with all available options documented. The
      generated file contains commented examples for each setting.

      Examples:
        great-docs config                     # Generate in current directory
        great-docs config --force             # Overwrite existing file
        great-docs config --project-path ../pkg

    Options:
      --project-path DIRECTORY  Path to your project root directory (default:
                                current directory)
      --force                   Overwrite existing great-docs.yml without
                                prompting
      --help                    Show this message and exit.


# Options


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

`--force`  
Overwrite existing great-docs.yml without prompting


# Examples

``` bash
  great-docs config                     # Generate in current directory
  great-docs config --force             # Overwrite existing file
  great-docs config --project-path ../pkg
```