Command Line Options¶

cookiecutter¶

Create a project from a Cookiecutter project template (TEMPLATE).

Cookiecutter is free and open source software, developed and managed by volunteers. If you would like to help out or fund the project, please get in touch at https://github.com/cookiecutter/cookiecutter.

cookiecutter [OPTIONS] [TEMPLATE] [EXTRA_CONTEXT]...

Options

-V, --version¶: Show the version and exit.

--context-file <context_file>¶: The input context file to parse - overrides default cookiecutter.json

--context-key <context_key>¶: The key to use in the output context - overrides default ‘cookiecutter’

--no-input¶: Do not prompt for parameters and only use cookiecutter.json file content

-c, --checkout <checkout>¶: branch, tag or commit to checkout after git clone

--directory <directory>¶: Directory within repo that holds cookiecutter.json file for advanced repositories with multi templates in it

-v, --verbose¶: Print debug information

--replay¶: Do not prompt for parameters and only use information entered previously

--replay-file <replay_file>¶: Use this file for replay instead of the default.

-f, --overwrite-if-exists¶: 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 <output_dir>¶: Where to output the generated project dir into

--config-file <config_file>¶: User configuration file

--default-config¶: Do not load a config file. Use the defaults instead

--debug-file <debug_file>¶: File to be used as a stream for DEBUG logging

--accept-hooks <accept_hooks>¶

Accept pre/post hooks

Options: yes|ask|no

-l, --list-installed¶: List currently installed templates.

Arguments

TEMPLATE¶: Optional argument

EXTRA_CONTEXT¶: Optional argument(s)