mecano
Version:
Common functions for system deployment.
40 lines (27 loc) • 1.42 kB
Markdown
[](http://travis-ci.org/wdavidw/node-mecano)
# Node.js Mecano
Mecano gather a set of functions usually used during system deployment.
Documentation is available on the [project website][mecano].
Functions include "chmod", "chown", "copy", "download", "execute", "extract", "git", "ini", "krb5_ktadd", "krb5_addprinc", "krb5_delprinc", "ldap_acl", "ldap_index", "ldap_schema", "link", "mkdir", "move", "remove", "render", "service", "touch", "upload" and "write". They all share common usages and philosophies:
* Run seamlessly both locally and remotely over SSH.
* Each action report if it had an effect.
* Common behavior and API between actions: same
action signature with options followed by callback; similar
options properties; same callback signature with an
error followed the number of affected actions.
* Run one or multiple actions depending on option
argument being an object or an array of objects.
* Optmized for ease of use and checking over performance.
* Full test coverage.
## Installation
```bash
npm install mecano
```
## Test
For the tests to execute successfully, you must:
* be online (attempt to fetch an ftp file)
* be able to ssh yourself (eg `ssh $(whoami)@localhost`) without a password
```bash
npm test
```
[mecano]: http://www.adaltas.com/projects/node-mecano/