https://github.com/zodern/nodemiral

https://github.com/zodern/nodemiral

Last synced: 10 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/zodern/nodemiral
• Owner: zodern
• License: mit
• Created: 2019-06-26T06:05:09.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-08T18:19:04.000Z (over 1 year ago)
• Last Synced: 2024-10-19T15:15:46.847Z (over 1 year ago)
• Language: JavaScript
• Size: 130 KB
• Stars: 0
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# nodemiral (node + admiral) ![Build Status](https://img.shields.io/github/workflow/status/zodern/nodemiral/ci:test/master?style=flat-square)

### Server Automation for NodeJS over SSH

Fork of https://github.com/arunoda/nodemiral

Changes:

- Update ssh2 and other dependencies

- Fix testing on windows

## Install

~~~js

npm install @zodern/nodemiral

~~~

## Features

* Support connecting to any unix remote server

* Authenticate with password(using [`sshpass`](http://sourceforge.net/projects/sshpass/)) or with a `pem` file

* Can work with multiple servers at once

* Supports, `copy`, `execute` and `executeScript` at core methods

* Familiar NodeJS API

## Example

~~~js

var nodemiral = require('@zodern/nodemiral');

var session = nodemiral.session('hostname', {username: 'root', password: 'password'});

session.execute('uname -a', function(err, code, logs) {

  console.log(logs.stdout);

});

~~~

## API

### Session

Create a session to a remote server. You can invoke following methods after created a session

    @param hostname - hostname or ip addess

    @param auth - object containing following fields: `username` and (`password` or `pem`)

    @param options - object of options described below

    nodemiral.session(hostname, auth, options);

`options`:

* `ejs` - ejs options with `ejs` fields

* `ssh` - object whose key and value will be passed as `-o key:value` to any ssh session. For example `{ 'StrictHostKeyChecking': 'no', 'UserKnownHostsFile': '/dev/null' }`

### Session Methods

#### execute

execute given shell command on the remote server

    @param shellCommand - shellCommand

    @param options - {onStdout, onStderr}

    @param callback - callback containing following parameters

      err - err if exists

      code - status code of the ssh process

      logs - {stdout: 'stdout logs', stderr: 'stderr logs'}

    session.execute(shellCommand, callback);

#### executeScript

execute a local shell script in the remote server. You can template shell script with [EJS](https://github.com/visionmedia/ejs).

    @param localScriptFile - localScriptFile

    @param options.vars - variables to the template if uses ejs in the script

    @param callback - callback containing following parameters

      err - err if exists

      code - status code of the ssh process

      logs - {stdout: 'stdout logs', stderr: 'stderr logs'}

    session.executeScript(localScriptFile, options, callback);

#### copy

copy a file from local machine to the remote machine. Supports binary files too. Support EJS templating with non-binary files

    @param localFile - localFile

    @param remoteFileLocation - remoteFileLocation

    @param options.vars - templateVars

    @param optiosn.progressBar - show progress bar

    @param callback - callback containing following parameters

      err - err if exists

      code - status code of the ssh process

      logs - {stdout: 'stdout logs', stderr: 'stderr logs'}

    session.copy(localFile, remoteFileLocation, options, callback)