Skip to content

Yeoman generator for node scripts meant to be used as global commands

License

Notifications You must be signed in to change notification settings

metajs/generator-yargs

 
 

Repository files navigation

generator-not-yargs Build Status

Yeoman generator

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-yargs from npm, run:

npm install -g generator-yargs

Finally, initiate the generator:

yo yargs

If you wish to use coffeescript:

yo yargs --coffee

To build your coffee files, run npm run build.

Usage

You can use npm link to create a global reference to your project, allowing you to call your script by the command you specified in the wizard.

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

License

MIT

About

Yeoman generator for node scripts meant to be used as global commands

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 95.3%
  • CoffeeScript 4.7%