(Node.js) SFTP Simplified Download

Demonstrates how to SFTP download a file by passing a remote filepath to DownloadFileByName.

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 assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var sftp = new chilkat.SFtp();

    // Set some timeouts, in milliseconds:
    sftp.ConnectTimeoutMs = 15000;
    sftp.IdleTimeoutMs = 15000;

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    var hostname = "sftp.example.com";
    var port = 22;
    var success = sftp.Connect(hostname,port);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    success = sftp.AuthenticatePw("myLogin","myPassword");
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // After authenticating, the SFTP subsystem must be initialized:
    success = sftp.InitializeSftp();
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Download the file:
    var remoteFilePath;
    var localFilePath;
    localFilePath = "c:/temp/hamlet.xml";
    // Note: The remote filepath may be an absolute filepath,
    // a relative filepath, or simply a filename.  
    // Relative filepaths are always relative to the home directory
    // of the SFTP/SSH user account.  There is no such thing
    // as "current remote directory" in the SFTP protocol. 
    // A filename with no path implies that the file is located
    // in the SFTP user account's home directory.
    remoteFilePath = "subdir1/subdir2/hamlet.xml";
    success = sftp.DownloadFileByName(remoteFilePath,localFilePath);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    console.log("Success.");

}

chilkatExample();