Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/martinheidegger/commandico

Command line tool - nothing special but good to organise things.
https://github.com/martinheidegger/commandico

cli nodejs util

Last synced: about 4 hours ago
JSON representation

Command line tool - nothing special but good to organise things.

Awesome Lists containing this project

README

        

# Commandico

[![Build Status](https://travis-ci.org/martinheidegger/commandico.svg?branch=master)](https://travis-ci.org/martinheidegger/commandico)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

A tiny - nodejs - command line tool that allows to cleanly create a command-line client.

# Usage

add `commandico` to your package.json:

```
npm i commandico --save
```

then instantiate commadico:

```JavaScript
var commandico = require('commandico')
, defaultCommand = 'help'
, scope = {
number: 2
};

var app = commandico(scope, defaultCommand)
```

then give it some commands

```JavaScript
app.addCommands([{
aliases: ['help'],
handler: function (scope) {
console.log(scope.number);
}
}])
```

And further execute the script with some arguments

```JavaScript
app.execute(['hello world'])
```