Difference between revisions of "Command-line arguments (Client)"

From FileZilla Wiki
Jump to navigationJump to search
m
 
(189 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
−
== FileZilla Client 3.x Command-Line Arguments ==
+
These are the command-line arguments for [[FileZilla FTP Client|FileZilla Client]]. The Server command-line arguments can be found under [[Command-line arguments (Server)]].
 +
If you are looking for a command-line version of FileZilla, check out [https://filezillapro.com/cli/ FileZilla Pro CLI].
  
−
support only the /h parameter (help) and --verbose option
+
== FileZilla Client command-line arguments ==
  
−
== FileZilla Client 2.x Command-Line Arguments ==
+
=== Synopsis ===
  
−
FileZilla Client does support some basic command-line arguments, but it's primarily a GUI application and as such isn't meant to do scripting/automation. Some functionality is nevertheless available through the command-line.
+
filezilla [<FTP URL>]
 +
filezilla -h, --help
 +
filezilla -s, --site-manager
 +
filezilla -c, --site=<string>
 +
filezilla -l, --logontype=<string>
 +
filezilla -a, --local=<string>
 +
filezilla --close
 +
filezilla --verbose
 +
filezilla -v, --version
  
−
=== Standard Synopsis ===
+
=== Options ===
 +
 
 +
*<FTP URL>
 +
<blockquote>
 +
Accepts all URLs of the form
 +
 
 +
<pre>[protocol://][user[:pass]@]host[:port][/path]
 +
eg.  sftp://username:password@server:port</pre>
 +
 
 +
Valid protocols are '''ftp://''' (the default if omitted), '''ftps://''', '''ftpes://''' and '''sftp://'''
 +
</blockquote>
 +
 
 +
*-h, --help
 +
<blockquote>
 +
Shows the help dialog.
 +
</blockquote>
 +
 
 +
*-s, --sitemanager
 +
<blockquote>
 +
Start with opened Site Manager.
 +
<br /><br />
 +
May not be used together with -c nor with URL parameter.
 +
</blockquote>
 +
 
 +
*-c, --site=&lt;string&gt;
 +
<blockquote>
 +
Connect to specified Site Manager site.
 +
<br /><br />
 +
Site name requirements:
 
<ul>
 
<ul>
−
<li>filezilla.exe <URL> [-du] <sourcefile> <targetdir> [-t] <targetname></li>
+
    <li>Site has to be given as complete path, with a slash as separation character.</li>
−
<li>filezilla.exe -s <name of site in Site Manager></li>
+
    <li>Any slash or backslash that is part of a segment has to be escaped with a backslash.</li>
−
</ul>
+
    <li>Path has to be prefixed with 0 for user defined entries or 1 for default entries.</li>
 +
    <li>Site path may not contain double quotation marks.</li>
 +
</ul>  
 +
 +
 
 +
Example:
 +
<pre>filezilla --site="0/foo/bar/sl\/ash"</pre>
 +
Connects to the user site "sl/ash" in the site directory "foo/bar".
  
−
=== Description ===
 
−
<ul>
 
−
<li>filezilla.exe [<protocol>://]<username>:<password>@<host>[:port]<br />
 
−
Used to connect to a host running a ftp server. The optional protocol can either be ftp://, sftp:// or ftps:// and defaults to ftp://. The port is optional. If it is ommited, the port defaults to 21 for ftp://, 22 for sftp:// and 990 for ftps://.
 
−
</li>
 
  
−
<li>filezilla.exe -s <name of site in Site Manager><br />
+
</blockquote>
−
Used to connect to a host that is defined in the Site Manager of the program. The name of the site is case sensitive.
 
−
</li>
 
  
−
<li>filezilla.exe [-du] <sourcefile> <targetdir> [-t] <targetname><br />
+
*-l, --logontype=(ask|interactive)
−
Used to download (-d) or upload (-u) a file from/to the host.
+
<blockquote>
−
</li>
+
Logon type, can only be used together with FTP URL. Argument has to be either 'ask' or 'interactive'.
 +
<br /><br />
 +
FileZilla will ask for any logon information not supplied in the FTP URL before connecting. Useful for custom scripts or shortcuts.
 +
</blockquote>
  
−
</ul>
 
  
−
=== User Commands ===
+
*-a, --local=&lt;string&gt;
−
The supported user commands are:
+
<blockquote>
−
<ul>
+
Sets the local site (left-hand side) to the given path. '''(Requires version 3.7.1-rc1 or higher)'''
 +
<br /><br />
 +
Use double quotation for paths with spaces in them.
 +
<br /><br />
  
−
<li>URL<br />
+
Example:
−
  You can specify an URL FileZilla connect to when started.
+
<pre>filezilla --site="0/site1" --local="C:\site1 downloads"
−
</li>
+
filezilla ftp://username:password@ftp.example.com --local="C:\server2 downloads"</pre>
−
<li>-s <name of site in Site Manager><br />
+
Connects to the user site "site1" and sets the local folder to '''C:\site1 downloads'''.
−
  Specifies an already defined site in the Site Manager that FileZilla tries to connect to when started.
 
−
</li>
 
−
<li>
 
−
-d <sourcefile> <targetdir><br />
 
−
  Downloads the specified file from the server into the target dir.
 
−
</li>
 
−
<li>
 
−
-u <sourcefile> <targetdir><br />
 
−
  Uploads the specified file into the target dir on the server. <sourcefile> has to be the full path of the file.
 
−
</li>
 
−
<li>
 
−
-t <targetname><br />
 
−
  Only valid together with -u or -d: Specifies an alternate name for the target file. Must come directly after one of -u or -d.
 
−
</li>
 
−
<li>
 
−
-quit <br />
 
−
Shuts down all running instances of FileZilla. Must be used solely; can't be combined with any of the other arguments.
 
−
</li>
 
−
<li>
 
−
-i <br />
 
−
Imports a Site Manager .xml file.
 
−
</li>
 
−
</ul>
 
  
−
Remarks:
+
Connects to server2 URL and sets the local folder to '''C:\server2 downloads'''.
−
You can not use -s as argument to either -u or -d. Both -u and -d expect a full hostname.
 
  
−
=== Options ===
+
</blockquote>
  
−
<ul>
 
−
<li>
 
−
-close <br />
 
−
  Will close FileZilla after all transfers have finished.
 
−
</li>
 
−
<li>
 
−
-config <configfile> <br />
 
−
  Loads the file specified as configuration for the program. If used it has to be the first argument to FileZilla.
 
−
</li>
 
−
<li>
 
−
-overwrite <br />
 
−
To set the fileexists action to overwrite.
 
−
</li>
 
−
</ul>
 
  
−
=== Example (version 2.2.29) ===
+
*--close ''(Windows only)''
−
<nowiki>filezilla.exe -s "Remote Site" -u "c:\ftp\TestFile.txt" ftp://ftp_user:ftp_password@ftp_host_ip/test_stuff -close</nowiki>
+
<blockquote>
 +
Closes all running instances of FileZilla.
 +
</blockquote>
  
−
<ul>
+
*--verbose
−
<li>
+
<blockquote>
−
...will connect to the site "Remote Site" (-s) defined in Site Manager and Upload (-u) the local file "c:\ftp\TestFile.txt" into remote folder "test_stuff"; when the transfer is complete, close FileZilla.</li>
+
Verbose log messages from wxWidgets.
−
<li>FileZilla 2.2.29 command line transfer does not support Wildcards/Subdirectory specifications (i.e. \* or \*.*) will not work to transfer all folders/files; only single file transfers are allowed.</li>
+
</blockquote>
−
</ul>
 
  
−
=== Example (version 2.2.29) ===
+
*-v, --version
−
<nowiki>c:\filezilla\filezilla.exe -u ".\filename.mpg" ftp://ftp_user:ftp_passwor@10.0.0.3:2002/test_stuff -close</nowiki>
+
<blockquote>
 +
Print version information to stdout and exit.
 +
</blockquote>
  
−
<ul>
+
=== Example ===
−
<li>
 
−
...will connect to the site 10.0.0.3 at port 2002 and Upload (-u) the local file "filename.mpg" from the current directory, into remote folder "test_stuff"; when the transfer is complete, close FileZilla.</li>
 
−
</ul>
 
  
−
=== Example (version 2.2.30) ===
+
[[Image:Cmdline argument example.png]]
−
<nowiki>filezilla.exe -close -overwrite -d ftp://ftp_user:ftp_password@ftp_host_ip/test_file.txt "c:\targetdirectory"</nowiki>
 
  
−
...will connect to the site ftp_host_ip and Download (-d) server file 'test_file.txt' into local folder "targetdirectory"; when the transfer is complete, close FileZilla and if the file already exists overwrite it automatically.
+
If you want to connect from the command-line to the site named '''Backup server''' in the directory '''foo/bar''', the command is:
 +
filezilla -c "0/foo\/bar/Backup server"

Latest revision as of 19:30, 6 March 2024

These are the command-line arguments for FileZilla Client. The Server command-line arguments can be found under Command-line arguments (Server). If you are looking for a command-line version of FileZilla, check out FileZilla Pro CLI.

FileZilla Client command-line arguments

Synopsis

filezilla [<FTP URL>]
filezilla -h, --help
filezilla -s, --site-manager
filezilla -c, --site=<string>
filezilla -l, --logontype=<string>
filezilla -a, --local=<string>
filezilla --close
filezilla --verbose
filezilla -v, --version

Options

  • <FTP URL>

Accepts all URLs of the form 

[protocol://][user[:pass]@]host[:port][/path]
eg.  sftp://username:password@server:port

Valid protocols are ftp:// (the default if omitted), ftps://, ftpes:// and sftp://

  • -h, --help

Shows the help dialog.

  • -s, --sitemanager

Start with opened Site Manager.

May not be used together with -c nor with URL parameter.

  • -c, --site=<string>

Connect to specified Site Manager site.

Site name requirements:

  • Site has to be given as complete path, with a slash as separation character.
  • Any slash or backslash that is part of a segment has to be escaped with a backslash.
  • Path has to be prefixed with 0 for user defined entries or 1 for default entries.
  • Site path may not contain double quotation marks.


Example: 

filezilla --site="0/foo/bar/sl\/ash"

Connects to the user site "sl/ash" in the site directory "foo/bar".


  • -l, --logontype=(ask|interactive)

Logon type, can only be used together with FTP URL. Argument has to be either 'ask' or 'interactive'.

FileZilla will ask for any logon information not supplied in the FTP URL before connecting. Useful for custom scripts or shortcuts.


  • -a, --local=<string>

Sets the local site (left-hand side) to the given path. (Requires version 3.7.1-rc1 or higher)

Use double quotation for paths with spaces in them.

Example: 

filezilla --site="0/site1" --local="C:\site1 downloads"
filezilla ftp://username:password@ftp.example.com --local="C:\server2 downloads"

Connects to the user site "site1" and sets the local folder to C:\site1 downloads.

Connects to server2 URL and sets the local folder to C:\server2 downloads.


  • --close (Windows only)

Closes all running instances of FileZilla.

  • --verbose

Verbose log messages from wxWidgets.

  • -v, --version

Print version information to stdout and exit.

Example

Cmdline argument example.png

If you want to connect from the command-line to the site named Backup server in the directory foo/bar, the command is: 

filezilla -c "0/foo\/bar/Backup server"
Retrieved from "https://wiki.filezilla-project.org/wiki/index.php?title=Command-line_arguments_(Client)&oldid=53289"