1 | apeman-demo-cmd
|
2 | ==========
|
3 |
|
4 |
|
5 | This file is generated by ape-tmpl. Do not update manually.
|
6 | --->
|
7 |
|
8 |
|
9 | <a name="badges"></a>
|
10 |
|
11 | [![Build Status][bd_travis_shield_url]][bd_travis_url]
|
12 | [![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
|
13 | [![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
|
14 | [![npm Version][bd_npm_shield_url]][bd_npm_url]
|
15 | [![JS Standard][bd_standard_shield_url]][bd_standard_url]
|
16 |
|
17 | [bd_repo_url]: https://github.com/apeman-demo-labo/apeman-demo-cmd
|
18 | [bd_travis_url]: http://travis-ci.org/apeman-demo-labo/apeman-demo-cmd
|
19 | [bd_travis_shield_url]: http://img.shields.io/travis/apeman-demo-labo/apeman-demo-cmd.svg?style=flat
|
20 | [bd_license_url]: https://github.com/apeman-demo-labo/apeman-demo-cmd/blob/master/LICENSE
|
21 | [bd_codeclimate_url]: http://codeclimate.com/github/apeman-demo-labo/apeman-demo-cmd
|
22 | [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-demo-labo/apeman-demo-cmd.svg?style=flat
|
23 | [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-demo-labo/apeman-demo-cmd.svg?style=flat
|
24 | [bd_gemnasium_url]: https://gemnasium.com/apeman-demo-labo/apeman-demo-cmd
|
25 | [bd_gemnasium_shield_url]: https://gemnasium.com/apeman-demo-labo/apeman-demo-cmd.svg
|
26 | [bd_npm_url]: http://www.npmjs.org/package/apeman-demo-cmd
|
27 | [bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-demo-cmd.svg?style=flat
|
28 | [bd_standard_url]: http://standardjs.com/
|
29 | [bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
|
30 |
|
31 |
|
32 |
|
33 |
|
34 |
|
35 | <a name="description"></a>
|
36 |
|
37 | Demo of command project.
|
38 |
|
39 |
|
40 |
|
41 |
|
42 |
|
43 | <a name="overview"></a>
|
44 |
|
45 |
|
46 |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 | <a name="sections"></a>
|
52 |
|
53 |
|
54 |
|
55 | <a name="section-doc-guides-01-installation-md"></a>
|
56 | Installation
|
57 | -----
|
58 |
|
59 | Install apeman-demo-cmd module via [npm][npm_url].
|
60 | ```bash
|
61 | $ npm install apeman-demo-cmd -g
|
62 | ```
|
63 |
|
64 |
|
65 | [npm_url]: https://www.npmjs.com/
|
66 |
|
67 |
|
68 |
|
69 |
|
70 |
|
71 |
|
72 | <a name="section-doc-guides-02-usage-md"></a>
|
73 | Usage
|
74 | ---------
|
75 |
|
76 | 1. Prepare an Apemanfile.js at your project root.
|
77 | 2. Run the command via CLI.
|
78 |
|
79 | ***Apemanfile.js***
|
80 | ```javascript
|
81 | /** Example of Apemanfile.js */
|
82 |
|
83 | 'use strict'
|
84 |
|
85 | module.exports = {
|
86 | $cwd: __dirname,
|
87 | $pkg: { /* ... */ },
|
88 | $proto: [ /* ... */ ],
|
89 | $tmpls: { /* ... */ },
|
90 | $tasks: { /* ... */ },
|
91 | $apps: { /* ... */ },
|
92 | $wtchs: { /* ... */ },
|
93 | $infra: { /* ... */ }
|
94 | }
|
95 | ```
|
96 |
|
97 | Then,
|
98 |
|
99 | ```bash
|
100 | $ apeman-demo-cmd
|
101 | ```
|
102 |
|
103 |
|
104 | ##### CLI Options
|
105 |
|
106 | ```bash
|
107 | $ apeman-demo-cmd -h
|
108 |
|
109 | Usage: apeman-demo-cmd [options]
|
110 |
|
111 | Demo of command project.
|
112 |
|
113 | Options:
|
114 |
|
115 | -h, --help output usage information
|
116 | -V, --version output the version number
|
117 | -v, --verbose Show verbose logs
|
118 | -c, --configuration <configuration> Pathname of Apemanfile
|
119 |
|
120 | Examples:
|
121 |
|
122 | $ apeman-demo-cmd # __description_of_command_usage__
|
123 |
|
124 |
|
125 | ```
|
126 |
|
127 |
|
128 |
|
129 |
|
130 |
|
131 |
|
132 | <a name="section-doc-guides-03-programmatic-a-p-i-md"></a>
|
133 | Programmatic API
|
134 | ---
|
135 |
|
136 | apeman-demo-cmd also provide programmatic API.
|
137 |
|
138 | Firstly, install the module locally.
|
139 |
|
140 | ```bash
|
141 | $ npm install apeman-demo-cmd --save-dev
|
142 | ```
|
143 |
|
144 | Then,
|
145 |
|
146 | ```javascript
|
147 | 'use strict'
|
148 |
|
149 | const apemanDemoCmd = require('apeman-demo-cmd')
|
150 |
|
151 | apemanDemoCmd({}).then(() => {
|
152 | /* ... */
|
153 | })
|
154 |
|
155 | ```
|
156 |
|
157 |
|
158 | ##### Programmatic Options
|
159 |
|
160 | | Key | Description | Default |
|
161 | | --- | ----------- | ------- |
|
162 | | verbose | Show verbose logs | |
|
163 | | configuration | Pathname of Apemanfile | |
|
164 |
|
165 |
|
166 |
|
167 |
|
168 |
|
169 |
|
170 |
|
171 |
|
172 |
|
173 | <a name="license"></a>
|
174 |
|
175 | License
|
176 | -------
|
177 | This software is released under the [MIT License](https://github.com/apeman-demo-labo/apeman-demo-cmd/blob/master/LICENSE).
|
178 |
|
179 |
|
180 |
|
181 |
|
182 |
|
183 | <a name="links"></a>
|
184 |
|
185 | Links
|
186 | ------
|
187 |
|
188 | + [apeman](http://github.com/apeman-labo/apeman)
|
189 | + [apeman-cmd-labo](http://github.com/apeman-cmd-labo)
|
190 |
|
191 |
|