(Node.js) SCP Download Files Matching a Pattern, such as *.txt

Demonstrates how to SCP download files matching a pattern, such as *.txt.

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();

    // Connect to an SSH server:
    var hostname = "MY-SSH-SERVER-DOMAIN-OR-IP";
    var port = 22;

    var success = ssh.Connect(hostname,port);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    // Wait a max of 5 seconds when reading responses..
    ssh.IdleTimeoutMs = 5000;

    // Authenticate using login/password:
    success = ssh.AuthenticatePw("MY-SSH-LOGIN","MY-SSH-PASSWORD");
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    // Once the SSH object is connected and authenticated, use it
    // in the SCP object.
    var scp = new chilkat.Scp();

    success = scp.UseSsh(ssh);
    if (success !== true) {
        console.log(scp.LastErrorText);
        return;
    }

    scp.HeartbeatMs = 200;

    // Set the SyncMustMatch property to "*.pem" to download only .pem files
    scp.SyncMustMatch = "*.pem";

    var remoteDir = "qa_syncA";
    var localDir = "c:/aaworkarea/scp/qa_syncA";

    // Download synchronization modes:
    // mode=0: Download all files
    // mode=1: Download all files that do not exist on the local filesystem.
    // mode=2: Download newer or non-existant files.
    // mode=3: Download only newer files.  
    //         If a file does not already exist on the local filesystem, it is not downloaded from the server.
    // mode=5: Download only missing files or files with size differences.
    // mode=6: Same as mode 5, but also download newer files.
    var mode = 0;

    // Do not recurse the remote directory tree.  Only download files matching *.pem
    // from the given remote directory.
    var bRecurse = false;

    success = scp.SyncTreeDownload(remoteDir,localDir,mode,bRecurse);
    if (success !== true) {
        console.log(scp.LastErrorText);
        return;
    }

    console.log("SCP download matching success.");

    // Disconnect
    ssh.Disconnect();

}

chilkatExample();