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

From FileZilla Wiki
Jump to navigationJump to search
(First draft)
 
m
 
(219 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
−
== DRAFT ==
+
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)]].
−
Unfinished page, saved for backup purposes.
+
If you are looking for a command-line version of FileZilla, check out [https://filezillapro.com/cli/ FileZilla Pro CLI].
  
−
== FileZilla Client 2.x Command-Line Arguments ==
+
== FileZilla Client command-line arguments ==
  
−
FileZilla Client does support some basic command line options, but as the program isn't meant to be a command-line application, only a small part of the functions are available through the command-line.
+
=== 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>
 +
<blockquote>
 +
Accepts all URLs of the form
  
−
=== Synopsis ===
+
<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] ...</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> [-du] ...</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".
 +
 
 +
 
 +
</blockquote>
 +
 
 +
*-l, --logontype=(ask|interactive)
 +
<blockquote>
 +
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>
 +
 
 +
 
 +
*-a, --local=&lt;string&gt;
 +
<blockquote>
 +
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 />
 +
 
 +
Example:
 +
<pre>filezilla --site="0/site1" --local="C:\site1 downloads"
 +
filezilla ftp://username:password@ftp.example.com --local="C:\server2 downloads"</pre>
 +
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'''.
 +
 
 +
</blockquote>
  
−
=== Description ===
 
−
<ul>
 
−
<li>filezilla.exe <protocol>://<username>:<password>@<host><br />
 
−
Used to connect to a host running a ftp server. Protocol can either be FTP:// or SFTP:// and host have the syntax <host address>:<port>.
 
−
</li>
 
  
−
<li>filezilla.exe -s <name of site in Site Manager><br />
+
*--close ''(Windows only)''
−
Used to connect to a host that is defined in the Site Manager of the program. The name of the site is case sensitive.
+
<blockquote>
−
</li>
+
Closes all running instances of FileZilla.
 +
</blockquote>
  
−
<li>filezilla.exe [-du] <sourcefile> <targetdir> [-t] <targetname><br />
+
*--verbose
−
Used to download (-d) or upload (-u) a file from/to the host.
+
<blockquote>
−
</li>
+
Verbose log messages from wxWidgets.
 +
</blockquote>
  
−
</ul>
+
*-v, --version
 +
<blockquote>
 +
Print version information to stdout and exit.
 +
</blockquote>
  
−
=== User Commands ===
+
=== Example ===
−
The supported user commands are:
 
−
<ul>
 
  
−
<li>URL<br />
+
[[Image:Cmdline argument example.png]]
−
  You can specify a URL FileZilla connect to when started.
 
−
</li>
 
−
<li>-s <name of site in Site Manager><br />
 
−
  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..
 
−
</li>
 
−
</ul>
 
  
−
=== Examples ===
+
If you want to connect from the command-line to the site named '''Backup server''' in the directory '''foo/bar''', the command is:
−
<ul>
+
filezilla -c "0/foo\/bar/Backup server"
−
<li>filezilla.exe -s mySite<br />
 
−
    Will connect to the site "mySite" (defined in the Site Manager) when FileZilla starts.
 
−
</li>
 
−
<li>filezilla.exe -u "c:\Program File\FileZilla\FileZilla.exe" ftp://user:pass@ftp.myserver.com/foobar -t CoolProg.exe<br/>
 
−
    Will upload FileZilla.exe to the host (and directory "foobar") specified and give it the name "CoolProg.exe".
 
−
</li>
 
−
</ul>
 

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"