Converting PuTTY PSFTP or OpenSSH SFTP script to WinSCP script

In your command that runs psftp.exe, substitute the psftp.exe with winscp.com.

The following table shows how to convert some psftp.exe parameters:

For example the following PSFTP command-line:

psftp.exe martin@example.com -pw password -hostkey aa:bb:cc:... -b script.txt 

converts to:

winscp.com /script=script.txt

with the script.txt containing open command at its beginning:

open sftp://martin:password@example.com/ -hostkey="ssh-rsa 2048 aa:bb:cc:..."

(assuming 2048-bit RSA host key)

WinSCP in a scripting/console mode shares a configuration with a graphical mode by default. Particularly when implementing the script from scratch, it is recommended to isolate the script from the graphical mode configuration to avoid the script breaking, when the GUI configuration changes.

For that, add an /ini=nul command-line parameter:

winscp.com /script=script.txt /ini=nul

If your psftp.exe command-line does not use -hostkey switch, it means that you rely on PuTTY/PSFTP host key cache in Windows registry. That makes your script non-portable.

With WinSCP it’s recommended to always verify the host key explicitly using -hostkey switch of an open command.

Many PSFTP commands work in WinSCP without any change.

The differences are described below.

Use a cd command with the same argument.

Use a chmod command with the same arguments.

WinSCP supports octal permissions format only.

Use a close command.

Use a rm command with the same arguments.

Use a ls command with the same argument.

Note that WinSCP also supports a dir alias.

Use a get command with the same arguments.

WinSCP downloads directories recursively by default. So remove a -r switch, if used.

When downloading file(s) to a specific directory, make sure you terminate a target path with a backslash:

get *.txt c:\path\

Use a lcd command with the same argument.

Use a lpwd command.

Use a get command.

The WinSCP command get can accept multiple files as its arguments, but the last argument needs to be a target path. Use .\ to download to the current local working directory (equivalent to the mget).

Example:

mget *.html *.txt

converts to:

get *.html *.txt .\

Note that WinSCP also supports a mget as an alias to the get command.

Use a mkdir command with the same argument.

Use a put command.

The WinSCP command put can accept multiple files as its arguments, but the last argument needs to be a target path. Use ./ to upload to the current remote working directory (equivalent to the mput).

Example:

mput *.html *.txt

converts to:

put *.html *.txt ./

Note that WinSCP also supports a mput as an alias to the put command.

Use a mv command with the same arguments.

When moving file(s) to a different directory, make sure you terminate the target path with a slash:

mv *.txt /path/

PSFTP aliases to the mv command, a rename and a ren, convert the same way.

Use an open command.

For example the full PSFTP open command:

open user@host 22

converts to:

open sftp://user@host:22/

Use put command with the same arguments.

WinSCP uploads directories recursively by default. So remove a -r switch, if used.

When uploading file(s) to a specific directory, make sure you terminate the target path with a slash:

put *.txt /path/

Use a pwd command.

Use an exit command.

Note that WinSCP also supports bye alias, just as PSFTP.

WinSCP resumes SFTP transfers automatically. To explicitly resume transfer (for example with an FTP protocol), use get -resume.

WinSCP resumes SFTP transfers automatically. To explicitly resume transfer (for example with an FTP protocol), use put -resume.

Use a rmdir command with the same arguments.

WinSCP does not support exiting to a local shell. You need to exit WinSCP script; execute your local commands from a wrapping batch file; and start a new WinSCP script afterwards.

For more advanced tasks, consider using WinSCP .NET assembly from PowerShell script.

A command psftp.exe -b script.txt with script.txt:

open user@example.com
cd /home/user
mget *.zip
close
quit

converts to a command winscp.com /script=script.txt /ini=nul with script.txt:

open sftp://user@example.com/
cd /home/user
get *.zip
close
exit