get command

get <file> [ [ <file2> ... ] <directory>\[ <newname> ] ]

Downloads one or more files from remote directory to local directory.

If only one parameter is specified, downloads the file to local working directory. If more parameters are specified, all except the last one specify set of files to download. Filename can be replaced with wildcard to select multiple files. To download all files in a directory, use mask *.

The last parameter specifies target local directory and optionally operation mask to store file(s) under different name. Target directory must end with backslash. To download more files to current working directory use .\ as the last parameter.

With the /stdout command-line switch, - can be used as a target to stream the contents of downloaded file(s) to the standard output of winscp.com. Streaming is supported with the SFTP and FTP protocols only.

When specific file name is used, command fails when the file does not exist. When wildcard is used, command succeeds, without doing anything, if the wildcard does not match any file, by default (you can change this using option failonnomatch on command).

You can have WinSCP generate a code template for get for you.

See also synchronize, if you need to transfer modified or non-existing files only.

Aliases: recv, mget

Switches:

Effective options: confirm, reconnecttime, failonnomatch

XML log elements: download, rm (with -delete)

get index.html

get -delete index.html about.html .\

get index.html about.html d:\www\

get public_html/index.html d:\www\about.*

get *.html *.png d:\www\*.bak

get -filemask=*.html -resumesupport=on *

When converting script to .NET Assembly, map get command to Session.GetFiles method.

Parameters mapping: Command parameter file maps to method parameter remotePath. When multiple source file parameters are used, you need to call Session.GetFiles multiple times. Command parameter directory\newname maps to method parameter localPath. You have to convert relative paths to absolute paths.

Switches mapping:

To emulate the (default) option batch abort mode, call TransferOperationResult.Check on method’s result. See also Capturing results of operations.

For example, following script snippet:

cd /home/martinp
lcd d:\
...
get -delete -filemask=*>1M -resumesupport=off *.txt *.xml web\

maps to following PowerShell code:

$transferOptions = New-Object WinSCP.TransferOptions
# -filemask=*>1M
$transferOptions.FileMask = "*>1M"
# -resumesupport=off
$transferOptions.ResumeSupport.State = [WinSCP.TransferResumeSupportState]::Off
# Absolute paths + $True for -delete + Two calls for two source parameters
# + calling Check on result to emulate the (default) "option batch abort" mode
$session.GetFiles("/home/martinp/*.txt", "d:\web\", $True, $transferOptions).Check()
$session.GetFiles("/home/martinp/*.xml", "d:\web\", $True, $transferOptions).Check()