| Current Path : /usr/share/doc/nextcloud-desktop/html/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : //usr/share/doc/nextcloud-desktop/html/nextcloudcmd.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Credential Handling — Nextcloud Client Manual 2.4.0 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="nav-item nav-item-0"><a href="index.html">Client Manual</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<p>The Nextcloud Client packages contain a command line client, <code class="docutils literal notranslate"><span class="pre">nextcloudcmd</span></code>, that can
be used to synchronize Nextcloud files to client machines.</p>
<p><code class="docutils literal notranslate"><span class="pre">nextcloudcmd</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">nextcloudcmd</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">nextcloudcmd</span></code> does not repeat synchronizations on its own. It also does not
monitor for file system changes.</p>
<p>To invoke <code class="docutils literal notranslate"><span class="pre">nextcloudcmd</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">nextcloudcmd</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">nextcloudurl</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">nextcloudurl</span></code> is
the server URL.</p>
<p>Other command line switches supported by <code class="docutils literal notranslate"><span class="pre">nextcloudcmd</span></code> include the following:</p>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">--user</span></code>, <code class="docutils literal notranslate"><span class="pre">-u</span></code> <code class="docutils literal notranslate"><span class="pre">[user]</span></code></dt>
<dd>Use <code class="docutils literal notranslate"><span class="pre">user</span></code> as the login name.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--password</span></code>, <code class="docutils literal notranslate"><span class="pre">-p</span></code> <code class="docutils literal notranslate"><span class="pre">[password]</span></code></dt>
<dd>Use <code class="docutils literal notranslate"><span class="pre">password</span></code> as the password.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-n</span></code></dt>
<dd>Use <code class="docutils literal notranslate"><span class="pre">netrc</span> <span class="pre">(5)</span></code> for login.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--non-interactive</span></code></dt>
<dd>Do not prompt for questions.</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>Inhibits verbose log output.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--trust</span></code></dt>
<dd>Trust any SSL certificate, including invalid ones.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--httpproxy</span>  <span class="pre">http://[user@pass:]<server>:<port></span></code></dt>
<dd>Uses <code class="docutils literal notranslate"><span class="pre">server</span></code> as HTTP proxy.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--nonshib</span></code></dt>
<dd>Uses Non Shibboleth WebDAV Authentication</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--davpath</span> <span class="pre">[path]</span></code></dt>
<dd>Overrides the WebDAV Path with <code class="docutils literal notranslate"><span class="pre">path</span></code></dd>
<dt><code class="docutils literal notranslate"><span class="pre">--exclude</span> <span class="pre">[file]</span></code></dt>
<dd>Exclude list file</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--unsyncedfolders</span> <span class="pre">[file]</span></code></dt>
<dd>File containing the list of un-synced remote folders (selective sync)</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--max-sync-retries</span> <span class="pre">[n]</span></code></dt>
<dd>Retries maximum n times (defaults to 3)</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-h</span></code></dt>
<dd>Sync hidden files, do not ignore them</dd>
</dl>
<div class="section" id="credential-handling">
<h1>Credential Handling<a class="headerlink" href="#credential-handling" title="Permalink to this headline">¶</a></h1>
<p><code class="docutils literal notranslate"><span class="pre">nextcloudcmd</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>$ nextcloudcmd /home/user/my_sync_folder https://carla:secret@server/nextcloud/remote.php/webdav/
</pre></div>
</div>
<p>To synchronize the Nextcloud 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>$ nextcloudcmd --httpproxy http://192.168.178.1:8080 \
$HOME/media/music \
https://server/nextcloud/remote.php/webdav/Music
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">nextcloudcmd</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>
</div>
<div class="section" id="exclude-list">
<h1>Exclude List<a class="headerlink" href="#exclude-list" title="Permalink to this headline">¶</a></h1>
<p><code class="docutils literal notranslate"><span class="pre">nextcloudcmd</span></code> requires access to an exclude list file. It must either be
installed along with <code class="docutils literal notranslate"><span class="pre">nextcloudcmd</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>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Credential Handling</a></li>
<li><a class="reference internal" href="#exclude-list">Exclude List</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/nextcloudcmd.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="nav-item nav-item-0"><a href="index.html">Client Manual</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2013-2020, The Nextcloud developers.
Last updated on Mar 24, 2020.
</div>
</body>
</html>