apeman-dply/README.md

apeman-dply
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]

[bd_repo_url]: https://github.com/apeman-cmd-labo/apeman-dply
[bd_travis_url]: http://travis-ci.org/apeman-cmd-labo/apeman-dply
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-cmd-labo/apeman-dply.svg?style=flat
[bd_license_url]: https://github.com/apeman-cmd-labo/apeman-dply/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-cmd-labo/apeman-dply
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-cmd-labo/apeman-dply.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-cmd-labo/apeman-dply.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-cmd-labo/apeman-dply
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-cmd-labo/apeman-dply.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-dply
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-dply.svg?style=flat
[bd_bower_badge_url]: https://img.shields.io/bower/v/apeman-dply.svg?style=flat

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Deply manager for apeman

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>
Installation
-----

Install apeman-dply module via [npm][npm_url].
```bash
$ npm install apeman-dply -g
```


[npm_url]: https://www.npmjs.com/


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>
Usage
---------

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

***Apemanfile.js***
```javascript
/** Example of Apemanfile.js */

"use strict";

module.exports = {
    $cwd: __dirname,
    $pkg: {/*...*/},
    $proto: [/*...*/],
    $tmpls: {/*...*/},
    $tasks: {/*...*/},
    $apps: {/*...*/},
    $wtchs: {/*...*/},
    $infrs: {
        'my-node-01': './infra/node/Dockerfile' // Path infra docker path.
    },
    $dply: {
        'my-deploy-01': [
            require.resolve('./deploy/conf/node.conf.json')
        ]
    }
};
```

Then,

```bash
$ apeman-dply
```


##### CLI Options

```bash
$ apeman-dply -h

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

  Deploy project on docker.

  Options:

    -h, --help                           output usage information
    -V, --version                        output the version number
    -v, --verbose                        Show verbose logs
    -f, --force                          Force to remove container.
    -d, --delete                         Remove container.
    -c, --configuration <configuration>  Pathname of Apemanfile
    -l, --list                           List available watches
    -t, --tty                            Open terminal for dply
    -r, --rerun                          Delete and execute deploying again.
    -e, --exec <exec>                    Execute a command inside container.
    -p, --print                          Print container log.
    -P, --printon                        Print and follow container log.

  Examples:

    $ apeman-dply                     # Execute deploying defined in $dplys prop.
    $ apeman-dply -l     # List available deploy.
    $ apeman-dply -t node     # Open terminal for a deploy.
    $ apeman-dply "node*"     # Execute deploy which match pattern.
    $ apeman-dply -d     # Remove all deploy defined in $infra prop.


```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Programmatic API.md.hbs" Start -->

<a name="section-doc-guides-03-programmatic-a-p-i-md"></a>
Programmatic API
---

apeman-dply also provide programmatic API.

Firstly, install the module locally.

```bash
$ npm install apeman-dply --save-dev
```

Then,

```javascript
"use strict";

const apemanDply = require('apeman-dply');

apemanDply({

}, (err) =>{
    /*...*/
});
```


##### Programmatic Options

| Key | Description | Default |
| --- | ----------- | ------- |
| verbose | Show verbose logs |  |
| force | Force to remove container. |  |
| delete | Remove container. |  |
| configuration | Pathname of Apemanfile |  |
| list | List available watches |  |
| tty | Open terminal for dply |  |
| rerun | Delete and execute deploying again. |  |
| exec | Execute a command inside container. |  |
| print | Print container log. |  |
| printon | Print and follow container log. |  |


<!-- Section from "doc/guides/03.Programmatic API.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/apeman-cmd-labo/apeman-dply/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [apeman](http://github.com/apeman-labo/apeman)
+ [apeman-cmd-labo](http://github.com/apeman-cmd-labo)

<!-- Links End -->