https://github.com/rumpl/cli-app

Simple command line application helper
https://github.com/rumpl/cli-app

Last synced: 15 days ago
JSON representation

Simple command line application helper

• Host: GitHub
• URL: https://github.com/rumpl/cli-app
• Owner: rumpl
• Created: 2013-03-18T12:41:20.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2013-03-23T09:25:22.000Z (almost 12 years ago)
• Last Synced: 2024-12-25T09:35:21.452Z (about 2 months ago)
• Language: JavaScript
• Size: 99.6 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# cli-app

Simple command line application helper. Helps you define actions for specific commands.

# Installation

```bash

npm install cli-app

```

# Usage

```javascript

var app = require('cli-app');

app.name = 'awesome';

app.command('command', 'Put some description', function() {

  console.log('YAY!');

});

app.command('commandWithParams', 'Some other description', function(param1, param2) {

  console.log('YAY too!');

  console.log('Got params: ', param1, param2);

});

app.run();

```

When run:

```

$ node app.js command

```

You will see `YAY!`

Or:

```

$ node app.js commandWithParams Hello World

Got params: Hello World

```

**Bonus: free usage!**

```

$ node app.js wat

Undefined command: wat

Usage: awesome [COMMANDS] [OPTIONS]

command                      Put some description

command2 [param1, param2]    Some other description

```

# License

[MIT](http://mit-license.org/rumpl)