apeman-bud v4.0.1

apeman-bud

Bud file renderer.

Installation

Install apeman-bud module via npm.

$ npm install apeman-bud -g

Usage

1. Prepare an Apemanfile.js at your project root.
2. Run the command via CLI.

Apemanfile.js

/** Example of Apemanfile.js */

'use strict'

module.exports = {
  $cwd: __dirname,
  $pkg: { /* ... */ },
  $proto: [ /* ... */ ],
  $tmpls: { /* ... */ },
  $tasks: { /* ... */ },
  $apps: { /* ... */ },
  $wtchs: { /* ... */ },
  $infra: { /* ... */ }
}

Then,

$ apeman-bud

CLI Options

$ apeman-bud -h

  Usage: apeman-bud [options] [name...] 

  Render bud files in the project.

  Options:

    -h, --help                           output usage information
    -V, --version                        output the version number
    -i, --ignore                         File patterns to ignore
    -f, --force                          Force to render template even if already exists
    -c, --configuration <configuration>  Pathname of Apemanfile

  Examples:

  $ apeman-bud                   # Render bud files in the current project.
  $ apeman-tmpl "ci/.*.bud"       # Render specific bud files.

Programmatic API

apeman-bud also provide programmatic API.

Firstly, install the module locally.

$ npm install apeman-bud --save-dev

Then,

'use strict'

const apemanBud = require('apeman-bud')

apemanBud({}, (err) => {
  /* ... */
})

Programmatic Options

License

This software is released under the MIT License.

Links

• apeman
• apeman-cmd-labo
• coz