'kickoff' is a Command-Line tool, which can be used to easily create boilerplate code for new projects and other things based on archetypes stored in GitHub repos or in local directories.
Run the install command:
npm install -g kickoff
Check if kickoff is properly installed:
$ kickoff -h Usage: kickoff [options] Options: -h, --help output usage information -V, --version output the version number -v, --verbose Verbose mode -a, --data-file <path> Path to the yaml format datafile -f, --folder <path> Path to the source directory -s, --src <username/repository> Git repository -d, --dest <dst> Destination folder
This is a normal repository, which can contain anything, including mustache templates. These files will be copied to the destination folder without modification. During this transfer, each file is processed by the mustache template engine, so you can place parameters into these files, which will be replaced by actual values, that you can define through the command line interface of the tool.
The enquiry for these parameters can be described in the
.kickoff.yml file, that you have to place into the root of the repository.
See ncli-archetype repository on GitHub, that is a Project archetype for Command Line tools using Node.js.
The following command will create a new command line tool project with all the required boilerplace code, using the ncli-archetype repository:
$ kickoff -s tombenke/ncli-archetype -d new_app ? The name of the application: new_app ? The full name of the author of the application: Tamás Benke ? The email address of the author: email@example.com ? The github account (username) of the author: tombenke
Check how the parameters requested through the console will substitute the mustache parameters in
This is a sample configuration file for the kickoff utility:
You can add as many parameters as you need, using the same names you put into the mustache templates.
To learn more about the tool visit the homepage.