ssh2-executor - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "ssh2-executor",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Execute one or more commands on the target machine by ssh2 and reduce results.",
@@ -24,3 +24,6 @@ "main": "ssh2exe.js",
     "ssh2": "^0.5.0"
+  },
+  "devDependencies": {
+    "optimist": "^0.6.1"
   }
 }

README.md

@@ -11,1 +11,36 @@ # ssh2-executor
 ### Usage
+```
+const Executor = require('ssh2-executor');
+Executor.run({object} argv, {Array} commands, {function} reduce);
+```
+* `argv` {object} SSH2 connection options:
+    * `host` {string} Default: localhost
+    * `port` {number} Default: 22
+    * `username` {string} Default: administrator
+    * `password` {string} Default: null
+* `commands` {Array} Commands to execute
+* `reduce` {function} Reduce function takes next parameters:
+    * `resutls` {Array} Result outputs according to commands
+    * `timing` {object} total beg, end ms
+
+### Example
+Execute `whoami` and `hostname` commands on the target machine, compare with the expected values and out boolean answer:
+```javascript
+'use strict';
+const argv = require('optimist').argv;
+const Executor = require('ssh2-executor');
+
+Executor.run(argv, [
+    'whoami',
+    'hostname'
+
+], (results, t) => {
+    console.log(/^administrator\s?/.test(results[0]) && /^SuperMachine\s?/.test(results[1]));
+    console.log(`Execution Time ${t.end - t.beg} ms`);
+});
+```
+Output:
+```
+true
+Execution Time 923 ms
+```

No alert changes

Improved metrics

Total package byte prevSize

5573

34.16%

Number of package files

6

20%

Lines of code

55

19.57%

Number of lines in readme file

46

318.18%

Worsened metrics

Dev dependency count

1

Infinity%

No dependency changes