commandline » Revisions »
Differences
This shows you the differences between the selected revisions of the page.
| commandline 2024-10-03 | commandline 2025-04-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: | ||
| - | &amp;lt;code batch&amp;gt; | + | <code batch> |
| winscp.exe site|workspace|folder | winscp.exe site|workspace|folder | ||
| - | winscp.exe &amp;lt;session_url&amp;gt;[/path/[file]] | + | winscp.exe <session_url>[/path/[file]] |
| - | winscp.exe [mysession] [/sessionname=&amp;lt;name&amp;gt;] | + | winscp.exe [mysession] [/sessionname=<name>] |
| winscp.exe [mysession] [/newinstance] | winscp.exe [mysession] [/newinstance] | ||
| - | winscp.exe [mysession] /edit &amp;lt;path&amp;gt; | + | winscp.exe [mysession] /edit <path> |
| - | winscp.exe [mysession] /browse[=&amp;lt;file&amp;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=&amp;lt;file&amp;gt; [/passphrase=&amp;lt;passphrase&amp;gt;]] | + | winscp.exe [mysession] [/privatekey=<file> [/passphrase=<passphrase>]] |
| - | winscp.exe [mysession] [/hostkey=&amp;lt;fingerprint&amp;gt;] | + | winscp.exe [mysession] [/hostkey=<fingerprint>] |
| - | winscp.exe [mysession] [/username=&amp;lt;user&amp;gt;] [/password=&amp;lt;pass&amp;gt;] | + | winscp.exe [mysession] [/username=<user>] [/password=<pass>] |
| winscp.exe [mysession] [/passwordsfromfiles] | winscp.exe [mysession] [/passwordsfromfiles] | ||
| - | winscp.exe [mysession] [/clientcert=&amp;lt;file&amp;gt; [/passphrase=&amp;lt;passphrase&amp;gt;]] | + | winscp.exe [mysession] [/clientcert=<file> [/passphrase=<passphrase>]] |
| - | winscp.exe [mysession] [/certificate=&amp;lt;fingerprint&amp;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=&amp;lt;sec&amp;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=&amp;lt;script_file&amp;gt;] [/command command1 command2 ...] | + | winscp.exe [/console] [/script=<script_file>] [/command command1 command2 ...] |
| [/parameter // param1 ...] | [/parameter // param1 ...] | ||
| - | winscp.exe [/log=&amp;lt;logfile&amp;gt; [/loglevel=&amp;lt;level&amp;gt;] [/logsize=[&amp;lt;count&amp;gt;*]&amp;lt;size&amp;gt;]] | + | winscp.exe [/log=<logfile> [/loglevel=<level>] [/logsize=[<count>*]<size>]] |
| - | [/xmllog=&amp;lt;logfile&amp;gt; [/xmlgroups]] | + | [/xmllog=<logfile> [/xmlgroups]] |
| - | winscp.exe [/ini=&amp;lt;inifile&amp;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 &amp;lt;site_mask&amp;gt; setting1=value1 setting2=value2 ... | + | winscp.exe /batchsettings <site_mask> setting1=value1 setting2=value2 ... |
| - | winscp.exe /keygen keyfile [/output=&amp;lt;file&amp;gt;] [/changepassphrase] | + | winscp.exe /keygen keyfile [/output=<file>] [/changepassphrase] |
| - | winscp.exe /keygen keyfile [/comment=&amp;lt;text&amp;gt;] [/certificate=&amp;lt;file&amp;gt;] | + | winscp.exe /keygen keyfile [/comment=<text>] [/certificate=<file>] |
| + | winscp.exe /copyid /identity=publickey mysession | ||
| winscp.exe /update | winscp.exe /update | ||
| winscp.exe /info | winscp.exe /info | ||
| winscp.exe /help | winscp.exe /help | ||
| - | &amp;lt;/code&amp;gt; | + | </code> |
| Parameters for ''[[executables|winscp.com]]'' executable: | Parameters for ''[[executables|winscp.com]]'' executable: | ||
| - | &amp;lt;code batch&amp;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=&amp;lt;logfile&amp;gt; [/loglevel=&amp;lt;level&amp;gt;] [/logsize=[&amp;lt;count&amp;gt;*]&amp;lt;size&amp;gt;]] | + | winscp.com [/log=<logfile> [/loglevel=<level>] [/logsize=[<count>*]<size>]] |
| - | [/xmllog=&amp;lt;logfile&amp;gt; [/xmlgroups]] [/nointeractiveinput] | + | [/xmllog=<logfile> [/xmlgroups]] [/nointeractiveinput] |
| - | winscp.com [/ini=&amp;lt;inifile&amp;gt;] | + | winscp.com [/ini=<inifile>] |
| winscp.com [/rawconfig config1=value1 config2=value2 ...] | winscp.com [/rawconfig config1=value1 config2=value2 ...] | ||
| - | winscp.com /batchsettings &amp;lt;site_mask&amp;gt; setting1=value1 setting2=value2 ... | + | winscp.com /batchsettings <site_mask> setting1=value1 setting2=value2 ... |
| - | winscp.com /keygen keyfile [/output=&amp;lt;file&amp;gt;] [/changepassphrase] | + | winscp.com /keygen keyfile [/output=<file>] [/changepassphrase] |
| - | winscp.com /keygen keyfile [/comment=&amp;lt;text&amp;gt;] [/certificate=&amp;lt;file&amp;gt;] | + | winscp.com /keygen keyfile [/comment=<text>] [/certificate=<file>] |
| + | winscp.exe /copyid /identity=publickey mysession | ||
| winscp.com /info | winscp.com /info | ||
| winscp.com /help | winscp.com /help | ||
| - | &amp;lt;/code&amp;gt; | + | </code> |
| ==== [[session]] Session ==== | ==== [[session]] Session ==== | ||
| Line 64: | Line 63: | ||
| 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. | 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'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 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 ''/==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 ''/==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]]. | ||
| Line 214: | Line 213: | ||
| winscp.com /keygen mykey.pem -o mykey.ppk -C "Converted from OpenSSH format" | winscp.com /keygen mykey.pem -o mykey.ppk -C "Converted from OpenSSH format" | ||
| </code> | </code> | ||
| + | |||
| + | ==== [[copyid]] Public key installation ==== | ||
| + | |||
| + | Use the ''/copyid'' switch to [[guide_public_key#configure_openssh|install your public key in a server's ''authorized_keys'' file]]. Use ''/identity'' switch to specify the path to your key pair in PPK format or public key in ''authorized_keys'' format. Supported with SFTP protocol only. | ||
| + | |||
| + | For example, to install public key from ''mykey.ppk'' key pair file, use: | ||
| + | |||
| + | <code batch> | ||
| + | winscp.com /copyid /identity=mykey.ppk martin@example.com | ||
| + | </code> | ||
| + | |||
| + | The functionality is a replacement for [[&man_ref(1,ssh-copy-id)|OpenSSH ''ssh-copy-id'' script]]. Contrary to the OpenSSH script, it does not require shell interpreter locally. Additionally, it uses SFTP protocol, so it does not rely on a shell access and shell commands on the server. For a compatibility with the script, the ''-i'' switch is understood as an alias to ''/identity''. So, for features supported by WinSCP, you can use the same arguments as for ''ssh-copy-id'', just prefixed with ''/copyid''. | ||
| ==== [[auxiliary]] Auxiliary ==== | ==== [[auxiliary]] Auxiliary ==== | ||