apeman-show

4.1.5 • Public • Published

apeman-show

Build Status Code Climate Code Coverage npm Version

show command module for apeman.

Overview

apeman-show shows data about Apemanfile configuration.

Installation

Install apeman-show module via npm.

$ npm install apeman-show -g

Usage

Runs apeman apeman-show command at your project root.

# Show build task defined in Apemanfile.js 
$ apeman-show tasks build
 

Some properties in Apemanfile begins with $ ("$tasks", "$cwd"... ). But you can jus skip typing $, which is bash meta charactor and needs to be escaped. task will resollved to $task automatically.

CLI Options
$ apeman-show -h
 
  Usage: apeman-show [options] [keypath...] 
 
  Show apemanfile configuration.
 
  Options:
 
    -h, --help                           output usage information
    -V, --version                        output the version number
    -c, --configuration <configuration>  Pathname of Apemanfile
    -k, --keysonly                       Show keys only
 
 

Programmatic API

apeman-show also provide programmatic API.

Firstly, install the module locally.

$ npm install apeman-show --save-dev

Then,

'use strict'
 
const apemanShow = require('apeman-show')
 
apemanShow("tmpl", "ci/*", {
    keysonly: true
}).then(() => {
    /* ... */
})
Programmatic Options
Key Description Default
configuration Pathname of Apemanfile
keysonly Show keys only

License

This software is released under the MIT License.

Links

Dependencies (11)

Dev Dependencies (9)

Package Sidebar

Install

npm i apeman-show

Weekly Downloads

49

Version

4.1.5

License

MIT

Last publish

Collaborators

  • okunishinishi