Lua

SFTP Download all Files in a Directory

See more SFTP Examples

Demonstrates how to download all files in a remote directory. This example uses the SyncTreeDownload method in a non-recursive mode that forces the download of all files, regardless of date/time or size differences. Lua

local chilkat = require("chilkat")

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

local sftp = chilkat.SFtp.new()

local success = sftp:connect("my-ssh-server.com", 22)
if success then
    success = sftp:authenticate_pw("mySshLogin", "mySshPassword")
end

if success then
    success = sftp:initialize_sftp()
end

if not success then
    print(sftp.last_error_text)
    return
end

-- Download all the files from the remote directory "syncDownloadTest/xml"
-- into our local directory "qa_output"
-- Both directories are relative paths.  The remote directory
-- is relative to the HOME directory of the SSH user account.
-- The local directory is relative to the current working directory of the process.
-- It is also possible to use absolute paths.

local remoteDir = "syncDownloadTest/xml"
local localDir = "qa_output"
-- Mode 0 causes SyncTreeDownload to download all files.
local mode = 0
-- Do not recursively descend the remote directory tree.  Just download all the files in specified directory.
local recursive = false
success = sftp:sync_tree_download(remoteDir, localDir, mode, recursive)
if not success then
    print(sftp.last_error_text)
    return
end

print("Success.")