Using the Cookiecutter Extension

Cookiecutter provides a graphical user interface to discover templates, input template options, and create projects and files. It's included with Visual Studio 2017 and can be installed separately in earlier versions of Visual Studio.

Cookiecutter requires Python 3.3 or later (32- or 64-bit) or Anaconda 3 4.2 or later (32- or 64-bit). If a suitable Python interpreter isn't available, Visual Studio will display a warning. If you install a Python interpreter while Visual Studio is running, click the Home button on the Cookiecutter toolbar to detect the newly installed interpreter.

Once installed, select View > Cookicutter Explorer to open its window:

Cookiecutter main window

Cookiecutter workflow

Working with Cookiecutter is a process of browsing and selecting a template, cloning it to your local machine, setting options, then creating code from that template, as described in the following sections.

Browsing templates

The Cookiecutter home page displays a list of templates to choose from, organized into the following groups:

Group Description
Installed Templates that have been installed to your local machine. When an online template is used, its repository is automatically cloned to a subfolder of ~/.cookiecutters. You can delete a selected installed template by pressing Del.
Recommended Templates loaded from the recommended feed. The default feed is curated by Microsoft. See Cookiecutter options below for details on customizing the feed.
GitHub GitHub search results for the cookiecutter keyword. Results from GitHub come back paginated, if more results are available, Load More appears at the end of the list.
Custom When a custom location is entered in the search box, it appears in this group. You can either type in a full path to the GitHub repository, or the full path to a folder on your local disk.


When you select a template followed by Next, Cookiecutter makes a local copy to work from.

If you select a template from the Recommended or GitHub groups or enter a custom URL into the search box and select that template, it's cloned and installed on your local machine. If that template was installed in a previous session of Visual Studio, it's automatically deleted and the latest version is cloned.

If you select a template from the Installed group or enter a custom folder path into the search box and select that template, Visual Studio loads that template without cloning.


Cookiecutter templates are cloned under a single folder ~/.cookiecutters. Each subfolder is named after the git repository name, which does not include the GitHub user name. Conflicts can arise if you clone different templates with the same name that come from different authors. In this case, Cookiecutter prevents you from overwriting the existing template with a different template of the same name. To install the other template, you must first delete the existing one.

Setting template options

After the template is installed locally, Cookiecutter displays an options page where you can specify where you want Cookiecutter to generate files along with other options:

Cookiecutter options page

Each Cookiecutter template defines its own set of options, and specifies a default value for each one (displayed as the suggested text in each entry field). A default value may be a code snippet, often when it's a dynamic value that uses other options.

It's possible to customize default values for specific options with a user configuration file. When the Cookiecutter extension detects a user configuration file, it overwrites the template's default values with the user config's default values. This is discussed in the User Config section of the Cookiecutter documentation.

If the template specifies specific Visual Studio tasks to run after code generation, an additional Run additional tasks on completion option appears that allows you to opt out of those tasks. The most common use of tasks is to open a web browser, open files in the editor, install dependencies, and so on.


Once you've set your options, select Create to generate code. Note that if the output folder isn't empty, you'll see a warning. If you're familiar with the template's output and don't mind overwriting files, you can dismiss the warning. Otherwise, select Cancel, specify an empty folder, and then manually copy the created files to your non-empty output folder.

After the files are created successfully, Cookiecutter provides an option to open the files in Solution Explorer:

Cookiecutter showing Solution Explorer command

Cookiecutter options

Cookiecutter options are available through Tools > Options > Cookiecutter:

Cookiecutter options

Option Description
Recommended Feed URL The location of the recommended templates feed. It can be a URL or a path to a local file. Leave the URL empty to use the default Microsoft curated feed. The feed provides a simple list of template locations, separated by newlines. To request changes to the curated feed, make a pull request against the source on GitHub.
Show Help Controls the visibility of the help information bar at the top of the Cookiecutter window.

Optimizing Cookiecutter templates for Visual Studio

For the basics of authoring a Cookiecutter template, see the Cookiecutter documentation. Note that the Cookiecutter extension for Visual Studio supports templates created for Cookiecutter v1.4.

The default rendering of a template variables depends on the type of data (string or list):

  • String: Label for variable name, text box for entering value, and a watermark showing the default value. Tooltip on the text box shows the default value.
  • List: Label for variable name, combo box for selecting a value. Tooltip on the combo box shows the default value.

