commandline » Revisions »
Differences
This shows you the differences between the selected revisions of the page.
| commandline 2025-10-13 | commandline 2025-10-13 (current) | ||
| Line 1: | Line 1: | ||
| ====== Command-line Options ====== | ====== Command-line Options ====== | ||
| - | |||
| ===== [[parameters]] Parameters ===== | ===== [[parameters]] Parameters ===== | ||
| - | Parameters for ''[[executables|winscp.exe]]'' executable: | + | Parameters for ''[[executables|winscp.exe]]'' executable: |
| - | &lt;code batch&gt; | + | <code batch> |
| winscp.exe site|workspace|folder | winscp.exe site|workspace|folder | ||
| - | winscp.exe &lt;session_url&gt;[/path/[file]] | + | winscp.exe <session_url>[/path/[file]] |
| - | winscp.exe [mysession] [/sessionname=&lt;name&gt;] | + | winscp.exe [mysession] [/sessionname=<name>] |
| winscp.exe [mysession] [/newinstance] | winscp.exe [mysession] [/newinstance] | ||
| - | winscp.exe [mysession] /edit &lt;path&gt; | + | winscp.exe [mysession] /edit <path> |
| - | winscp.exe [mysession] /browse[=&lt;file&gt;] | + | winscp.exe [mysession] /browse[=<file>] |
| winscp.exe [mysession] /synchronize [local_directory] [remote_directory] [/defaults[=secs]] | winscp.exe [mysession] /synchronize [local_directory] [remote_directory] [/defaults[=secs]] | ||
| winscp.exe [mysession] /keepuptodate [local_directory] [remote_directory] [/defaults[=secs]] | winscp.exe [mysession] /keepuptodate [local_directory] [remote_directory] [/defaults[=secs]] | ||
| winscp.exe [mysession] /refresh [path] | winscp.exe [mysession] /refresh [path] | ||
| winscp.exe [mysession] /upload file1 file2 file3 ... [/defaults[=secs]] | winscp.exe [mysession] /upload file1 file2 file3 ... [/defaults[=secs]] | ||
| - | winscp.exe [mysession] [/privatekey=&lt;file&gt; [/passphrase=&lt;passphrase&gt;]] | + | winscp.exe [mysession] [/privatekey=<file> [/passphrase=<passphrase>]] |
| - | winscp.exe [mysession] [/hostkey=&lt;fingerprint&gt;] | + | winscp.exe [mysession] [/hostkey=<fingerprint>] |
| - | winscp.exe [mysession] [/username=&lt;user&gt;] [/password=&lt;pass&gt;] | + | winscp.exe [mysession] [/username=<user>] [/password=<pass>] |
| winscp.exe [mysession] [/passwordsfromfiles] | winscp.exe [mysession] [/passwordsfromfiles] | ||
| - | winscp.exe [mysession] [/clientcert=&lt;file&gt; [/passphrase=&lt;passphrase&gt;]] | + | winscp.exe [mysession] [/clientcert=<file> [/passphrase=<passphrase>]] |
| - | winscp.exe [mysession] [/certificate=&lt;fingerprint&gt;] | + | winscp.exe [mysession] [/certificate=<fingerprint>] |
| winscp.exe [mysession] [/passive[=on|off]] [/implicit|explicit] | winscp.exe [mysession] [/passive[=on|off]] [/implicit|explicit] | ||
| - | winscp.exe [mysession] [/timeout=&lt;sec&gt;] | + | winscp.exe [mysession] [/timeout=<sec>] |
| winscp.exe [mysession] [/rawsettings setting1=value1 setting2=value2 ...] | winscp.exe [mysession] [/rawsettings setting1=value1 setting2=value2 ...] | ||
| - | winscp.exe [/console] [/script=&lt;script_file&gt;] [/command command1 command2 ...] | + | winscp.exe [/console] [/script=<script_file>] [/command command1 command2 ...] |
| [/parameter // param1 ...] | [/parameter // param1 ...] | ||
| - | winscp.exe [/log=&lt;logfile&gt; [/loglevel=&lt;level&gt;] [/logsize=[&lt;count&gt;*]&lt;size&gt;]] | + | winscp.exe [/log=<logfile> [/loglevel=<level>] [/logsize=[<count>*]<size>]] |
| - | [/xmllog=&lt;logfile&gt; [/xmlgroups]] | + | [/xmllog=<logfile> [/xmlgroups]] |
| - | winscp.exe [/ini=&lt;inifile&gt;] | + | winscp.exe [/ini=<inifile>] |
| winscp.exe [/rawconfig config1=value1 config2=value2 ...] | winscp.exe [/rawconfig config1=value1 config2=value2 ...] | ||
| winscp.exe [/rawtransfersettings setting1=value1 setting2=value2 ...] | winscp.exe [/rawtransfersettings setting1=value1 setting2=value2 ...] | ||
| - | winscp.exe /batchsettings &lt;site_mask&gt; setting1=value1 setting2=value2 ... | + | winscp.exe /batchsettings <site_mask> setting1=value1 setting2=value2 ... |
| - | winscp.exe /keygen keyfile [/output=&lt;file&gt;] [/changepassphrase] | + | winscp.exe /keygen keyfile [/output=<file>] [/changepassphrase] |
| - | winscp.exe /keygen keyfile [/comment=&lt;text&gt;] [/certificate=&lt;file&gt;] | + | winscp.exe /keygen keyfile [/comment=<text>] [/certificate=<file>] |
| winscp.exe /copyid /identity=publickey mysession | winscp.exe /copyid /identity=publickey mysession | ||
| winscp.exe /update | winscp.exe /update | ||
| winscp.exe /info | winscp.exe /info | ||
| winscp.exe /help | winscp.exe /help | ||
| - | &lt;/code&gt; | + | </code> |
| - | Parameters for &#039;&#039;[[executables|winscp.com]]&#039;&#039; executable: | + | Parameters for ''[[executables|winscp.com]]'' executable: |
| - | &lt;code batch&gt; | + | <code batch> |
| winscp.com [/script=script_file] [/command command1 command2 ...] | winscp.com [/script=script_file] [/command command1 command2 ...] | ||
| [/parameter // param1 ...] | [/parameter // param1 ...] | ||
| winscp.com [/stdout[=binary|chunked]] [/stdin] | winscp.com [/stdout[=binary|chunked]] [/stdin] | ||
| - | winscp.com [/log=&lt;logfile&gt; [/loglevel=&lt;level&gt;] [/logsize=[&lt;count&gt;*]&lt;size&gt;]] | + | winscp.com [/log=<logfile> [/loglevel=<level>] [/logsize=[<count>*]<size>]] |
| - | [/xmllog=&lt;logfile&gt; [/xmlgroups]] [/nointeractiveinput] | + | [/xmllog=<logfile> [/xmlgroups]] [/nointeractiveinput] |
| - | winscp.com [/ini=&lt;inifile&gt;] | + | winscp.com [/ini=<inifile>] |
| winscp.com [/rawconfig config1=value1 config2=value2 ...] | winscp.com [/rawconfig config1=value1 config2=value2 ...] | ||
| - | winscp.com /batchsettings &lt;site_mask&gt; setting1=value1 setting2=value2 ... | + | winscp.com /batchsettings <site_mask> setting1=value1 setting2=value2 ... |
| - | winscp.com /keygen keyfile [/output=&lt;file&gt;] [/changepassphrase] | + | winscp.com /keygen keyfile [/output=<file>] [/changepassphrase] |
| - | winscp.com /keygen keyfile [/comment=&lt;text&gt;] [/certificate=&lt;file&gt;] | + | winscp.com /keygen keyfile [/comment=<text>] [/certificate=<file>] |
| winscp.exe /copyid /identity=publickey mysession | winscp.exe /copyid /identity=publickey mysession | ||
| winscp.com /info | winscp.com /info | ||
| winscp.com /help | winscp.com /help | ||
| - | &lt;/code&gt; | + | </code> |
| - | + | ||
| ==== [[session]] Session ==== | ==== [[session]] Session ==== | ||
| - | The first syntax opens the [[session_configuration#site|site]]. To open site, stored in folder, use path syntax &quot;folder/site&quot;. You can also open [[workspace|workspace]] or all sites in site folder. | + | The first syntax opens the [[session_configuration#site|site]]. To open site, stored in folder, use path syntax "folder/site". You can also open [[workspace|workspace]] or all sites in site folder. |
| - | The second creates the session specified by [[session_url|session URL]] and optionally by initial remote path. If the remote path is not ended by slash (&#039;&#039;/&#039;&#039;), it is treated as path to file (or even directory) that should be [[task_download#url|downloaded]]. | + | The second creates the session specified by [[session_url|session URL]] and optionally by initial remote path. If the remote path is not ended by slash (''/''), it is treated as path to file (or even directory) that should be [[task_download#url|downloaded]]. |
| - | The parameter &#039;&#039;/==sessionname==&#039;&#039; specifies a custom name of the session to be used instead of the automatically generated name in a format &#039;&#039;username@hostname&#039;&#039; or to override the name of the saved site. | + | The parameter ''/==sessionname=='' specifies a custom name of the session to be used instead of the automatically generated name in a format ''username@hostname'' or to override the name of the saved site. |
| - | If there&#039;s already an idle WinSCP instance running, the session(s) opens in the existing instance. To force the session to open in a new instance of WinSCP, use &#039;&#039;/==newinstance==&#039;&#039; parameter. If no session is specified on command-line, [[ui_login|Login dialog]] opens to select one. | + | If there's already an idle WinSCP instance running, the session(s) opens in the existing instance. To force the session to open in a new instance of WinSCP, use ''/==newinstance=='' parameter. If no session is specified on command-line, [[ui_login|Login dialog]] opens to select one. |
| - | The parameter &#039;&#039;/==privatekey==&#039;&#039; specifies a [[local_path|local path]] to an [[public_key#private|SSH private key file]]. If the key file is encrypted, use the &#039;&#039;/passphrase&#039;&#039; to specify its passphrase. The passphrase [[#passwordsfromfiles|can be read from a file]]. | + | The parameter ''/==privatekey=='' specifies a [[local_path|local path]] to an [[public_key#private|SSH private key file]]. If the key file is encrypted, use the ''/passphrase'' to specify its passphrase. The passphrase [[#passwordsfromfiles|can be read from a file]]. |
| - | The parameter &#039;&#039;/hostkey&#039;&#039; specifies the fingerprint of the expected SSH host key (or several alternative fingerprints separated by a semicolon). It makes WinSCP automatically [[ssh_verifying_the_host_key|accept the host key]] with the fingerprint. | + | The parameter ''/hostkey'' specifies the fingerprint of the expected SSH host key (or several alternative fingerprints separated by a semicolon). It makes WinSCP automatically [[ssh_verifying_the_host_key|accept the host key]] with the fingerprint. |
| - | You can use the parameters &#039;&#039;/==username==&#039;&#039; and &#039;&#039;/password&#039;&#039; as an alternative way to specify the credentials. The credentials are normally part of the [[session_url|session URL]]. Using these switches has the advantage of not needing to [[session_url#special|URL-encode special characters]]. The password [[#passwordsfromfiles|can be read from a file]]. | + | You can use the parameters ''/==username=='' and ''/password'' as an alternative way to specify the credentials. The credentials are normally part of the [[session_url|session URL]]. Using these switches has the advantage of not needing to [[session_url#special|URL-encode special characters]]. The password [[#passwordsfromfiles|can be read from a file]]. |
| - | With parameter &#039;&#039;/==passwordsfromfiles==&#039;&#039;, the values of [[#username|&#039;&#039;/password&#039;&#039;]], [[#privatekey|&#039;&#039;/passphrase&#039;&#039;]] and in general all passwords from all sources are interpreted as paths to files, where the actual passwords are read from. The files must use UTF-8 or UTF-16 encoding.((With UTF-8 encoding use of BOM is optional. With UTF-16 the BOM is mandatory. Only the first line of the file is considered. Use of more lines is reserved for the future.)) | + | With parameter ''/==passwordsfromfiles=='', the values of [[#username|''/password'']], [[#privatekey|''/passphrase'']] and in general all passwords from all sources are interpreted as paths to files, where the actual passwords are read from. The files must use UTF-8 or UTF-16 encoding.((With UTF-8 encoding use of BOM is optional. With UTF-16 the BOM is mandatory. Only the first line of the file is considered. Use of more lines is reserved for the future.)) |
| - | The parameter &#039;&#039;/clientcert&#039;&#039; specifies a [[local_path|local path]] to FTPS or WebDAVS [[tls#client_certificate|TLS/SSL client certificate]]. If the certificate is encrypted, use the &#039;&#039;/passphrase&#039;&#039; to specify its passphrase. | + | The parameter ''/clientcert'' specifies a [[local_path|local path]] to FTPS or WebDAVS [[tls#client_certificate|TLS/SSL client certificate]]. If the certificate is encrypted, use the ''/passphrase'' to specify its passphrase. |
| - | When a FTPS or WebDAVS server [[tls#certificate|TLS/SSL certificate]] is not trusted (typically a self-signed certificate), use the parameter &#039;&#039;/certificate&#039;&#039; to specify the fingerprint of the untrusted certificate. It makes WinSCP trust the certificate. Several alternative fingerprints can be separated by a semicolon. | + | When a FTPS or WebDAVS server [[tls#certificate|TLS/SSL certificate]] is not trusted (typically a self-signed certificate), use the parameter ''/certificate'' to specify the fingerprint of the untrusted certificate. It makes WinSCP trust the certificate. Several alternative fingerprints can be separated by a semicolon. |
| - | The parameter &#039;&#039;/passive&#039;&#039; enables a [[ui_login_connection#connection|passive]] (&#039;&#039;=on&#039;&#039;) or an active (&#039;&#039;=off&#039;&#039;) transfer mode ([[FTP]] protocol only). | + | The parameter ''/passive'' enables a [[ui_login_connection#connection|passive]] (''=on'') or an active (''=off'') transfer mode ([[FTP]] protocol only). |
| - | The parameters &#039;&#039;/implicit&#039;&#039;, and &#039;&#039;/explicit&#039;&#039; enable respective [[ftps#methods|method of invoking FTPS]]. | + | The parameters ''/implicit'', and ''/explicit'' enable respective [[ftps#methods|method of invoking FTPS]]. |
| - | The parameter &#039;&#039;/timeout&#039;&#039; specifies [[ui_login_connection#timeout|server response timeout]]. | + | The parameter ''/timeout'' specifies [[ui_login_connection#timeout|server response timeout]]. |
| - | The parameter &#039;&#039;/==rawsettings==&#039;&#039; allows configuring any site settings [[rawsettings|using raw format as in an INI file]]. E.g. to enable an SSH compression and an agent forwarding, use &#039;&#039;/rawsettings Compression=1 AgentFwd=1&#039;&#039;. The parameter must come after the session URL (if any). | + | The parameter ''/==rawsettings=='' allows configuring any site settings [[rawsettings|using raw format as in an INI file]]. E.g. to enable an SSH compression and an agent forwarding, use ''/rawsettings Compression=1 AgentFwd=1''. The parameter must come after the session URL (if any). |
| - | When using [[scripting]], use the &#039;&#039;[[scriptcommand_open|open]]&#039;&#039; command (and its switches) instead. | + | When using [[scripting]], use the ''[[scriptcommand_open|open]]'' command (and its switches) instead. |
| Examples: | Examples: | ||
| - | &lt;code batch&gt; | + | <code batch> |
| - | winscp.exe &quot;My site&quot; | + | winscp.exe "My site" |
| - | winscp.exe sftp://martin:password@example.com/ /hostkey=&quot;ssh-rsa 2048 xxxxxxxxxxx...&quot; | + | winscp.exe sftp://martin:password@example.com/ /hostkey="ssh-rsa 2048 xxxxxxxxxxx..." |
| winscp.exe scp://test@example.com:2222/ /privatekey=mykey.ppk | winscp.exe scp://test@example.com:2222/ /privatekey=mykey.ppk | ||
| winscp.exe ftps://martin:password@example.com/ | winscp.exe ftps://martin:password@example.com/ | ||
| - | &lt;/code&gt; | + | </code> |
| ==== [[logging]] Logging ==== | ==== [[logging]] Logging ==== | ||