node package manager
Easy sharing. Manage teams and permissions with one click. Create a free org »



Quickly create helpers for use with Assemble, using grunt-init. Includes README documentation, test files, metadata, bower.json and package.json.


If you have grunt-init and are familiar with using it:

git clone ~/.grunt-init/assemble

Then, in empty directory:

  • Run grunt-init assemble-helper
  • Then npm i
  • Then grunt to test that it works

In the the test directory you will find the following files:

  • example.hbs: this is an example template, which contains code for both an example helper and a starting point for your new custom helper.
  • example.json: this is the data file used by the helper
  • helper-example.js: umm...

Detailed instructions


If you haven't already done so, install Grunt and grunt-init:

npm i -g grunt-cli grunt-init

Once grunt-init is installed, place this template in your ~/.grunt-init/ directory. It's recommended that you use git clone to install this template into that directory as follows:

git clone ~/.grunt-init/assemble

(Windows users, see the documentation for the correct destination directory path)

To force grunt-init to use custom default values, move the defaults.json file to your ~/.grunt-init/ directory, and customize the values in that file.


Now that grunt init is intalled. At the command-line, cd into an empty directory and run grunt-init assemble and follow the prompts. You might want to test that it works before you begin customizing the project:

  • Next, run npm install to install the project's dependencies.
  • Then, run grunt to build the project.

Note that this template will generate files in the current directory, so be sure to change to a new directory first.

Related info