Skip to content

CLI Reference

This page provides documentation for our command line tools.

main

Create a Project from the project template.

Cookiecutter Python Package is Free/Libre Open Source Software. If you would like to get in touch, please see https://github.com/boromir674/cookiecutter-python-package.

Usage:

main [OPTIONS]

Options:

  -V, --version              Show the version and exit.
  --no-input                 Do not prompt for parameters and only use
                             cookiecutter.json file content
  --offline                  Disable Async Http Project Existence Check, on
                             PyPI and RTD servers
  -c, --checkout TEXT        branch, tag or commit to checkout after git clone
  --directory TEXT           Directory within repo that holds
                             cookiecutter.json file for advanced repositories
                             with multi templates in it
  --replay                   Do not prompt for parameters and only use
                             information entered previously
  -f, --overwrite            Overwrite the contents of the output directory if
                             it already exists
  -s, --skip-if-file-exists  Skip the files in the corresponding directories
                             if they already exist
  -o, --output-dir PATH      Where to output the generated project dir into
  --config-file PATH         User configuration file
  --default-config           Do not load a config file. Use the defaults
                             instead
  --help                     Show this message and exit.