(Node.js) SSH Execute Remote Commands

See more SSH Examples

Shows how to execute a command on an SSH server and retrieve the command output.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var ssh = new chilkat.Ssh();

    var port = 22;
    var success = ssh.Connect("the-ssh-server.com",port);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    // Authenticate using login/password:
    success = ssh.AuthenticatePw("theSshLogin","theSshPassword");
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    // Send some commands and get the output.
    var strOutput = ssh.QuickCommand("df","ansi");
    if (ssh.LastMethodSuccess !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    console.log("---- df ----");
    console.log(strOutput);

    strOutput = ssh.QuickCommand("echo hello world","ansi");
    if (ssh.LastMethodSuccess !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    console.log("---- echo hello world ----");
    console.log(strOutput);

    strOutput = ssh.QuickCommand("date","ansi");
    if (ssh.LastMethodSuccess !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    console.log("---- date ----");
    console.log(strOutput);

    // --------------
    // Sample output:

    // 	---- df ----
    // 	Filesystem    512-blocks      Used  Available Capacity  iused     ifree %iused  Mounted on
    // 	/dev/disk2    2176716032 265736304 1910467728    13% 33281036 238808466   12%   /
    // 	devfs                382       382          0   100%      662         0  100%   /dev
    // 	map -hosts             0         0          0   100%        0         0  100%   /net
    // 	map auto_home          0         0          0   100%        0         0  100%   /home
    // 	/dev/disk3s2      374668    374668          0   100%    93665         0  100%   /Volumes/Google Chrome
    // 
    // 	---- echo hello world ----
    // 	hello world
    // 
    // 	---- date ----
    // 	Thu Dec 22 17:19:32 CST 2016

}

chilkatExample();