⚠️⚠️⚠️ This repo has been archived. Gruntjs is outdated. ⚠️⚠️⚠️

grunt-install

Simple Bash script for Grunt template installation

installation:

This method clones the Github repository and runs the install.sh script in the newly-created directory. The last command may require sudo.

⇒ git clone https://github.com/GochoMugo/grunt-install.git
⇒ cd grunt-install
⇒ ./install.sh

usage:

grunt-install allows you to install Grunt templates from both Github and NPM online registry with much ease.

To install a template from Github, such as this one, simply run:

⇒ grunt-install forfuture-dev/grunt-template-esta MyTemplate

This uses a Github shorthand which will be expanded to match the Github Repository URL. You also provide a name, in this case MyTemplate, that will be given to the template.

You may also install templates from NPM online registry, by simply running:

⇒ grunt-install grunt-template-esta MyTemplate

Once templates are installed, you may now use grunt-init to initiate a Grunt project.

⇒ grunt-init MyTemplate

tips:

Lets say we version bump and you want to upgrade to the latest version grunt-install, it is simple (you may require sudo):

⇒ grunt-install --upgrade

In the spirit of keeping up to date, you want to update your templates:

⇒ grunt-install --update

If you ever want to replace a template with another while installing, you could simply use the --force option. Example:

⇒ grunt-install --force forfuture-dev/grunt-template-esta esta

Setting the environment variable GRUNT_INSTALL_NO_COLOR will disable colored output. If you just don't want to see any output at all, you could simply use the --silent option.

help information:

⇒ grunt-install --help
grunt-install 0.0.1

Usage: grunt-install [install_options] <URI> <template_name>

Where <URI> can be:
    UserName/RepoName    github shorthand
    PackageName          npm package name

Install Options:
    -f,  --force         Force installation
    -s,  --silent        Be Silent

More Options:
    -h,  --help          Show this help information
    -u,  --update        Update installed templates
    -up, --upgrade       Upgrade grunt-install
    -v,  --version       Show version information

Examples:
    grunt-install forfuture-dev/grunt-template-esta MyTemplate
    grunt-install grunt-template-esta AwesomeNess

available templates:

Here is a list of grunt templates you may be interested in. You can install them using the label shown.

• forfuture-dev/grunt-template-esta (⇒ grunt-install forfuture-dev/grunt-template-esta MyPreferredName will just do)
• mathiasbynens/grunt-template
• leemunroe/grunt-email-design
• dwightjack/grunt-email-boilerplate
• fooplugins/grunt-wp-boilerplate
• eunjae-lee/node-express-grunt-boilerplate
• ghost-town/grunt-init-assemble

contribution:

Hands-on the develop branch. Don't touch master, only stable release branches are merged into it.

Tests are run using bats. Please accompany PR's with relevant tests. Issues are tracked from here.

license:

The MIT License (MIT)

Copyright (c) 2014 Gocho Mugo mugo@forfuture.co.ke

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.