commandline » Revisions »
Differences
This shows you the differences between the selected revisions of the page.
| 2026-03-10 | 2026-03-10 (current) | ||
| 1 (107.175.35.126) (hidden) (untrusted) | 6.6 Consistently calling command to open window with specific directory Explore, instead of sometimes Browse (martin) | ||
| Line 55: | Line 55: | ||
| winscp.com /help | winscp.com /help | ||
| </code> | </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 ==== | ||