README
apeman-demo-cmd
Demo of command project.
Installation
Install apeman-demo-cmd module via npm.
$ npm install apeman-demo-cmd -g
Usage
- Prepare an Apemanfile.js at your project root.
- Run the command via CLI.
Apemanfile.js
/** Example of Apemanfile.js */
'use strict'
module.exports = {
$cwd: __dirname,
$pkg: { /* ... */ },
$proto: [ /* ... */ ]
}
Then,
$ apeman-demo-cmd
CLI Options
$ apeman-demo-cmd -h
Usage: apeman-demo-cmd [options]
Demo of command project.
Options:
-h, --help output usage information
-V, --version output the version number
-v, --verbose Show verbose logs
-c, --configuration <configuration> Pathname of Apemanfile
Examples:
$ apeman-demo-cmd # __description_of_command_usage__
Programmatic API
apeman-demo-cmd also provide programmatic API.
Firstly, install the module locally.
$ npm install apeman-demo-cmd --save-dev
Then,
#!/usr/bin/env
'use strict'
const apemanDemoCmd = require('apeman-demo-cmd')
const co = require('co')
co(function * () {
yield apemanDemoCmd({})
}).catch((err) => console.error(err))
Programmatic Options
Key | Description | Default |
---|---|---|
verbose | Show verbose logs | |
configuration | Pathname of Apemanfile |
License
This software is released under the MIT License.