initialize

Create a new repo with sane defaults. Provides all the tools needed to create a unix style module.

Installation

$ npm install -g initialize

Usage

initialize - generate a fresh package

Usage: initialize [options]

Options:
  -h, --help        Output usage information
  -v, --version     Output version number
  -u, --user        Override user with organization
  -d, --directory   Specify output directory

Examples:
  $ initialize            # generate package in `./`
  $ initialize -d ./dir   # generate package in `./dir`
  $ initialize -u npm     # generate package for `npm`

Docs: https://github.com/yoshuawuyts/initialize
Bugs: https://github.com/yoshuawuyts/initialize/issues

.npmrc

Requires npm to be configured:

# required
npm config set init.author.name "Your Name"
npm config set init.author.email "[email protected]"
npm config set init.author.github "your-github-handle"

# optional, defaults to your github
npm config set init.author.url "http://your-site.com/"

Variables

The following variables are used in the templates:

name          Name of the package
varName       Name of package usable as JS var
description   Description of the package
tags          Package tags
user          Logged in user (github)
realName      User's real name
date.year     Current year
date.month    Current month
date.day      Current day
date.date     Current date

See Also

• initialize-cli
• initialize-project
• initialize-subpackage

License

MIT