Scripting and Task Automation

Enter the console/scripting mode by using winscp.com; or /console command-line parameter with winscp.exe. For details see console/scripting command-line parameters.

For automation, commands can be read from a script file specified by /script switch, passed from the command-line using the /command switch, or read from standard input of winscp.com.

The script file must use UTF-8 encoding and must start with UTF-8 BOM (The BOM is not required by the latest beta version anymore).

When running commands specified using /script or /command, batch mode is used implicitly and overwrite confirmations are turned off. In an interactive scripting mode, the user is prompted in the same way as in GUI mode. To force batch mode (all prompts are automatically answered negatively) use the command option batch abort. For batch mode it is recommended to turn off confirmations using option confirm off to allow overwrites (otherwise the overwrite confirmation prompt would be answered negatively, making overwrites impossible).

Multiple sessions can be opened simultaneously. Use the session command to switch between them.

Note that the first connection to an SSH server requires verification of the host key. Also the first connection to FTPS or WebDAVS host with certificate signed by untrusted authority requires verification of the certificate.

WinSCP executables return exit code 1 when any command is interrupted due to an error or any prompt is answered Abort (even automatically in batch mode). Otherwise it returns the exit code 0.

To further analyze results of scripted operations, you will find XML logging useful.

All WinSCP commands have syntax:

command -switch -switch2 parameter1 parameter2 ... parametern

Command parameters that include space(s) have to be surrounded by double-quotes. To use double-quote literally, double it:

put "file with spaces and ""quotes"".html"

Note that when you are specifying commands on command-line using /command, you need to surround each command by double-quote and escape the in-command double-quotes by doubling them.

To debug the quoting, enable session logging on level Debug 1 (/loglevel=1). The log will show how WinSCP understands both your command-line and individual scripting commands.

You can use environment variables in the commands, with syntax %NAME%1:

put "%FILE_TO_UPLOAD%"

Note that variable expansion is different than in Windows batch files:

• You cannot use any string processing syntax.
• You cannot use dynamic/pseudo environment variables, such as %DATE% or %RANDOM%.
• References to undefined variables are kept intact (not removed).
• You can use %WINSCP_PATH% to refer to WinSCP executable path.

WinSCP automatically resolves %TIMESTAMP% to a real time with format 20141024161712.2

You can customize the format using syntax %TIMESTAMP#format% where format may include yyyy for year, mm for month, dd for day, hh for hour, nn for minute and ss for second. For example %TIMESTAMP#yyyy-mm-dd% resolves to 2014-10-24.3 See other formats you can use.

To use %TIMESTAMP% on command-line in a batch file, you need to escape the % by doubling it to %%TIMESTAMP%%, to avoid batch file interpreter trying to resolve the variable.

You can reference script arguments (passed on command-line using parameter /parameter) using syntax %N%, where N is ordinal number of argument:1

put "%1%"

Note that WinSCP treats filenames in case sensitive manner. So even if your server treats filenames in case insensitive manner, make sure you specify case properly.4

To insert comments into the script file, start the line with # (hash):

# Connect to the server
open mysession

The following commands are implemented.

To see help for the command, read respective documentation article below or type command help <command> directly in console.

help call

The first connection to an SSH server requires verification of the host key. To automate the verification in script, use -hostkey switch of open command to accept the expected host key automatically.

You can find the key fingerprint on Server and Protocol Information Dialog. You can also copy the key fingerprint to clipboard from the confirmation prompt on the first (interactive) connection using Copy Key button. Learn more about obtaining host key fingerprint.

FTPS/WebDAVS TLS/SSL certificate signed by untrusted authority may also need to be verified. To automate the verification in script, use -certificate switch of open command to accept the expected certificate automatically.

If you are going to run the script under a different account (for example using the Windows scheduler), don’t forget that WinSCP still needs to access its configuration. Note that when using registry as configuration storage, the settings are accessible only for your Windows account, so in such a case you may need to either transfer the configuration from your account registry to the other account’s registry or use the INI file instead.

Note that the configuration also includes verified SSH host keys and FTPS/WebDAVS TLS/SSL certificates.

WinSCP in scripting/console mode shares configuration with graphical mode. This can be both advantageous and disadvantageous.

The advantage is that you can use graphical interface to configure options for which there are no script commands.

The disadvantage is that change to configuration in graphical mode may break your script (common example is enabling Existing files only option for synchronization).

If you want to protect your script from such inadvertent change, you should isolate its configuration from graphical mode explicitly.

The best way to do that is to configure all the options you need using script commands only (option command, switches of other commands, session URL), or if no such command is available, using raw site settings and raw configuration. Finally force scripting mode to start with the default configuration using /ini=nul command-line parameter.

Alternatively export your configuration to a separate INI file and reference it using /ini= command-line parameter. Also consider setting the INI file read-only, to prevent WinSCP writing to it, when exiting. Particularly, if you are running multiple scripts in parallel, to prevent different instances of WinSCP trying to write it at the same time.

You can have WinSCP generate a script template for you.

In the example below, WinSCP connects to example.com server with account user, downloads file and closes the session. Then it connects to the same server with the account user2 and uploads the file back.

# Connect
open sftp://user:password@example.com/ -hostkey="ssh-rsa 2048 xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx"
# Change remote directory
cd /home/user
# Force binary mode transfer
option transfer binary
# Download file to the local directory d:\
get examplefile.txt d:\
# Disconnect
close
# Connect as a different user
open sftp://user2:password@example.com/
# Change the remote directory
cd /home/user2
# Upload the file to current working directory
put d:\examplefile.txt 
# Disconnect
close
# Exit WinSCP
exit

Save the script to the file example.txt. To execute the script file use the following command.

winscp.com /script=example.txt

For simple scripts you can specify all the commands on command-line using /command switch:

winscp.com /command "open sftp://user:password@example.com/ -hostkey=""ssh-rsa 2048 xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx""" "get examplefile.txt d:\" "exit"

In Windows batch file, you can use ^ to split too long command-line to separate lines by escaping following new-line character:

winscp.com /command ^
    "open sftp://user:password@example.com/ -hostkey=""ssh-rsa 2048 xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx""" ^
    "get examplefile.txt d:\" ^
    "exit"

See other useful example scripts.

When you find yourself limited by scripting capabilities, you may consider converting your script to code that uses WinSCP .NET assembly.

• Guide to scripting;
• FAQs about scripting;
• Useful example scripts;
• WinSCP .NET assembly.