generator-commander

generator-commander

A CLI generator for Yeoman.

This generator will create a Commander.js based command line application using yo with options to include autocmdr components.

Installation

Install Yeoman if you haven't done so already.

$ npm install -g yo

To install generator-commander:

$ npm install -g generator-commander

Usage

At the command-line, cd into an empty directory, run this command and initiate the app generator:

$ yo commander

This will generate files in the current working directory for a Commander.js based application.

To create a commander.js command-component initiate the command generator:

$ yo commander:command <name>

This will create a new file in cmds/ directory of the current working directory. This file can be included in your application by adding

require('../cmds/<name>.js')(program);

to your application in the bin directory; or optionally install the autocmdr components for auto-loading cmds.

autocmdr and generator-commander

autocmdr and generator-commander are brothers. autcmdr is a command line tool for running commands (commands in a commander.js command-component) and a set of libraries for enhancing command line applications. generator-commander is a tool for scaffolding commander.js command-components and command line applications.

Calling autocmdr from a shell will load commands located in the current working directory's cmds/ folder. New commands can be added to any directory by invoking yo commander:command <name>. When running yo commander you are given the option of including autocmdr components in your application. See the autocmdr readme for a complete workflow and explanation of the available components.

What is Yeoman?

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 License

Copyright (c) 2013 J. Harshbarger