It's possible to improve on this by specifying additional metadata in your cookiecutter.json file that's specific to Visual Studio (and ignored by the Cookiecutter CLI). All properties are optional:

Property Description
Label Specifies what appears above the editor for the variable, instead of the name of the variable.
Description Specifies the tooltip that appears on the edit control will show that description, instead of the default value for that variable.
URL Changes the the label into a hyperlink, with a tooltip that shows the URL. Clicking on the hyperlink will open the user's default browser to that URL.
Selector Allows customization of the editor for a variable. The following selectors are currently supported:
  • string: Standard text box, default for strings.
  • list: Standard combo box, default for lists.
  • yesno: Combo box to choose between y and n, for strings.
  • odbcConnection: Text box with a "..." button that brings up a database connection dialog.


    "site_name": "web-app",
    "python_version": ["3.5.2", "2.7.12"],
    "use_azure": "y",

    "_visual_studio": {
        "site_name": {
            "label": "Site name",
            "description": "E.g. <site-name> (can only contain alphanumeric characters and `-`)"
        "python_version": {
            "label": "Python version",
            "description": "The version of Python to run the site on"
        "use_azure" : {
            "label": "Use Azure",
            "description": "Include Azure deployment files",
            "selector": "yesno",
            "url": ""

Running Visual Studio tasks

Cookiecutter has a feature called Post-Generate Hooks that allows for running arbitrary Python code after the files are generated. Although flexible, it doesn't allow easy access to Visual Studio.

For example, you may want to open a file in the Visual Studio editor, or in its web browser, or trigger the Visual Studio UI that prompts the user to create a virtual environment and install package requirements.

To allow these scenarios, Visual Studio looks for extended metadata in cookiecutter.json that describes the commands to run after the user opens the generated files in Solution Explorer or after the files are added to an existing project. (Again, the user can opt-out of running the tasks by clearing Run additional tasks on completion in the template options.)


"_visual_studio_post_cmds": [
        "name": "File.OpenFile",
        "args": "{{cookiecutter._output_folder_path}}\\readme.txt"
        "name": "Cookiecutter.ExternalWebBrowser",
        "args": ""
        "name": "Python.InstallProjectRequirements",
        "args": "{{cookiecutter._output_folder_path}}\\dev-requirements.txt"

Commands are specified by name, and should use the non-localized (English) name to work on localized installs of Visual Studio. You can test and discover command names in the Visual Studio Command Window.

If you want to pass a single argument, specify it as a string like in the previous example.

If you don't need to pass an argument, leave it an empty string or omit it from the JSON:

"_visual_studio_post_cmds": [
        "name": "View.WebBrowser"

Use an array for multiple arguments. For switches, split the switch and its value into separate arguments iensure proper quoting. For example:

"_visual_studio_post_cmds": [
        "name": "File.OpenFile",
        "args": [
            "{{cookiecutter._output_folder_path}}\\read me.txt",
            "Source Code (text) Editor"

Arguments can refer to other Cookiecutter variables. In the examples above, the internal _output_folder_path variable is used to form an absolute path to generated files.

Note that the Python.InstallProjectRequirements command works only when adding files to an existing project. That's because it is processed by the Python project in Solution Explorer, and there's no project to receive the message while in Solution Explorer - Folder View. This is a limitation we hope to address in a future release (better Folder View support in general).


Error loading template

Some templates may be using invalid data types, such as boolean, in their cookiecutter.json. This should be reported to the template author. Click on the Issues link in the template information pane.

Hook script failed

Some templates may use post-generation scripts that are not compatible with the Cookiecutter UI. For example, scripts that query the user for input will fail due to not having a terminal console.

Hook script not supported on Windows

If the post script is .sh, then it may not be associated with an application on your Windows machine. You may see a Windows dialog pop up asking you to find a compatible application in the Windows store.

Templates with known issues

Clone failures:

  • wildfish/cookiecutter-django-crud (invalid character | in subfolder name)
  • cookiecutter-pyvanguard (invalid character | in subfolder name)

Load failures:

  • chrisdev/wagtail-cookiecutter-foundation (uses a boolean type in cookiecutter.json)
  • quintoandar/cookiecutter-android (no template folder)

Run failures:

  • iknite/cookiecutter-ansible-role (post hook script requires console input)
  • benregn/cookiecutter-django-ansible (jinja error)

Uses bash (not fatal):

  • openstack-dev/cookiecutter