Script Commands

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

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

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 properly1.

With SFTP and SCP protocols, executes arbitrary remote shell command. With FTP protocol, executes a protocol command.

call <command>

If current session does not allow execution of arbitrary remote command separate shell session will be automatically opened.

The command must not require user input.

Alias: !

XML Log Element: call

Examples:

call mysqldump --opt -u USERNAME --password=PASSWORD --all-databases > all_databases.sql
call gzip -c all_databases.sql > all_databases.gz

Changes remote working directory for active session.

cd [ <directory> ]

If directory is not specified, changes to home directory.

Examples:

cd /home/martin
cd

Changes permissions of one or more remote files.

chmod <mode> <file> [ <file2> ... ]

mode can be specified as three or four-digit octal number.

Filename can be replaced with wildcard to select multiple files.

XML Log Element: chmod

Examples:

chmod 644 index.html about.html
chmod 1700 /home/martin/public_html
chmod 644 *.html

Closes session.

close [ <session> ]

Closes session specified by its number. When session is not specified, closes currently selected session.

Examples:

close 1
close

Closes all sessions and terminates the program.

exit

Alias: bye

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

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. The last parameter specifies target local directory and optionally operation mask to store file(s) under different name. Destination directory must end with backslash. Filename can be replaced with wildcard to select multiple files. To download more files to current working directory use .\ as the last parameter.

Use option command to set transfer options.

Alias: recv

Switches:

Effective options: transfer, confirm, exclude (not with -delete), include (not with -delete), reconnecttime

XML Log Elements: download, rm (with -delete)

Examples:

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

See also synchronize if you need to transfer modified files only.

Displays help for script commands.

help [ <command> [ <command2> ... ] ]

Displays list of commands when no parameters are specified. Displays help for each command when some are specified.

Alias: man

Examples:

help ls
help

Watches for changes in local directory and reflects them on remote one.

keepuptodate [ <local directory> [ <remote directory> ] ]

When directories are not specified, current working directories are synchronized. To stop watching for changes press Ctrl-C.

Note: Overwrite confirmations are always off for the command.

Switches:

Effective options: transfer, exclude, include, reconnecttime

XML Log Elements: upload, touch, chmod (with -permissions), rm (with -delete)

Examples:

keepuptodate -delete
keepuptodate d:\www /home/martin/public_html

Changes local working directory for all sessions.

lcd <directory>

Example:

lcd d:\

Lists the contents of local directory.

lls [ <directory> ]\[ <wildcard> ]

If directory is not specified, lists working directory. When wildcard is specified, it is treated as set of files to list. Otherwise, all files are listed.

Examples:

lls *.html
lls d:\
lls

Creates remote symlink.

ln <target> <symlink>

Alias: symlink

Example:

ln /home/martin/public_html www

Prints current local working directory (valid for all sessions).

lpwd

Lists the contents of specified directory.

ls [ <directory> ]/[ <wildcard> ]

Lists the contents of specified remote directory. If directory is not specified, lists working directory. When wildcard2 is specified, it is treated as set of files to list. Otherwise, all files are listed.

Alias: dir

XML Log Element: ls

Examples:

ls *.html
ls /home/martin
ls

Creates remote directory.

mkdir <directory>

XML Log Element: mkdir

Example:

mkdir public_html

Moves or renames one or more remote files.

mv <file> [ <file2> ... ] [ <directory>/ ][ <newname> ]

Destination directory or newname or both must be specified. Destination directory must end with slash. Operation mask can be used instead of new name. Filename can be replaced with wildcard to select multiple files.

Alias: rename

XML Log Element: mv

Examples:

mv index.html public_html/
mv index.html about.*
mv index.html public_html/about.*
mv public_html/index.html public_html/about.html /home/martin/*.bak
mv *.html /home/backup/*.bak

Establishes new connection.

open <stored session>
open [ sftp|ftp|scp:// ][ <user> [ :password ] @ ] <host> [ :<port> ]

Establishes connection to given host. Use name of the stored session (to open session, stored in folder, use path syntax “folder/session”). You can also specify host, username, port and protocol directly.

Switches:

XML Log Element: session

Examples:

open sftp://martin@example.com -hostkey="ssh-rsa 1024 xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx"
open scp://test@example.com:2222 -privatekey=mykey.ppk
open ftps://martin@example.com -implicit -certificate="xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx"
open martin@example.com
open example.com
open

Shows or sets value of script options.

option [ <option> [ <value> ] ]

If no parameters are specified, lists all script options and their values. When one parameter is specified only, shows value of the option. When two parameters are specified sets value of the option. Initial values of some options are taken from application configuration, however modifing the options does not change the application configuration.

Options are:

Aliases: ascii (for option transfer ascii), binary (for option transfer binary)

Examples:

option transfer
option confirm off
option include "*.html; */"
option exclude "*.tpl.php"
option exclude "*.mp3; *.mp4; *.lnk; *.exe; *.msi; My Pictures; My Music; My Videos;"
option

Note that resetting the same option overwrites previous values, it does not append.

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

put <file> [ [ <file2> ... ] <directory>/[ <newname> ] ]

If only one parameter is specified uploads the file to remote working directory. If more parameters are specified, all except the last one specify set of files to upload. The last parameter specifies target remote directory and optionally operation mask to store file(s) under different name. Destination directory must end with slash. Filename can be replaced with Windows wildcard2 to select multiple files. To upload more files to current working directory use ./ as the last parameter.

Use option command to set transfer options.

Switches:

Alias: send

Effective options: transfer, confirm, exclude (not with -delete), include (not with -delete), reconnecttime

XML Log Elements: upload, chmod (with -permissions), touch (with -preservetime)

Examples:

put index.html
put -delete index.html about.html ./
put -permissions=644 index.html about.html /home/martin/public_html/
put d:\www\index.html about.*
put *.html *.png /home/martin/backup/*.bak

See also synchronize if you need to transfer modified files only.

Prints current remote working directory for active session.

pwd

Removes one or more remote files.

rm <file> [ <file2> ... ]

If remote recycle bin is configured, moves file to the bin instead of deleting it. Filename can be replaced with wildcard to select multiple files.

XML Log Element: rm

Examples:

rm index.html
rm index.html about.html
rm *.html

Removes one or more remote directories.

rmdir <directory> [ <directory2> ... ]

If remote recycle bin is configured, moves directory to the bin instead of deleting it.

XML Log Element: rm

Example:

rmdir public_html

Manages opened sessions.

session [ <session> ]

Makes session specified by its number active. When session number is not specified, lists connected sessions.

Examples:

session 1
session

Synchronizes directories.

synchronize local|remote|both [ <local directory> [ <remote directory> ] ]

When the first parameter is local, changes from remote directory are applied to local directory. When the first parameter is remote, changes from the local directory are applied to the remote directory. When the first parameter is both, both local and remote directories can be modified.

When directories are not specified, current working directories are synchronized.

Note: Overwrite confirmations are always off for the command.

Switches:

Effective options: transfer, exclude, include, reconnecttime

XML Log Elements: download (with local or both), upload (with remote or both), touch (with remote or both), chmod (with remote or both and -permissions), rm (with remote and -delete)

Examples:

synchronize remote -delete
synchronize both d:\www /home/martin/public_html