root/f7cloud_client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
8b6a0139db
f7cloud_client/core/doc/admin/desktop/commandline.html
root 8b6a0139db f7cloud_client 
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-17 22:59:26 +00:00

365 lines
21 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="readthedocs-addons-api-version" content="1"><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Command Line Client &mdash; F7cloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=8ff6e0db" />
<link rel="stylesheet" type="text/css" href="../_static/dark_mode_css/general.css?v=c0a7eb24" />
<link rel="stylesheet" type="text/css" href="../_static/dark_mode_css/dark.css?v=70edf1c7" />
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=f4332903"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=f281be69"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<script src="../_static/js/versions.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Command-line Account Setup" href="accountcommand.html" />
<link rel="prev" title="Environment Variables" href="envvars.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<div class="switch-menus">
<div class="version-switch"></div>
<div class="language-switch"></div>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_schedule.html">Maintenance and release schedule</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Release notes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Critical changes</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Installation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation and server configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Configuration</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration_server/index.html">F7cloud configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../occ_command.html">Using the occ command</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../webhook_listeners/index.html">Webhook Listeners</a></li>
<li class="toctree-l1"><a class="reference internal" href="../windmill_workflows/index.html">Windmill Workflows</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Files</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration_files/index.html">File sharing and management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../file_workflows/index.html">Flow</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Apps</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../apps_management.html">Apps management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../exapps_management/index.html">ExApps management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ai/index.html">Artificial Intelligence</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Users</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../configuration_user/index.html">User management</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Desktop Clients</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="options.html">Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="massdeployment.html">Mass Deployment And Account Creation</a></li>
<li class="toctree-l2"><a class="reference internal" href="configfile.html">Configuration File</a></li>
<li class="toctree-l2"><a class="reference internal" href="envvars.html">Environment Variables</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Command Line Client</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#install-f7cloudcmd">Install <code class="docutils literal notranslate"><span class="pre">f7cloudcmd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#credential-handling">Credential Handling</a></li>
<li class="toctree-l3"><a class="reference internal" href="#exclude-list">Exclude List</a></li>
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="accountcommand.html">Command-line Account Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Groupware</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../groupware/index.html">Groupware</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Office</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Maintenance</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../maintenance/index.html">Maintenance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../issues/index.html">Issues and troubleshooting</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Links</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://help.f7cloud.com/">Community Help Forum</a></li>
<li class="toctree-l1"><a class="reference external" href="https://docs.f7cloud.com/">User Manuals</a></li>
<li class="toctree-l1"><a class="reference external" href="https://docs.f7cloud.com/">Developer Manuals</a></li>
<li class="toctree-l1"><a class="reference external" href="https://f7cloud.com/install/">Download</a></li>
<li class="toctree-l1"><a class="reference external" href="https://apps.f7cloud.com">App Store</a></li>
<li class="toctree-l1"><a class="reference external" href="https://help.f7cloud.com/t/translation-knowledge-valid-for-the-entire-f7cloud-project-wiki/51550">Translations</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/f7cloud/">GitHub</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/f7cloud/server/wiki/Maintenance-and-Release-Schedule">Supported versions</a></li>
<li class="toctree-l1"><a class="reference external" href="https://f7cloud.com/enterprise/">F7cloud Enterprise</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/f7cloud/server/blob/master/COPYING-README">License</a></li>
<li class="toctree-l1"><a class="reference external" href="https://f7cloud.com/">F7cloud GmbH</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../contents.html">F7cloud latest Administration Manual</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../contents.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="index.html">Desktop Clients</a></li>
<li class="breadcrumb-item active">Command Line Client</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/f7cloud/documentation/edit/master/admin_manual/desktop/commandline.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="command-line-client">
<h1>Command Line Client<a class="headerlink" href="#command-line-client" title="Link to this heading"></a></h1>
<p>The F7cloud Client packages contain a command line client, <code class="docutils literal notranslate"><span class="pre">f7cloudcmd</span></code>, that can
be used to synchronize F7cloud files to client machines.</p>
<p><code class="docutils literal notranslate"><span class="pre">f7cloudcmd</span></code> performs a single <em>sync run</em> and then exits the synchronization
process. In this manner, <code class="docutils literal notranslate"><span class="pre">f7cloudcmd</span></code> processes the differences between
client and server directories and propagates the files to bring both
repositories to the same state. Contrary to the GUI-based client,
<code class="docutils literal notranslate"><span class="pre">f7cloudcmd</span></code> does not repeat synchronizations on its own. It also does not
monitor for file system changes.</p>
<section id="install-f7cloudcmd">
<h2>Install <code class="docutils literal notranslate"><span class="pre">f7cloudcmd</span></code><a class="headerlink" href="#install-f7cloudcmd" title="Link to this heading"></a></h2>
<p>CentOS</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo yum -y install epel-release
$ sudo yum -y install f7cloud-client
</pre></div>
</div>
<p>Ubuntu</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo add-apt-repository ppa:f7cloud-devs/client
$ sudo apt update
$ sudo apt install f7cloud-client
</pre></div>
</div>
<p>Debian</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo apt install f7cloud-desktop-cmd
</pre></div>
</div>
<p>Refer to the link</p>
<ul class="simple">
<li><p><a class="reference external" href="https://f7cloud.com/install/#install-clients">https://f7cloud.com/install/#install-clients</a></p></li>
<li><p><a class="reference external" href="https://launchpad.net/~f7cloud-devs/+archive/ubuntu/client">https://launchpad.net/~f7cloud-devs/+archive/ubuntu/client</a></p></li>
<li><p><a class="reference external" href="https://pkgs.alpinelinux.org/packages?name=f7cloud-client">https://pkgs.alpinelinux.org/packages?name=f7cloud-client</a></p></li>
<li><p><a class="reference external" href="https://help.f7cloud.com/t/linux-packages-status/10216">https://help.f7cloud.com/t/linux-packages-status/10216</a></p></li>
</ul>
<p>To invoke <code class="docutils literal notranslate"><span class="pre">f7cloudcmd</span></code>, you must provide the local and the remote repository
URL using the following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">f7cloudcmd</span> <span class="p">[</span><span class="n">OPTIONS</span><span class="o">...</span><span class="p">]</span> <span class="n">sourcedir</span> <span class="n">f7cloudurl</span>
</pre></div>
</div>
<p>where <code class="docutils literal notranslate"><span class="pre">sourcedir</span></code> is the local directory and <code class="docutils literal notranslate"><span class="pre">f7cloudurl</span></code> is
the server URL.</p>
<p>Other command line switches supported by <code class="docutils literal notranslate"><span class="pre">f7cloudcmd</span></code> include the following:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">--path</span></code></dt><dd><p>Overrides default remote root folder to a specific subfolder on the server(e.g.: /Documents would sync the Documents subfolder on the server)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--user</span></code>, <code class="docutils literal notranslate"><span class="pre">-u</span></code> <cite>&lt;user&gt;</cite></dt><dd><p>Use <code class="docutils literal notranslate"><span class="pre">user</span></code> as the login name.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--password</span></code>, <code class="docutils literal notranslate"><span class="pre">-p</span></code> <cite>&lt;password&gt;</cite></dt><dd><p>Use <cite>password</cite> as the password.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-n</span></code></dt><dd><p>Use`netrc(5)` for login.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--non-interactive</span></code></dt><dd><p>Do not prompt for questions and tries to read $NC_USER and $NC_PASSWORD from the environment.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--silent</span></code>, <code class="docutils literal notranslate"><span class="pre">--s</span></code></dt><dd><p>Inhibits verbose log output.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--trust</span></code></dt><dd><p>Trust any SSL certificate, including invalid ones.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--httpproxy</span></code> <cite>http://[user&#64;pass:]&lt;server&gt;:&lt;port&gt;</cite></dt><dd><p>Uses <cite>server</cite> as HTTP proxy.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--exclude</span></code> <cite>&lt;file&gt;</cite></dt><dd><p>Exclude list file</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--unsyncedfolders</span></code> <cite>&lt;file&gt;</cite></dt><dd><p>File containing the list of unsynced folders (selective sync)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--max-sync-retries</span></code> <cite>&lt;n&gt;</cite></dt><dd><p>Retries maximum n times (defaults to 3)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-h</span></code></dt><dd><p>Sync hidden files,do not ignore them</p>
</dd>
</dl>
</section>
<section id="credential-handling">
<h2>Credential Handling<a class="headerlink" href="#credential-handling" title="Link to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">f7cloudcmd</span></code> requires the user to specify the username and password using the standard URL pattern, e.g.,</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ f7cloudcmd /home/user/my_sync_folder https://carla:secret@server/f7cloud
</pre></div>
</div>
<p>To synchronize the F7cloud directory <code class="docutils literal notranslate"><span class="pre">Music</span></code> to the local directory
<code class="docutils literal notranslate"><span class="pre">media/music</span></code>, through a proxy listening on port <code class="docutils literal notranslate"><span class="pre">8080</span></code>, and on a gateway
machine using IP address <code class="docutils literal notranslate"><span class="pre">192.168.178.1</span></code>, the command line would be:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ f7cloudcmd --httpproxy http://192.168.178.1:8080 --path /Music \
$HOME/media/music \
https://server/f7cloud
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">f7cloudcmd</span></code> will prompt for the user name and password, unless they have
been specified on the command line or <code class="docutils literal notranslate"><span class="pre">-n</span></code> has been passed.</p>
</section>
<section id="exclude-list">
<h2>Exclude List<a class="headerlink" href="#exclude-list" title="Link to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">f7cloudcmd</span></code> requires access to an exclude list file. It must either be
installed along with <code class="docutils literal notranslate"><span class="pre">f7cloudcmd</span></code> and thus be available in a system location,
be placed next to the binary as <code class="docutils literal notranslate"><span class="pre">sync-exclude.lst</span></code> or be explicitly specified
with the <code class="docutils literal notranslate"><span class="pre">--exclude</span></code> switch.</p>
<p>The required file content is one exclude item per line where wildcards are allowed, e.g.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">~*.</span><span class="n">tmp</span>
<span class="o">.</span><span class="n">_</span><span class="o">*</span>
<span class="p">]</span><span class="n">Thumbs</span><span class="o">.</span><span class="n">db</span>
<span class="p">]</span><span class="n">photothumb</span><span class="o">.</span><span class="n">db</span>
<span class="n">System</span> <span class="n">Volume</span> <span class="n">Information</span>
</pre></div>
</div>
</section>
<section id="example">
<h2>Example<a class="headerlink" href="#example" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>Synchronize a local directory to the specified directory of the f7cloud server</p></li>
</ul>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ f7cloudcmd --path /&lt;Directory_that_has_been_created&gt; /home/user/&lt;my_sync_folder&gt; \
https://&lt;username&gt;:&lt;secret&gt;@&lt;server_address&gt;
</pre></div>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="envvars.html" class="btn btn-neutral float-left" title="Environment Variables" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="accountcommand.html" class="btn btn-neutral float-right" title="Command-line Account Setup" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2016-2026 F7cloud GmbH and F7cloud contributors.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
☁️ latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>☁️ Versions</dt>
<dd style="width: 32%">
<a href="https://docs.f7cloud.com/server/latest/admin_manual"
style="color: var(--dark-link-color);"
>
latest
</a>
</dd>
<dd style="width: 32%">
<a href="https://docs.f7cloud.com/server/stable/admin_manual"
>
stable
</a>
</dd>
<dd style="width: 32%">
<a href="https://docs.f7cloud.com/server/31/admin_manual"
>
31
</a>
</dd>
<dd style="width: 32%">
<a href="https://docs.f7cloud.com/server/30/admin_manual"
>
30
</a>
</dd>
<dd style="width: 32%">
<a href="https://docs.f7cloud.com/server/29/admin_manual"
>
29
</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink