es128 / init-skeleton

A simple interface that clones or copies skeletons (base projects for your apps).

init-skeleton

A simple interface that clones or copies skeletons. skeleton is a base repo for your application (any technology).

init-skeleton currently just clones or copies the repository, executes npm install and removes .git directory. Useful for Brunch and Grunt base repos (skeletons).

grunt-init is similar, except it requires to clone projects to home directory before initialising from it.

Supported formats:

• File system
• Git URI
• GitHub URI (gh:user/project)

Install with npm: npm install -g init-skeleton.

Usage

init-skeleton <uri-or-path-to-skeleton> [--path <path-to-output-dir>]

Examples:

init-skeleton ../dir/my-skeleton
init-skeleton gh:paulmillr/brunch-with-chaplin
init-skeleton https://github.com/scotch/angular-brunch-seed
init-skeleton [e-mail]:nezoomie/brunch-with-eggs-and-bacon.git -p current-project
init-skeleton gh:visionmedia/cool-skeleton -p ../../stuff

You can use it programmatically too, from node.js:

var initSkeleton = require('init-skeleton');

initSkeleton('gh:paulirish/cool-skeleton', function(error) {
  console.log('Cloned!');
});

initSkeleton('gh:paulirish/cool-skeleton', 'output', function(error) {
  console.log('Done!');
});

License

The MIT License (MIT)

Copyright (c) 2013 Paul Miller (http://paulmillr.com/)

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.