githubmirror/rclone

MANUAL.html
72 381 строка3 MB
Nick Craig-Wood
Version v1.71.2
20 окт 2025, 15:02
20 окт 2025, 15:0284a8536
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
  <meta charset="utf-8" />
  <meta name="generator" content="pandoc" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
  <meta name="author" content="Nick Craig-Wood" />
  <title>rclone(1) User Manual</title>
  <style>
    html {
      color: #1a1a1a;
      background-color: #fdfdfd;
    }
    body {
      margin: 0 auto;
      max-width: 36em;
      padding-left: 50px;
      padding-right: 50px;
      padding-top: 50px;
      padding-bottom: 50px;
      hyphens: auto;
      overflow-wrap: break-word;
      text-rendering: optimizeLegibility;
      font-kerning: normal;
    }
    @media (max-width: 600px) {
      body {
        font-size: 0.9em;
        padding: 12px;
      }
      h1 {
        font-size: 1.8em;
      }
    }
    @media print {
      html {
        background-color: white;
      }
      body {
        background-color: transparent;
        color: black;
        font-size: 12pt;
      }
      p, h2, h3 {
        orphans: 3;
        widows: 3;
      }
      h2, h3, h4 {
        page-break-after: avoid;
      }
    }
    p {
      margin: 1em 0;
    }
    a {
      color: #1a1a1a;
    }
    a:visited {
      color: #1a1a1a;
    }
    img {
      max-width: 100%;
    }
    h1, h2, h3, h4, h5, h6 {
      margin-top: 1.4em;
    }
    h5, h6 {
      font-size: 1em;
      font-style: italic;
    }
    h6 {
      font-weight: normal;
    }
    ol, ul {
      padding-left: 1.7em;
      margin-top: 1em;
    }
    li > ol, li > ul {
      margin-top: 0;
    }
    blockquote {
      margin: 1em 0 1em 1.7em;
      padding-left: 1em;
      border-left: 2px solid #e6e6e6;
      color: #606060;
    }
    code {
      font-family: Menlo, Monaco, Consolas, 'Lucida Console', monospace;
      font-size: 85%;
      margin: 0;
      hyphens: manual;
    }
    pre {
      margin: 1em 0;
      overflow: auto;
    }
    pre code {
      padding: 0;
      overflow: visible;
      overflow-wrap: normal;
    }
    .sourceCode {
     background-color: transparent;
     overflow: visible;
    }
    hr {
      background-color: #1a1a1a;
      border: none;
      height: 1px;
      margin: 1em 0;
    }
    table {
      margin: 1em 0;
      border-collapse: collapse;
      width: 100%;
      overflow-x: auto;
      display: block;
      font-variant-numeric: lining-nums tabular-nums;
    }
    table caption {
      margin-bottom: 0.75em;
    }
    tbody {
      margin-top: 0.5em;
      border-top: 1px solid #1a1a1a;
      border-bottom: 1px solid #1a1a1a;
    }
    th {
      border-top: 1px solid #1a1a1a;
      padding: 0.25em 0.5em 0.25em 0.5em;
    }
    td {
      padding: 0.125em 0.5em 0.25em 0.5em;
    }
    header {
      margin-bottom: 4em;
      text-align: center;
    }
    #TOC li {
      list-style: none;
    }
    #TOC ul {
      padding-left: 1.3em;
    }
    #TOC > ul {
      padding-left: 0;
    }
    #TOC a:not(:hover) {
      text-decoration: none;
    }
    code{white-space: pre-wrap;}
    span.smallcaps{font-variant: small-caps;}
    div.columns{display: flex; gap: min(4vw, 1.5em);}
    div.column{flex: auto; overflow-x: auto;}
    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
    /* The extra [class] is a hack that increases specificity enough to
       override a similar rule in reveal.js */
    ul.task-list[class]{list-style: none;}
    ul.task-list li input[type="checkbox"] {
      font-size: inherit;
      width: 0.8em;
      margin: 0 0.8em 0.2em -1.6em;
      vertical-align: middle;
    }
    .display.math{display: block; text-align: center; margin: 0.5rem auto;}
    /* CSS for syntax highlighting */
    pre > code.sourceCode { white-space: pre; position: relative; }
    pre > code.sourceCode > span { line-height: 1.25; }
    pre > code.sourceCode > span:empty { height: 1.2em; }
    .sourceCode { overflow: visible; }
    code.sourceCode > span { color: inherit; text-decoration: inherit; }
    div.sourceCode { margin: 1em 0; }
    pre.sourceCode { margin: 0; }
    @media screen {
    div.sourceCode { overflow: auto; }
    }
    @media print {
    pre > code.sourceCode { white-space: pre-wrap; }
    pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
    }
    pre.numberSource code
      { counter-reset: source-line 0; }
    pre.numberSource code > span
      { position: relative; left: -4em; counter-increment: source-line; }
    pre.numberSource code > span > a:first-child::before
      { content: counter(source-line);
        position: relative; left: -1em; text-align: right; vertical-align: baseline;
        border: none; display: inline-block;
        -webkit-touch-callout: none; -webkit-user-select: none;
        -khtml-user-select: none; -moz-user-select: none;
        -ms-user-select: none; user-select: none;
        padding: 0 4px; width: 4em;
        color: #aaaaaa;
      }
    pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa;  padding-left: 4px; }
    div.sourceCode
      {   }
    @media screen {
    pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
    }
    code span.al { color: #ff0000; font-weight: bold; } /* Alert */
    code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
    code span.at { color: #7d9029; } /* Attribute */
    code span.bn { color: #40a070; } /* BaseN */
    code span.bu { color: #008000; } /* BuiltIn */
    code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
    code span.ch { color: #4070a0; } /* Char */
    code span.cn { color: #880000; } /* Constant */
    code span.co { color: #60a0b0; font-style: italic; } /* Comment */
    code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
    code span.do { color: #ba2121; font-style: italic; } /* Documentation */
    code span.dt { color: #902000; } /* DataType */
    code span.dv { color: #40a070; } /* DecVal */
    code span.er { color: #ff0000; font-weight: bold; } /* Error */
    code span.ex { } /* Extension */
    code span.fl { color: #40a070; } /* Float */
    code span.fu { color: #06287e; } /* Function */
    code span.im { color: #008000; font-weight: bold; } /* Import */
    code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
    code span.kw { color: #007020; font-weight: bold; } /* Keyword */
    code span.op { color: #666666; } /* Operator */
    code span.ot { color: #007020; } /* Other */
    code span.pp { color: #bc7a00; } /* Preprocessor */
    code span.sc { color: #4070a0; } /* SpecialChar */
    code span.ss { color: #bb6688; } /* SpecialString */
    code span.st { color: #4070a0; } /* String */
    code span.va { color: #19177c; } /* Variable */
    code span.vs { color: #4070a0; } /* VerbatimString */
    code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
  </style>
</head>
<body>
<header id="title-block-header">
<h1 class="title">rclone(1) User Manual</h1>
<p class="author">Nick Craig-Wood</p>
<p class="date">Oct 20, 2025</p>
</header>
<h1 id="name">NAME</h1>
<p>rclone - manage files on cloud storage</p>
<h1 id="synopsis">SYNOPSIS</h1>
<pre><code>Usage:
  rclone [flags]
  rclone [command]

Available commands:
  about       Get quota information from the remote.
  authorize   Remote authorization.
  backend     Run a backend-specific command.
  bisync      Perform bidirectional synchronization between two paths.
  cat         Concatenates any files and sends them to stdout.
  check       Checks the files in the source and destination match.
  checksum    Checks the files in the destination against a SUM file.
  cleanup     Clean up the remote if possible.
  completion  Output completion script for a given shell.
  config      Enter an interactive configuration session.
  convmv      Convert file and directory names in place.
  copy        Copy files from source to dest, skipping identical files.
  copyto      Copy files from source to dest, skipping identical files.
  copyurl     Copy the contents of the URL supplied content to dest:path.
  cryptcheck  Cryptcheck checks the integrity of an encrypted remote.
  cryptdecode Cryptdecode returns unencrypted file names.
  dedupe      Interactively find duplicate filenames and delete/rename them.
  delete      Remove the files in path.
  deletefile  Remove a single file from remote.
  gendocs     Output markdown docs for rclone to the directory supplied.
  gitannex    Speaks with git-annex over stdin/stdout.
  hashsum     Produces a hashsum file for all the objects in the path.
  help        Show help for rclone commands, flags and backends.
  link        Generate public link to file/folder.
  listremotes List all the remotes in the config file and defined in environment variables.
  ls          List the objects in the path with size and path.
  lsd         List all directories/containers/buckets in the path.
  lsf         List directories and objects in remote:path formatted for parsing.
  lsjson      List directories and objects in the path in JSON format.
  lsl         List the objects in path with modification time, size and path.
  md5sum      Produces an md5sum file for all the objects in the path.
  mkdir       Make the path if it doesn&#39;t already exist.
  mount       Mount the remote as file system on a mountpoint.
  move        Move files from source to dest.
  moveto      Move file or directory from source to dest.
  ncdu        Explore a remote with a text based user interface.
  nfsmount    Mount the remote as file system on a mountpoint.
  obscure     Obscure password for use in the rclone config file.
  purge       Remove the path and all of its contents.
  rc          Run a command against a running rclone.
  rcat        Copies standard input to file on remote.
  rcd         Run rclone listening to remote control commands only.
  rmdir       Remove the empty directory at path.
  rmdirs      Remove empty directories under the path.
  selfupdate  Update the rclone binary.
  serve       Serve a remote over a protocol.
  settier     Changes storage class/tier of objects in remote.
  sha1sum     Produces an sha1sum file for all the objects in the path.
  size        Prints the total size and number of objects in remote:path.
  sync        Make source and dest identical, modifying destination only.
  test        Run a test command
  touch       Create new file or change file modification time.
  tree        List the contents of the remote in a tree like fashion.
  version     Show the version number.

Use &quot;rclone [command] --help&quot; for more information about a command.
Use &quot;rclone help flags&quot; for to see the global flags.
Use &quot;rclone help backends&quot; for a list of supported services.
</code></pre>
<h1 id="rclone-syncs-your-files-to-cloud-storage">Rclone syncs your
files to cloud storage</h1>
<p><img width="50%" src="https://rclone.org/img/logo_on_light__horizontal_color.svg" alt="rclone logo" style="float:right; padding: 5px;" ></p>
<ul>
<li><a href="#about">About rclone</a></li>
<li><a href="#what">What can rclone do for you?</a></li>
<li><a href="#features">What features does rclone have?</a></li>
<li><a href="#providers">What providers does rclone support?</a></li>
<li><a href="https://rclone.org/downloads/">Download</a></li>
<li><a href="https://rclone.org/install/">Install</a></li>
<li><a href="https://rclone.org/donate/">Donate.</a></li>
</ul>
<h2 id="about">About rclone</h2>
<p>Rclone is a command-line program to manage files on cloud storage. It
is a feature-rich alternative to cloud vendors' web storage interfaces.
<a href="#providers">Over 70 cloud storage products</a> support rclone
including S3 object stores, business &amp; consumer file storage
services, as well as standard transfer protocols.</p>
<p>Rclone has powerful cloud equivalents to the unix commands rsync, cp,
mv, mount, ls, ncdu, tree, rm, and cat. Rclone's familiar syntax
includes shell pipeline support, and <code>--dry-run</code> protection.
It is used at the command line, in scripts or via its <a
href="/rc">API</a>.</p>
<p>Users call rclone <em>"The Swiss army knife of cloud storage"</em>,
and <em>"Technology indistinguishable from magic"</em>.</p>
<p>Rclone really looks after your data. It preserves timestamps and
verifies checksums at all times. Transfers over limited bandwidth;
intermittent connections, or subject to quota can be restarted, from the
last good file transferred. You can <a
href="https://rclone.org/commands/rclone_check/">check</a> the integrity
of your files. Where possible, rclone employs server-side transfers to
minimise local bandwidth use and transfers from one provider to another
without using local disk.</p>
<p>Virtual backends wrap local and cloud file systems to apply <a
href="https://rclone.org/crypt/">encryption</a>, <a
href="https://rclone.org/compress/">compression</a>, <a
href="https://rclone.org/chunker/">chunking</a>, <a
href="https://rclone.org/hasher/">hashing</a> and <a
href="https://rclone.org/union/">joining</a>.</p>
<p>Rclone <a href="https://rclone.org/commands/rclone_mount/">mounts</a>
any local, cloud or virtual filesystem as a disk on Windows, macOS,
linux and FreeBSD, and also serves these over <a
href="https://rclone.org/commands/rclone_serve_sftp/">SFTP</a>, <a
href="https://rclone.org/commands/rclone_serve_http/">HTTP</a>, <a
href="https://rclone.org/commands/rclone_serve_webdav/">WebDAV</a>, <a
href="https://rclone.org/commands/rclone_serve_ftp/">FTP</a> and <a
href="https://rclone.org/commands/rclone_serve_dlna/">DLNA</a>.</p>
<p>Rclone is mature, open-source software originally inspired by rsync
and written in <a href="https://golang.org">Go</a>. The friendly support
community is familiar with varied use cases. Official Ubuntu, Debian,
Fedora, Brew and Chocolatey repos. include rclone. For the latest
version <a href="https://rclone.org/downloads/">downloading from
rclone.org</a> is recommended.</p>
<p>Rclone is widely used on Linux, Windows and Mac. Third-party
developers create innovative backup, restore, GUI and business process
solutions using the rclone command line or API.</p>
<p>Rclone does the heavy lifting of communicating with cloud
storage.</p>
<h2 id="what">What can rclone do for you?</h2>
<p>Rclone helps you:</p>
<ul>
<li>Backup (and encrypt) files to cloud storage</li>
<li>Restore (and decrypt) files from cloud storage</li>
<li>Mirror cloud data to other cloud services or locally</li>
<li>Migrate data to the cloud, or between cloud storage vendors</li>
<li>Mount multiple, encrypted, cached or diverse cloud storage as a
disk</li>
<li>Analyse and account for data held on cloud storage using <a
href="https://rclone.org/commands/rclone_lsf/">lsf</a>, <a
href="https://rclone.org/commands/rclone_lsjson/">ljson</a>, <a
href="https://rclone.org/commands/rclone_size/">size</a>, <a
href="https://rclone.org/commands/rclone_ncdu/">ncdu</a></li>
<li><a href="https://rclone.org/union/">Union</a> file systems together
to present multiple local and/or cloud file systems as one</li>
</ul>
<h2 id="features">Features</h2>
<ul>
<li>Transfers
<ul>
<li>MD5, SHA1 hashes are checked at all times for file integrity</li>
<li>Timestamps are preserved on files</li>
<li>Operations can be restarted at any time</li>
<li>Can be to and from network, e.g. two different cloud providers</li>
<li>Can use multi-threaded downloads to local disk</li>
</ul></li>
<li><a href="https://rclone.org/commands/rclone_copy/">Copy</a> new or
changed files to cloud storage</li>
<li><a href="https://rclone.org/commands/rclone_sync/">Sync</a> (one
way) to make a directory identical</li>
<li><a href="https://rclone.org/bisync/">Bisync</a> (two way) to keep
two directories in sync bidirectionally</li>
<li><a href="https://rclone.org/commands/rclone_move/">Move</a> files to
cloud storage deleting the local after verification</li>
<li><a href="https://rclone.org/commands/rclone_check/">Check</a> hashes
and for missing/extra files</li>
<li><a href="https://rclone.org/commands/rclone_mount/">Mount</a> your
cloud storage as a network disk</li>
<li><a href="https://rclone.org/commands/rclone_serve/">Serve</a> local
or remote files over <a
href="https://rclone.org/commands/rclone_serve_http/">HTTP</a>/<a
href="https://rclone.org/commands/rclone_serve_webdav/">WebDav</a>/<a
href="https://rclone.org/commands/rclone_serve_ftp/">FTP</a>/<a
href="https://rclone.org/commands/rclone_serve_sftp/">SFTP</a>/<a
href="https://rclone.org/commands/rclone_serve_dlna/">DLNA</a></li>
<li>Experimental <a href="https://rclone.org/gui/">Web based
GUI</a></li>
</ul>
<h2 id="providers">Supported providers</h2>
<p>(There are many others, built on standard protocols such as WebDAV or
S3, that work out of the box.)</p>
<ul>
<li>1Fichier</li>
<li>Akamai Netstorage</li>
<li>Alibaba Cloud (Aliyun) Object Storage System (OSS)</li>
<li>Amazon S3</li>
<li>Backblaze B2</li>
<li>Box</li>
<li>Ceph</li>
<li>China Mobile Ecloud Elastic Object Storage (EOS)</li>
<li>Arvan Cloud Object Storage (AOS)</li>
<li>Citrix ShareFile</li>
<li>Cloudflare R2</li>
<li>Cloudinary</li>
<li>DigitalOcean Spaces</li>
<li>Digi Storage</li>
<li>Dreamhost</li>
<li>Dropbox</li>
<li>Enterprise File Fabric</li>
<li>Exaba</li>
<li>Fastmail Files</li>
<li>FileLu Cloud Storage</li>
<li>Files.com</li>
<li>FlashBlade</li>
<li>FTP</li>
<li>Gofile</li>
<li>Google Cloud Storage</li>
<li>Google Drive</li>
<li>Google Photos</li>
<li>HDFS</li>
<li>Hetzner Storage Box</li>
<li>HiDrive</li>
<li>HTTP</li>
<li>Huawei OBS</li>
<li>iCloud Drive</li>
<li>ImageKit</li>
<li>Internet Archive</li>
<li>Jottacloud</li>
<li>IBM COS S3</li>
<li>IDrive e2</li>
<li>IONOS Cloud</li>
<li>Koofr</li>
<li>Leviia Object Storage</li>
<li>Liara Object Storage</li>
<li>Linkbox</li>
<li>Linode Object Storage</li>
<li>Magalu</li>
<li>Mail.ru Cloud</li>
<li>Memset Memstore</li>
<li>MEGA</li>
<li>MEGA S4</li>
<li>Memory</li>
<li>Microsoft Azure Blob Storage</li>
<li>Microsoft Azure Files Storage</li>
<li>Microsoft OneDrive</li>
<li>Minio</li>
<li>Nextcloud</li>
<li>Blomp Cloud Storage</li>
<li>OpenDrive</li>
<li>OpenStack Swift</li>
<li>Oracle Cloud Storage Swift</li>
<li>Oracle Object Storage</li>
<li>Outscale</li>
<li>OVHcloud Object Storage (Swift)</li>
<li>OVHcloud Object Storage (S3-compatible)</li>
<li>ownCloud</li>
<li>pCloud</li>
<li>Petabox</li>
<li>PikPak</li>
<li>Pixeldrain</li>
<li>premiumize.me</li>
<li>put.io</li>
<li>Proton Drive</li>
<li>QingStor</li>
<li>Qiniu Cloud Object Storage (Kodo)</li>
<li>Quatrix by Maytech</li>
<li>RackCorp Object Storage</li>
<li>Rackspace Cloud Files</li>
<li>Rclone Serve S3</li>
<li>rsync.net</li>
<li>Scaleway</li>
<li>Seafile</li>
<li>Seagate Lyve Cloud</li>
<li>SeaweedFS</li>
<li>Selectel</li>
<li>SFTP</li>
<li>Sia</li>
<li>SMB / CIFS</li>
<li>StackPath</li>
<li>Storj</li>
<li>Synology</li>
<li>SugarSync</li>
<li>Tencent Cloud Object Storage (COS)</li>
<li>Uloz.to</li>
<li>Uptobox</li>
<li>Wasabi</li>
<li>WebDAV</li>
<li>Yandex Disk</li>
<li>Zoho WorkDrive</li>
<li>Zata</li>
<li>The local filesystem</li>
</ul>
<h2 id="virtual-providers">Virtual providers</h2>
<p>These backends adapt or modify other storage providers:</p>
<ul>
<li>Alias: Rename existing remotes</li>
<li>Cache: Cache remotes (DEPRECATED)</li>
<li>Chunker: Split large files</li>
<li>Combine: Combine multiple remotes into a directory tree</li>
<li>Compress: Compress files</li>
<li>Crypt: Encrypt files</li>
<li>Hasher: Hash files</li>
<li>Union: Join multiple remotes to work together</li>
</ul>
<h2 id="links">Links</h2>
<ul>
<li><a href="https://rclone.org/">Home page</a></li>
<li><a href="https://github.com/rclone/rclone">GitHub project page for
source and bug tracker</a></li>
<li><a href="https://forum.rclone.org">Rclone Forum</a></li>
<li><a href="https://rclone.org/downloads/">Downloads</a></li>
</ul>
<h1 id="install">Install</h1>
<p>Rclone is a Go program and comes as a single binary file.</p>
<h2 id="quickstart">Quickstart</h2>
<ul>
<li><a href="https://rclone.org/downloads/">Download</a> the relevant
binary.</li>
<li>Extract the <code>rclone</code> executable, <code>rclone.exe</code>
on Windows, from the archive.</li>
<li>Run <code>rclone config</code> to setup. See <a
href="https://rclone.org/docs/">rclone config docs</a> for more
details.</li>
<li>Optionally configure <a href="#autostart">automatic
execution</a>.</li>
</ul>
<p>See below for some expanded Linux / macOS / Windows instructions.</p>
<p>See the <a href="https://rclone.org/docs/">usage</a> docs for how to
use rclone, or run <code>rclone -h</code>.</p>
<p>Already installed rclone can be easily updated to the latest version
using the <a
href="https://rclone.org/commands/rclone_selfupdate/">rclone
selfupdate</a> command.</p>
<p>See <a href="https://rclone.org/release_signing/">the release signing
docs</a> for how to verify signatures on the release.</p>
<h2 id="script-installation">Script installation</h2>
<p>To install rclone on Linux/macOS/BSD systems, run:</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> <span class="at">-v</span> <span class="kw">;</span> <span class="ex">curl</span> https://rclone.org/install.sh <span class="kw">|</span> <span class="fu">sudo</span> bash</span></code></pre></div>
<p>For beta installation, run:</p>
<div class="sourceCode" id="cb3"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> <span class="at">-v</span> <span class="kw">;</span> <span class="ex">curl</span> https://rclone.org/install.sh <span class="kw">|</span> <span class="fu">sudo</span> bash <span class="at">-s</span> beta</span></code></pre></div>
<p>Note that this script checks the version of rclone installed first
and won't re-download if not needed.</p>
<h2 id="linux">Linux installation</h2>
<h3 id="linux-precompiled">Precompiled binary</h3>
<p>Fetch and unpack</p>
<div class="sourceCode" id="cb4"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">curl</span> <span class="at">-O</span> https://downloads.rclone.org/rclone-current-linux-amd64.zip</span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="fu">unzip</span> rclone-current-linux-amd64.zip</span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> rclone-<span class="pp">*</span>-linux-amd64</span></code></pre></div>
<p>Copy binary file</p>
<div class="sourceCode" id="cb5"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> cp rclone /usr/bin/</span>
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> chown root:root /usr/bin/rclone</span>
<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> chmod 755 /usr/bin/rclone</span></code></pre></div>
<p>Install manpage</p>
<div class="sourceCode" id="cb6"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> mkdir <span class="at">-p</span> /usr/local/share/man/man1</span>
<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> cp rclone.1 /usr/local/share/man/man1/</span>
<span id="cb6-3"><a href="#cb6-3" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> mandb</span></code></pre></div>
<p>Run <code>rclone config</code> to setup. See <a
href="https://rclone.org/docs/">rclone config docs</a> for more
details.</p>
<div class="sourceCode" id="cb7"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<h2 id="macos">macOS installation</h2>
<h3 id="macos-brew">Installation with brew</h3>
<div class="sourceCode" id="cb8"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="ex">brew</span> install rclone</span></code></pre></div>
<p>NOTE: This version of rclone will not support <code>mount</code> any
more (see <a
href="https://github.com/rclone/rclone/issues/5373">#5373</a>). If
mounting is wanted on macOS, either install a precompiled binary or
enable the relevant option when <a href="#source">installing from
source</a>.</p>
<p>Note that this is a third party installer not controlled by the
rclone developers so it may be out of date. Its current version is as
below.</p>
<p><a href="https://repology.org/project/rclone/versions"><img
src="https://repology.org/badge/version-for-repo/homebrew/rclone.svg"
alt="Homebrew package" /></a></p>
<h3 id="macos-macports">Installation with MacPorts</h3>
<p>On macOS, rclone can also be installed via <a
href="https://www.macports.org">MacPorts</a>:</p>
<div class="sourceCode" id="cb9"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> port install rclone</span></code></pre></div>
<p>Note that this is a third party installer not controlled by the
rclone developers so it may be out of date. Its current version is as
below.</p>
<p><a href="https://repology.org/project/rclone/versions"><img
src="https://repology.org/badge/version-for-repo/macports/rclone.svg"
alt="MacPorts port" /></a></p>
<p>More information on <a
href="https://ports.macports.org/port/rclone/">macports.org</a>.</p>
<h3 id="macos-precompiled">Precompiled binary, using curl</h3>
<p>To avoid problems with macOS gatekeeper enforcing the binary to be
signed and notarized it is enough to download with
<code>curl</code>.</p>
<p>Download the latest version of rclone.</p>
<div class="sourceCode" id="cb10"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> <span class="kw">&amp;&amp;</span> <span class="ex">curl</span> <span class="at">-O</span> https://downloads.rclone.org/rclone-current-osx-amd64.zip</span></code></pre></div>
<p>Unzip the download and cd to the extracted folder.</p>
<div class="sourceCode" id="cb11"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="fu">unzip</span> <span class="at">-a</span> rclone-current-osx-amd64.zip <span class="kw">&amp;&amp;</span> <span class="bu">cd</span> rclone-<span class="pp">*</span>-osx-amd64</span></code></pre></div>
<p>Move rclone to your $PATH. You will be prompted for your
password.</p>
<div class="sourceCode" id="cb12"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> mkdir <span class="at">-p</span> /usr/local/bin</span>
<span id="cb12-2"><a href="#cb12-2" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> mv rclone /usr/local/bin/</span></code></pre></div>
<p>(the <code>mkdir</code> command is safe to run, even if the directory
already exists).</p>
<p>Remove the leftover files.</p>
<div class="sourceCode" id="cb13"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> .. <span class="kw">&amp;&amp;</span> <span class="fu">rm</span> <span class="at">-rf</span> rclone-<span class="pp">*</span>-osx-amd64 rclone-current-osx-amd64.zip</span></code></pre></div>
<p>Run <code>rclone config</code> to setup. See <a
href="https://rclone.org/docs/">rclone config docs</a> for more
details.</p>
<div class="sourceCode" id="cb14"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<h3 id="macos-precompiled-web">Precompiled binary, using a web
browser</h3>
<p>When downloading a binary with a web browser, the browser will set
the macOS gatekeeper quarantine attribute. Starting from Catalina, when
attempting to run <code>rclone</code>, a pop-up will appear saying:</p>
<div class="sourceCode" id="cb15"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a><span class="st">&quot;rclone&quot;</span> cannot be opened because the developer cannot be verified.</span>
<span id="cb15-2"><a href="#cb15-2" aria-hidden="true" tabindex="-1"></a><span class="ex">macOS</span> cannot verify that this app is free from malware.</span></code></pre></div>
<p>The simplest fix is to run</p>
<div class="sourceCode" id="cb16"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a><span class="ex">xattr</span> <span class="at">-d</span> com.apple.quarantine rclone</span></code></pre></div>
<h2 id="windows">Windows installation</h2>
<h3 id="windows-precompiled">Precompiled binary</h3>
<p>Fetch the correct binary for your processor type by clicking on these
links. If not sure, use the first link.</p>
<ul>
<li><a
href="https://downloads.rclone.org/rclone-current-windows-amd64.zip">Intel/AMD
- 64 Bit</a></li>
<li><a
href="https://downloads.rclone.org/rclone-current-windows-386.zip">Intel/AMD
- 32 Bit</a></li>
<li><a
href="https://downloads.rclone.org/rclone-current-windows-arm64.zip">ARM
- 64 Bit</a></li>
</ul>
<p>Open this file in the Explorer and extract <code>rclone.exe</code>.
Rclone is a portable executable so you can place it wherever is
convenient.</p>
<p>Open a CMD window (or powershell) and run the binary. Note that
rclone does not launch a GUI by default, it runs in the CMD Window.</p>
<ul>
<li>Run <code>rclone.exe config</code> to setup. See <a
href="https://rclone.org/docs/">rclone config docs</a> for more
details.</li>
<li>Optionally configure <a href="#autostart">automatic
execution</a>.</li>
</ul>
<p>If you are planning to use the <a
href="https://rclone.org/commands/rclone_mount/">rclone mount</a>
feature then you will need to install the third party utility <a
href="https://winfsp.dev/">WinFsp</a> also.</p>
<h3 id="windows-chocolatey">Windows package manager (Winget)</h3>
<p><a
href="https://learn.microsoft.com/en-us/windows/package-manager/">Winget</a>
comes pre-installed with the latest versions of Windows. If not, update
the <a href="https://www.microsoft.com/p/app-installer/9nblggh4nns1">App
Installer</a> package from the Microsoft store.</p>
<p>To install rclone</p>
<div class="sourceCode" id="cb17"><pre
class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a>winget install Rclone.Rclone</span></code></pre></div>
<p>To uninstall rclone</p>
<div class="sourceCode" id="cb18"><pre
class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true" tabindex="-1"></a>winget uninstall Rclone.Rclone -<span class="at">-force</span></span></code></pre></div>
<h3 id="windows-chocolatey">Chocolatey package manager</h3>
<p>Make sure you have <a href="https://chocolatey.org/">Choco</a>
installed</p>
<div class="sourceCode" id="cb19"><pre
class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true" tabindex="-1"></a>choco search rclone</span>
<span id="cb19-2"><a href="#cb19-2" aria-hidden="true" tabindex="-1"></a>choco install rclone</span></code></pre></div>
<p>This will install rclone on your Windows machine. If you are planning
to use <a href="https://rclone.org/commands/rclone_mount/">rclone
mount</a> then</p>
<div class="sourceCode" id="cb20"><pre
class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true" tabindex="-1"></a>choco install winfsp</span></code></pre></div>
<p>will install that too.</p>
<p>Note that this is a third party installer not controlled by the
rclone developers so it may be out of date. Its current version is as
below.</p>
<p><a href="https://repology.org/project/rclone/versions"><img
src="https://repology.org/badge/version-for-repo/chocolatey/rclone.svg"
alt="Chocolatey package" /></a></p>
<h3 id="windows-scoop">Scoop package manager</h3>
<p>Make sure you have <a href="https://scoop.sh/">Scoop</a>
installed</p>
<div class="sourceCode" id="cb21"><pre
class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true" tabindex="-1"></a>scoop install rclone</span></code></pre></div>
<p>Note that this is a third party installer not controlled by the
rclone developers so it may be out of date. Its current version is as
below.</p>
<p><a href="https://repology.org/project/rclone/versions"><img
src="https://repology.org/badge/version-for-repo/scoop/rclone.svg"
alt="Scoop package" /></a></p>
<h2 id="package-manager">Package manager installation</h2>
<p>Many Linux, Windows, macOS and other OS distributions package and
distribute rclone.</p>
<p>The distributed versions of rclone are often quite out of date and
for this reason we recommend one of the other installation methods if
possible.</p>
<p>You can get an idea of how up to date or not your OS distribution's
package is here.</p>
<p><a href="https://repology.org/project/rclone/versions"><img
src="https://repology.org/badge/vertical-allrepos/rclone.svg?columns=3"
alt="Packaging status" /></a></p>
<h2 id="docker">Docker installation</h2>
<p>The rclone developers maintain a <a
href="https://hub.docker.com/r/rclone/rclone">docker image for
rclone</a>.</p>
<p><strong>Note:</strong> We also now offer a paid version of rclone
with enterprise-grade security and zero CVEs through our partner <a
href="https://securebuild.com/blog/introducing-securebuild">SecureBuild</a>.
If you are interested, check out their website and the <a
href="https://securebuild.com/images/rclone">Rclone SecureBuild
Image</a>.</p>
<p>These images are built as part of the release process based on a
minimal Alpine Linux.</p>
<p>The <code>:latest</code> tag will always point to the latest stable
release. You can use the <code>:beta</code> tag to get the latest build
from master. You can also use version tags, e.g. <code>:1.49.1</code>,
<code>:1.49</code> or <code>:1</code>.</p>
<div class="sourceCode" id="cb22"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb22-1"><a href="#cb22-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> docker pull rclone/rclone:latest</span>
<span id="cb22-2"><a href="#cb22-2" aria-hidden="true" tabindex="-1"></a><span class="ex">latest:</span> Pulling from rclone/rclone</span>
<span id="cb22-3"><a href="#cb22-3" aria-hidden="true" tabindex="-1"></a><span class="ex">Digest:</span> sha256:0e0ced72671989bb837fea8e88578b3fc48371aa45d209663683e24cfdaa0e11</span>
<span id="cb22-4"><a href="#cb22-4" aria-hidden="true" tabindex="-1"></a><span class="ex">...</span></span>
<span id="cb22-5"><a href="#cb22-5" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> docker run <span class="at">--rm</span> rclone/rclone:latest version</span>
<span id="cb22-6"><a href="#cb22-6" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> v1.49.1</span>
<span id="cb22-7"><a href="#cb22-7" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> os/arch: linux/amd64</span>
<span id="cb22-8"><a href="#cb22-8" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> go version: go1.12.9</span></code></pre></div>
<p>There are a few command line options to consider when starting an
rclone Docker container from the rclone image.</p>
<ul>
<li><p>You need to mount the host rclone config dir at
<code>/config/rclone</code> into the Docker container. Due to the fact
that rclone updates tokens inside its config file, and that the update
process involves a file rename, you need to mount the whole host rclone
config dir, not just the single host rclone config file.</p></li>
<li><p>You need to mount a host data dir at <code>/data</code> into the
Docker container.</p></li>
<li><p>By default, the rclone binary inside a Docker container runs with
UID=0 (root). As a result, all files created in a run will have UID=0.
If your config and data files reside on the host with a non-root
UID:GID, you need to pass these on the container start command
line.</p></li>
<li><p>If you want to access the RC interface (either via the API or the
Web UI), it is required to set the <code>--rc-addr</code> to
<code>:5572</code> in order to connect to it from outside the container.
An explanation about why this is necessary can be found in an old <a
href="https://web.archive.org/web/20200808071950/https://pythonspeed.com/articles/docker-connection-refused/">pythonspeed.com</a>
article.</p>
<ul>
<li>NOTE: Users running this container with the docker network set to
<code>host</code> should probably set it to listen to localhost only,
with <code>127.0.0.1:5572</code> as the value for
<code>--rc-addr</code></li>
</ul></li>
<li><p>It is possible to use <code>rclone mount</code> inside a
userspace Docker container, and expose the resulting fuse mount to the
host. The exact <code>docker run</code> options to do that might vary
slightly between hosts. See, e.g. the discussion in this <a
href="https://github.com/moby/moby/issues/9448">thread</a>.</p>
<p>You also need to mount the host <code>/etc/passwd</code> and
<code>/etc/group</code> for fuse to work inside the container.</p></li>
</ul>
<p>Here are some commands tested on an Ubuntu 18.04.3 host:</p>
<div class="sourceCode" id="cb23"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb23-1"><a href="#cb23-1" aria-hidden="true" tabindex="-1"></a><span class="co"># config on host at ~/.config/rclone/rclone.conf</span></span>
<span id="cb23-2"><a href="#cb23-2" aria-hidden="true" tabindex="-1"></a><span class="co"># data on host at ~/data</span></span>
<span id="cb23-3"><a href="#cb23-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb23-4"><a href="#cb23-4" aria-hidden="true" tabindex="-1"></a><span class="co"># add a remote interactively</span></span>
<span id="cb23-5"><a href="#cb23-5" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> run <span class="at">--rm</span> <span class="at">-it</span> <span class="dt">\</span></span>
<span id="cb23-6"><a href="#cb23-6" aria-hidden="true" tabindex="-1"></a>    <span class="at">--volume</span> ~/.config/rclone:/config/rclone <span class="dt">\</span></span>
<span id="cb23-7"><a href="#cb23-7" aria-hidden="true" tabindex="-1"></a>    <span class="at">--user</span> <span class="va">$(</span><span class="fu">id</span> <span class="at">-u</span><span class="va">)</span>:<span class="va">$(</span><span class="fu">id</span> <span class="at">-g</span><span class="va">)</span> <span class="dt">\</span></span>
<span id="cb23-8"><a href="#cb23-8" aria-hidden="true" tabindex="-1"></a>    rclone/rclone <span class="dt">\</span></span>
<span id="cb23-9"><a href="#cb23-9" aria-hidden="true" tabindex="-1"></a>    config</span>
<span id="cb23-10"><a href="#cb23-10" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb23-11"><a href="#cb23-11" aria-hidden="true" tabindex="-1"></a><span class="co"># make sure the config is ok by listing the remotes</span></span>
<span id="cb23-12"><a href="#cb23-12" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> run <span class="at">--rm</span> <span class="dt">\</span></span>
<span id="cb23-13"><a href="#cb23-13" aria-hidden="true" tabindex="-1"></a>    <span class="at">--volume</span> ~/.config/rclone:/config/rclone <span class="dt">\</span></span>
<span id="cb23-14"><a href="#cb23-14" aria-hidden="true" tabindex="-1"></a>    <span class="at">--user</span> <span class="va">$(</span><span class="fu">id</span> <span class="at">-u</span><span class="va">)</span>:<span class="va">$(</span><span class="fu">id</span> <span class="at">-g</span><span class="va">)</span> <span class="dt">\</span></span>
<span id="cb23-15"><a href="#cb23-15" aria-hidden="true" tabindex="-1"></a>    rclone/rclone <span class="dt">\</span></span>
<span id="cb23-16"><a href="#cb23-16" aria-hidden="true" tabindex="-1"></a>    listremotes</span>
<span id="cb23-17"><a href="#cb23-17" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb23-18"><a href="#cb23-18" aria-hidden="true" tabindex="-1"></a><span class="co"># perform mount inside Docker container, expose result to host</span></span>
<span id="cb23-19"><a href="#cb23-19" aria-hidden="true" tabindex="-1"></a><span class="fu">mkdir</span> <span class="at">-p</span> ~/data/mount</span>
<span id="cb23-20"><a href="#cb23-20" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> run <span class="at">--rm</span> <span class="dt">\</span></span>
<span id="cb23-21"><a href="#cb23-21" aria-hidden="true" tabindex="-1"></a>    <span class="at">--volume</span> ~/.config/rclone:/config/rclone <span class="dt">\</span></span>
<span id="cb23-22"><a href="#cb23-22" aria-hidden="true" tabindex="-1"></a>    <span class="at">--volume</span> ~/data:/data:shared <span class="dt">\</span></span>
<span id="cb23-23"><a href="#cb23-23" aria-hidden="true" tabindex="-1"></a>    <span class="at">--user</span> <span class="va">$(</span><span class="fu">id</span> <span class="at">-u</span><span class="va">)</span>:<span class="va">$(</span><span class="fu">id</span> <span class="at">-g</span><span class="va">)</span> <span class="dt">\</span></span>
<span id="cb23-24"><a href="#cb23-24" aria-hidden="true" tabindex="-1"></a>    <span class="at">--volume</span> /etc/passwd:/etc/passwd:ro <span class="at">--volume</span> /etc/group:/etc/group:ro <span class="dt">\</span></span>
<span id="cb23-25"><a href="#cb23-25" aria-hidden="true" tabindex="-1"></a>    <span class="at">--device</span> /dev/fuse <span class="at">--cap-add</span> SYS_ADMIN <span class="at">--security-opt</span> apparmor:unconfined <span class="dt">\</span></span>
<span id="cb23-26"><a href="#cb23-26" aria-hidden="true" tabindex="-1"></a>    rclone/rclone <span class="dt">\</span></span>
<span id="cb23-27"><a href="#cb23-27" aria-hidden="true" tabindex="-1"></a>    mount dropbox:Photos /data/mount <span class="kw">&amp;</span></span>
<span id="cb23-28"><a href="#cb23-28" aria-hidden="true" tabindex="-1"></a><span class="fu">ls</span> ~/data/mount</span>
<span id="cb23-29"><a href="#cb23-29" aria-hidden="true" tabindex="-1"></a><span class="bu">kill</span> %1</span></code></pre></div>
<h2 id="snap">Snap installation</h2>
<p><a href="https://snapcraft.io/rclone"><img
src="https://snapcraft.io/static/images/badges/en/snap-store-black.svg"
alt="Get it from the Snap Store" /></a></p>
<p>Make sure you have <a
href="https://snapcraft.io/docs/installing-snapd">Snapd
installed</a></p>
<div class="sourceCode" id="cb24"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb24-1"><a href="#cb24-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> snap install rclone</span></code></pre></div>
<p>Due to the strict confinement of Snap, rclone snap cannot access real
<code>/home/$USER/.config/rclone</code> directory, default config path
is as below.</p>
<ul>
<li>Default config directory:
<ul>
<li>/home/$USER/snap/rclone/current/.config/rclone</li>
</ul></li>
</ul>
<p>Note: Due to the strict confinement of Snap,
<code>rclone mount</code> feature is <code>not</code> supported.</p>
<p>If mounting is wanted, either install a precompiled binary or enable
the relevant option when <a href="#source">installing from
source</a>.</p>
<p>Note that this is controlled by <a
href="https://github.com/boukendesho/rclone-snap">community
maintainer</a> not the rclone developers so it may be out of date. Its
current version is as below.</p>
<p><a href="https://snapcraft.io/rclone"><img
src="https://snapcraft.io/rclone/badge.svg" alt="rclone" /></a></p>
<h2 id="source">Source installation</h2>
<p>Make sure you have git and <a href="https://golang.org/">Go</a>
installed. Go version 1.24 or newer is required, the latest release is
recommended. You can get it from your package manager, or download it
from <a href="https://golang.org/dl/">golang.org/dl</a>. Then you can
run the following:</p>
<div class="sourceCode" id="cb25"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb25-1"><a href="#cb25-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> clone https://github.com/rclone/rclone.git</span>
<span id="cb25-2"><a href="#cb25-2" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> rclone</span>
<span id="cb25-3"><a href="#cb25-3" aria-hidden="true" tabindex="-1"></a><span class="ex">go</span> build</span></code></pre></div>
<p>This will check out the rclone source in subfolder rclone, which you
can later modify and send pull requests with. Then it will build the
rclone executable in the same folder. As an initial check you can now
run <code>./rclone version</code> (<code>.\rclone version</code> on
Windows).</p>
<p>Note that on macOS and Windows the <a
href="https://rclone.org/commands/rclone_mount/">mount</a> command will
not be available unless you specify an additional build tag
<code>cmount</code>.</p>
<div class="sourceCode" id="cb26"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb26-1"><a href="#cb26-1" aria-hidden="true" tabindex="-1"></a><span class="ex">go</span> build <span class="at">-tags</span> cmount</span></code></pre></div>
<p>This assumes you have a GCC compatible C compiler (GCC or Clang) in
your PATH, as it uses <a href="https://pkg.go.dev/cmd/cgo">cgo</a>. But
on Windows, the <a href="https://github.com/winfsp/cgofuse">cgofuse</a>
library that the cmount implementation is based on, also supports
building <a href="https://github.com/golang/go/wiki/WindowsDLLs">without
cgo</a>, i.e. by setting environment variable CGO_ENABLED to value 0
(static linking). This is how the official Windows release of rclone is
being built, starting with version 1.59. It is still possible to build
with cgo on Windows as well, by using the MinGW port of GCC, e.g. by
installing it in a <a href="https://www.msys2.org">MSYS2</a>
distribution (make sure you install it in the classic mingw64 subsystem,
the ucrt64 version is not compatible).</p>
<p>Additionally, to build with mount on Windows, you must install the
third party utility <a href="https://winfsp.dev/">WinFsp</a>, with the
"Developer" feature selected. If building with cgo, you must also set
environment variable CPATH pointing to the fuse include directory within
the WinFsp installation (normally
<code>C:\Program Files (x86)\WinFsp\inc\fuse</code>).</p>
<p>You may add arguments <code>-ldflags -s</code> to omit symbol table
and debug information, making the executable file smaller, and
<code>-trimpath</code> to remove references to local file system paths.
The official rclone releases are built with both of these.</p>
<div class="sourceCode" id="cb27"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb27-1"><a href="#cb27-1" aria-hidden="true" tabindex="-1"></a><span class="ex">go</span> build <span class="at">-trimpath</span> <span class="at">-ldflags</span> <span class="at">-s</span> <span class="at">-tags</span> cmount</span></code></pre></div>
<p>If you want to customize the version string, as reported by the
<code>rclone version</code> command, you can set one of the variables
<code>fs.Version</code>, <code>fs.VersionTag</code> (to keep default
suffix but customize the number), or <code>fs.VersionSuffix</code> (to
keep default number but customize the suffix). This can be done from the
build command, by adding to the <code>-ldflags</code> argument value as
shown below.</p>
<div class="sourceCode" id="cb28"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb28-1"><a href="#cb28-1" aria-hidden="true" tabindex="-1"></a><span class="ex">go</span> build <span class="at">-trimpath</span> <span class="at">-ldflags</span> <span class="st">&quot;-s -X github.com/rclone/rclone/fs.Version=v9.9.9-test&quot;</span> <span class="at">-tags</span> cmount</span></code></pre></div>
<p>On Windows, the official executables also have the version
information, as well as a file icon, embedded as binary resources. To
get that with your own build you need to run the following command
<strong>before</strong> the build command. It generates a Windows
resource system object file, with extension .syso, e.g.
<code>resource_windows_amd64.syso</code>, that will be automatically
picked up by future build commands.</p>
<div class="sourceCode" id="cb29"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb29-1"><a href="#cb29-1" aria-hidden="true" tabindex="-1"></a><span class="ex">go</span> run bin/resource_windows.go</span></code></pre></div>
<p>The above command will generate a resource file containing version
information based on the fs.Version variable in source at the time you
run the command, which means if the value of this variable changes you
need to re-run the command for it to be reflected in the version
information. Also, if you override this version variable in the build
command as described above, you need to do that also when generating the
resource file, or else it will still use the value from the source.</p>
<div class="sourceCode" id="cb30"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb30-1"><a href="#cb30-1" aria-hidden="true" tabindex="-1"></a><span class="ex">go</span> run bin/resource_windows.go <span class="at">-version</span> v9.9.9-test</span></code></pre></div>
<p>Instead of executing the <code>go build</code> command directly, you
can run it via the Makefile. The default target changes the version
suffix from "-DEV" to "-beta" followed by additional commit details,
embeds version information binary resources on Windows, and copies the
resulting rclone executable into your GOPATH bin folder
(<code>$(go env GOPATH)/bin</code>, which corresponds to
<code>~/go/bin/rclone</code> by default).</p>
<div class="sourceCode" id="cb31"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb31-1"><a href="#cb31-1" aria-hidden="true" tabindex="-1"></a><span class="fu">make</span></span></code></pre></div>
<p>To include mount command on macOS and Windows with Makefile
build:</p>
<div class="sourceCode" id="cb32"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb32-1"><a href="#cb32-1" aria-hidden="true" tabindex="-1"></a><span class="fu">make</span> GOTAGS=cmount</span></code></pre></div>
<p>There are other make targets that can be used for more advanced
builds, such as cross-compiling for all supported os/architectures, and
packaging results into release artifacts. See <a
href="https://github.com/rclone/rclone/blob/master/Makefile">Makefile</a>
and <a
href="https://github.com/rclone/rclone/blob/master/bin/cross-compile.go">cross-compile.go</a>
for details.</p>
<p>Another alternative method for source installation is to download the
source, build and install rclone - all in one operation, as a regular Go
package. The source will be stored it in the Go module cache, and the
resulting executable will be in your GOPATH bin folder
(<code>$(go env GOPATH)/bin</code>, which corresponds to
<code>~/go/bin/rclone</code> by default).</p>
<div class="sourceCode" id="cb33"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb33-1"><a href="#cb33-1" aria-hidden="true" tabindex="-1"></a><span class="ex">go</span> install github.com/rclone/rclone@latest</span></code></pre></div>
<p>In some situations, rclone executable size might be too big for
deployment in very restricted environments when all backends with large
SDKs are included. To limit binary size unused backends can be commented
out in <code>backends/all/all.go</code> and unused commands in
<code>cmd/all/all.go</code> before building with <code>go build</code>
or <code>make</code></p>
<h2 id="ansible">Ansible installation</h2>
<p>This can be done with <a
href="https://github.com/stefangweichinger/ansible-rclone">Stefan
Weichinger's ansible role</a>.</p>
<p>Instructions</p>
<ol type="1">
<li><p><code>git clone https://github.com/stefangweichinger/ansible-rclone.git</code>
into your local roles-directory</p></li>
<li><p>add the role to the hosts you want rclone installed to:</p>
<div class="sourceCode" id="cb34"><pre
class="sourceCode yml"><code class="sourceCode yaml"><span id="cb34-1"><a href="#cb34-1" aria-hidden="true" tabindex="-1"></a><span class="kw">-</span><span class="at"> </span><span class="fu">hosts</span><span class="kw">:</span><span class="at"> rclone-hosts</span></span>
<span id="cb34-2"><a href="#cb34-2" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">roles</span><span class="kw">:</span></span>
<span id="cb34-3"><a href="#cb34-3" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="kw">-</span><span class="at"> rclone</span></span></code></pre></div></li>
</ol>
<h2 id="portable">Portable installation</h2>
<p>As mentioned <a
href="https://rclone.org/install/#quickstart">above</a>, rclone is
single executable (<code>rclone</code>, or <code>rclone.exe</code> on
Windows) that you can download as a zip archive and extract into a
location of your choosing. When executing different commands, it may
create files in different locations, such as a configuration file and
various temporary files. By default the locations for these are
according to your operating system, e.g. configuration file in your user
profile directory and temporary files in the standard temporary
directory, but you can customize all of them, e.g. to make a completely
self-contained, portable installation.</p>
<p>Run the <a
href="https://rclone.org/commands/rclone_config_paths/">config paths</a>
command to see the locations that rclone will use.</p>
<p>To override them set the corresponding options (as command-line
arguments, or as <a
href="https://rclone.org/docs/#environment-variables">environment
variables</a>):</p>
<ul>
<li><a href="https://rclone.org/docs/#config-string">--config</a></li>
<li><a
href="https://rclone.org/docs/#cache-dir-string">--cache-dir</a></li>
<li><a
href="https://rclone.org/docs/#temp-dir-string">--temp-dir</a></li>
</ul>
<h2 id="autostart">Autostart</h2>
<p>After installing and configuring rclone, as described above, you are
ready to use rclone as an interactive command line utility. If your goal
is to perform <em>periodic</em> operations, such as a regular <a
href="https://rclone.org/commands/rclone_sync/">sync</a>, you will
probably want to configure your rclone command in your operating
system's scheduler. If you need to expose <em>service</em>-like
features, such as <a href="https://rclone.org/rc/">remote control</a>,
<a href="https://rclone.org/gui/">GUI</a>, <a
href="https://rclone.org/commands/rclone_serve/">serve</a> or <a
href="https://rclone.org/commands/rclone_mount/">mount</a>, you will
often want an rclone command always running in the background, and
configuring it to run in a service infrastructure may be a better
option. Below are some alternatives on how to achieve this on different
operating systems.</p>
<p>NOTE: Before setting up autorun it is highly recommended that you
have tested your command manually from a Command Prompt first.</p>
<h3 id="autostart-on-windows">Autostart on Windows</h3>
<p>The most relevant alternatives for autostart on Windows are:</p>
<ul>
<li>Run at user log on using the Startup folder</li>
<li>Run at user log on, at system startup or at schedule using Task
Scheduler</li>
<li>Run at system startup using Windows service</li>
</ul>
<h4 id="running-in-background">Running in background</h4>
<p>Rclone is a console application, so if not starting from an existing
Command Prompt, e.g. when starting rclone.exe from a shortcut, it will
open a Command Prompt window. When configuring rclone to run from task
scheduler and windows service you are able to set it to run hidden in
background. From rclone version 1.54 you can also make it run hidden
from anywhere by adding option <code>--no-console</code> (it may still
flash briefly when the program starts). Since rclone normally writes
information and any error messages to the console, you must redirect
this to a file to be able to see it. Rclone has a built-in option
<code>--log-file</code> for that.</p>
<p>Example command to run a sync in background:</p>
<div class="sourceCode" id="cb35"><pre
class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb35-1"><a href="#cb35-1" aria-hidden="true" tabindex="-1"></a>c:\rclone\rclone.exe sync c:\files remote:<span class="at">/files</span> -<span class="at">-no-console</span> -<span class="at">-log-file</span> c:\rclone\logs\sync_files.txt</span></code></pre></div>
<h4 id="user-account">User account</h4>
<p>As mentioned in the <a
href="https://rclone.org/commands/rclone_mount/">mount</a>
documentation, mounted drives created as Administrator are not visible
to other accounts, not even the account that was elevated as
Administrator. By running the mount command as the built-in
<code>SYSTEM</code> user account, it will create drives accessible for
everyone on the system. Both scheduled task and Windows service can be
used to achieve this.</p>
<p>NOTE: Remember that when rclone runs as the <code>SYSTEM</code> user,
the user profile that it sees will not be yours. This means that if you
normally run rclone with configuration file in the default location, to
be able to use the same configuration when running as the system user
you must explicitly tell rclone where to find it with the <a
href="https://rclone.org/docs/#config-string"><code>--config</code></a>
option, or else it will look in the system users profile path
(<code>C:\Windows\System32\config\systemprofile</code>). To test your
command manually from a Command Prompt, you can run it with the <a
href="https://docs.microsoft.com/en-us/sysinternals/downloads/psexec">PsExec</a>
utility from Microsoft's Sysinternals suite, which takes option
<code>-s</code> to execute commands as the <code>SYSTEM</code> user.</p>
<h4 id="start-from-startup-folder">Start from Startup folder</h4>
<p>To quickly execute an rclone command you can simply create a standard
Windows Explorer shortcut for the complete rclone command you want to
run. If you store this shortcut in the special "Startup" start-menu
folder, Windows will automatically run it at login. To open this folder
in Windows Explorer, enter path
<code>%APPDATA%\Microsoft\Windows\Start Menu\Programs\Startup</code>, or
<code>C:\ProgramData\Microsoft\Windows\Start Menu\Programs\StartUp</code>
if you want the command to start for <em>every</em> user that logs
in.</p>
<p>This is the easiest approach to autostarting of rclone, but it offers
no functionality to set it to run as different user, or to set
conditions or actions on certain events. Setting up a scheduled task as
described below will often give you better results.</p>
<h4 id="start-from-task-scheduler">Start from Task Scheduler</h4>
<p>Task Scheduler is an administrative tool built into Windows, and it
can be used to configure rclone to be started automatically in a highly
configurable way, e.g. periodically on a schedule, on user log on, or at
system startup. It can run be configured to run as the current user, or
for a mount command that needs to be available to all users it can run
as the <code>SYSTEM</code> user. For technical information, see <a
href="https://docs.microsoft.com/windows/win32/taskschd/task-scheduler-start-page">Task
Scheduler for developers</a>.</p>
<h4 id="run-as-service">Run as service</h4>
<p>For running rclone at system startup, you can create a Windows
service that executes your rclone command, as an alternative to
scheduled task configured to run at startup.</p>
<h5 id="mount-command-built-in-service-integration">Mount command
built-in service integration</h5>
<p>For mount commands, rclone has a built-in Windows service integration
via the third-party WinFsp library it uses. Registering as a regular
Windows service easy, as you just have to execute the built-in
PowerShell command <code>New-Service</code> (requires administrative
privileges).</p>
<p>Example of a PowerShell command that creates a Windows service for
mounting some <code>remote:/files</code> as drive letter
<code>X:</code>, for <em>all</em> users (service will be running as the
local system account):</p>
<pre class="pwsh"><code>New-Service -Name Rclone -BinaryPathName &#39;c:\rclone\rclone.exe mount remote:/files X: --config c:\rclone\config\rclone.conf --log-file c:\rclone\logs\mount.txt&#39;</code></pre>
<p>The <a
href="https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture">WinFsp
service infrastructure</a> supports incorporating services for file
system implementations, such as rclone, into its own launcher service,
as kind of "child services". This has the additional advantage that it
also implements a network provider that integrates into Windows standard
methods for managing network drives. This is currently not officially
supported by Rclone, but with WinFsp version 2019.3 B2 / v1.5B2 or later
it should be possible through path rewriting as described in <a
href="https://github.com/rclone/rclone/issues/3340">#3340</a>.</p>
<h5 id="third-party-service-integration">Third-party service
integration</h5>
<p>To Windows service running any rclone command, the excellent
third-party utility <a href="http://nssm.cc">NSSM</a>, the "Non-Sucking
Service Manager", can be used. It includes some advanced features such
as adjusting process priority, defining process environment variables,
redirect to file anything written to stdout, and customized response to
different exit codes, with a GUI to configure everything from (although
it can also be used from command line ).</p>
<p>There are also several other alternatives. To mention one more, <a
href="https://github.com/winsw/winsw">WinSW</a>, "Windows Service
Wrapper", is worth checking out. It requires .NET Framework, but it is
preinstalled on newer versions of Windows, and it also provides
alternative standalone distributions which includes necessary runtime
(.NET 5). WinSW is a command-line only utility, where you have to
manually create an XML file with service configuration. This may be a
drawback for some, but it can also be an advantage as it is easy to back
up and reuse the configuration settings, without having go through
manual steps in a GUI. One thing to note is that by default it does not
restart the service on error, one have to explicit enable this in the
configuration file (via the "onfailure" parameter).</p>
<h3 id="autostart-on-linux">Autostart on Linux</h3>
<h4 id="start-as-a-service">Start as a service</h4>
<p>To always run rclone in background, relevant for mount commands etc,
you can use systemd to set up rclone as a system or user service.
Running as a system service ensures that it is run at startup even if
the user it is running as has no active session. Running rclone as a
user service ensures that it only starts after the configured user has
logged into the system.</p>
<h4 id="run-periodically-from-cron">Run periodically from cron</h4>
<p>To run a periodic command, such as a copy/sync, you can set up a cron
job.</p>
<h1 id="usage">Usage</h1>
<p>Rclone is a command line program to manage files on cloud storage.
After <a href="https://rclone.org/downloads/">download</a> and <a
href="/install">install</a>, continue here to learn how to use it:
Initial <a href="#configure">configuration</a>, what the <a
href="#basic-syntax">basic syntax</a> looks like, describes the various
<a href="#subcommands">subcommands</a>, the various <a
href="#options">options</a>, and more.</p>
<h2 id="configure">Configure</h2>
<p>First, you'll need to configure rclone. As the object storage systems
have quite complicated authentication these are kept in a config file.
(See the <a href="#config-string"><code>--config</code></a> entry for
how to find the config file and choose its location.)</p>
<p>The easiest way to make the config is to run rclone with the config
option:</p>
<div class="sourceCode" id="cb37"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb37-1"><a href="#cb37-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>See the following for detailed instructions for</p>
<ul>
<li><a href="https://rclone.org/fichier/">1Fichier</a></li>
<li><a href="https://rclone.org/netstorage/">Akamai Netstorage</a></li>
<li><a href="https://rclone.org/alias/">Alias</a></li>
<li><a href="https://rclone.org/s3/">Amazon S3</a></li>
<li><a href="https://rclone.org/b2/">Backblaze B2</a></li>
<li><a href="https://rclone.org/box/">Box</a></li>
<li><a href="https://rclone.org/chunker/">Chunker</a> - transparently
splits large files for other remotes</li>
<li><a href="https://rclone.org/sharefile/">Citrix ShareFile</a></li>
<li><a href="https://rclone.org/compress/">Compress</a></li>
<li><a href="https://rclone.org/cloudinary/">Cloudinary</a></li>
<li><a href="https://rclone.org/combine/">Combine</a></li>
<li><a href="https://rclone.org/crypt/">Crypt</a> - to encrypt other
remotes</li>
<li><a href="https://rclone.org/s3/#digitalocean-spaces">DigitalOcean
Spaces</a></li>
<li><a href="https://rclone.org/koofr/#digi-storage">Digi
Storage</a></li>
<li><a href="https://rclone.org/dropbox/">Dropbox</a></li>
<li><a href="https://rclone.org/filefabric/">Enterprise File
Fabric</a></li>
<li><a href="https://rclone.org/filelu/">FileLu Cloud Storage</a></li>
<li><a href="https://rclone.org/filescom/">Files.com</a></li>
<li><a href="https://rclone.org/ftp/">FTP</a></li>
<li><a href="https://rclone.org/gofile/">Gofile</a></li>
<li><a href="https://rclone.org/googlecloudstorage/">Google Cloud
Storage</a></li>
<li><a href="https://rclone.org/drive/">Google Drive</a></li>
<li><a href="https://rclone.org/googlephotos/">Google Photos</a></li>
<li><a href="https://rclone.org/hasher/">Hasher</a> - to handle
checksums for other remotes</li>
<li><a href="https://rclone.org/hdfs/">HDFS</a></li>
<li><a href="https://rclone.org/sftp/#hetzner-storage-box">Hetzner
Storage Box</a></li>
<li><a href="https://rclone.org/hidrive/">HiDrive</a></li>
<li><a href="https://rclone.org/http/">HTTP</a></li>
<li><a href="https://rclone.org/iclouddrive/">iCloud Drive</a></li>
<li><a href="https://rclone.org/internetarchive/">Internet
Archive</a></li>
<li><a href="https://rclone.org/jottacloud/">Jottacloud</a></li>
<li><a href="https://rclone.org/koofr/">Koofr</a></li>
<li><a href="https://rclone.org/linkbox/">Linkbox</a></li>
<li><a href="https://rclone.org/mailru/">Mail.ru Cloud</a></li>
<li><a href="https://rclone.org/mega/">Mega</a></li>
<li><a href="https://rclone.org/memory/">Memory</a></li>
<li><a href="https://rclone.org/azureblob/">Microsoft Azure Blob
Storage</a></li>
<li><a href="https://rclone.org/azurefiles/">Microsoft Azure Files
Storage</a></li>
<li><a href="https://rclone.org/onedrive/">Microsoft OneDrive</a></li>
<li><a href="https://rclone.org/swift/">OpenStack Swift / Rackspace
Cloudfiles / Blomp Cloud Storage / Memset Memstore</a></li>
<li><a href="https://rclone.org/opendrive/">OpenDrive</a></li>
<li><a href="https://rclone.org/oracleobjectstorage/">Oracle Object
Storage</a></li>
<li><a href="https://rclone.org/pcloud/">Pcloud</a></li>
<li><a href="https://rclone.org/pikpak/">PikPak</a></li>
<li><a href="https://rclone.org/pixeldrain/">Pixeldrain</a></li>
<li><a href="https://rclone.org/premiumizeme/">premiumize.me</a></li>
<li><a href="https://rclone.org/putio/">put.io</a></li>
<li><a href="https://rclone.org/protondrive/">Proton Drive</a></li>
<li><a href="https://rclone.org/qingstor/">QingStor</a></li>
<li><a href="https://rclone.org/quatrix/">Quatrix by Maytech</a></li>
<li><a href="https://rclone.org/sftp/#rsync-net">rsync.net</a></li>
<li><a href="https://rclone.org/seafile/">Seafile</a></li>
<li><a href="https://rclone.org/sftp/">SFTP</a></li>
<li><a href="https://rclone.org/sia/">Sia</a></li>
<li><a href="https://rclone.org/smb/">SMB</a></li>
<li><a href="https://rclone.org/storj/">Storj</a></li>
<li><a href="https://rclone.org/sugarsync/">SugarSync</a></li>
<li><a href="https://rclone.org/union/">Union</a></li>
<li><a href="https://rclone.org/ulozto/">Uloz.to</a></li>
<li><a href="https://rclone.org/uptobox/">Uptobox</a></li>
<li><a href="https://rclone.org/webdav/">WebDAV</a></li>
<li><a href="https://rclone.org/yandex/">Yandex Disk</a></li>
<li><a href="https://rclone.org/zoho/">Zoho WorkDrive</a></li>
<li><a href="https://rclone.org/local/">The local filesystem</a></li>
</ul>
<h2 id="basic-syntax">Basic syntax</h2>
<p>Rclone syncs a directory tree from one storage system to another.</p>
<p>Its syntax is like this</p>
<div class="sourceCode" id="cb38"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb38-1"><a href="#cb38-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> subcommand <span class="pp">[</span><span class="ss">options</span><span class="pp">]</span> <span class="op">&lt;</span>parameters<span class="op">&gt;</span> <span class="op">&lt;</span>parameters...<span class="op">&gt;</span></span></code></pre></div>
<p>A <code>subcommand</code> is an rclone operation required (e.g.
<code>sync</code>, <code>copy</code>, <code>ls</code>).</p>
<p>An <code>option</code> is a single letter flag (e.g. <code>-v</code>)
or a group of single letter flags (e.g. <code>-Pv</code>) or a long flag
(e.g. <code>--progress</code>). No options are required. Options can
come after the <code>subcommand</code> or in between parameters too or
on the end, but only global options can be used before the
<code>subcommand</code>. Anything after a <code>--</code> option will
not be interpreted as an option so if you need to add a parameter which
starts with a <code>-</code> then put a <code>--</code> on its own
first, eg</p>
<div class="sourceCode" id="cb39"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb39-1"><a href="#cb39-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf <span class="at">--</span> <span class="at">-directory-starting-with-dash</span></span></code></pre></div>
<p>A <code>parameter</code> is usually a file path or <a
href="#syntax-of-remote-paths">rclone remote</a>, eg
<code>/path/to/file</code> or <code>remote:path/to/file</code> but it
can be other things - the <code>subcommand</code> help will tell you
what.</p>
<p>Source and destination paths are specified by the name you gave the
storage system in the config file then the sub path, e.g.
"drive:myfolder" to look at "myfolder" in Google drive.</p>
<p>You can define as many storage paths as you like in the config
file.</p>
<p>Please use the <a
href="#interactive"><code>--interactive</code>/<code>-i</code></a> flag
while learning rclone to avoid accidental data loss.</p>
<h2 id="subcommands">Subcommands</h2>
<p>rclone uses a system of subcommands. For example</p>
<div class="sourceCode" id="cb40"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb40-1"><a href="#cb40-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> ls remote:path <span class="co"># lists a remote</span></span>
<span id="cb40-2"><a href="#cb40-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy /local/path remote:path <span class="co"># copies /local/path to the remote</span></span>
<span id="cb40-3"><a href="#cb40-3" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--interactive</span> /local/path remote:path <span class="co"># syncs /local/path to the remote</span></span></code></pre></div>
<h1 id="rclone-config">rclone config</h1>
<p>Enter an interactive configuration session.</p>
<h2 id="synopsis-1">Synopsis</h2>
<p>Enter an interactive configuration session where you can setup new
remotes and manage existing ones. You may also set or remove a password
to protect your configuration.</p>
<pre><code>rclone config [flags]</code></pre>
<h2 id="options">Options</h2>
<pre><code>  -h, --help   help for config</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
<li><a href="https://rclone.org/commands/rclone_config_create/">rclone
config create</a> - Create a new remote with name, type and
options.</li>
<li><a href="https://rclone.org/commands/rclone_config_delete/">rclone
config delete</a> - Delete an existing remote.</li>
<li><a
href="https://rclone.org/commands/rclone_config_disconnect/">rclone
config disconnect</a> - Disconnects user from remote</li>
<li><a href="https://rclone.org/commands/rclone_config_dump/">rclone
config dump</a> - Dump the config file as JSON.</li>
<li><a href="https://rclone.org/commands/rclone_config_edit/">rclone
config edit</a> - Enter an interactive configuration session.</li>
<li><a
href="https://rclone.org/commands/rclone_config_encryption/">rclone
config encryption</a> - set, remove and check the encryption for the
config file</li>
<li><a href="https://rclone.org/commands/rclone_config_file/">rclone
config file</a> - Show path of configuration file in use.</li>
<li><a href="https://rclone.org/commands/rclone_config_password/">rclone
config password</a> - Update password in an existing remote.</li>
<li><a href="https://rclone.org/commands/rclone_config_paths/">rclone
config paths</a> - Show paths used for configuration, cache, temp
etc.</li>
<li><a
href="https://rclone.org/commands/rclone_config_providers/">rclone
config providers</a> - List in JSON format all the providers and
options.</li>
<li><a
href="https://rclone.org/commands/rclone_config_reconnect/">rclone
config reconnect</a> - Re-authenticates user with remote.</li>
<li><a href="https://rclone.org/commands/rclone_config_redacted/">rclone
config redacted</a> - Print redacted (decrypted) config file, or the
redacted config for a single remote.</li>
<li><a href="https://rclone.org/commands/rclone_config_show/">rclone
config show</a> - Print (decrypted) config file, or the config for a
single remote.</li>
<li><a href="https://rclone.org/commands/rclone_config_touch/">rclone
config touch</a> - Ensure configuration file exists.</li>
<li><a href="https://rclone.org/commands/rclone_config_update/">rclone
config update</a> - Update options in an existing remote.</li>
<li><a href="https://rclone.org/commands/rclone_config_userinfo/">rclone
config userinfo</a> - Prints info about logged in user of remote.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-copy">rclone copy</h1>
<p>Copy files from source to dest, skipping identical files.</p>
<h2 id="synopsis-2">Synopsis</h2>
<p>Copy the source to the destination. Does not transfer files that are
identical on source and destination, testing by size and modification
time or MD5SUM. Doesn't delete files from the destination. If you want
to also delete files from destination, to make it match source, use the
<a href="https://rclone.org/commands/rclone_sync/">sync</a> command
instead.</p>
<p>Note that it is always the contents of the directory that is synced,
not the directory itself. So when source:path is a directory, it's the
contents of source:path that are copied, not the directory name and
contents.</p>
<p>To copy single files, use the <a
href="https://rclone.org/commands/rclone_copyto/">copyto</a> command
instead.</p>
<p>If dest:path doesn't exist, it is created and the source:path
contents go there.</p>
<p>For example</p>
<div class="sourceCode" id="cb43"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb43-1"><a href="#cb43-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy source:sourcepath dest:destpath</span></code></pre></div>
<p>Let's say there are two files in sourcepath</p>
<pre class="text"><code>sourcepath/one.txt
sourcepath/two.txt</code></pre>
<p>This copies them to</p>
<pre class="text"><code>destpath/one.txt
destpath/two.txt</code></pre>
<p>Not to</p>
<pre class="text"><code>destpath/sourcepath/one.txt
destpath/sourcepath/two.txt</code></pre>
<p>If you are familiar with <code>rsync</code>, rclone always works as
if you had written a trailing <code>/</code> - meaning "copy the
contents of this directory". This applies to all commands and whether
you are talking about the source or destination.</p>
<p>See the <a
href="https://rclone.org/docs/#no-traverse">--no-traverse</a> option for
controlling whether rclone lists the destination directory or not.
Supplying this option when copying a small number of files into a large
destination can speed transfers up greatly.</p>
<p>For example, if you have many files in /path/to/src but only a few of
them change every day, you can copy all the files which have changed
recently very efficiently like this:</p>
<div class="sourceCode" id="cb47"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb47-1"><a href="#cb47-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="at">--max-age</span> 24h <span class="at">--no-traverse</span> /path/to/src remote:</span></code></pre></div>
<p>Rclone will sync the modification times of files and directories if
the backend supports it. If metadata syncing is required then use the
<code>--metadata</code> flag.</p>
<p>Note that the modification time and metadata for the root directory
will <strong>not</strong> be synced. See <a
href="https://github.com/rclone/rclone/issues/7652">issue #7652</a> for
more info.</p>
<p><strong>Note</strong>: Use the
<code>-P</code>/<code>--progress</code> flag to view real-time transfer
statistics.</p>
<p><strong>Note</strong>: Use the <code>--dry-run</code> or the
<code>--interactive</code>/<code>-i</code> flag to test without copying
anything.</p>
<h2 id="logger-flags">Logger Flags</h2>
<p>The <code>--differ</code>, <code>--missing-on-dst</code>,
<code>--missing-on-src</code>, <code>--match</code> and
<code>--error</code> flags write paths, one per line, to the file name
(or stdout if it is <code>-</code>) supplied. What they write is
described in the help below. For example <code>--differ</code> will
write all paths which are present on both the source and destination but
different.</p>
<p>The <code>--combined</code> flag will write a file (or stdout) which
contains all file paths with a symbol and then a space and then the path
to tell you what happened to it. These are reminiscent of diff
files.</p>
<ul>
<li><code>= path</code> means path was found in source and destination
and was identical</li>
<li><code>- path</code> means path was missing on the source, so only in
the destination</li>
<li><code>+ path</code> means path was missing on the destination, so
only in the source</li>
<li><code>* path</code> means path was present in source and destination
but different.</li>
<li><code>! path</code> means there was an error reading or hashing the
source or dest.</li>
</ul>
<p>The <code>--dest-after</code> flag writes a list file using the same
format flags as <a
href="https://rclone.org/commands/rclone_lsf/#synopsis"><code>lsf</code></a>
(including <a
href="https://rclone.org/commands/rclone_lsf/#synopsis">customizable
options for hash, modtime, etc.</a>) Conceptually it is similar to
rsync's <code>--itemize-changes</code>, but not identical -- it should
output an accurate list of what will be on the destination after the
command is finished.</p>
<p>When the <code>--no-traverse</code> flag is set, all logs involving
files that exist only on the destination will be incomplete or
completely missing.</p>
<p>Note that these logger flags have a few limitations, and certain
scenarios are not currently supported:</p>
<ul>
<li><code>--max-duration</code> / <code>CutoffModeHard</code></li>
<li><code>--compare-dest</code> / <code>--copy-dest</code></li>
<li>server-side moves of an entire dir at once</li>
<li>High-level retries, because there would be duplicates (use
<code>--retries 1</code> to disable)</li>
<li>Possibly some unusual error scenarios</li>
</ul>
<p>Note also that each file is logged during execution, as opposed to
after, so it is most useful as a predictor of what SHOULD happen to each
file (which may or may not match what actually DID).</p>
<pre><code>rclone copy source:path dest:path [flags]</code></pre>
<h2 id="options-1">Options</h2>
<pre><code>      --absolute                Put a leading / in front of path names
      --combined string         Make a combined report of changes to this file
      --create-empty-src-dirs   Create empty source dirs on destination after copy
      --csv                     Output in CSV format
      --dest-after string       Report all files that exist on the dest post-sync
      --differ string           Report all non-matching files to this file
  -d, --dir-slash               Append a slash to directory names (default true)
      --dirs-only               Only list directories
      --error string            Report all files with errors (hashing or reading) to this file
      --files-only              Only list files (default true)
  -F, --format string           Output format - see lsf help for details (default &quot;p&quot;)
      --hash h                  Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default &quot;md5&quot;)
  -h, --help                    help for copy
      --match string            Report all matching files to this file
      --missing-on-dst string   Report all files missing from the destination to this file
      --missing-on-src string   Report all files missing from the source to this file
  -s, --separator string        Separator for the items in the format (default &quot;;&quot;)
  -t, --timeformat string       Specify a custom time format, or &#39;max&#39; for max precision supported by remote (default: 2006-01-02 15:04:05)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="copy-options">Copy Options</h3>
<p>Flags for anything which can copy a file</p>
<pre class="text"><code>      --check-first                                 Do all the checks before starting transfers
  -c, --checksum                                    Check for changes with size &amp; checksum (if available, or fallback to size only)
      --compare-dest stringArray                    Include additional server-side paths during comparison
      --copy-dest stringArray                       Implies --compare-dest but also copies files from paths into destination
      --cutoff-mode HARD|SOFT|CAUTIOUS              Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
      --ignore-case-sync                            Ignore case when synchronizing
      --ignore-checksum                             Skip post copy check of checksums
      --ignore-existing                             Skip all files that exist on destination
      --ignore-size                                 Ignore size when skipping use modtime or checksum
  -I, --ignore-times                                Don&#39;t skip items that match size and time - transfer all unconditionally
      --immutable                                   Do not modify files, fail if existing files have been modified
      --inplace                                     Download directly to destination file instead of atomic download to temp/rename
  -l, --links                                       Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension
      --max-backlog int                             Maximum number of objects in sync or check backlog (default 10000)
      --max-duration Duration                       Maximum duration rclone will transfer data for (default 0s)
      --max-transfer SizeSuffix                     Maximum size of data to transfer (default off)
  -M, --metadata                                    If set, preserve metadata when copying objects
      --modify-window Duration                      Max time diff to be considered the same (default 1ns)
      --multi-thread-chunk-size SizeSuffix          Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi)
      --multi-thread-cutoff SizeSuffix              Use multi-thread downloads for files above this size (default 256Mi)
      --multi-thread-streams int                    Number of streams to use for multi-thread downloads (default 4)
      --multi-thread-write-buffer-size SizeSuffix   In memory buffer size for writing when in multi-thread mode (default 128Ki)
      --name-transform stringArray                  Transform paths during the copy process
      --no-check-dest                               Don&#39;t check the destination, copy regardless
      --no-traverse                                 Don&#39;t traverse destination file system on copy
      --no-update-dir-modtime                       Don&#39;t update directory modification times
      --no-update-modtime                           Don&#39;t update destination modtime if files identical
      --order-by string                             Instructions on how to order the transfers, e.g. &#39;size,descending&#39;
      --partial-suffix string                       Add partial-suffix to temporary file name when --inplace is not used (default &quot;.partial&quot;)
      --refresh-times                               Refresh the modtime of remote files
      --server-side-across-configs                  Allow server-side operations (e.g. copy) to work across different configs
      --size-only                                   Skip based on size only, not modtime or checksum
      --streaming-upload-cutoff SizeSuffix          Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki)
  -u, --update                                      Skip files that are newer on the destination</code></pre>
<h3 id="important-options">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h3 id="filter-options">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-1">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-sync">rclone sync</h1>
<p>Make source and dest identical, modifying destination only.</p>
<h2 id="synopsis-3">Synopsis</h2>
<p>Sync the source to the destination, changing the destination only.
Doesn't transfer files that are identical on source and destination,
testing by size and modification time or MD5SUM. Destination is updated
to match source, including deleting files if necessary (except duplicate
objects, see below). If you don't want to delete files from destination,
use the <a href="https://rclone.org/commands/rclone_copy/">copy</a>
command instead.</p>
<p><strong>Important</strong>: Since this can cause data loss, test
first with the <code>--dry-run</code> or the
<code>--interactive</code>/<code>i</code> flag.</p>
<div class="sourceCode" id="cb54"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb54-1"><a href="#cb54-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--interactive</span> SOURCE remote:DESTINATION</span></code></pre></div>
<p>Files in the destination won't be deleted if there were any errors at
any point. Duplicate objects (files with the same name, on those
providers that support it) are not yet handled. Files that are excluded
won't be deleted unless <code>--delete-excluded</code> is used. Symlinks
won't be transferred or deleted from local file systems unless
<code>--links</code> is used.</p>
<p>It is always the contents of the directory that is synced, not the
directory itself. So when source:path is a directory, it's the contents
of source:path that are copied, not the directory name and contents. See
extended explanation in the <a
href="https://rclone.org/commands/rclone_copy/">copy</a> command if
unsure.</p>
<p>If dest:path doesn't exist, it is created and the source:path
contents go there.</p>
<p>It is not possible to sync overlapping remotes. However, you may
exclude the destination from the sync with a filter rule or by putting
an exclude-if-present file inside the destination directory and sync to
a destination that is inside the source directory.</p>
<p>Rclone will sync the modification times of files and directories if
the backend supports it. If metadata syncing is required then use the
<code>--metadata</code> flag.</p>
<p>Note that the modification time and metadata for the root directory
will <strong>not</strong> be synced. See <a
href="https://github.com/rclone/rclone/issues/7652"
class="uri">https://github.com/rclone/rclone/issues/7652</a> for more
info.</p>
<p><strong>Note</strong>: Use the
<code>-P</code>/<code>--progress</code> flag to view real-time transfer
statistics</p>
<p><strong>Note</strong>: Use the <code>rclone dedupe</code> command to
deal with "Duplicate object/directory found in source/destination -
ignoring" errors. See <a
href="https://forum.rclone.org/t/sync-not-clearing-duplicates/14372">this
forum post</a> for more info.</p>
<h2 id="logger-flags-1">Logger Flags</h2>
<p>The <code>--differ</code>, <code>--missing-on-dst</code>,
<code>--missing-on-src</code>, <code>--match</code> and
<code>--error</code> flags write paths, one per line, to the file name
(or stdout if it is <code>-</code>) supplied. What they write is
described in the help below. For example <code>--differ</code> will
write all paths which are present on both the source and destination but
different.</p>
<p>The <code>--combined</code> flag will write a file (or stdout) which
contains all file paths with a symbol and then a space and then the path
to tell you what happened to it. These are reminiscent of diff
files.</p>
<ul>
<li><code>= path</code> means path was found in source and destination
and was identical</li>
<li><code>- path</code> means path was missing on the source, so only in
the destination</li>
<li><code>+ path</code> means path was missing on the destination, so
only in the source</li>
<li><code>* path</code> means path was present in source and destination
but different.</li>
<li><code>! path</code> means there was an error reading or hashing the
source or dest.</li>
</ul>
<p>The <code>--dest-after</code> flag writes a list file using the same
format flags as <a
href="https://rclone.org/commands/rclone_lsf/#synopsis"><code>lsf</code></a>
(including <a
href="https://rclone.org/commands/rclone_lsf/#synopsis">customizable
options for hash, modtime, etc.</a>) Conceptually it is similar to
rsync's <code>--itemize-changes</code>, but not identical -- it should
output an accurate list of what will be on the destination after the
command is finished.</p>
<p>When the <code>--no-traverse</code> flag is set, all logs involving
files that exist only on the destination will be incomplete or
completely missing.</p>
<p>Note that these logger flags have a few limitations, and certain
scenarios are not currently supported:</p>
<ul>
<li><code>--max-duration</code> / <code>CutoffModeHard</code></li>
<li><code>--compare-dest</code> / <code>--copy-dest</code></li>
<li>server-side moves of an entire dir at once</li>
<li>High-level retries, because there would be duplicates (use
<code>--retries 1</code> to disable)</li>
<li>Possibly some unusual error scenarios</li>
</ul>
<p>Note also that each file is logged during execution, as opposed to
after, so it is most useful as a predictor of what SHOULD happen to each
file (which may or may not match what actually DID).</p>
<pre><code>rclone sync source:path dest:path [flags]</code></pre>
<h2 id="options-2">Options</h2>
<pre><code>      --absolute                Put a leading / in front of path names
      --combined string         Make a combined report of changes to this file
      --create-empty-src-dirs   Create empty source dirs on destination after sync
      --csv                     Output in CSV format
      --dest-after string       Report all files that exist on the dest post-sync
      --differ string           Report all non-matching files to this file
  -d, --dir-slash               Append a slash to directory names (default true)
      --dirs-only               Only list directories
      --error string            Report all files with errors (hashing or reading) to this file
      --files-only              Only list files (default true)
  -F, --format string           Output format - see lsf help for details (default &quot;p&quot;)
      --hash h                  Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default &quot;md5&quot;)
  -h, --help                    help for sync
      --match string            Report all matching files to this file
      --missing-on-dst string   Report all files missing from the destination to this file
      --missing-on-src string   Report all files missing from the source to this file
  -s, --separator string        Separator for the items in the format (default &quot;;&quot;)
  -t, --timeformat string       Specify a custom time format, or &#39;max&#39; for max precision supported by remote (default: 2006-01-02 15:04:05)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="copy-options-1">Copy Options</h3>
<p>Flags for anything which can copy a file</p>
<pre class="text"><code>      --check-first                                 Do all the checks before starting transfers
  -c, --checksum                                    Check for changes with size &amp; checksum (if available, or fallback to size only)
      --compare-dest stringArray                    Include additional server-side paths during comparison
      --copy-dest stringArray                       Implies --compare-dest but also copies files from paths into destination
      --cutoff-mode HARD|SOFT|CAUTIOUS              Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
      --ignore-case-sync                            Ignore case when synchronizing
      --ignore-checksum                             Skip post copy check of checksums
      --ignore-existing                             Skip all files that exist on destination
      --ignore-size                                 Ignore size when skipping use modtime or checksum
  -I, --ignore-times                                Don&#39;t skip items that match size and time - transfer all unconditionally
      --immutable                                   Do not modify files, fail if existing files have been modified
      --inplace                                     Download directly to destination file instead of atomic download to temp/rename
  -l, --links                                       Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension
      --max-backlog int                             Maximum number of objects in sync or check backlog (default 10000)
      --max-duration Duration                       Maximum duration rclone will transfer data for (default 0s)
      --max-transfer SizeSuffix                     Maximum size of data to transfer (default off)
  -M, --metadata                                    If set, preserve metadata when copying objects
      --modify-window Duration                      Max time diff to be considered the same (default 1ns)
      --multi-thread-chunk-size SizeSuffix          Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi)
      --multi-thread-cutoff SizeSuffix              Use multi-thread downloads for files above this size (default 256Mi)
      --multi-thread-streams int                    Number of streams to use for multi-thread downloads (default 4)
      --multi-thread-write-buffer-size SizeSuffix   In memory buffer size for writing when in multi-thread mode (default 128Ki)
      --name-transform stringArray                  Transform paths during the copy process
      --no-check-dest                               Don&#39;t check the destination, copy regardless
      --no-traverse                                 Don&#39;t traverse destination file system on copy
      --no-update-dir-modtime                       Don&#39;t update directory modification times
      --no-update-modtime                           Don&#39;t update destination modtime if files identical
      --order-by string                             Instructions on how to order the transfers, e.g. &#39;size,descending&#39;
      --partial-suffix string                       Add partial-suffix to temporary file name when --inplace is not used (default &quot;.partial&quot;)
      --refresh-times                               Refresh the modtime of remote files
      --server-side-across-configs                  Allow server-side operations (e.g. copy) to work across different configs
      --size-only                                   Skip based on size only, not modtime or checksum
      --streaming-upload-cutoff SizeSuffix          Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki)
  -u, --update                                      Skip files that are newer on the destination</code></pre>
<h3 id="sync-options">Sync Options</h3>
<p>Flags used for sync commands</p>
<pre class="text"><code>      --backup-dir string               Make backups into hierarchy based in DIR
      --delete-after                    When synchronizing, delete files on destination after transferring (default)
      --delete-before                   When synchronizing, delete files on destination before transferring
      --delete-during                   When synchronizing, delete files during transfer
      --fix-case                        Force rename of case insensitive dest to match source
      --ignore-errors                   Delete even if there are I/O errors
      --list-cutoff int                 To save memory, sort directory listings on disk above this threshold (default 1000000)
      --max-delete int                  When synchronizing, limit the number of deletes (default -1)
      --max-delete-size SizeSuffix      When synchronizing, limit the total size of deletes (default off)
      --suffix string                   Suffix to add to changed files
      --suffix-keep-extension           Preserve the extension when using --suffix
      --track-renames                   When synchronizing, track file renames and do a server-side move if possible
      --track-renames-strategy string   Strategies to use when synchronizing using track-renames hash|modtime|leaf (default &quot;hash&quot;)</code></pre>
<h3 id="important-options-1">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h3 id="filter-options-1">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-1">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-2">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-move">rclone move</h1>
<p>Move files from source to dest.</p>
<h2 id="synopsis-4">Synopsis</h2>
<p>Moves the contents of the source directory to the destination
directory. Rclone will error if the source and destination overlap and
the remote does not support a server-side directory move operation.</p>
<p>To move single files, use the <a
href="https://rclone.org/commands/rclone_moveto/">moveto</a> command
instead.</p>
<p>If no filters are in use and if possible this will server-side move
<code>source:path</code> into <code>dest:path</code>. After this
<code>source:path</code> will no longer exist.</p>
<p>Otherwise for each file in <code>source:path</code> selected by the
filters (if any) this will move it into <code>dest:path</code>. If
possible a server-side move will be used, otherwise it will copy it
(server-side if possible) into <code>dest:path</code> then delete the
original (if no errors on copy) in <code>source:path</code>.</p>
<p>If you want to delete empty source directories after move, use the
<code>--delete-empty-src-dirs</code> flag.</p>
<p>See the <a
href="https://rclone.org/docs/#no-traverse">--no-traverse</a> option for
controlling whether rclone lists the destination directory or not.
Supplying this option when moving a small number of files into a large
destination can speed transfers up greatly.</p>
<p>Rclone will sync the modification times of files and directories if
the backend supports it. If metadata syncing is required then use the
<code>--metadata</code> flag.</p>
<p>Note that the modification time and metadata for the root directory
will <strong>not</strong> be synced. See <a
href="https://github.com/rclone/rclone/issues/7652"
class="uri">https://github.com/rclone/rclone/issues/7652</a> for more
info.</p>
<p><strong>Important</strong>: Since this can cause data loss, test
first with the <code>--dry-run</code> or the
<code>--interactive</code>/<code>-i</code> flag.</p>
<p><strong>Note</strong>: Use the
<code>-P</code>/<code>--progress</code> flag to view real-time transfer
statistics.</p>
<h2 id="logger-flags-2">Logger Flags</h2>
<p>The <code>--differ</code>, <code>--missing-on-dst</code>,
<code>--missing-on-src</code>, <code>--match</code> and
<code>--error</code> flags write paths, one per line, to the file name
(or stdout if it is <code>-</code>) supplied. What they write is
described in the help below. For example <code>--differ</code> will
write all paths which are present on both the source and destination but
different.</p>
<p>The <code>--combined</code> flag will write a file (or stdout) which
contains all file paths with a symbol and then a space and then the path
to tell you what happened to it. These are reminiscent of diff
files.</p>
<ul>
<li><code>= path</code> means path was found in source and destination
and was identical</li>
<li><code>- path</code> means path was missing on the source, so only in
the destination</li>
<li><code>+ path</code> means path was missing on the destination, so
only in the source</li>
<li><code>* path</code> means path was present in source and destination
but different.</li>
<li><code>! path</code> means there was an error reading or hashing the
source or dest.</li>
</ul>
<p>The <code>--dest-after</code> flag writes a list file using the same
format flags as <a
href="https://rclone.org/commands/rclone_lsf/#synopsis"><code>lsf</code></a>
(including <a
href="https://rclone.org/commands/rclone_lsf/#synopsis">customizable
options for hash, modtime, etc.</a>) Conceptually it is similar to
rsync's <code>--itemize-changes</code>, but not identical -- it should
output an accurate list of what will be on the destination after the
command is finished.</p>
<p>When the <code>--no-traverse</code> flag is set, all logs involving
files that exist only on the destination will be incomplete or
completely missing.</p>
<p>Note that these logger flags have a few limitations, and certain
scenarios are not currently supported:</p>
<ul>
<li><code>--max-duration</code> / <code>CutoffModeHard</code></li>
<li><code>--compare-dest</code> / <code>--copy-dest</code></li>
<li>server-side moves of an entire dir at once</li>
<li>High-level retries, because there would be duplicates (use
<code>--retries 1</code> to disable)</li>
<li>Possibly some unusual error scenarios</li>
</ul>
<p>Note also that each file is logged during execution, as opposed to
after, so it is most useful as a predictor of what SHOULD happen to each
file (which may or may not match what actually DID).</p>
<pre><code>rclone move source:path dest:path [flags]</code></pre>
<h2 id="options-3">Options</h2>
<pre><code>      --absolute                Put a leading / in front of path names
      --combined string         Make a combined report of changes to this file
      --create-empty-src-dirs   Create empty source dirs on destination after move
      --csv                     Output in CSV format
      --delete-empty-src-dirs   Delete empty source dirs after move
      --dest-after string       Report all files that exist on the dest post-sync
      --differ string           Report all non-matching files to this file
  -d, --dir-slash               Append a slash to directory names (default true)
      --dirs-only               Only list directories
      --error string            Report all files with errors (hashing or reading) to this file
      --files-only              Only list files (default true)
  -F, --format string           Output format - see lsf help for details (default &quot;p&quot;)
      --hash h                  Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default &quot;md5&quot;)
  -h, --help                    help for move
      --match string            Report all matching files to this file
      --missing-on-dst string   Report all files missing from the destination to this file
      --missing-on-src string   Report all files missing from the source to this file
  -s, --separator string        Separator for the items in the format (default &quot;;&quot;)
  -t, --timeformat string       Specify a custom time format, or &#39;max&#39; for max precision supported by remote (default: 2006-01-02 15:04:05)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="copy-options-2">Copy Options</h3>
<p>Flags for anything which can copy a file</p>
<pre class="text"><code>      --check-first                                 Do all the checks before starting transfers
  -c, --checksum                                    Check for changes with size &amp; checksum (if available, or fallback to size only)
      --compare-dest stringArray                    Include additional server-side paths during comparison
      --copy-dest stringArray                       Implies --compare-dest but also copies files from paths into destination
      --cutoff-mode HARD|SOFT|CAUTIOUS              Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
      --ignore-case-sync                            Ignore case when synchronizing
      --ignore-checksum                             Skip post copy check of checksums
      --ignore-existing                             Skip all files that exist on destination
      --ignore-size                                 Ignore size when skipping use modtime or checksum
  -I, --ignore-times                                Don&#39;t skip items that match size and time - transfer all unconditionally
      --immutable                                   Do not modify files, fail if existing files have been modified
      --inplace                                     Download directly to destination file instead of atomic download to temp/rename
  -l, --links                                       Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension
      --max-backlog int                             Maximum number of objects in sync or check backlog (default 10000)
      --max-duration Duration                       Maximum duration rclone will transfer data for (default 0s)
      --max-transfer SizeSuffix                     Maximum size of data to transfer (default off)
  -M, --metadata                                    If set, preserve metadata when copying objects
      --modify-window Duration                      Max time diff to be considered the same (default 1ns)
      --multi-thread-chunk-size SizeSuffix          Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi)
      --multi-thread-cutoff SizeSuffix              Use multi-thread downloads for files above this size (default 256Mi)
      --multi-thread-streams int                    Number of streams to use for multi-thread downloads (default 4)
      --multi-thread-write-buffer-size SizeSuffix   In memory buffer size for writing when in multi-thread mode (default 128Ki)
      --name-transform stringArray                  Transform paths during the copy process
      --no-check-dest                               Don&#39;t check the destination, copy regardless
      --no-traverse                                 Don&#39;t traverse destination file system on copy
      --no-update-dir-modtime                       Don&#39;t update directory modification times
      --no-update-modtime                           Don&#39;t update destination modtime if files identical
      --order-by string                             Instructions on how to order the transfers, e.g. &#39;size,descending&#39;
      --partial-suffix string                       Add partial-suffix to temporary file name when --inplace is not used (default &quot;.partial&quot;)
      --refresh-times                               Refresh the modtime of remote files
      --server-side-across-configs                  Allow server-side operations (e.g. copy) to work across different configs
      --size-only                                   Skip based on size only, not modtime or checksum
      --streaming-upload-cutoff SizeSuffix          Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki)
  -u, --update                                      Skip files that are newer on the destination</code></pre>
<h3 id="important-options-2">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h3 id="filter-options-2">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-2">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-3">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-delete">rclone delete</h1>
<p>Remove the files in path.</p>
<h2 id="synopsis-5">Synopsis</h2>
<p>Remove the files in path. Unlike <a
href="https://rclone.org/commands/rclone_purge/">purge</a> it obeys
include/exclude filters so can be used to selectively delete files.</p>
<p><code>rclone delete</code> only deletes files but leaves the
directory structure alone. If you want to delete a directory and all of
its contents use the <a
href="https://rclone.org/commands/rclone_purge/">purge</a> command.</p>
<p>If you supply the <code>--rmdirs</code> flag, it will remove all
empty directories along with it. You can also use the separate command
<a href="https://rclone.org/commands/rclone_rmdir/">rmdir</a> or <a
href="https://rclone.org/commands/rclone_rmdirs/">rmdirs</a> to delete
empty directories only.</p>
<p>For example, to delete all files bigger than 100 MiB, you may first
want to check what would be deleted (use either):</p>
<div class="sourceCode" id="cb68"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb68-1"><a href="#cb68-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">--min-size</span> 100M lsl remote:path</span>
<span id="cb68-2"><a href="#cb68-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">--dry-run</span> <span class="at">--min-size</span> 100M delete remote:path</span></code></pre></div>
<p>Then proceed with the actual delete:</p>
<div class="sourceCode" id="cb69"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb69-1"><a href="#cb69-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">--min-size</span> 100M delete remote:path</span></code></pre></div>
<p>That reads "delete everything with a minimum size of 100 MiB", hence
delete all files bigger than 100 MiB.</p>
<p><strong>Important</strong>: Since this can cause data loss, test
first with the <code>--dry-run</code> or the
<code>--interactive</code>/<code>-i</code> flag.</p>
<pre><code>rclone delete remote:path [flags]</code></pre>
<h2 id="options-4">Options</h2>
<pre><code>  -h, --help     help for delete
      --rmdirs   rmdirs removes empty directories but leaves root intact</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="important-options-3">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h3 id="filter-options-3">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-3">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-4">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-purge">rclone purge</h1>
<p>Remove the path and all of its contents.</p>
<h2 id="synopsis-6">Synopsis</h2>
<p>Remove the path and all of its contents. Note that this does not obey
include/exclude filters - everything will be removed. Use the <a
href="https://rclone.org/commands/rclone_delete/">delete</a> command if
you want to selectively delete files. To delete empty directories only,
use command <a
href="https://rclone.org/commands/rclone_rmdir/">rmdir</a> or <a
href="https://rclone.org/commands/rclone_rmdirs/">rmdirs</a>.</p>
<p>The concurrency of this operation is controlled by the
<code>--checkers</code> global flag. However, some backends will
implement this command directly, in which case <code>--checkers</code>
will be ignored.</p>
<p><strong>Important</strong>: Since this can cause data loss, test
first with the <code>--dry-run</code> or the
<code>--interactive</code>/<code>-i</code> flag.</p>
<pre><code>rclone purge remote:path [flags]</code></pre>
<h2 id="options-5">Options</h2>
<pre><code>  -h, --help   help for purge</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="important-options-4">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h2 id="see-also-5">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-mkdir">rclone mkdir</h1>
<p>Make the path if it doesn't already exist.</p>
<pre><code>rclone mkdir remote:path [flags]</code></pre>
<h2 id="options-6">Options</h2>
<pre><code>  -h, --help   help for mkdir</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="important-options-5">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h2 id="see-also-6">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-rmdir">rclone rmdir</h1>
<p>Remove the empty directory at path.</p>
<h2 id="synopsis-7">Synopsis</h2>
<p>This removes empty directory given by path. Will not remove the path
if it has any objects in it, not even empty subdirectories. Use command
<a href="https://rclone.org/commands/rclone_rmdirs/">rmdirs</a> (or <a
href="https://rclone.org/commands/rclone_delete/">delete</a> with option
<code>--rmdirs</code>) to do that.</p>
<p>To delete a path and any objects in it, use <a
href="https://rclone.org/commands/rclone_purge/">purge</a> command.</p>
<pre><code>rclone rmdir remote:path [flags]</code></pre>
<h2 id="options-7">Options</h2>
<pre><code>  -h, --help   help for rmdir</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="important-options-6">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h2 id="see-also-7">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-check">rclone check</h1>
<p>Checks the files in the source and destination match.</p>
<h2 id="synopsis-8">Synopsis</h2>
<p>Checks the files in the source and destination match. It compares
sizes and hashes (MD5 or SHA1) and logs a report of files that don't
match. It doesn't alter the source or destination.</p>
<p>For the <a href="https://rclone.org/crypt/">crypt</a> remote there is
a dedicated command, <a
href="https://rclone.org/commands/rclone_cryptcheck/">cryptcheck</a>,
that are able to check the checksums of the encrypted files.</p>
<p>If you supply the <code>--size-only</code> flag, it will only compare
the sizes not the hashes as well. Use this for a quick check.</p>
<p>If you supply the <code>--download</code> flag, it will download the
data from both remotes and check them against each other on the fly.
This can be useful for remotes that don't support hashes or if you
really want to check all the data.</p>
<p>If you supply the <code>--checkfile HASH</code> flag with a valid
hash name, the <code>source:path</code> must point to a text file in the
SUM format.</p>
<p>If you supply the <code>--one-way</code> flag, it will only check
that files in the source match the files in the destination, not the
other way around. This means that extra files in the destination that
are not in the source will not be detected.</p>
<p>The <code>--differ</code>, <code>--missing-on-dst</code>,
<code>--missing-on-src</code>, <code>--match</code> and
<code>--error</code> flags write paths, one per line, to the file name
(or stdout if it is <code>-</code>) supplied. What they write is
described in the help below. For example <code>--differ</code> will
write all paths which are present on both the source and destination but
different.</p>
<p>The <code>--combined</code> flag will write a file (or stdout) which
contains all file paths with a symbol and then a space and then the path
to tell you what happened to it. These are reminiscent of diff
files.</p>
<ul>
<li><code>= path</code> means path was found in source and destination
and was identical</li>
<li><code>- path</code> means path was missing on the source, so only in
the destination</li>
<li><code>+ path</code> means path was missing on the destination, so
only in the source</li>
<li><code>* path</code> means path was present in source and destination
but different.</li>
<li><code>! path</code> means there was an error reading or hashing the
source or dest.</li>
</ul>
<p>The default number of parallel checks is 8. See the <a
href="https://rclone.org/docs/#checkers-int">--checkers</a> option for
more information.</p>
<pre><code>rclone check source:path dest:path [flags]</code></pre>
<h2 id="options-8">Options</h2>
<pre><code>  -C, --checkfile string        Treat source:path as a SUM file with hashes of given type
      --combined string         Make a combined report of changes to this file
      --differ string           Report all non-matching files to this file
      --download                Check by downloading rather than with hash
      --error string            Report all files with errors (hashing or reading) to this file
  -h, --help                    help for check
      --match string            Report all matching files to this file
      --missing-on-dst string   Report all files missing from the destination to this file
      --missing-on-src string   Report all files missing from the source to this file
      --one-way                 Check one way only, source files must exist on remote</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="check-options">Check Options</h3>
<p>Flags used for check commands</p>
<pre class="text"><code>      --max-backlog int   Maximum number of objects in sync or check backlog (default 10000)</code></pre>
<h3 id="filter-options-4">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-4">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-8">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-ls">rclone ls</h1>
<p>List the objects in the path with size and path.</p>
<h2 id="synopsis-9">Synopsis</h2>
<p>Lists the objects in the source path to standard output in a human
readable format with size and path. Recurses by default.</p>
<p>E.g.</p>
<div class="sourceCode" id="cb89"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb89-1"><a href="#cb89-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone ls swift:bucket</span>
<span id="cb89-2"><a href="#cb89-2" aria-hidden="true" tabindex="-1"></a>    <span class="ex">60295</span> bevajer5jef</span>
<span id="cb89-3"><a href="#cb89-3" aria-hidden="true" tabindex="-1"></a>    <span class="ex">90613</span> canole</span>
<span id="cb89-4"><a href="#cb89-4" aria-hidden="true" tabindex="-1"></a>    <span class="ex">94467</span> diwogej7</span>
<span id="cb89-5"><a href="#cb89-5" aria-hidden="true" tabindex="-1"></a>    <span class="ex">37600</span> fubuwic</span></code></pre></div>
<p>Any of the filtering options can be applied to this command.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects
only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse
format</li>
<li><code>lsjson</code> to list objects and directories in JSON
format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be
human-readable. <code>lsf</code> is designed to be human and
machine-readable. <code>lsjson</code> is designed to be
machine-readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default -
use <code>--max-depth 1</code> to stop the recursion.</p>
<p>The other list commands
<code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by
default - use <code>-R</code> to make them recurse.</p>
<p>Listing a nonexistent directory will produce an error except for
remotes which can't have empty directories (e.g. s3, swift, or gcs - the
bucket-based remotes).</p>
<pre><code>rclone ls remote:path [flags]</code></pre>
<h2 id="options-9">Options</h2>
<pre><code>  -h, --help   help for ls</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-5">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-5">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-9">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-lsd">rclone lsd</h1>
<p>List all directories/containers/buckets in the path.</p>
<h2 id="synopsis-10">Synopsis</h2>
<p>Lists the directories in the source path to standard output. Does not
recurse by default. Use the <code>-R</code> flag to recurse.</p>
<p>This command lists the total size of the directory (if known, -1 if
not), the modification time (if known, the current time if not), the
number of objects in the directory (if known, -1 if not) and the name of
the directory, E.g.</p>
<div class="sourceCode" id="cb94"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb94-1"><a href="#cb94-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsd swift:</span>
<span id="cb94-2"><a href="#cb94-2" aria-hidden="true" tabindex="-1"></a>      <span class="ex">494000</span> 2018-04-26 08:43:20     10000 10000files</span>
<span id="cb94-3"><a href="#cb94-3" aria-hidden="true" tabindex="-1"></a>          <span class="ex">65</span> 2018-04-26 08:43:20         1 1File</span></code></pre></div>
<p>Or</p>
<div class="sourceCode" id="cb95"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb95-1"><a href="#cb95-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsd drive:test</span>
<span id="cb95-2"><a href="#cb95-2" aria-hidden="true" tabindex="-1"></a>          <span class="ex">-1</span> 2016-10-17 17:41:53        <span class="at">-1</span> 1000files</span>
<span id="cb95-3"><a href="#cb95-3" aria-hidden="true" tabindex="-1"></a>          <span class="ex">-1</span> 2017-01-03 14:40:54        <span class="at">-1</span> 2500files</span>
<span id="cb95-4"><a href="#cb95-4" aria-hidden="true" tabindex="-1"></a>          <span class="ex">-1</span> 2017-07-08 14:39:28        <span class="at">-1</span> 4000files</span></code></pre></div>
<p>If you just want the directory names use
<code>rclone lsf --dirs-only</code>.</p>
<p>Any of the filtering options can be applied to this command.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects
only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse
format</li>
<li><code>lsjson</code> to list objects and directories in JSON
format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be
human-readable. <code>lsf</code> is designed to be human and
machine-readable. <code>lsjson</code> is designed to be
machine-readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default -
use <code>--max-depth 1</code> to stop the recursion.</p>
<p>The other list commands
<code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by
default - use <code>-R</code> to make them recurse.</p>
<p>Listing a nonexistent directory will produce an error except for
remotes which can't have empty directories (e.g. s3, swift, or gcs - the
bucket-based remotes).</p>
<pre><code>rclone lsd remote:path [flags]</code></pre>
<h2 id="options-10">Options</h2>
<pre><code>  -h, --help        help for lsd
  -R, --recursive   Recurse into the listing</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-6">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-6">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-10">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-lsl">rclone lsl</h1>
<p>List the objects in path with modification time, size and path.</p>
<h2 id="synopsis-11">Synopsis</h2>
<p>Lists the objects in the source path to standard output in a human
readable format with modification time, size and path. Recurses by
default.</p>
<p>E.g.</p>
<div class="sourceCode" id="cb100"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb100-1"><a href="#cb100-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsl swift:bucket</span>
<span id="cb100-2"><a href="#cb100-2" aria-hidden="true" tabindex="-1"></a>    <span class="ex">60295</span> 2016-06-25 18:55:41.062626927 bevajer5jef</span>
<span id="cb100-3"><a href="#cb100-3" aria-hidden="true" tabindex="-1"></a>    <span class="ex">90613</span> 2016-06-25 18:55:43.302607074 canole</span>
<span id="cb100-4"><a href="#cb100-4" aria-hidden="true" tabindex="-1"></a>    <span class="ex">94467</span> 2016-06-25 18:55:43.046609333 diwogej7</span>
<span id="cb100-5"><a href="#cb100-5" aria-hidden="true" tabindex="-1"></a>    <span class="ex">37600</span> 2016-06-25 18:55:40.814629136 fubuwic</span></code></pre></div>
<p>Any of the filtering options can be applied to this command.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects
only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse
format</li>
<li><code>lsjson</code> to list objects and directories in JSON
format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be
human-readable. <code>lsf</code> is designed to be human and
machine-readable. <code>lsjson</code> is designed to be
machine-readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default -
use <code>--max-depth 1</code> to stop the recursion.</p>
<p>The other list commands
<code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by
default - use <code>-R</code> to make them recurse.</p>
<p>Listing a nonexistent directory will produce an error except for
remotes which can't have empty directories (e.g. s3, swift, or gcs - the
bucket-based remotes).</p>
<pre><code>rclone lsl remote:path [flags]</code></pre>
<h2 id="options-11">Options</h2>
<pre><code>  -h, --help   help for lsl</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-7">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-7">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-11">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-md5sum">rclone md5sum</h1>
<p>Produces an md5sum file for all the objects in the path.</p>
<h2 id="synopsis-12">Synopsis</h2>
<p>Produces an md5sum file for all the objects in the path. This is in
the same format as the standard md5sum tool produces.</p>
<p>By default, the hash is requested from the remote. If MD5 is not
supported by the remote, no hash will be returned. With the download
flag, the file will be downloaded from the remote and hashed locally
enabling MD5 for any remote.</p>
<p>For other algorithms, see the <a
href="https://rclone.org/commands/rclone_hashsum/">hashsum</a> command.
Running <code>rclone md5sum remote:path</code> is equivalent to running
<code>rclone hashsum MD5 remote:path</code>.</p>
<p>This command can also hash data received on standard input (stdin),
by not passing a remote:path, or by passing a hyphen as remote:path when
there is data to read (if not, the hyphen will be treated literally, as
a relative path).</p>
<pre><code>rclone md5sum remote:path [flags]</code></pre>
<h2 id="options-12">Options</h2>
<pre><code>      --base64               Output base64 encoded hashsum
  -C, --checkfile string     Validate hashes against a given SUM file instead of printing them
      --download             Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote
  -h, --help                 help for md5sum
      --output-file string   Output hashsums to a file rather than the terminal</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-8">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-8">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-12">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-sha1sum">rclone sha1sum</h1>
<p>Produces an sha1sum file for all the objects in the path.</p>
<h2 id="synopsis-13">Synopsis</h2>
<p>Produces an sha1sum file for all the objects in the path. This is in
the same format as the standard sha1sum tool produces.</p>
<p>By default, the hash is requested from the remote. If SHA-1 is not
supported by the remote, no hash will be returned. With the download
flag, the file will be downloaded from the remote and hashed locally
enabling SHA-1 for any remote.</p>
<p>For other algorithms, see the <a
href="https://rclone.org/commands/rclone_hashsum/">hashsum</a> command.
Running <code>rclone sha1sum remote:path</code> is equivalent to running
<code>rclone hashsum SHA1 remote:path</code>.</p>
<p>This command can also hash data received on standard input (stdin),
by not passing a remote:path, or by passing a hyphen as remote:path when
there is data to read (if not, the hyphen will be treated literally, as
a relative path).</p>
<p>This command can also hash data received on STDIN, if not passing a
remote:path.</p>
<pre><code>rclone sha1sum remote:path [flags]</code></pre>
<h2 id="options-13">Options</h2>
<pre><code>      --base64               Output base64 encoded hashsum
  -C, --checkfile string     Validate hashes against a given SUM file instead of printing them
      --download             Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote
  -h, --help                 help for sha1sum
      --output-file string   Output hashsums to a file rather than the terminal</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-9">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-9">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-13">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-size">rclone size</h1>
<p>Prints the total size and number of objects in remote:path.</p>
<h2 id="synopsis-14">Synopsis</h2>
<p>Counts objects in the path and calculates the total size. Prints the
result to standard output.</p>
<p>By default the output is in human-readable format, but shows values
in both human-readable format as well as the raw numbers (global option
<code>--human-readable</code> is not considered). Use option
<code>--json</code> to format output as JSON instead.</p>
<p>Recurses by default, use <code>--max-depth 1</code> to stop the
recursion.</p>
<p>Some backends do not always provide file sizes, see for example <a
href="https://rclone.org/googlephotos/#size">Google Photos</a> and <a
href="https://rclone.org/drive/#limitations-of-google-docs">Google
Docs</a>. Rclone will then show a notice in the log indicating how many
such files were encountered, and count them in as empty files in the
output of the size command.</p>
<pre><code>rclone size remote:path [flags]</code></pre>
<h2 id="options-14">Options</h2>
<pre><code>  -h, --help   help for size
      --json   Format output as JSON</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-10">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-10">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-14">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-version">rclone version</h1>
<p>Show the version number.</p>
<h2 id="synopsis-15">Synopsis</h2>
<p>Show the rclone version number, the go version, the build target OS
and architecture, the runtime OS and kernel version and bitness, build
tags and the type of executable (static or dynamic).</p>
<p>For example:</p>
<div class="sourceCode" id="cb117"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb117-1"><a href="#cb117-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone version</span>
<span id="cb117-2"><a href="#cb117-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> v1.55.0</span>
<span id="cb117-3"><a href="#cb117-3" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> os/version: ubuntu 18.04 <span class="er">(</span><span class="ex">64</span> bit<span class="kw">)</span></span>
<span id="cb117-4"><a href="#cb117-4" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> os/kernel: 4.15.0-136-generic <span class="er">(</span><span class="ex">x86_64</span><span class="kw">)</span></span>
<span id="cb117-5"><a href="#cb117-5" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> os/type: linux</span>
<span id="cb117-6"><a href="#cb117-6" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> os/arch: amd64</span>
<span id="cb117-7"><a href="#cb117-7" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> go/version: go1.16</span>
<span id="cb117-8"><a href="#cb117-8" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> go/linking: static</span>
<span id="cb117-9"><a href="#cb117-9" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> go/tags: none</span></code></pre></div>
<p>Note: before rclone version 1.55 the os/type and os/arch lines were
merged, and the "go/version" line was tagged as "go version".</p>
<p>If you supply the --check flag, then it will do an online check to
compare your version with the latest release and the latest beta.</p>
<div class="sourceCode" id="cb118"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb118-1"><a href="#cb118-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone version <span class="at">--check</span></span>
<span id="cb118-2"><a href="#cb118-2" aria-hidden="true" tabindex="-1"></a><span class="ex">yours:</span>  1.42.0.6</span>
<span id="cb118-3"><a href="#cb118-3" aria-hidden="true" tabindex="-1"></a><span class="ex">latest:</span> 1.42          <span class="er">(</span><span class="ex">released</span> 2018-06-16<span class="kw">)</span></span>
<span id="cb118-4"><a href="#cb118-4" aria-hidden="true" tabindex="-1"></a><span class="ex">beta:</span>   1.42.0.5      <span class="er">(</span><span class="ex">released</span> 2018-06-17<span class="kw">)</span></span></code></pre></div>
<p>Or</p>
<div class="sourceCode" id="cb119"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb119-1"><a href="#cb119-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone version <span class="at">--check</span></span>
<span id="cb119-2"><a href="#cb119-2" aria-hidden="true" tabindex="-1"></a><span class="ex">yours:</span>  1.41</span>
<span id="cb119-3"><a href="#cb119-3" aria-hidden="true" tabindex="-1"></a><span class="ex">latest:</span> 1.42          <span class="er">(</span><span class="ex">released</span> 2018-06-16<span class="kw">)</span></span>
<span id="cb119-4"><a href="#cb119-4" aria-hidden="true" tabindex="-1"></a>  <span class="ex">upgrade:</span> https://downloads.rclone.org/v1.42</span>
<span id="cb119-5"><a href="#cb119-5" aria-hidden="true" tabindex="-1"></a><span class="ex">beta:</span>   1.42.0.5      <span class="er">(</span><span class="ex">released</span> 2018-06-17<span class="kw">)</span></span>
<span id="cb119-6"><a href="#cb119-6" aria-hidden="true" tabindex="-1"></a>  <span class="ex">upgrade:</span> https://beta.rclone.org/v1.42-005-g56e1e820</span></code></pre></div>
<p>If you supply the --deps flag then rclone will print a list of all
the packages it depends on and their versions along with some other
information about the build.</p>
<pre><code>rclone version [flags]</code></pre>
<h2 id="options-15">Options</h2>
<pre><code>      --check   Check for new version
      --deps    Show the Go dependencies
  -h, --help    help for version</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-15">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-cleanup">rclone cleanup</h1>
<p>Clean up the remote if possible.</p>
<h2 id="synopsis-16">Synopsis</h2>
<p>Clean up the remote if possible. Empty the trash or delete old file
versions. Not supported by all remotes.</p>
<pre><code>rclone cleanup remote:path [flags]</code></pre>
<h2 id="options-16">Options</h2>
<pre><code>  -h, --help   help for cleanup</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="important-options-7">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h2 id="see-also-16">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-dedupe">rclone dedupe</h1>
<p>Interactively find duplicate filenames and delete/rename them.</p>
<h2 id="synopsis-17">Synopsis</h2>
<p>By default <code>dedupe</code> interactively finds files with
duplicate names and offers to delete all but one or rename them to be
different. This is known as deduping by name.</p>
<p>Deduping by name is only useful with a small group of backends (e.g.
Google Drive, Opendrive) that can have duplicate file names. It can be
run on wrapping backends (e.g. crypt) if they wrap a backend which
supports duplicate file names.</p>
<p>However if <code>--by-hash</code> is passed in then dedupe will find
files with duplicate hashes instead which will work on any backend which
supports at least one hash. This can be used to find files with
duplicate content. This is known as deduping by hash.</p>
<p>If deduping by name, first rclone will merge directories with the
same name. It will do this iteratively until all the identically named
directories have been merged.</p>
<p>Next, if deduping by name, for every group of duplicate file names /
hashes, it will delete all but one identical file it finds without
confirmation. This means that for most duplicated files the
<code>dedupe</code> command will not be interactive.</p>
<p><code>dedupe</code> considers files to be identical if they have the
same file path and the same hash. If the backend does not support hashes
(e.g. crypt wrapping Google Drive) then they will never be found to be
identical. If you use the <code>--size-only</code> flag then files will
be considered identical if they have the same size (any hash will be
ignored). This can be useful on crypt backends which do not support
hashes.</p>
<p>Next rclone will resolve the remaining duplicates. Exactly which
action is taken depends on the dedupe mode. By default, rclone will
interactively query the user for each one.</p>
<p><strong>Important</strong>: Since this can cause data loss, test
first with the <code>--dry-run</code> or the
<code>--interactive</code>/<code>-i</code> flag.</p>
<p>Here is an example run.</p>
<p>Before - with duplicates</p>
<div class="sourceCode" id="cb125"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb125-1"><a href="#cb125-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsl drive:dupes</span>
<span id="cb125-2"><a href="#cb125-2" aria-hidden="true" tabindex="-1"></a>  <span class="ex">6048320</span> 2016-03-05 16:23:16.798000000 one.txt</span>
<span id="cb125-3"><a href="#cb125-3" aria-hidden="true" tabindex="-1"></a>  <span class="ex">6048320</span> 2016-03-05 16:23:11.775000000 one.txt</span>
<span id="cb125-4"><a href="#cb125-4" aria-hidden="true" tabindex="-1"></a>   <span class="ex">564374</span> 2016-03-05 16:23:06.731000000 one.txt</span>
<span id="cb125-5"><a href="#cb125-5" aria-hidden="true" tabindex="-1"></a>  <span class="ex">6048320</span> 2016-03-05 16:18:26.092000000 one.txt</span>
<span id="cb125-6"><a href="#cb125-6" aria-hidden="true" tabindex="-1"></a>  <span class="ex">6048320</span> 2016-03-05 16:22:46.185000000 two.txt</span>
<span id="cb125-7"><a href="#cb125-7" aria-hidden="true" tabindex="-1"></a>  <span class="ex">1744073</span> 2016-03-05 16:22:38.104000000 two.txt</span>
<span id="cb125-8"><a href="#cb125-8" aria-hidden="true" tabindex="-1"></a>   <span class="ex">564374</span> 2016-03-05 16:22:52.118000000 two.txt</span></code></pre></div>
<p>Now the <code>dedupe</code> session</p>
<div class="sourceCode" id="cb126"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb126-1"><a href="#cb126-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone dedupe drive:dupes</span>
<span id="cb126-2"><a href="#cb126-2" aria-hidden="true" tabindex="-1"></a><span class="ex">2016/03/05</span> 16:24:37 Google drive root <span class="st">&#39;dupes&#39;</span>: Looking for duplicates using interactive mode.</span>
<span id="cb126-3"><a href="#cb126-3" aria-hidden="true" tabindex="-1"></a><span class="ex">one.txt:</span> Found 4 files with duplicate names</span>
<span id="cb126-4"><a href="#cb126-4" aria-hidden="true" tabindex="-1"></a><span class="ex">one.txt:</span> Deleting 2/3 identical duplicates <span class="er">(</span><span class="ex">MD5</span> <span class="st">&quot;1eedaa9fe86fd4b8632e2ac549403b36&quot;</span><span class="kw">)</span></span>
<span id="cb126-5"><a href="#cb126-5" aria-hidden="true" tabindex="-1"></a><span class="ex">one.txt:</span> 2 duplicates remain</span>
<span id="cb126-6"><a href="#cb126-6" aria-hidden="true" tabindex="-1"></a>  <span class="ex">1:</span>      6048320 bytes, 2016-03-05 16:23:16.798000000, MD5 1eedaa9fe86fd4b8632e2ac549403b36</span>
<span id="cb126-7"><a href="#cb126-7" aria-hidden="true" tabindex="-1"></a>  <span class="ex">2:</span>       564374 bytes, 2016-03-05 16:23:06.731000000, MD5 7594e7dc9fc28f727c42ee3e0749de81</span>
<span id="cb126-8"><a href="#cb126-8" aria-hidden="true" tabindex="-1"></a><span class="ex">s</span><span class="er">)</span> <span class="ex">Skip</span> and do nothing</span>
<span id="cb126-9"><a href="#cb126-9" aria-hidden="true" tabindex="-1"></a><span class="ex">k</span><span class="er">)</span> <span class="ex">Keep</span> just one <span class="er">(</span><span class="ex">choose</span> which in next step<span class="kw">)</span></span>
<span id="cb126-10"><a href="#cb126-10" aria-hidden="true" tabindex="-1"></a><span class="ex">r</span><span class="er">)</span> <span class="ex">Rename</span> all to be different <span class="er">(</span><span class="ex">by</span> changing file.jpg to file-1.jpg<span class="kw">)</span></span>
<span id="cb126-11"><a href="#cb126-11" aria-hidden="true" tabindex="-1"></a><span class="ex">s/k/r</span><span class="op">&gt;</span> k</span>
<span id="cb126-12"><a href="#cb126-12" aria-hidden="true" tabindex="-1"></a><span class="ex">Enter</span> the number of the file to keep<span class="op">&gt;</span> 1</span>
<span id="cb126-13"><a href="#cb126-13" aria-hidden="true" tabindex="-1"></a><span class="ex">one.txt:</span> Deleted 1 extra copies</span>
<span id="cb126-14"><a href="#cb126-14" aria-hidden="true" tabindex="-1"></a><span class="ex">two.txt:</span> Found 3 files with duplicate names</span>
<span id="cb126-15"><a href="#cb126-15" aria-hidden="true" tabindex="-1"></a><span class="ex">two.txt:</span> 3 duplicates remain</span>
<span id="cb126-16"><a href="#cb126-16" aria-hidden="true" tabindex="-1"></a>  <span class="ex">1:</span>       564374 bytes, 2016-03-05 16:22:52.118000000, MD5 7594e7dc9fc28f727c42ee3e0749de81</span>
<span id="cb126-17"><a href="#cb126-17" aria-hidden="true" tabindex="-1"></a>  <span class="ex">2:</span>      6048320 bytes, 2016-03-05 16:22:46.185000000, MD5 1eedaa9fe86fd4b8632e2ac549403b36</span>
<span id="cb126-18"><a href="#cb126-18" aria-hidden="true" tabindex="-1"></a>  <span class="ex">3:</span>      1744073 bytes, 2016-03-05 16:22:38.104000000, MD5 851957f7fb6f0bc4ce76be966d336802</span>
<span id="cb126-19"><a href="#cb126-19" aria-hidden="true" tabindex="-1"></a><span class="ex">s</span><span class="er">)</span> <span class="ex">Skip</span> and do nothing</span>
<span id="cb126-20"><a href="#cb126-20" aria-hidden="true" tabindex="-1"></a><span class="ex">k</span><span class="er">)</span> <span class="ex">Keep</span> just one <span class="er">(</span><span class="ex">choose</span> which in next step<span class="kw">)</span></span>
<span id="cb126-21"><a href="#cb126-21" aria-hidden="true" tabindex="-1"></a><span class="ex">r</span><span class="er">)</span> <span class="ex">Rename</span> all to be different <span class="er">(</span><span class="ex">by</span> changing file.jpg to file-1.jpg<span class="kw">)</span></span>
<span id="cb126-22"><a href="#cb126-22" aria-hidden="true" tabindex="-1"></a><span class="ex">s/k/r</span><span class="op">&gt;</span> r</span>
<span id="cb126-23"><a href="#cb126-23" aria-hidden="true" tabindex="-1"></a><span class="ex">two-1.txt:</span> renamed from: two.txt</span>
<span id="cb126-24"><a href="#cb126-24" aria-hidden="true" tabindex="-1"></a><span class="ex">two-2.txt:</span> renamed from: two.txt</span>
<span id="cb126-25"><a href="#cb126-25" aria-hidden="true" tabindex="-1"></a><span class="ex">two-3.txt:</span> renamed from: two.txt</span></code></pre></div>
<p>The result being</p>
<div class="sourceCode" id="cb127"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb127-1"><a href="#cb127-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsl drive:dupes</span>
<span id="cb127-2"><a href="#cb127-2" aria-hidden="true" tabindex="-1"></a>  <span class="ex">6048320</span> 2016-03-05 16:23:16.798000000 one.txt</span>
<span id="cb127-3"><a href="#cb127-3" aria-hidden="true" tabindex="-1"></a>   <span class="ex">564374</span> 2016-03-05 16:22:52.118000000 two-1.txt</span>
<span id="cb127-4"><a href="#cb127-4" aria-hidden="true" tabindex="-1"></a>  <span class="ex">6048320</span> 2016-03-05 16:22:46.185000000 two-2.txt</span>
<span id="cb127-5"><a href="#cb127-5" aria-hidden="true" tabindex="-1"></a>  <span class="ex">1744073</span> 2016-03-05 16:22:38.104000000 two-3.txt</span></code></pre></div>
<p>Dedupe can be run non interactively using the
<code>--dedupe-mode</code> flag or by using an extra parameter with the
same value</p>
<ul>
<li><code>--dedupe-mode interactive</code> - interactive as above.</li>
<li><code>--dedupe-mode skip</code> - removes identical files then skips
anything left.</li>
<li><code>--dedupe-mode first</code> - removes identical files then
keeps the first one.</li>
<li><code>--dedupe-mode newest</code> - removes identical files then
keeps the newest one.</li>
<li><code>--dedupe-mode oldest</code> - removes identical files then
keeps the oldest one.</li>
<li><code>--dedupe-mode largest</code> - removes identical files then
keeps the largest one.</li>
<li><code>--dedupe-mode smallest</code> - removes identical files then
keeps the smallest one.</li>
<li><code>--dedupe-mode rename</code> - removes identical files then
renames the rest to be different.</li>
<li><code>--dedupe-mode list</code> - lists duplicate dirs and files
only and changes nothing.</li>
</ul>
<p>For example, to rename all the identically named photos in your
Google Photos directory, do</p>
<div class="sourceCode" id="cb128"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb128-1"><a href="#cb128-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> dedupe <span class="at">--dedupe-mode</span> rename <span class="st">&quot;drive:Google Photos&quot;</span></span></code></pre></div>
<p>Or</p>
<div class="sourceCode" id="cb129"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb129-1"><a href="#cb129-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> dedupe rename <span class="st">&quot;drive:Google Photos&quot;</span></span></code></pre></div>
<pre><code>rclone dedupe [mode] remote:path [flags]</code></pre>
<h2 id="options-17">Options</h2>
<pre><code>      --by-hash              Find identical hashes rather than names
      --dedupe-mode string   Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename (default &quot;interactive&quot;)
  -h, --help                 help for dedupe</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="important-options-8">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h2 id="see-also-17">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-about">rclone about</h1>
<p>Get quota information from the remote.</p>
<h2 id="synopsis-18">Synopsis</h2>
<p>Prints quota information about a remote to standard output. The
output is typically used, free, quota and trash contents.</p>
<p>E.g. Typical output from <code>rclone about remote:</code> is:</p>
<pre class="text"><code>Total:   17 GiB
Used:    7.444 GiB
Free:    1.315 GiB
Trashed: 100.000 MiB
Other:   8.241 GiB</code></pre>
<p>Where the fields are:</p>
<ul>
<li>Total: Total size available.</li>
<li>Used: Total size used.</li>
<li>Free: Total space available to this user.</li>
<li>Trashed: Total space used by trash.</li>
<li>Other: Total amount in other storage (e.g. Gmail, Google
Photos).</li>
<li>Objects: Total number of objects in the storage.</li>
</ul>
<p>All sizes are in number of bytes.</p>
<p>Applying a <code>--full</code> flag to the command prints the bytes
in full, e.g.</p>
<pre class="text"><code>Total:   18253611008
Used:    7993453766
Free:    1411001220
Trashed: 104857602
Other:   8849156022</code></pre>
<p>A <code>--json</code> flag generates conveniently machine-readable
output, e.g.</p>
<div class="sourceCode" id="cb135"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb135-1"><a href="#cb135-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb135-2"><a href="#cb135-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;total&quot;</span><span class="fu">:</span> <span class="dv">18253611008</span><span class="fu">,</span></span>
<span id="cb135-3"><a href="#cb135-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;used&quot;</span><span class="fu">:</span> <span class="dv">7993453766</span><span class="fu">,</span></span>
<span id="cb135-4"><a href="#cb135-4" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;trashed&quot;</span><span class="fu">:</span> <span class="dv">104857602</span><span class="fu">,</span></span>
<span id="cb135-5"><a href="#cb135-5" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;other&quot;</span><span class="fu">:</span> <span class="dv">8849156022</span><span class="fu">,</span></span>
<span id="cb135-6"><a href="#cb135-6" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;free&quot;</span><span class="fu">:</span> <span class="dv">1411001220</span></span>
<span id="cb135-7"><a href="#cb135-7" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Not all backends print all fields. Information is not included if it
is not provided by a backend. Where the value is unlimited it is
omitted.</p>
<p>Some backends does not support the <code>rclone about</code> command
at all, see complete list in <a
href="https://rclone.org/overview/#optional-features">documentation</a>.</p>
<pre><code>rclone about remote: [flags]</code></pre>
<h2 id="options-18">Options</h2>
<pre><code>      --full   Full numbers instead of human-readable
  -h, --help   help for about
      --json   Format output as JSON</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-18">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-authorize">rclone authorize</h1>
<p>Remote authorization.</p>
<h2 id="synopsis-19">Synopsis</h2>
<p>Remote authorization. Used to authorize a remote or headless rclone
from a machine with a browser. Use as instructed by rclone config. See
also the <a href="/remote_setup">remote setup documentation</a>.</p>
<p>The command requires 1-3 arguments:</p>
<ul>
<li>Name of a backend (e.g. "drive", "s3")</li>
<li>Either a base64 encoded JSON blob obtained from a previous rclone
config session</li>
<li>Or a client_id and client_secret pair obtained from the remote
service</li>
</ul>
<p>Use --auth-no-open-browser to prevent rclone to open auth link in
default browser automatically.</p>
<p>Use --template to generate HTML output via a custom Go template. If a
blank string is provided as an argument to this flag, the default
template is used.</p>
<pre><code>rclone authorize &lt;backendname&gt; [base64_json_blob | client_id client_secret] [flags]</code></pre>
<h2 id="options-19">Options</h2>
<pre><code>      --auth-no-open-browser   Do not automatically open auth link in default browser
  -h, --help                   help for authorize
      --template string        The path to a custom Go template for generating HTML responses</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-19">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-backend">rclone backend</h1>
<p>Run a backend-specific command.</p>
<h2 id="synopsis-20">Synopsis</h2>
<p>This runs a backend-specific command. The commands themselves (except
for "help" and "features") are defined by the backends and you should
see the backend docs for definitions.</p>
<p>You can discover what commands a backend implements by using</p>
<div class="sourceCode" id="cb140"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb140-1"><a href="#cb140-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> backend help remote:</span>
<span id="cb140-2"><a href="#cb140-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> backend help <span class="op">&lt;</span>backendname<span class="op">&gt;</span></span></code></pre></div>
<p>You can also discover information about the backend using (see <a
href="https://rclone.org/rc/#operations-fsinfo">operations/fsinfo</a> in
the remote control docs for more info).</p>
<div class="sourceCode" id="cb141"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb141-1"><a href="#cb141-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> backend features remote:</span></code></pre></div>
<p>Pass options to the backend command with -o. This should be key=value
or key, e.g.:</p>
<div class="sourceCode" id="cb142"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb142-1"><a href="#cb142-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> backend stats remote:path stats <span class="at">-o</span> format=json <span class="at">-o</span> long</span></code></pre></div>
<p>Pass arguments to the backend by placing them on the end of the
line</p>
<div class="sourceCode" id="cb143"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb143-1"><a href="#cb143-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> backend cleanup remote:path file1 file2 file3</span></code></pre></div>
<p>Note to run these commands on a running backend then see <a
href="https://rclone.org/rc/#backend-command">backend/command</a> in the
rc docs.</p>
<pre><code>rclone backend &lt;command&gt; remote:path [opts] &lt;args&gt; [flags]</code></pre>
<h2 id="options-20">Options</h2>
<pre><code>  -h, --help                 help for backend
      --json                 Always output in JSON format
  -o, --option stringArray   Option in the form name=value or name</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="important-options-9">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h2 id="see-also-20">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-bisync">rclone bisync</h1>
<p>Perform bidirectional synchronization between two paths.</p>
<h2 id="synopsis-21">Synopsis</h2>
<p>Perform bidirectional synchronization between two paths.</p>
<p><a href="https://rclone.org/bisync/">Bisync</a> provides a
bidirectional cloud sync solution in rclone. It retains the Path1 and
Path2 filesystem listings from the prior run. On each successive run it
will:</p>
<ul>
<li>list files on Path1 and Path2, and check for changes on each side.
Changes include <code>New</code>, <code>Newer</code>,
<code>Older</code>, and <code>Deleted</code> files.</li>
<li>Propagate changes on Path1 to Path2, and vice-versa.</li>
</ul>
<p>Bisync is considered an <strong>advanced command</strong>, so use
with care. Make sure you have read and understood the entire <a
href="https://rclone.org/bisync">manual</a> (especially the <a
href="https://rclone.org/bisync/#limitations">Limitations</a> section)
before using, or data loss can result. Questions can be asked in the <a
href="https://forum.rclone.org/">Rclone Forum</a>.</p>
<p>See <a href="https://rclone.org/bisync/">full bisync description</a>
for details.</p>
<pre><code>rclone bisync remote1:path1 remote2:path2 [flags]</code></pre>
<h2 id="options-21">Options</h2>
<pre><code>      --backup-dir1 string                   --backup-dir for Path1. Must be a non-overlapping path on the same remote.
      --backup-dir2 string                   --backup-dir for Path2. Must be a non-overlapping path on the same remote.
      --check-access                         Ensure expected RCLONE_TEST files are found on both Path1 and Path2 filesystems, else abort.
      --check-filename string                Filename for --check-access (default: RCLONE_TEST)
      --check-sync string                    Controls comparison of final listings: true|false|only (default: true) (default &quot;true&quot;)
      --compare string                       Comma-separated list of bisync-specific compare options ex. &#39;size,modtime,checksum&#39; (default: &#39;size,modtime&#39;)
      --conflict-loser ConflictLoserAction   Action to take on the loser of a sync conflict (when there is a winner) or on both files (when there is no winner): , num, pathname, delete (default: num)
      --conflict-resolve string              Automatically resolve conflicts by preferring the version that is: none, path1, path2, newer, older, larger, smaller (default: none) (default &quot;none&quot;)
      --conflict-suffix string               Suffix to use when renaming a --conflict-loser. Can be either one string or two comma-separated strings to assign different suffixes to Path1/Path2. (default: &#39;conflict&#39;)
      --create-empty-src-dirs                Sync creation and deletion of empty directories. (Not compatible with --remove-empty-dirs)
      --download-hash                        Compute hash by downloading when otherwise unavailable. (warning: may be slow and use lots of data!)
      --filters-file string                  Read filtering patterns from a file
      --force                                Bypass --max-delete safety check and run the sync. Consider using with --verbose
  -h, --help                                 help for bisync
      --ignore-listing-checksum              Do not use checksums for listings (add --ignore-checksum to additionally skip post-copy checksum checks)
      --max-lock Duration                    Consider lock files older than this to be expired (default: 0 (never expire)) (minimum: 2m) (default 0s)
      --no-cleanup                           Retain working files (useful for troubleshooting and testing).
      --no-slow-hash                         Ignore listing checksums only on backends where they are slow
      --recover                              Automatically recover from interruptions without requiring --resync.
      --remove-empty-dirs                    Remove ALL empty directories at the final cleanup step.
      --resilient                            Allow future runs to retry after certain less-serious errors, instead of requiring --resync.
  -1, --resync                               Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first.
      --resync-mode string                   During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) (default &quot;none&quot;)
      --slow-hash-sync-only                  Ignore slow checksums for listings and deltas, but still consider them during sync calls.
      --workdir string                       Use custom working dir - useful for testing. (default: {WORKDIR})</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="copy-options-3">Copy Options</h3>
<p>Flags for anything which can copy a file</p>
<pre class="text"><code>      --check-first                                 Do all the checks before starting transfers
  -c, --checksum                                    Check for changes with size &amp; checksum (if available, or fallback to size only)
      --compare-dest stringArray                    Include additional server-side paths during comparison
      --copy-dest stringArray                       Implies --compare-dest but also copies files from paths into destination
      --cutoff-mode HARD|SOFT|CAUTIOUS              Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
      --ignore-case-sync                            Ignore case when synchronizing
      --ignore-checksum                             Skip post copy check of checksums
      --ignore-existing                             Skip all files that exist on destination
      --ignore-size                                 Ignore size when skipping use modtime or checksum
  -I, --ignore-times                                Don&#39;t skip items that match size and time - transfer all unconditionally
      --immutable                                   Do not modify files, fail if existing files have been modified
      --inplace                                     Download directly to destination file instead of atomic download to temp/rename
  -l, --links                                       Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension
      --max-backlog int                             Maximum number of objects in sync or check backlog (default 10000)
      --max-duration Duration                       Maximum duration rclone will transfer data for (default 0s)
      --max-transfer SizeSuffix                     Maximum size of data to transfer (default off)
  -M, --metadata                                    If set, preserve metadata when copying objects
      --modify-window Duration                      Max time diff to be considered the same (default 1ns)
      --multi-thread-chunk-size SizeSuffix          Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi)
      --multi-thread-cutoff SizeSuffix              Use multi-thread downloads for files above this size (default 256Mi)
      --multi-thread-streams int                    Number of streams to use for multi-thread downloads (default 4)
      --multi-thread-write-buffer-size SizeSuffix   In memory buffer size for writing when in multi-thread mode (default 128Ki)
      --name-transform stringArray                  Transform paths during the copy process
      --no-check-dest                               Don&#39;t check the destination, copy regardless
      --no-traverse                                 Don&#39;t traverse destination file system on copy
      --no-update-dir-modtime                       Don&#39;t update directory modification times
      --no-update-modtime                           Don&#39;t update destination modtime if files identical
      --order-by string                             Instructions on how to order the transfers, e.g. &#39;size,descending&#39;
      --partial-suffix string                       Add partial-suffix to temporary file name when --inplace is not used (default &quot;.partial&quot;)
      --refresh-times                               Refresh the modtime of remote files
      --server-side-across-configs                  Allow server-side operations (e.g. copy) to work across different configs
      --size-only                                   Skip based on size only, not modtime or checksum
      --streaming-upload-cutoff SizeSuffix          Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki)
  -u, --update                                      Skip files that are newer on the destination</code></pre>
<h3 id="important-options-10">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h3 id="filter-options-11">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h2 id="see-also-21">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-cat">rclone cat</h1>
<p>Concatenates any files and sends them to stdout.</p>
<h2 id="synopsis-22">Synopsis</h2>
<p>Sends any files to standard output.</p>
<p>You can use it like this to output a single file</p>
<div class="sourceCode" id="cb152"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb152-1"><a href="#cb152-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> cat remote:path/to/file</span></code></pre></div>
<p>Or like this to output any file in dir or its subdirectories.</p>
<div class="sourceCode" id="cb153"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb153-1"><a href="#cb153-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> cat remote:path/to/dir</span></code></pre></div>
<p>Or like this to output any .txt files in dir or its
subdirectories.</p>
<div class="sourceCode" id="cb154"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb154-1"><a href="#cb154-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">--include</span> <span class="st">&quot;*.txt&quot;</span> cat remote:path/to/dir</span></code></pre></div>
<p>Use the <code>--head</code> flag to print characters only at the
start, <code>--tail</code> for the end and <code>--offset</code> and
<code>--count</code> to print a section in the middle. Note that if
offset is negative it will count from the end, so
<code>--offset -1 --count 1</code> is equivalent to
<code>--tail 1</code>.</p>
<p>Use the <code>--separator</code> flag to print a separator value
between files. Be sure to shell-escape special characters. For example,
to print a newline between files, use:</p>
<ul>
<li><p>bash:</p>
<div class="sourceCode" id="cb155"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb155-1"><a href="#cb155-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">--include</span> <span class="st">&quot;*.txt&quot;</span> <span class="at">--separator</span> <span class="st">$&#39;</span><span class="dt">\n</span><span class="st">&#39;</span> cat remote:path/to/dir</span></code></pre></div></li>
<li><p>powershell:</p>
<div class="sourceCode" id="cb156"><pre
class="sourceCode powershell"><code class="sourceCode powershell"><span id="cb156-1"><a href="#cb156-1" aria-hidden="true" tabindex="-1"></a>rclone <span class="op">--</span>include <span class="st">&quot;*.txt&quot;</span> <span class="op">--</span>separator <span class="st">&quot;</span><span class="ch">`n</span><span class="st">&quot;</span> <span class="fu">cat</span> remote<span class="op">:</span>path<span class="op">/</span>to<span class="op">/</span><span class="fu">dir</span></span></code></pre></div></li>
</ul>
<pre><code>rclone cat remote:path [flags]</code></pre>
<h2 id="options-22">Options</h2>
<pre><code>      --count int          Only print N characters (default -1)
      --discard            Discard the output instead of printing
      --head int           Only print the first N characters
  -h, --help               help for cat
      --offset int         Start printing at offset N (or from end if -ve)
      --separator string   Separator to use between objects when printing multiple files
      --tail int           Only print the last N characters</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-12">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-11">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-22">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-checksum">rclone checksum</h1>
<p>Checks the files in the destination against a SUM file.</p>
<h2 id="synopsis-23">Synopsis</h2>
<p>Checks that hashsums of destination files match the SUM file. It
compares hashes (MD5, SHA1, etc) and logs a report of files which don't
match. It doesn't alter the file system.</p>
<p>The sumfile is treated as the source and the dst:path is treated as
the destination for the purposes of the output.</p>
<p>If you supply the <code>--download</code> flag, it will download the
data from the remote and calculate the content hash on the fly. This can
be useful for remotes that don't support hashes or if you really want to
check all the data.</p>
<p>Note that hash values in the SUM file are treated as case
insensitive.</p>
<p>If you supply the <code>--one-way</code> flag, it will only check
that files in the source match the files in the destination, not the
other way around. This means that extra files in the destination that
are not in the source will not be detected.</p>
<p>The <code>--differ</code>, <code>--missing-on-dst</code>,
<code>--missing-on-src</code>, <code>--match</code> and
<code>--error</code> flags write paths, one per line, to the file name
(or stdout if it is <code>-</code>) supplied. What they write is
described in the help below. For example <code>--differ</code> will
write all paths which are present on both the source and destination but
different.</p>
<p>The <code>--combined</code> flag will write a file (or stdout) which
contains all file paths with a symbol and then a space and then the path
to tell you what happened to it. These are reminiscent of diff
files.</p>
<ul>
<li><code>= path</code> means path was found in source and destination
and was identical</li>
<li><code>- path</code> means path was missing on the source, so only in
the destination</li>
<li><code>+ path</code> means path was missing on the destination, so
only in the source</li>
<li><code>* path</code> means path was present in source and destination
but different.</li>
<li><code>! path</code> means there was an error reading or hashing the
source or dest.</li>
</ul>
<p>The default number of parallel checks is 8. See the <a
href="https://rclone.org/docs/#checkers-int">--checkers</a> option for
more information.</p>
<pre><code>rclone checksum &lt;hash&gt; sumfile dst:path [flags]</code></pre>
<h2 id="options-23">Options</h2>
<pre><code>      --combined string         Make a combined report of changes to this file
      --differ string           Report all non-matching files to this file
      --download                Check by hashing the contents
      --error string            Report all files with errors (hashing or reading) to this file
  -h, --help                    help for checksum
      --match string            Report all matching files to this file
      --missing-on-dst string   Report all files missing from the destination to this file
      --missing-on-src string   Report all files missing from the source to this file
      --one-way                 Check one way only, source files must exist on remote</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-13">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-12">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-23">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-completion">rclone completion</h1>
<p>Output completion script for a given shell.</p>
<h2 id="synopsis-24">Synopsis</h2>
<p>Generates a shell completion script for rclone. Run with
<code>--help</code> to list the supported shells.</p>
<h2 id="options-24">Options</h2>
<pre><code>  -h, --help   help for completion</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-24">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
<li><a href="https://rclone.org/commands/rclone_completion_bash/">rclone
completion bash</a> - Output bash completion script for rclone.</li>
<li><a href="https://rclone.org/commands/rclone_completion_fish/">rclone
completion fish</a> - Output fish completion script for rclone.</li>
<li><a
href="https://rclone.org/commands/rclone_completion_powershell/">rclone
completion powershell</a> - Output powershell completion script for
rclone.</li>
<li><a href="https://rclone.org/commands/rclone_completion_zsh/">rclone
completion zsh</a> - Output zsh completion script for rclone.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-completion-bash">rclone completion bash</h1>
<p>Output bash completion script for rclone.</p>
<h2 id="synopsis-25">Synopsis</h2>
<p>Generates a bash shell autocompletion script for rclone.</p>
<p>By default, when run without any arguments,</p>
<div class="sourceCode" id="cb166"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb166-1"><a href="#cb166-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> completion bash</span></code></pre></div>
<p>the generated script will be written to</p>
<div class="sourceCode" id="cb167"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb167-1"><a href="#cb167-1" aria-hidden="true" tabindex="-1"></a><span class="ex">/etc/bash_completion.d/rclone</span></span></code></pre></div>
<p>and so rclone will probably need to be run as root, or with sudo.</p>
<p>If you supply a path to a file as the command line argument, then the
generated script will be written to that file, in which case you should
not need root privileges.</p>
<p>If output_file is "-", then the output will be written to stdout.</p>
<p>If you have installed the script into the default location, you can
logout and login again to use the autocompletion script.</p>
<p>Alternatively, you can source the script directly</p>
<div class="sourceCode" id="cb168"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb168-1"><a href="#cb168-1" aria-hidden="true" tabindex="-1"></a><span class="bu">.</span> /path/to/my_bash_completion_scripts/rclone</span></code></pre></div>
<p>and the autocompletion functionality will be added to your current
shell.</p>
<pre><code>rclone completion bash [output_file] [flags]</code></pre>
<h2 id="options-25">Options</h2>
<pre><code>  -h, --help   help for bash</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-25">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_completion/">rclone
completion</a> - Output completion script for a given shell.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-completion-fish">rclone completion fish</h1>
<p>Output fish completion script for rclone.</p>
<h2 id="synopsis-26">Synopsis</h2>
<p>Generates a fish autocompletion script for rclone.</p>
<p>This writes to /etc/fish/completions/rclone.fish by default so will
probably need to be run with sudo or as root, e.g.</p>
<div class="sourceCode" id="cb171"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb171-1"><a href="#cb171-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> rclone completion fish</span></code></pre></div>
<p>Logout and login again to use the autocompletion scripts, or source
them directly</p>
<div class="sourceCode" id="cb172"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb172-1"><a href="#cb172-1" aria-hidden="true" tabindex="-1"></a><span class="bu">.</span> /etc/fish/completions/rclone.fish</span></code></pre></div>
<p>If you supply a command line argument the script will be written
there.</p>
<p>If output_file is "-", then the output will be written to stdout.</p>
<pre><code>rclone completion fish [output_file] [flags]</code></pre>
<h2 id="options-26">Options</h2>
<pre><code>  -h, --help   help for fish</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-26">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_completion/">rclone
completion</a> - Output completion script for a given shell.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-completion-powershell">rclone completion powershell</h1>
<p>Output powershell completion script for rclone.</p>
<h2 id="synopsis-27">Synopsis</h2>
<p>Generate the autocompletion script for powershell.</p>
<p>To load completions in your current shell session:</p>
<div class="sourceCode" id="cb175"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb175-1"><a href="#cb175-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> completion powershell <span class="kw">|</span> <span class="ex">Out-String</span> <span class="kw">|</span> <span class="ex">Invoke-Expression</span></span></code></pre></div>
<p>To load completions for every new session, add the output of the
above command to your powershell profile.</p>
<p>If output_file is "-" or missing, then the output will be written to
stdout.</p>
<pre><code>rclone completion powershell [output_file] [flags]</code></pre>
<h2 id="options-27">Options</h2>
<pre><code>  -h, --help   help for powershell</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-27">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_completion/">rclone
completion</a> - Output completion script for a given shell.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-completion-zsh">rclone completion zsh</h1>
<p>Output zsh completion script for rclone.</p>
<h2 id="synopsis-28">Synopsis</h2>
<p>Generates a zsh autocompletion script for rclone.</p>
<p>This writes to /usr/share/zsh/vendor-completions/_rclone by default
so will probably need to be run with sudo or as root, e.g.</p>
<div class="sourceCode" id="cb178"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb178-1"><a href="#cb178-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> rclone completion zsh</span></code></pre></div>
<p>Logout and login again to use the autocompletion scripts, or source
them directly</p>
<div class="sourceCode" id="cb179"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb179-1"><a href="#cb179-1" aria-hidden="true" tabindex="-1"></a><span class="ex">autoload</span> <span class="at">-U</span> compinit <span class="kw">&amp;&amp;</span> <span class="ex">compinit</span></span></code></pre></div>
<p>If you supply a command line argument the script will be written
there.</p>
<p>If output_file is "-", then the output will be written to stdout.</p>
<pre><code>rclone completion zsh [output_file] [flags]</code></pre>
<h2 id="options-28">Options</h2>
<pre><code>  -h, --help   help for zsh</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-28">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_completion/">rclone
completion</a> - Output completion script for a given shell.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-create">rclone config create</h1>
<p>Create a new remote with name, type and options.</p>
<h2 id="synopsis-29">Synopsis</h2>
<p>Create a new remote of <code>name</code> with <code>type</code> and
options. The options should be passed in pairs of <code>key</code>
<code>value</code> or as <code>key=value</code>.</p>
<p>For example, to make a swift remote of name myremote using auto
config you would do:</p>
<div class="sourceCode" id="cb182"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb182-1"><a href="#cb182-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config create myremote swift env_auth true</span>
<span id="cb182-2"><a href="#cb182-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config create myremote swift env_auth=true</span></code></pre></div>
<p>So for example if you wanted to configure a Google Drive remote but
using remote authorization you would do this:</p>
<div class="sourceCode" id="cb183"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb183-1"><a href="#cb183-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config create mydrive drive config_is_local=false</span></code></pre></div>
<p>Note that if the config process would normally ask a question the
default is taken (unless <code>--non-interactive</code> is used). Each
time that happens rclone will print or DEBUG a message saying how to
affect the value taken.</p>
<p>If any of the parameters passed is a password field, then rclone will
automatically obscure them if they aren't already obscured before
putting them in the config file.</p>
<p><strong>NB</strong> If the password parameter is 22 characters or
longer and consists only of base64 characters then rclone can get
confused about whether the password is already obscured or not and put
unobscured passwords into the config file. If you want to be 100%
certain that the passwords get obscured then use the
<code>--obscure</code> flag, or if you are 100% certain you are already
passing obscured passwords then use <code>--no-obscure</code>. You can
also set obscured passwords using the
<code>rclone config password</code> command.</p>
<p>The flag <code>--non-interactive</code> is for use by applications
that wish to configure rclone themselves, rather than using rclone's
text based configuration questions. If this flag is set, and rclone
needs to ask the user a question, a JSON blob will be returned with the
question in it.</p>
<p>This will look something like (some irrelevant detail removed):</p>
<div class="sourceCode" id="cb184"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb184-1"><a href="#cb184-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb184-2"><a href="#cb184-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;State&quot;</span><span class="fu">:</span> <span class="st">&quot;*oauth-islocal,teamdrive,,&quot;</span><span class="fu">,</span></span>
<span id="cb184-3"><a href="#cb184-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Option&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb184-4"><a href="#cb184-4" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Name&quot;</span><span class="fu">:</span> <span class="st">&quot;config_is_local&quot;</span><span class="fu">,</span></span>
<span id="cb184-5"><a href="#cb184-5" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Use web browser to automatically authenticate rclone with remote?</span><span class="ch">\n</span><span class="st"> * Say Y if the machine running rclone has a web browser you can use</span><span class="ch">\n</span><span class="st"> * Say N if running rclone on a (remote) machine without web browser access</span><span class="ch">\n</span><span class="st">If not sure try Y. If Y failed, try N.</span><span class="ch">\n</span><span class="st">&quot;</span><span class="fu">,</span></span>
<span id="cb184-6"><a href="#cb184-6" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Default&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
<span id="cb184-7"><a href="#cb184-7" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Examples&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
<span id="cb184-8"><a href="#cb184-8" aria-hidden="true" tabindex="-1"></a>      <span class="fu">{</span></span>
<span id="cb184-9"><a href="#cb184-9" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;true&quot;</span><span class="fu">,</span></span>
<span id="cb184-10"><a href="#cb184-10" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Yes&quot;</span></span>
<span id="cb184-11"><a href="#cb184-11" aria-hidden="true" tabindex="-1"></a>      <span class="fu">}</span><span class="ot">,</span></span>
<span id="cb184-12"><a href="#cb184-12" aria-hidden="true" tabindex="-1"></a>      <span class="fu">{</span></span>
<span id="cb184-13"><a href="#cb184-13" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;false&quot;</span><span class="fu">,</span></span>
<span id="cb184-14"><a href="#cb184-14" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;No&quot;</span></span>
<span id="cb184-15"><a href="#cb184-15" aria-hidden="true" tabindex="-1"></a>      <span class="fu">}</span></span>
<span id="cb184-16"><a href="#cb184-16" aria-hidden="true" tabindex="-1"></a>    <span class="ot">]</span><span class="fu">,</span></span>
<span id="cb184-17"><a href="#cb184-17" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Required&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
<span id="cb184-18"><a href="#cb184-18" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;IsPassword&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
<span id="cb184-19"><a href="#cb184-19" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Type&quot;</span><span class="fu">:</span> <span class="st">&quot;bool&quot;</span><span class="fu">,</span></span>
<span id="cb184-20"><a href="#cb184-20" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Exclusive&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
<span id="cb184-21"><a href="#cb184-21" aria-hidden="true" tabindex="-1"></a>  <span class="fu">},</span></span>
<span id="cb184-22"><a href="#cb184-22" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Error&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
<span id="cb184-23"><a href="#cb184-23" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>The format of <code>Option</code> is the same as returned by
<code>rclone config providers</code>. The question should be asked to
the user and returned to rclone as the <code>--result</code> option
along with the <code>--state</code> parameter.</p>
<p>The keys of <code>Option</code> are used as follows:</p>
<ul>
<li><code>Name</code> - name of variable - show to user</li>
<li><code>Help</code> - help text. Hard wrapped at 80 chars. Any URLs
should be clicky.</li>
<li><code>Default</code> - default value - return this if the user just
wants the default.</li>
<li><code>Examples</code> - the user should be able to choose one of
these</li>
<li><code>Required</code> - the value should be non-empty</li>
<li><code>IsPassword</code> - the value is a password and should be
edited as such</li>
<li><code>Type</code> - type of value, eg <code>bool</code>,
<code>string</code>, <code>int</code> and others</li>
<li><code>Exclusive</code> - if set no free-form entry allowed only the
<code>Examples</code></li>
<li>Irrelevant keys <code>Provider</code>, <code>ShortOpt</code>,
<code>Hide</code>, <code>NoPrefix</code>, <code>Advanced</code></li>
</ul>
<p>If <code>Error</code> is set then it should be shown to the user at
the same time as the question.</p>
<div class="sourceCode" id="cb185"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb185-1"><a href="#cb185-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update name <span class="at">--continue</span> <span class="at">--state</span> <span class="st">&quot;*oauth-islocal,teamdrive,,&quot;</span> <span class="at">--result</span> <span class="st">&quot;true&quot;</span></span></code></pre></div>
<p>Note that when using <code>--continue</code> all passwords should be
passed in the clear (not obscured). Any default config values should be
passed in with each invocation of <code>--continue</code>.</p>
<p>At the end of the non interactive process, rclone will return a
result with <code>State</code> as empty string.</p>
<p>If <code>--all</code> is passed then rclone will ask all the config
questions, not just the post config questions. Any parameters are used
as defaults for questions as usual.</p>
<p>Note that <code>bin/config.py</code> in the rclone source implements
this protocol as a readable demonstration.</p>
<pre><code>rclone config create name type [key value]* [flags]</code></pre>
<h2 id="options-29">Options</h2>
<pre><code>      --all               Ask the full set of config questions
      --continue          Continue the configuration process with an answer
  -h, --help              help for create
      --no-obscure        Force any passwords not to be obscured
      --no-output         Don&#39;t provide any output
      --non-interactive   Don&#39;t interact with user and return questions
      --obscure           Force any passwords to be obscured
      --result string     Result - use with --continue
      --state string      State - use with --continue</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-29">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-delete">rclone config delete</h1>
<p>Delete an existing remote.</p>
<pre><code>rclone config delete name [flags]</code></pre>
<h2 id="options-30">Options</h2>
<pre><code>  -h, --help   help for delete</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-30">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-disconnect">rclone config disconnect</h1>
<p>Disconnects user from remote</p>
<h2 id="synopsis-30">Synopsis</h2>
<p>This disconnects the remote: passed in to the cloud storage
system.</p>
<p>This normally means revoking the oauth token.</p>
<p>To reconnect use "rclone config reconnect".</p>
<pre><code>rclone config disconnect remote: [flags]</code></pre>
<h2 id="options-31">Options</h2>
<pre><code>  -h, --help   help for disconnect</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-31">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-dump">rclone config dump</h1>
<p>Dump the config file as JSON.</p>
<pre><code>rclone config dump [flags]</code></pre>
<h2 id="options-32">Options</h2>
<pre><code>  -h, --help   help for dump</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-32">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-edit">rclone config edit</h1>
<p>Enter an interactive configuration session.</p>
<h2 id="synopsis-31">Synopsis</h2>
<p>Enter an interactive configuration session where you can setup new
remotes and manage existing ones. You may also set or remove a password
to protect your configuration.</p>
<pre><code>rclone config edit [flags]</code></pre>
<h2 id="options-33">Options</h2>
<pre><code>  -h, --help   help for edit</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-33">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-encryption">rclone config encryption</h1>
<p>set, remove and check the encryption for the config file</p>
<h2 id="synopsis-32">Synopsis</h2>
<p>This command sets, clears and checks the encryption for the config
file using the subcommands below.</p>
<h2 id="options-34">Options</h2>
<pre><code>  -h, --help   help for encryption</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-34">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
<li><a
href="https://rclone.org/commands/rclone_config_encryption_check/">rclone
config encryption check</a> - Check that the config file is
encrypted</li>
<li><a
href="https://rclone.org/commands/rclone_config_encryption_remove/">rclone
config encryption remove</a> - Remove the config file encryption
password</li>
<li><a
href="https://rclone.org/commands/rclone_config_encryption_set/">rclone
config encryption set</a> - Set or change the config file encryption
password</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-encryption-check">rclone config encryption
check</h1>
<p>Check that the config file is encrypted</p>
<h2 id="synopsis-33">Synopsis</h2>
<p>This checks the config file is encrypted and that you can decrypt
it.</p>
<p>It will attempt to decrypt the config using the password you
supply.</p>
<p>If decryption fails it will return a non-zero exit code if using
<code>--password-command</code>, otherwise it will prompt again for the
password.</p>
<p>If the config file is not encrypted it will return a non zero exit
code.</p>
<pre><code>rclone config encryption check [flags]</code></pre>
<h2 id="options-35">Options</h2>
<pre><code>  -h, --help   help for check</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-35">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a
href="https://rclone.org/commands/rclone_config_encryption/">rclone
config encryption</a> - set, remove and check the encryption for the
config file</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-encryption-remove">rclone config encryption
remove</h1>
<p>Remove the config file encryption password</p>
<h2 id="synopsis-34">Synopsis</h2>
<p>Remove the config file encryption password</p>
<p>This removes the config file encryption, returning it to
un-encrypted.</p>
<p>If <code>--password-command</code> is in use, this will be called to
supply the old config password.</p>
<p>If the config was not encrypted then no error will be returned and
this command will do nothing.</p>
<pre><code>rclone config encryption remove [flags]</code></pre>
<h2 id="options-36">Options</h2>
<pre><code>  -h, --help   help for remove</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-36">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a
href="https://rclone.org/commands/rclone_config_encryption/">rclone
config encryption</a> - set, remove and check the encryption for the
config file</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-encryption-set">rclone config encryption set</h1>
<p>Set or change the config file encryption password</p>
<h2 id="synopsis-35">Synopsis</h2>
<p>This command sets or changes the config file encryption password.</p>
<p>If there was no config password set then it sets a new one, otherwise
it changes the existing config password.</p>
<p>Note that if you are changing an encryption password using
<code>--password-command</code> then this will be called once to decrypt
the config using the old password and then again to read the new
password to re-encrypt the config.</p>
<p>When <code>--password-command</code> is called to change the password
then the environment variable <code>RCLONE_PASSWORD_CHANGE=1</code> will
be set. So if changing passwords programmatically you can use the
environment variable to distinguish which password you must supply.</p>
<p>Alternatively you can remove the password first (with
<code>rclone config encryption remove</code>), then set it again with
this command which may be easier if you don't mind the unencrypted
config file being on the disk briefly.</p>
<pre><code>rclone config encryption set [flags]</code></pre>
<h2 id="options-37">Options</h2>
<pre><code>  -h, --help   help for set</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-37">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a
href="https://rclone.org/commands/rclone_config_encryption/">rclone
config encryption</a> - set, remove and check the encryption for the
config file</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-file">rclone config file</h1>
<p>Show path of configuration file in use.</p>
<pre><code>rclone config file [flags]</code></pre>
<h2 id="options-38">Options</h2>
<pre><code>  -h, --help   help for file</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-38">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-password">rclone config password</h1>
<p>Update password in an existing remote.</p>
<h2 id="synopsis-36">Synopsis</h2>
<p>Update an existing remote's password. The password should be passed
in pairs of <code>key</code> <code>password</code> or as
<code>key=password</code>. The <code>password</code> should be passed in
in clear (unobscured).</p>
<p>For example, to set password of a remote of name myremote you would
do:</p>
<div class="sourceCode" id="cb205"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb205-1"><a href="#cb205-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config password myremote fieldname mypassword</span>
<span id="cb205-2"><a href="#cb205-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config password myremote fieldname=mypassword</span></code></pre></div>
<p>This command is obsolete now that "config update" and "config create"
both support obscuring passwords directly.</p>
<pre><code>rclone config password name [key value]+ [flags]</code></pre>
<h2 id="options-39">Options</h2>
<pre><code>  -h, --help   help for password</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-39">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-paths">rclone config paths</h1>
<p>Show paths used for configuration, cache, temp etc.</p>
<pre><code>rclone config paths [flags]</code></pre>
<h2 id="options-40">Options</h2>
<pre><code>  -h, --help   help for paths</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-40">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-providers">rclone config providers</h1>
<p>List in JSON format all the providers and options.</p>
<pre><code>rclone config providers [flags]</code></pre>
<h2 id="options-41">Options</h2>
<pre><code>  -h, --help   help for providers</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-41">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-reconnect">rclone config reconnect</h1>
<p>Re-authenticates user with remote.</p>
<h2 id="synopsis-37">Synopsis</h2>
<p>This reconnects remote: passed in to the cloud storage system.</p>
<p>To disconnect the remote use "rclone config disconnect".</p>
<p>This normally means going through the interactive oauth flow
again.</p>
<pre><code>rclone config reconnect remote: [flags]</code></pre>
<h2 id="options-42">Options</h2>
<pre><code>  -h, --help   help for reconnect</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-42">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-redacted">rclone config redacted</h1>
<p>Print redacted (decrypted) config file, or the redacted config for a
single remote.</p>
<h2 id="synopsis-38">Synopsis</h2>
<p>This prints a redacted copy of the config file, either the whole
config file or for a given remote.</p>
<p>The config file will be redacted by replacing all passwords and other
sensitive info with XXX.</p>
<p>This makes the config file suitable for posting online for
support.</p>
<p>It should be double checked before posting as the redaction may not
be perfect.</p>
<pre><code>rclone config redacted [&lt;remote&gt;] [flags]</code></pre>
<h2 id="options-43">Options</h2>
<pre><code>  -h, --help   help for redacted</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-43">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-show">rclone config show</h1>
<p>Print (decrypted) config file, or the config for a single remote.</p>
<pre><code>rclone config show [&lt;remote&gt;] [flags]</code></pre>
<h2 id="options-44">Options</h2>
<pre><code>  -h, --help   help for show</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-44">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-touch">rclone config touch</h1>
<p>Ensure configuration file exists.</p>
<pre><code>rclone config touch [flags]</code></pre>
<h2 id="options-45">Options</h2>
<pre><code>  -h, --help   help for touch</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-45">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-update">rclone config update</h1>
<p>Update options in an existing remote.</p>
<h2 id="synopsis-39">Synopsis</h2>
<p>Update an existing remote's options. The options should be passed in
pairs of <code>key</code> <code>value</code> or as
<code>key=value</code>.</p>
<p>For example, to update the env_auth field of a remote of name
myremote you would do:</p>
<div class="sourceCode" id="cb220"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb220-1"><a href="#cb220-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update myremote env_auth true</span>
<span id="cb220-2"><a href="#cb220-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update myremote env_auth=true</span></code></pre></div>
<p>If the remote uses OAuth the token will be updated, if you don't
require this add an extra parameter thus:</p>
<div class="sourceCode" id="cb221"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb221-1"><a href="#cb221-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update myremote env_auth=true config_refresh_token=false</span></code></pre></div>
<p>Note that if the config process would normally ask a question the
default is taken (unless <code>--non-interactive</code> is used). Each
time that happens rclone will print or DEBUG a message saying how to
affect the value taken.</p>
<p>If any of the parameters passed is a password field, then rclone will
automatically obscure them if they aren't already obscured before
putting them in the config file.</p>
<p><strong>NB</strong> If the password parameter is 22 characters or
longer and consists only of base64 characters then rclone can get
confused about whether the password is already obscured or not and put
unobscured passwords into the config file. If you want to be 100%
certain that the passwords get obscured then use the
<code>--obscure</code> flag, or if you are 100% certain you are already
passing obscured passwords then use <code>--no-obscure</code>. You can
also set obscured passwords using the
<code>rclone config password</code> command.</p>
<p>The flag <code>--non-interactive</code> is for use by applications
that wish to configure rclone themselves, rather than using rclone's
text based configuration questions. If this flag is set, and rclone
needs to ask the user a question, a JSON blob will be returned with the
question in it.</p>
<p>This will look something like (some irrelevant detail removed):</p>
<div class="sourceCode" id="cb222"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb222-1"><a href="#cb222-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb222-2"><a href="#cb222-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;State&quot;</span><span class="fu">:</span> <span class="st">&quot;*oauth-islocal,teamdrive,,&quot;</span><span class="fu">,</span></span>
<span id="cb222-3"><a href="#cb222-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Option&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb222-4"><a href="#cb222-4" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Name&quot;</span><span class="fu">:</span> <span class="st">&quot;config_is_local&quot;</span><span class="fu">,</span></span>
<span id="cb222-5"><a href="#cb222-5" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Use web browser to automatically authenticate rclone with remote?</span><span class="ch">\n</span><span class="st"> * Say Y if the machine running rclone has a web browser you can use</span><span class="ch">\n</span><span class="st"> * Say N if running rclone on a (remote) machine without web browser access</span><span class="ch">\n</span><span class="st">If not sure try Y. If Y failed, try N.</span><span class="ch">\n</span><span class="st">&quot;</span><span class="fu">,</span></span>
<span id="cb222-6"><a href="#cb222-6" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Default&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
<span id="cb222-7"><a href="#cb222-7" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Examples&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
<span id="cb222-8"><a href="#cb222-8" aria-hidden="true" tabindex="-1"></a>      <span class="fu">{</span></span>
<span id="cb222-9"><a href="#cb222-9" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;true&quot;</span><span class="fu">,</span></span>
<span id="cb222-10"><a href="#cb222-10" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Yes&quot;</span></span>
<span id="cb222-11"><a href="#cb222-11" aria-hidden="true" tabindex="-1"></a>      <span class="fu">}</span><span class="ot">,</span></span>
<span id="cb222-12"><a href="#cb222-12" aria-hidden="true" tabindex="-1"></a>      <span class="fu">{</span></span>
<span id="cb222-13"><a href="#cb222-13" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;false&quot;</span><span class="fu">,</span></span>
<span id="cb222-14"><a href="#cb222-14" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;No&quot;</span></span>
<span id="cb222-15"><a href="#cb222-15" aria-hidden="true" tabindex="-1"></a>      <span class="fu">}</span></span>
<span id="cb222-16"><a href="#cb222-16" aria-hidden="true" tabindex="-1"></a>    <span class="ot">]</span><span class="fu">,</span></span>
<span id="cb222-17"><a href="#cb222-17" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Required&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
<span id="cb222-18"><a href="#cb222-18" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;IsPassword&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
<span id="cb222-19"><a href="#cb222-19" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Type&quot;</span><span class="fu">:</span> <span class="st">&quot;bool&quot;</span><span class="fu">,</span></span>
<span id="cb222-20"><a href="#cb222-20" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Exclusive&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
<span id="cb222-21"><a href="#cb222-21" aria-hidden="true" tabindex="-1"></a>  <span class="fu">},</span></span>
<span id="cb222-22"><a href="#cb222-22" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Error&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
<span id="cb222-23"><a href="#cb222-23" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>The format of <code>Option</code> is the same as returned by
<code>rclone config providers</code>. The question should be asked to
the user and returned to rclone as the <code>--result</code> option
along with the <code>--state</code> parameter.</p>
<p>The keys of <code>Option</code> are used as follows:</p>
<ul>
<li><code>Name</code> - name of variable - show to user</li>
<li><code>Help</code> - help text. Hard wrapped at 80 chars. Any URLs
should be clicky.</li>
<li><code>Default</code> - default value - return this if the user just
wants the default.</li>
<li><code>Examples</code> - the user should be able to choose one of
these</li>
<li><code>Required</code> - the value should be non-empty</li>
<li><code>IsPassword</code> - the value is a password and should be
edited as such</li>
<li><code>Type</code> - type of value, eg <code>bool</code>,
<code>string</code>, <code>int</code> and others</li>
<li><code>Exclusive</code> - if set no free-form entry allowed only the
<code>Examples</code></li>
<li>Irrelevant keys <code>Provider</code>, <code>ShortOpt</code>,
<code>Hide</code>, <code>NoPrefix</code>, <code>Advanced</code></li>
</ul>
<p>If <code>Error</code> is set then it should be shown to the user at
the same time as the question.</p>
<div class="sourceCode" id="cb223"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb223-1"><a href="#cb223-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update name <span class="at">--continue</span> <span class="at">--state</span> <span class="st">&quot;*oauth-islocal,teamdrive,,&quot;</span> <span class="at">--result</span> <span class="st">&quot;true&quot;</span></span></code></pre></div>
<p>Note that when using <code>--continue</code> all passwords should be
passed in the clear (not obscured). Any default config values should be
passed in with each invocation of <code>--continue</code>.</p>
<p>At the end of the non interactive process, rclone will return a
result with <code>State</code> as empty string.</p>
<p>If <code>--all</code> is passed then rclone will ask all the config
questions, not just the post config questions. Any parameters are used
as defaults for questions as usual.</p>
<p>Note that <code>bin/config.py</code> in the rclone source implements
this protocol as a readable demonstration.</p>
<pre><code>rclone config update name [key value]+ [flags]</code></pre>
<h2 id="options-46">Options</h2>
<pre><code>      --all               Ask the full set of config questions
      --continue          Continue the configuration process with an answer
  -h, --help              help for update
      --no-obscure        Force any passwords not to be obscured
      --no-output         Don&#39;t provide any output
      --non-interactive   Don&#39;t interact with user and return questions
      --obscure           Force any passwords to be obscured
      --result string     Result - use with --continue
      --state string      State - use with --continue</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-46">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-config-userinfo">rclone config userinfo</h1>
<p>Prints info about logged in user of remote.</p>
<h2 id="synopsis-40">Synopsis</h2>
<p>This prints the details of the person logged in to the cloud storage
system.</p>
<pre><code>rclone config userinfo remote: [flags]</code></pre>
<h2 id="options-47">Options</h2>
<pre><code>  -h, --help   help for userinfo
      --json   Format output as JSON</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-47">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-convmv">rclone convmv</h1>
<p>Convert file and directory names in place.</p>
<h2 id="synopsis-41">Synopsis</h2>
<p>convmv supports advanced path name transformations for converting and
renaming files and directories by applying prefixes, suffixes, and other
alterations.</p>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="header">
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><code>--name-transform prefix=XXXX</code></td>
<td>Prepends XXXX to the file name.</td>
</tr>
<tr class="even">
<td><code>--name-transform suffix=XXXX</code></td>
<td>Appends XXXX to the file name after the extension.</td>
</tr>
<tr class="odd">
<td><code>--name-transform suffix_keep_extension=XXXX</code></td>
<td>Appends XXXX to the file name while preserving the original file
extension.</td>
</tr>
<tr class="even">
<td><code>--name-transform trimprefix=XXXX</code></td>
<td>Removes XXXX if it appears at the start of the file name.</td>
</tr>
<tr class="odd">
<td><code>--name-transform trimsuffix=XXXX</code></td>
<td>Removes XXXX if it appears at the end of the file name.</td>
</tr>
<tr class="even">
<td><code>--name-transform regex=pattern/replacement</code></td>
<td>Applies a regex-based transformation.</td>
</tr>
<tr class="odd">
<td><code>--name-transform replace=old:new</code></td>
<td>Replaces occurrences of old with new in the file name.</td>
</tr>
<tr class="even">
<td><code>--name-transform date={YYYYMMDD}</code></td>
<td>Appends or prefixes the specified date format.</td>
</tr>
<tr class="odd">
<td><code>--name-transform truncate=N</code></td>
<td>Truncates the file name to a maximum of N characters.</td>
</tr>
<tr class="even">
<td><code>--name-transform truncate_keep_extension=N</code></td>
<td>Truncates the file name to a maximum of N characters while
preserving the original file extension.</td>
</tr>
<tr class="odd">
<td><code>--name-transform truncate_bytes=N</code></td>
<td>Truncates the file name to a maximum of N bytes (not
characters).</td>
</tr>
<tr class="even">
<td><code>--name-transform truncate_bytes_keep_extension=N</code></td>
<td>Truncates the file name to a maximum of N bytes (not characters)
while preserving the original file extension.</td>
</tr>
<tr class="odd">
<td><code>--name-transform base64encode</code></td>
<td>Encodes the file name in Base64.</td>
</tr>
<tr class="even">
<td><code>--name-transform base64decode</code></td>
<td>Decodes a Base64-encoded file name.</td>
</tr>
<tr class="odd">
<td><code>--name-transform encoder=ENCODING</code></td>
<td>Converts the file name to the specified encoding (e.g., ISO-8859-1,
Windows-1252, Macintosh).</td>
</tr>
<tr class="even">
<td><code>--name-transform decoder=ENCODING</code></td>
<td>Decodes the file name from the specified encoding.</td>
</tr>
<tr class="odd">
<td><code>--name-transform charmap=MAP</code></td>
<td>Applies a character mapping transformation.</td>
</tr>
<tr class="even">
<td><code>--name-transform lowercase</code></td>
<td>Converts the file name to lowercase.</td>
</tr>
<tr class="odd">
<td><code>--name-transform uppercase</code></td>
<td>Converts the file name to UPPERCASE.</td>
</tr>
<tr class="even">
<td><code>--name-transform titlecase</code></td>
<td>Converts the file name to Title Case.</td>
</tr>
<tr class="odd">
<td><code>--name-transform ascii</code></td>
<td>Strips non-ASCII characters.</td>
</tr>
<tr class="even">
<td><code>--name-transform url</code></td>
<td>URL-encodes the file name.</td>
</tr>
<tr class="odd">
<td><code>--name-transform nfc</code></td>
<td>Converts the file name to NFC Unicode normalization form.</td>
</tr>
<tr class="even">
<td><code>--name-transform nfd</code></td>
<td>Converts the file name to NFD Unicode normalization form.</td>
</tr>
<tr class="odd">
<td><code>--name-transform nfkc</code></td>
<td>Converts the file name to NFKC Unicode normalization form.</td>
</tr>
<tr class="even">
<td><code>--name-transform nfkd</code></td>
<td>Converts the file name to NFKD Unicode normalization form.</td>
</tr>
<tr class="odd">
<td><code>--name-transform command=/path/to/my/programfile names.</code></td>
<td>Executes an external program to transform.</td>
</tr>
</tbody>
</table>
<p>Conversion modes:</p>
<pre class="text"><code>none
nfc
nfd
nfkc
nfkd
replace
prefix
suffix
suffix_keep_extension
trimprefix
trimsuffix
index
date
truncate
truncate_keep_extension
truncate_bytes
truncate_bytes_keep_extension
base64encode
base64decode
encoder
decoder
ISO-8859-1
Windows-1252
Macintosh
charmap
lowercase
uppercase
titlecase
ascii
url
regex
command</code></pre>
<p>Char maps:</p>
<pre class="text"><code>IBM-Code-Page-037
IBM-Code-Page-437
IBM-Code-Page-850
IBM-Code-Page-852
IBM-Code-Page-855
Windows-Code-Page-858
IBM-Code-Page-860
IBM-Code-Page-862
IBM-Code-Page-863
IBM-Code-Page-865
IBM-Code-Page-866
IBM-Code-Page-1047
IBM-Code-Page-1140
ISO-8859-1
ISO-8859-2
ISO-8859-3
ISO-8859-4
ISO-8859-5
ISO-8859-6
ISO-8859-7
ISO-8859-8
ISO-8859-9
ISO-8859-10
ISO-8859-13
ISO-8859-14
ISO-8859-15
ISO-8859-16
KOI8-R
KOI8-U
Macintosh
Macintosh-Cyrillic
Windows-874
Windows-1250
Windows-1251
Windows-1252
Windows-1253
Windows-1254
Windows-1255
Windows-1256
Windows-1257
Windows-1258
X-User-Defined</code></pre>
<p>Encoding masks:</p>
<pre class="text"><code>Asterisk
BackQuote
BackSlash
Colon
CrLf
Ctl
Del
Dollar
Dot
DoubleQuote
Exclamation
Hash
InvalidUtf8
LeftCrLfHtVt
LeftPeriod
LeftSpace
LeftTilde
LtGt
None
Percent
Pipe
Question
Raw
RightCrLfHtVt
RightPeriod
RightSpace
Semicolon
SingleQuote
Slash
SquareBracket</code></pre>
<p>Examples:</p>
<div class="sourceCode" id="cb231"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb231-1"><a href="#cb231-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,uppercase&quot;</span></span>
<span id="cb231-2"><a href="#cb231-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: STORIES/THE QUICK BROWN FOX!.TXT</span></code></pre></div>
<div class="sourceCode" id="cb232"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb232-1"><a href="#cb232-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,replace=Fox:Turtle&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,replace=Quick:Slow&quot;</span></span>
<span id="cb232-2"><a href="#cb232-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Slow Brown Turtle!.txt</span></code></pre></div>
<div class="sourceCode" id="cb233"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb233-1"><a href="#cb233-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,base64encode&quot;</span></span>
<span id="cb233-2"><a href="#cb233-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: c3Rvcmllcw==/VGhlIFF1aWNrIEJyb3duIEZveCEudHh0</span></code></pre></div>
<div class="sourceCode" id="cb234"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb234-1"><a href="#cb234-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;c3Rvcmllcw==/VGhlIFF1aWNrIEJyb3duIEZveCEudHh0&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,base64decode&quot;</span></span>
<span id="cb234-2"><a href="#cb234-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown Fox!.txt</span></code></pre></div>
<div class="sourceCode" id="cb235"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb235-1"><a href="#cb235-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown 🦊 Fox Went to the Café!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,nfc&quot;</span></span>
<span id="cb235-2"><a href="#cb235-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown 🦊 Fox Went to the Café!.txt</span></code></pre></div>
<div class="sourceCode" id="cb236"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb236-1"><a href="#cb236-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown 🦊 Fox Went to the Café!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,nfd&quot;</span></span>
<span id="cb236-2"><a href="#cb236-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown 🦊 Fox Went to the Café!.txt</span></code></pre></div>
<div class="sourceCode" id="cb237"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb237-1"><a href="#cb237-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown 🦊 Fox!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,ascii&quot;</span></span>
<span id="cb237-2"><a href="#cb237-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown  Fox!.txt</span></code></pre></div>
<div class="sourceCode" id="cb238"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb238-1"><a href="#cb238-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,trimsuffix=.txt&quot;</span></span>
<span id="cb238-2"><a href="#cb238-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown Fox!</span></code></pre></div>
<div class="sourceCode" id="cb239"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb239-1"><a href="#cb239-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,prefix=OLD_&quot;</span></span>
<span id="cb239-2"><a href="#cb239-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: OLD_stories/OLD_The Quick Brown Fox!.txt</span></code></pre></div>
<div class="sourceCode" id="cb240"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb240-1"><a href="#cb240-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown 🦊 Fox Went to the Café!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,charmap=ISO-8859-7&quot;</span></span>
<span id="cb240-2"><a href="#cb240-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown _ Fox Went to the Caf_!.txt</span></code></pre></div>
<div class="sourceCode" id="cb241"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb241-1"><a href="#cb241-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox: A Memoir [draft].txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,encoder=Colon,SquareBracket&quot;</span></span>
<span id="cb241-2"><a href="#cb241-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown Fox： A Memoir ［draft］.txt</span></code></pre></div>
<div class="sourceCode" id="cb242"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb242-1"><a href="#cb242-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown 🦊 Fox Went to the Café!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,truncate=21&quot;</span></span>
<span id="cb242-2"><a href="#cb242-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown 🦊 Fox</span></code></pre></div>
<div class="sourceCode" id="cb243"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb243-1"><a href="#cb243-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,command=echo&quot;</span></span>
<span id="cb243-2"><a href="#cb243-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown Fox!.txt</span></code></pre></div>
<div class="sourceCode" id="cb244"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb244-1"><a href="#cb244-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox!&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;date=-{YYYYMMDD}&quot;</span></span>
<span id="cb244-2"><a href="#cb244-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown Fox!-20251020</span></code></pre></div>
<div class="sourceCode" id="cb245"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb245-1"><a href="#cb245-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox!&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;date=-{macfriendlytime}&quot;</span></span>
<span id="cb245-2"><a href="#cb245-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown Fox!-2025-10-20 1251PM</span></code></pre></div>
<div class="sourceCode" id="cb246"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb246-1"><a href="#cb246-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,regex=[</span><span class="dt">\\</span><span class="st">.</span><span class="dt">\\</span><span class="st">w]/ab&quot;</span></span>
<span id="cb246-2"><a href="#cb246-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: ababababababab/ababab ababababab ababababab ababab!abababab</span></code></pre></div>
<p>The regex command generally accepts Perl-style regular expressions,
the exact syntax is defined in the <a
href="https://golang.org/pkg/regexp/syntax/">Go regular expression
reference</a>. The replacement string may contain capturing group
variables, referencing capturing groups using the syntax
<code>$name</code> or <code>${name}</code>, where the name can refer to
a named capturing group or it can simply be the index as a number. To
insert a literal $, use $$.</p>
<p>Multiple transformations can be used in sequence, applied in the
order they are specified on the command line.</p>
<p>The <code>--name-transform</code> flag is also available in
<code>sync</code>, <code>copy</code>, and <code>move</code>.</p>
<h2 id="files-vs-directories">Files vs Directories</h2>
<p>By default <code>--name-transform</code> will only apply to file
names. The means only the leaf file name will be transformed. However
some of the transforms would be better applied to the whole path or just
directories. To choose which which part of the file path is affected
some tags can be added to the <code>--name-transform</code>.</p>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="header">
<th>Tag</th>
<th>Effect</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><code>file</code></td>
<td>Only transform the leaf name of files (DEFAULT)</td>
</tr>
<tr class="even">
<td><code>dir</code></td>
<td>Only transform name of directories - these may appear anywhere in
the path</td>
</tr>
<tr class="odd">
<td><code>all</code></td>
<td>Transform the entire path for files and directories</td>
</tr>
</tbody>
</table>
<p>This is used by adding the tag into the transform name like this:
<code>--name-transform file,prefix=ABC</code> or
<code>--name-transform dir,prefix=DEF</code>.</p>
<p>For some conversions using all is more likely to be useful, for
example <code>--name-transform all,nfc</code>.</p>
<p>Note that <code>--name-transform</code> may not add path separators
<code>/</code> to the name. This will cause an error.</p>
<h2 id="ordering-and-conflicts">Ordering and Conflicts</h2>
<ul>
<li>Transformations will be applied in the order specified by the user.
<ul>
<li>If the <code>file</code> tag is in use (the default) then only the
leaf name of files will be transformed.</li>
<li>If the <code>dir</code> tag is in use then directories anywhere in
the path will be transformed</li>
<li>If the <code>all</code> tag is in use then directories and files
anywhere in the path will be transformed</li>
<li>Each transformation will be run one path segment at a time.</li>
<li>If a transformation adds a <code>/</code> or ends up with an empty
path segment then that will be an error.</li>
</ul></li>
<li>It is up to the user to put the transformations in a sensible order.
<ul>
<li>Conflicting transformations, such as <code>prefix</code> followed by
<code>trimprefix</code> or <code>nfc</code> followed by
<code>nfd</code>, are possible.</li>
<li>Instead of enforcing mutual exclusivity, transformations are applied
in sequence as specified by the user, allowing for intentional use cases
(e.g., trimming one prefix before adding another).</li>
<li>Users should be aware that certain combinations may lead to
unexpected results and should verify transformations using
<code>--dry-run</code> before execution.</li>
</ul></li>
</ul>
<h2 id="race-conditions-and-non-deterministic-behavior">Race Conditions
and Non-Deterministic Behavior</h2>
<p>Some transformations, such as <code>replace=old:new</code>, may
introduce conflicts where multiple source files map to the same
destination name. This can lead to race conditions when performing
concurrent transfers. It is up to the user to anticipate these.</p>
<ul>
<li>If two files from the source are transformed into the same name at
the destination, the final state may be non-deterministic.</li>
<li>Running rclone check after a sync using such transformations may
erroneously report missing or differing files due to overwritten
results.</li>
</ul>
<p>To minimize risks, users should:</p>
<ul>
<li>Carefully review transformations that may introduce conflicts.</li>
<li>Use <code>--dry-run</code> to inspect changes before executing a
sync (but keep in mind that it won't show the effect of
non-deterministic transformations).</li>
<li>Avoid transformations that cause multiple distinct source files to
map to the same destination name.</li>
<li>Consider disabling concurrency with <code>--transfers=1</code> if
necessary.</li>
<li>Certain transformations (e.g. <code>prefix</code>) will have a
multiplying effect every time they are used. Avoid these when using
<code>bisync</code>.</li>
</ul>
<pre><code>rclone convmv dest:path --name-transform XXX [flags]</code></pre>
<h2 id="options-48">Options</h2>
<pre><code>      --create-empty-src-dirs   Create empty source dirs on destination after move
      --delete-empty-src-dirs   Delete empty source dirs after move
  -h, --help                    help for convmv</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="copy-options-4">Copy Options</h3>
<p>Flags for anything which can copy a file</p>
<pre class="text"><code>      --check-first                                 Do all the checks before starting transfers
  -c, --checksum                                    Check for changes with size &amp; checksum (if available, or fallback to size only)
      --compare-dest stringArray                    Include additional server-side paths during comparison
      --copy-dest stringArray                       Implies --compare-dest but also copies files from paths into destination
      --cutoff-mode HARD|SOFT|CAUTIOUS              Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
      --ignore-case-sync                            Ignore case when synchronizing
      --ignore-checksum                             Skip post copy check of checksums
      --ignore-existing                             Skip all files that exist on destination
      --ignore-size                                 Ignore size when skipping use modtime or checksum
  -I, --ignore-times                                Don&#39;t skip items that match size and time - transfer all unconditionally
      --immutable                                   Do not modify files, fail if existing files have been modified
      --inplace                                     Download directly to destination file instead of atomic download to temp/rename
  -l, --links                                       Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension
      --max-backlog int                             Maximum number of objects in sync or check backlog (default 10000)
      --max-duration Duration                       Maximum duration rclone will transfer data for (default 0s)
      --max-transfer SizeSuffix                     Maximum size of data to transfer (default off)
  -M, --metadata                                    If set, preserve metadata when copying objects
      --modify-window Duration                      Max time diff to be considered the same (default 1ns)
      --multi-thread-chunk-size SizeSuffix          Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi)
      --multi-thread-cutoff SizeSuffix              Use multi-thread downloads for files above this size (default 256Mi)
      --multi-thread-streams int                    Number of streams to use for multi-thread downloads (default 4)
      --multi-thread-write-buffer-size SizeSuffix   In memory buffer size for writing when in multi-thread mode (default 128Ki)
      --name-transform stringArray                  Transform paths during the copy process
      --no-check-dest                               Don&#39;t check the destination, copy regardless
      --no-traverse                                 Don&#39;t traverse destination file system on copy
      --no-update-dir-modtime                       Don&#39;t update directory modification times
      --no-update-modtime                           Don&#39;t update destination modtime if files identical
      --order-by string                             Instructions on how to order the transfers, e.g. &#39;size,descending&#39;
      --partial-suffix string                       Add partial-suffix to temporary file name when --inplace is not used (default &quot;.partial&quot;)
      --refresh-times                               Refresh the modtime of remote files
      --server-side-across-configs                  Allow server-side operations (e.g. copy) to work across different configs
      --size-only                                   Skip based on size only, not modtime or checksum
      --streaming-upload-cutoff SizeSuffix          Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki)
  -u, --update                                      Skip files that are newer on the destination</code></pre>
<h3 id="important-options-11">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h3 id="filter-options-14">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-13">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-48">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-copyto">rclone copyto</h1>
<p>Copy files from source to dest, skipping identical files.</p>
<h2 id="synopsis-42">Synopsis</h2>
<p>If source:path is a file or directory then it copies it to a file or
directory named dest:path.</p>
<p>This can be used to upload single files to other than their current
name. If the source is a directory then it acts exactly like the <a
href="https://rclone.org/commands/rclone_copy/">copy</a> command.</p>
<p>So</p>
<div class="sourceCode" id="cb253"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb253-1"><a href="#cb253-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copyto src dst</span></code></pre></div>
<p>where src and dst are rclone paths, either <code>remote:path</code>
or <code>/path/to/local</code> or
<code>C:\windows\path\if\on\windows</code>.</p>
<p>This will:</p>
<pre class="text"><code>if src is file
    copy it to dst, overwriting an existing file if it exists
if src is directory
    copy it to dst, overwriting existing files if they exist
    see copy command for full details</code></pre>
<p>This doesn't transfer files that are identical on src and dst,
testing by size and modification time or MD5SUM. It doesn't delete files
from the destination.</p>
<p><em>If you are looking to copy just a byte range of a file, please
see <code>rclone cat --offset X --count Y</code>.</em></p>
<p><strong>Note</strong>: Use the
<code>-P</code>/<code>--progress</code> flag to view real-time transfer
statistics.</p>
<h2 id="logger-flags-3">Logger Flags</h2>
<p>The <code>--differ</code>, <code>--missing-on-dst</code>,
<code>--missing-on-src</code>, <code>--match</code> and
<code>--error</code> flags write paths, one per line, to the file name
(or stdout if it is <code>-</code>) supplied. What they write is
described in the help below. For example <code>--differ</code> will
write all paths which are present on both the source and destination but
different.</p>
<p>The <code>--combined</code> flag will write a file (or stdout) which
contains all file paths with a symbol and then a space and then the path
to tell you what happened to it. These are reminiscent of diff
files.</p>
<ul>
<li><code>= path</code> means path was found in source and destination
and was identical</li>
<li><code>- path</code> means path was missing on the source, so only in
the destination</li>
<li><code>+ path</code> means path was missing on the destination, so
only in the source</li>
<li><code>* path</code> means path was present in source and destination
but different.</li>
<li><code>! path</code> means there was an error reading or hashing the
source or dest.</li>
</ul>
<p>The <code>--dest-after</code> flag writes a list file using the same
format flags as <a
href="https://rclone.org/commands/rclone_lsf/#synopsis"><code>lsf</code></a>
(including <a
href="https://rclone.org/commands/rclone_lsf/#synopsis">customizable
options for hash, modtime, etc.</a>) Conceptually it is similar to
rsync's <code>--itemize-changes</code>, but not identical -- it should
output an accurate list of what will be on the destination after the
command is finished.</p>
<p>When the <code>--no-traverse</code> flag is set, all logs involving
files that exist only on the destination will be incomplete or
completely missing.</p>
<p>Note that these logger flags have a few limitations, and certain
scenarios are not currently supported:</p>
<ul>
<li><code>--max-duration</code> / <code>CutoffModeHard</code></li>
<li><code>--compare-dest</code> / <code>--copy-dest</code></li>
<li>server-side moves of an entire dir at once</li>
<li>High-level retries, because there would be duplicates (use
<code>--retries 1</code> to disable)</li>
<li>Possibly some unusual error scenarios</li>
</ul>
<p>Note also that each file is logged during execution, as opposed to
after, so it is most useful as a predictor of what SHOULD happen to each
file (which may or may not match what actually DID).</p>
<pre><code>rclone copyto source:path dest:path [flags]</code></pre>
<h2 id="options-49">Options</h2>
<pre><code>      --absolute                Put a leading / in front of path names
      --combined string         Make a combined report of changes to this file
      --csv                     Output in CSV format
      --dest-after string       Report all files that exist on the dest post-sync
      --differ string           Report all non-matching files to this file
  -d, --dir-slash               Append a slash to directory names (default true)
      --dirs-only               Only list directories
      --error string            Report all files with errors (hashing or reading) to this file
      --files-only              Only list files (default true)
  -F, --format string           Output format - see lsf help for details (default &quot;p&quot;)
      --hash h                  Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default &quot;md5&quot;)
  -h, --help                    help for copyto
      --match string            Report all matching files to this file
      --missing-on-dst string   Report all files missing from the destination to this file
      --missing-on-src string   Report all files missing from the source to this file
  -s, --separator string        Separator for the items in the format (default &quot;;&quot;)
  -t, --timeformat string       Specify a custom time format, or &#39;max&#39; for max precision supported by remote (default: 2006-01-02 15:04:05)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="copy-options-5">Copy Options</h3>
<p>Flags for anything which can copy a file</p>
<pre class="text"><code>      --check-first                                 Do all the checks before starting transfers
  -c, --checksum                                    Check for changes with size &amp; checksum (if available, or fallback to size only)
      --compare-dest stringArray                    Include additional server-side paths during comparison
      --copy-dest stringArray                       Implies --compare-dest but also copies files from paths into destination
      --cutoff-mode HARD|SOFT|CAUTIOUS              Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
      --ignore-case-sync                            Ignore case when synchronizing
      --ignore-checksum                             Skip post copy check of checksums
      --ignore-existing                             Skip all files that exist on destination
      --ignore-size                                 Ignore size when skipping use modtime or checksum
  -I, --ignore-times                                Don&#39;t skip items that match size and time - transfer all unconditionally
      --immutable                                   Do not modify files, fail if existing files have been modified
      --inplace                                     Download directly to destination file instead of atomic download to temp/rename
  -l, --links                                       Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension
      --max-backlog int                             Maximum number of objects in sync or check backlog (default 10000)
      --max-duration Duration                       Maximum duration rclone will transfer data for (default 0s)
      --max-transfer SizeSuffix                     Maximum size of data to transfer (default off)
  -M, --metadata                                    If set, preserve metadata when copying objects
      --modify-window Duration                      Max time diff to be considered the same (default 1ns)
      --multi-thread-chunk-size SizeSuffix          Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi)
      --multi-thread-cutoff SizeSuffix              Use multi-thread downloads for files above this size (default 256Mi)
      --multi-thread-streams int                    Number of streams to use for multi-thread downloads (default 4)
      --multi-thread-write-buffer-size SizeSuffix   In memory buffer size for writing when in multi-thread mode (default 128Ki)
      --name-transform stringArray                  Transform paths during the copy process
      --no-check-dest                               Don&#39;t check the destination, copy regardless
      --no-traverse                                 Don&#39;t traverse destination file system on copy
      --no-update-dir-modtime                       Don&#39;t update directory modification times
      --no-update-modtime                           Don&#39;t update destination modtime if files identical
      --order-by string                             Instructions on how to order the transfers, e.g. &#39;size,descending&#39;
      --partial-suffix string                       Add partial-suffix to temporary file name when --inplace is not used (default &quot;.partial&quot;)
      --refresh-times                               Refresh the modtime of remote files
      --server-side-across-configs                  Allow server-side operations (e.g. copy) to work across different configs
      --size-only                                   Skip based on size only, not modtime or checksum
      --streaming-upload-cutoff SizeSuffix          Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki)
  -u, --update                                      Skip files that are newer on the destination</code></pre>
<h3 id="important-options-12">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h3 id="filter-options-15">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-14">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-49">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-copyurl">rclone copyurl</h1>
<p>Copy the contents of the URL supplied content to dest:path.</p>
<h2 id="synopsis-43">Synopsis</h2>
<p>Download a URL's content and copy it to the destination without
saving it in temporary storage.</p>
<p>Setting <code>--auto-filename</code> will attempt to automatically
determine the filename from the URL (after any redirections) and used in
the destination path.</p>
<p>With <code>--header-filename</code> in addition, if a specific
filename is set in HTTP headers, it will be used instead of the name
from the URL. With <code>--print-filename</code> in addition, the
resulting file name will be printed.</p>
<p>Setting <code>--no-clobber</code> will prevent overwriting file on
the destination if there is one with the same name.</p>
<p>Setting <code>--stdout</code> or making the output file name
<code>-</code> will cause the output to be written to standard
output.</p>
<h2 id="troubleshooting">Troubleshooting</h2>
<p>If you can't get <code>rclone copyurl</code> to work then here are
some things you can try:</p>
<ul>
<li><code>--disable-http2</code> rclone will use HTTP2 if available -
try disabling it</li>
<li><code>--bind 0.0.0.0</code> rclone will use IPv6 if available - try
disabling it</li>
<li><code>--bind ::0</code> to disable IPv4</li>
<li><code>--user agent curl</code> - some sites have whitelists for
curl's user-agent - try that</li>
<li>Make sure the site works with <code>curl</code> directly</li>
</ul>
<pre><code>rclone copyurl https://example.com dest:path [flags]</code></pre>
<h2 id="options-50">Options</h2>
<pre><code>  -a, --auto-filename     Get the file name from the URL and use it for destination file path
      --header-filename   Get the file name from the Content-Disposition header
  -h, --help              help for copyurl
      --no-clobber        Prevent overwriting file with same name
  -p, --print-filename    Print the resulting name from --auto-filename
      --stdout            Write the output to stdout rather than a file</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="important-options-13">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h2 id="see-also-50">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-cryptcheck">rclone cryptcheck</h1>
<p>Cryptcheck checks the integrity of an encrypted remote.</p>
<h2 id="synopsis-44">Synopsis</h2>
<p>Checks a remote against a <a
href="https://rclone.org/crypt/">crypted</a> remote. This is the
equivalent of running rclone <a
href="https://rclone.org/commands/rclone_check/">check</a>, but able to
check the checksums of the encrypted remote.</p>
<p>For it to work the underlying remote of the cryptedremote must
support some kind of checksum.</p>
<p>It works by reading the nonce from each file on the cryptedremote:
and using that to encrypt each file on the remote:. It then checks the
checksum of the underlying file on the cryptedremote: against the
checksum of the file it has just encrypted.</p>
<p>Use it like this</p>
<div class="sourceCode" id="cb264"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb264-1"><a href="#cb264-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> cryptcheck /path/to/files encryptedremote:path</span></code></pre></div>
<p>You can use it like this also, but that will involve downloading all
the files in <code>remote:path</code>.</p>
<div class="sourceCode" id="cb265"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb265-1"><a href="#cb265-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> cryptcheck remote:path encryptedremote:path</span></code></pre></div>
<p>After it has run it will log the status of the
<code>encryptedremote:</code>.</p>
<p>If you supply the <code>--one-way</code> flag, it will only check
that files in the source match the files in the destination, not the
other way around. This means that extra files in the destination that
are not in the source will not be detected.</p>
<p>The <code>--differ</code>, <code>--missing-on-dst</code>,
<code>--missing-on-src</code>, <code>--match</code> and
<code>--error</code> flags write paths, one per line, to the file name
(or stdout if it is <code>-</code>) supplied. What they write is
described in the help below. For example <code>--differ</code> will
write all paths which are present on both the source and destination but
different.</p>
<p>The <code>--combined</code> flag will write a file (or stdout) which
contains all file paths with a symbol and then a space and then the path
to tell you what happened to it. These are reminiscent of diff
files.</p>
<ul>
<li><code>= path</code> means path was found in source and destination
and was identical</li>
<li><code>- path</code> means path was missing on the source, so only in
the destination</li>
<li><code>+ path</code> means path was missing on the destination, so
only in the source</li>
<li><code>* path</code> means path was present in source and destination
but different.</li>
<li><code>! path</code> means there was an error reading or hashing the
source or dest.</li>
</ul>
<p>The default number of parallel checks is 8. See the <a
href="https://rclone.org/docs/#checkers-int">--checkers</a> option for
more information.</p>
<pre><code>rclone cryptcheck remote:path cryptedremote:path [flags]</code></pre>
<h2 id="options-51">Options</h2>
<pre><code>      --combined string         Make a combined report of changes to this file
      --differ string           Report all non-matching files to this file
      --error string            Report all files with errors (hashing or reading) to this file
  -h, --help                    help for cryptcheck
      --match string            Report all matching files to this file
      --missing-on-dst string   Report all files missing from the destination to this file
      --missing-on-src string   Report all files missing from the source to this file
      --one-way                 Check one way only, source files must exist on remote</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="check-options-1">Check Options</h3>
<p>Flags used for check commands</p>
<pre class="text"><code>      --max-backlog int   Maximum number of objects in sync or check backlog (default 10000)</code></pre>
<h3 id="filter-options-16">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-15">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-51">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-cryptdecode">rclone cryptdecode</h1>
<p>Cryptdecode returns unencrypted file names.</p>
<h2 id="synopsis-45">Synopsis</h2>
<p>Returns unencrypted file names when provided with a list of encrypted
file names. List limit is 10 items.</p>
<p>If you supply the <code>--reverse</code> flag, it will return
encrypted file names.</p>
<p>use it like this</p>
<div class="sourceCode" id="cb271"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb271-1"><a href="#cb271-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> cryptdecode encryptedremote: encryptedfilename1 encryptedfilename2</span>
<span id="cb271-2"><a href="#cb271-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> cryptdecode <span class="at">--reverse</span> encryptedremote: filename1 filename2</span></code></pre></div>
<p>Another way to accomplish this is by using the
<code>rclone backend encode</code> (or <code>decode</code>) command. See
the documentation on the <a href="https://rclone.org/crypt/">crypt</a>
overlay for more info.</p>
<pre><code>rclone cryptdecode encryptedremote: encryptedfilename [flags]</code></pre>
<h2 id="options-52">Options</h2>
<pre><code>  -h, --help      help for cryptdecode
      --reverse   Reverse cryptdecode, encrypts filenames</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-52">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-deletefile">rclone deletefile</h1>
<p>Remove a single file from remote.</p>
<h2 id="synopsis-46">Synopsis</h2>
<p>Remove a single file from remote. Unlike <code>delete</code> it
cannot be used to remove a directory and it doesn't obey include/exclude
filters - if the specified file exists, it will always be removed.</p>
<pre><code>rclone deletefile remote:path [flags]</code></pre>
<h2 id="options-53">Options</h2>
<pre><code>  -h, --help   help for deletefile</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="important-options-14">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h2 id="see-also-53">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-gendocs">rclone gendocs</h1>
<p>Output markdown docs for rclone to the directory supplied.</p>
<h2 id="synopsis-47">Synopsis</h2>
<p>This produces markdown docs for the rclone commands to the directory
supplied. These are in a format suitable for hugo to render into the
rclone.org website.</p>
<pre><code>rclone gendocs output_directory [flags]</code></pre>
<h2 id="options-54">Options</h2>
<pre><code>  -h, --help   help for gendocs</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-54">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-gitannex">rclone gitannex</h1>
<p>Speaks with git-annex over stdin/stdout.</p>
<h2 id="synopsis-48">Synopsis</h2>
<p>Rclone's <code>gitannex</code> subcommand enables <a
href="https://git-annex.branchable.com/">git-annex</a> to store and
retrieve content from an rclone remote. It is meant to be run by
git-annex, not directly by users.</p>
<h2 id="installation-on-linux">Installation on Linux</h2>
<ol type="1">
<li><p>Skip this step if your version of git-annex is <a
href="https://git-annex.branchable.com/news/version_10.20240430/">10.20240430</a>
or newer. Otherwise, you must create a symlink somewhere on your PATH
with a particular name. This symlink helps git-annex tell rclone it
wants to run the "gitannex" subcommand.</p>
<div class="sourceCode" id="cb279"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb279-1"><a href="#cb279-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Create the helper symlink in &quot;$HOME/bin&quot;.</span></span>
<span id="cb279-2"><a href="#cb279-2" aria-hidden="true" tabindex="-1"></a><span class="fu">ln</span> <span class="at">-s</span> <span class="st">&quot;</span><span class="va">$(</span><span class="fu">realpath</span> rclone<span class="va">)</span><span class="st">&quot;</span> <span class="st">&quot;</span><span class="va">$HOME</span><span class="st">/bin/git-annex-remote-rclone-builtin&quot;</span></span>
<span id="cb279-3"><a href="#cb279-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb279-4"><a href="#cb279-4" aria-hidden="true" tabindex="-1"></a><span class="co"># Verify the new symlink is on your PATH.</span></span>
<span id="cb279-5"><a href="#cb279-5" aria-hidden="true" tabindex="-1"></a><span class="fu">which</span> git-annex-remote-rclone-builtin</span></code></pre></div></li>
<li><p>Add a new remote to your git-annex repo. This new remote will
connect git-annex with the <code>rclone gitannex</code> subcommand.</p>
<p>Start by asking git-annex to describe the remote's available
configuration parameters.</p>
<div class="sourceCode" id="cb280"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb280-1"><a href="#cb280-1" aria-hidden="true" tabindex="-1"></a><span class="co"># If you skipped step 1:</span></span>
<span id="cb280-2"><a href="#cb280-2" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> annex initremote MyRemote type=rclone <span class="at">--whatelse</span></span>
<span id="cb280-3"><a href="#cb280-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb280-4"><a href="#cb280-4" aria-hidden="true" tabindex="-1"></a><span class="co"># If you created a symlink in step 1:</span></span>
<span id="cb280-5"><a href="#cb280-5" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> annex initremote MyRemote type=external externaltype=rclone-builtin <span class="at">--whatelse</span></span></code></pre></div>
<blockquote>
<p><strong>NOTE</strong>: If you're porting an existing <a
href="https://github.com/git-annex-remote-rclone/git-annex-remote-rclone">git-annex-remote-rclone</a>
remote to use <code>rclone gitannex</code>, you can probably reuse the
configuration parameters verbatim without renaming them. Check parameter
synonyms with <code>--whatelse</code> as shown above.</p>
</blockquote>
<p>The following example creates a new git-annex remote named "MyRemote"
that will use the rclone remote named "SomeRcloneRemote". That rclone
remote must be one configured in your rclone.conf file, which can be
located with <code>rclone config file</code>.</p>
<div class="sourceCode" id="cb281"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb281-1"><a href="#cb281-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> annex initremote MyRemote         <span class="dt">\</span></span>
<span id="cb281-2"><a href="#cb281-2" aria-hidden="true" tabindex="-1"></a>    type=external                     <span class="dt">\</span></span>
<span id="cb281-3"><a href="#cb281-3" aria-hidden="true" tabindex="-1"></a>    externaltype=rclone-builtin       <span class="dt">\</span></span>
<span id="cb281-4"><a href="#cb281-4" aria-hidden="true" tabindex="-1"></a>    encryption=none                   <span class="dt">\</span></span>
<span id="cb281-5"><a href="#cb281-5" aria-hidden="true" tabindex="-1"></a>    rcloneremotename=SomeRcloneRemote <span class="dt">\</span></span>
<span id="cb281-6"><a href="#cb281-6" aria-hidden="true" tabindex="-1"></a>    rcloneprefix=git-annex-content    <span class="dt">\</span></span>
<span id="cb281-7"><a href="#cb281-7" aria-hidden="true" tabindex="-1"></a>    rclonelayout=nodir</span></code></pre></div></li>
<li><p>Before you trust this command with your precious data, be sure to
<strong>test the remote</strong>. This command is very new and has not
been tested on many rclone backends. Caveat emptor!</p>
<div class="sourceCode" id="cb282"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb282-1"><a href="#cb282-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> annex testremote MyRemote</span></code></pre></div></li>
</ol>
<p>Happy annexing!</p>
<pre><code>rclone gitannex [flags]</code></pre>
<h2 id="options-55">Options</h2>
<pre><code>  -h, --help   help for gitannex</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-55">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-hashsum">rclone hashsum</h1>
<p>Produces a hashsum file for all the objects in the path.</p>
<h2 id="synopsis-49">Synopsis</h2>
<p>Produces a hash file for all the objects in the path using the hash
named. The output is in the same format as the standard md5sum/sha1sum
tool.</p>
<p>By default, the hash is requested from the remote. If the hash is not
supported by the remote, no hash will be returned. With the download
flag, the file will be downloaded from the remote and hashed locally
enabling any hash for any remote.</p>
<p>For the MD5 and SHA1 algorithms there are also dedicated commands, <a
href="https://rclone.org/commands/rclone_md5sum/">md5sum</a> and <a
href="https://rclone.org/commands/rclone_sha1sum/">sha1sum</a>.</p>
<p>This command can also hash data received on standard input (stdin),
by not passing a remote:path, or by passing a hyphen as remote:path when
there is data to read (if not, the hyphen will be treated literally, as
a relative path).</p>
<p>Run without a hash to see the list of all supported hashes, e.g.</p>
<div class="sourceCode" id="cb285"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb285-1"><a href="#cb285-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone hashsum</span>
<span id="cb285-2"><a href="#cb285-2" aria-hidden="true" tabindex="-1"></a><span class="ex">Supported</span> hashes are:</span>
<span id="cb285-3"><a href="#cb285-3" aria-hidden="true" tabindex="-1"></a>  <span class="ex">*</span> md5</span>
<span id="cb285-4"><a href="#cb285-4" aria-hidden="true" tabindex="-1"></a>  <span class="ex">*</span> sha1</span>
<span id="cb285-5"><a href="#cb285-5" aria-hidden="true" tabindex="-1"></a>  <span class="ex">*</span> whirlpool</span>
<span id="cb285-6"><a href="#cb285-6" aria-hidden="true" tabindex="-1"></a>  <span class="ex">*</span> crc32</span>
<span id="cb285-7"><a href="#cb285-7" aria-hidden="true" tabindex="-1"></a>  <span class="ex">*</span> sha256</span>
<span id="cb285-8"><a href="#cb285-8" aria-hidden="true" tabindex="-1"></a>  <span class="ex">*</span> sha512</span>
<span id="cb285-9"><a href="#cb285-9" aria-hidden="true" tabindex="-1"></a>  <span class="ex">*</span> blake3</span>
<span id="cb285-10"><a href="#cb285-10" aria-hidden="true" tabindex="-1"></a>  <span class="ex">*</span> xxh3</span>
<span id="cb285-11"><a href="#cb285-11" aria-hidden="true" tabindex="-1"></a>  <span class="ex">*</span> xxh128</span></code></pre></div>
<p>Then</p>
<div class="sourceCode" id="cb286"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb286-1"><a href="#cb286-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> hashsum MD5 remote:path</span></code></pre></div>
<p>Note that hash names are case insensitive and values are output in
lower case.</p>
<pre><code>rclone hashsum [&lt;hash&gt; remote:path] [flags]</code></pre>
<h2 id="options-56">Options</h2>
<pre><code>      --base64               Output base64 encoded hashsum
  -C, --checkfile string     Validate hashes against a given SUM file instead of printing them
      --download             Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote
  -h, --help                 help for hashsum
      --output-file string   Output hashsums to a file rather than the terminal</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-17">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-16">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-56">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-link">rclone link</h1>
<p>Generate public link to file/folder.</p>
<h2 id="synopsis-50">Synopsis</h2>
<p>Create, retrieve or remove a public link to the given file or
folder.</p>
<div class="sourceCode" id="cb291"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb291-1"><a href="#cb291-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> link remote:path/to/file</span>
<span id="cb291-2"><a href="#cb291-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> link remote:path/to/folder/</span>
<span id="cb291-3"><a href="#cb291-3" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> link <span class="at">--unlink</span> remote:path/to/folder/</span>
<span id="cb291-4"><a href="#cb291-4" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> link <span class="at">--expire</span> 1d remote:path/to/file</span></code></pre></div>
<p>If you supply the --expire flag, it will set the expiration time
otherwise it will use the default (100 years). <strong>Note</strong> not
all backends support the --expire flag - if the backend doesn't support
it then the link returned won't expire.</p>
<p>Use the --unlink flag to remove existing public links to the file or
folder. <strong>Note</strong> not all backends support "--unlink" flag -
those that don't will just ignore it.</p>
<p>If successful, the last line of the output will contain the link.
Exact capabilities depend on the remote, but the link will always by
default be created with the least constraints - e.g. no expiry, no
password protection, accessible without account.</p>
<pre><code>rclone link remote:path [flags]</code></pre>
<h2 id="options-57">Options</h2>
<pre><code>      --expire Duration   The amount of time that the link will be valid (default off)
  -h, --help              help for link
      --unlink            Remove existing public link to file/folder</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-57">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-listremotes">rclone listremotes</h1>
<p>List all the remotes in the config file and defined in environment
variables.</p>
<h2 id="synopsis-51">Synopsis</h2>
<p>Lists all the available remotes from the config file, or the remotes
matching an optional filter.</p>
<p>Prints the result in human-readable format by default, and as a
simple list of remote names, or if used with flag <code>--long</code> a
tabular format including the remote names, types and descriptions. Using
flag <code>--json</code> produces machine-readable output instead, which
always includes all attributes - including the source (file or
environment).</p>
<p>Result can be filtered by a filter argument which applies to all
attributes, and/or filter flags specific for each attribute. The values
must be specified according to regular rclone filtering pattern
syntax.</p>
<pre><code>rclone listremotes [&lt;filter&gt;] [flags]</code></pre>
<h2 id="options-58">Options</h2>
<pre><code>      --description string   Filter remotes by description
  -h, --help                 help for listremotes
      --json                 Format output as JSON
      --long                 Show type and description in addition to name
      --name string          Filter remotes by name
      --order-by string      Instructions on how to order the result, e.g. &#39;type,name=descending&#39;
      --source string        Filter remotes by source, e.g. &#39;file&#39; or &#39;environment&#39;
      --type string          Filter remotes by type</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-58">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-lsf">rclone lsf</h1>
<p>List directories and objects in remote:path formatted for
parsing.</p>
<h2 id="synopsis-52">Synopsis</h2>
<p>List the contents of the source path (directories and objects) to
standard output in a form which is easy to parse by scripts. By default
this will just be the names of the objects and directories, one per
line. The directories will have a / suffix.</p>
<p>E.g.</p>
<div class="sourceCode" id="cb296"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb296-1"><a href="#cb296-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsf swift:bucket</span>
<span id="cb296-2"><a href="#cb296-2" aria-hidden="true" tabindex="-1"></a><span class="ex">bevajer5jef</span></span>
<span id="cb296-3"><a href="#cb296-3" aria-hidden="true" tabindex="-1"></a><span class="ex">canole</span></span>
<span id="cb296-4"><a href="#cb296-4" aria-hidden="true" tabindex="-1"></a><span class="ex">diwogej7</span></span>
<span id="cb296-5"><a href="#cb296-5" aria-hidden="true" tabindex="-1"></a><span class="ex">ferejej3gux/</span></span>
<span id="cb296-6"><a href="#cb296-6" aria-hidden="true" tabindex="-1"></a><span class="ex">fubuwic</span></span></code></pre></div>
<p>Use the <code>--format</code> option to control what gets listed. By
default this is just the path, but you can use these parameters to
control the output:</p>
<pre class="text"><code>p - path
s - size
t - modification time
h - hash
i - ID of object
o - Original ID of underlying object
m - MimeType of object if known
e - encrypted name
T - tier of storage if known, e.g. &quot;Hot&quot; or &quot;Cool&quot;
M - Metadata of object in JSON blob format, eg {&quot;key&quot;:&quot;value&quot;}</code></pre>
<p>So if you wanted the path, size and modification time, you would use
<code>--format "pst"</code>, or maybe <code>--format "tsp"</code> to put
the path last.</p>
<p>E.g.</p>
<div class="sourceCode" id="cb298"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb298-1"><a href="#cb298-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsf  <span class="at">--format</span> <span class="st">&quot;tsp&quot;</span> swift:bucket</span>
<span id="cb298-2"><a href="#cb298-2" aria-hidden="true" tabindex="-1"></a><span class="ex">2016-06-25</span> 18:55:41<span class="kw">;</span><span class="ex">60295</span><span class="kw">;</span><span class="ex">bevajer5jef</span></span>
<span id="cb298-3"><a href="#cb298-3" aria-hidden="true" tabindex="-1"></a><span class="ex">2016-06-25</span> 18:55:43<span class="kw">;</span><span class="ex">90613</span><span class="kw">;</span><span class="ex">canole</span></span>
<span id="cb298-4"><a href="#cb298-4" aria-hidden="true" tabindex="-1"></a><span class="ex">2016-06-25</span> 18:55:43<span class="kw">;</span><span class="ex">94467</span><span class="kw">;</span><span class="ex">diwogej7</span></span>
<span id="cb298-5"><a href="#cb298-5" aria-hidden="true" tabindex="-1"></a><span class="ex">2018-04-26</span> 08:50:45<span class="kw">;</span><span class="ex">0</span><span class="kw">;</span><span class="ex">ferejej3gux/</span></span>
<span id="cb298-6"><a href="#cb298-6" aria-hidden="true" tabindex="-1"></a><span class="ex">2016-06-25</span> 18:55:40<span class="kw">;</span><span class="ex">37600</span><span class="kw">;</span><span class="ex">fubuwic</span></span></code></pre></div>
<p>If you specify "h" in the format you will get the MD5 hash by
default, use the <code>--hash</code> flag to change which hash you want.
Note that this can be returned as an empty string if it isn't available
on the object (and for directories), "ERROR" if there was an error
reading it from the object and "UNSUPPORTED" if that object does not
support that hash type.</p>
<p>For example, to emulate the md5sum command you can use</p>
<div class="sourceCode" id="cb299"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb299-1"><a href="#cb299-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf <span class="at">-R</span> <span class="at">--hash</span> MD5 <span class="at">--format</span> hp <span class="at">--separator</span> <span class="st">&quot;  &quot;</span> <span class="at">--files-only</span> .</span></code></pre></div>
<p>E.g.</p>
<div class="sourceCode" id="cb300"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb300-1"><a href="#cb300-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsf <span class="at">-R</span> <span class="at">--hash</span> MD5 <span class="at">--format</span> hp <span class="at">--separator</span> <span class="st">&quot;  &quot;</span> <span class="at">--files-only</span> swift:bucket</span>
<span id="cb300-2"><a href="#cb300-2" aria-hidden="true" tabindex="-1"></a><span class="ex">7908e352297f0f530b84a756f188baa3</span>  bevajer5jef</span>
<span id="cb300-3"><a href="#cb300-3" aria-hidden="true" tabindex="-1"></a><span class="ex">cd65ac234e6fea5925974a51cdd865cc</span>  canole</span>
<span id="cb300-4"><a href="#cb300-4" aria-hidden="true" tabindex="-1"></a><span class="ex">03b5341b4f234b9d984d03ad076bae91</span>  diwogej7</span>
<span id="cb300-5"><a href="#cb300-5" aria-hidden="true" tabindex="-1"></a><span class="ex">8fd37c3810dd660778137ac3a66cc06d</span>  fubuwic</span>
<span id="cb300-6"><a href="#cb300-6" aria-hidden="true" tabindex="-1"></a><span class="ex">99713e14a4c4ff553acaf1930fad985b</span>  gixacuh7ku</span></code></pre></div>
<p>(Though "rclone md5sum ." is an easier way of typing this.)</p>
<p>By default the separator is ";" this can be changed with the
<code>--separator</code> flag. Note that separators aren't escaped in
the path so putting it last is a good strategy.</p>
<p>E.g.</p>
<div class="sourceCode" id="cb301"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb301-1"><a href="#cb301-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsf  <span class="at">--separator</span> <span class="st">&quot;,&quot;</span> <span class="at">--format</span> <span class="st">&quot;tshp&quot;</span> swift:bucket</span>
<span id="cb301-2"><a href="#cb301-2" aria-hidden="true" tabindex="-1"></a><span class="ex">2016-06-25</span> 18:55:41,60295,7908e352297f0f530b84a756f188baa3,bevajer5jef</span>
<span id="cb301-3"><a href="#cb301-3" aria-hidden="true" tabindex="-1"></a><span class="ex">2016-06-25</span> 18:55:43,90613,cd65ac234e6fea5925974a51cdd865cc,canole</span>
<span id="cb301-4"><a href="#cb301-4" aria-hidden="true" tabindex="-1"></a><span class="ex">2016-06-25</span> 18:55:43,94467,03b5341b4f234b9d984d03ad076bae91,diwogej7</span>
<span id="cb301-5"><a href="#cb301-5" aria-hidden="true" tabindex="-1"></a><span class="ex">2018-04-26</span> 08:52:53,0,,ferejej3gux/</span>
<span id="cb301-6"><a href="#cb301-6" aria-hidden="true" tabindex="-1"></a><span class="ex">2016-06-25</span> 18:55:40,37600,8fd37c3810dd660778137ac3a66cc06d,fubuwic</span></code></pre></div>
<p>You can output in CSV standard format. This will escape things in "
if they contain,</p>
<p>E.g.</p>
<div class="sourceCode" id="cb302"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb302-1"><a href="#cb302-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsf <span class="at">--csv</span> <span class="at">--files-only</span> <span class="at">--format</span> ps remote:path</span>
<span id="cb302-2"><a href="#cb302-2" aria-hidden="true" tabindex="-1"></a><span class="ex">test.log,22355</span></span>
<span id="cb302-3"><a href="#cb302-3" aria-hidden="true" tabindex="-1"></a><span class="ex">test.sh,449</span></span>
<span id="cb302-4"><a href="#cb302-4" aria-hidden="true" tabindex="-1"></a><span class="st">&quot;this file contains a comma, in the file name.txt&quot;</span><span class="ex">,6</span></span></code></pre></div>
<p>Note that the <code>--absolute</code> parameter is useful for making
lists of files to pass to an rclone copy with the
<code>--files-from-raw</code> flag.</p>
<p>For example, to find all the files modified within one day and copy
those only (without traversing the whole directory structure):</p>
<div class="sourceCode" id="cb303"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb303-1"><a href="#cb303-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf <span class="at">--absolute</span> <span class="at">--files-only</span> <span class="at">--max-age</span> 1d /path/to/local <span class="op">&gt;</span> new_files</span>
<span id="cb303-2"><a href="#cb303-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="at">--files-from-raw</span> new_files /path/to/local remote:path</span></code></pre></div>
<p>The default time format is <code>'2006-01-02 15:04:05'</code>. <a
href="https://pkg.go.dev/time#pkg-constants">Other formats</a> can be
specified with the <code>--time-format</code> flag. Examples:</p>
<div class="sourceCode" id="cb304"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb304-1"><a href="#cb304-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf remote:path <span class="at">--format</span> pt <span class="at">--time-format</span> <span class="st">&#39;Jan 2, 2006 at 3:04pm (MST)&#39;</span></span>
<span id="cb304-2"><a href="#cb304-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf remote:path <span class="at">--format</span> pt <span class="at">--time-format</span> <span class="st">&#39;2006-01-02 15:04:05.000000000&#39;</span></span>
<span id="cb304-3"><a href="#cb304-3" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf remote:path <span class="at">--format</span> pt <span class="at">--time-format</span> <span class="st">&#39;2006-01-02T15:04:05.999999999Z07:00&#39;</span></span>
<span id="cb304-4"><a href="#cb304-4" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf remote:path <span class="at">--format</span> pt <span class="at">--time-format</span> RFC3339</span>
<span id="cb304-5"><a href="#cb304-5" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf remote:path <span class="at">--format</span> pt <span class="at">--time-format</span> DateOnly</span>
<span id="cb304-6"><a href="#cb304-6" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf remote:path <span class="at">--format</span> pt <span class="at">--time-format</span> max</span></code></pre></div>
<p><code>--time-format max</code> will automatically truncate
<code>2006-01-02 15:04:05.000000000</code> to the maximum precision
supported by the remote.</p>
<p>Any of the filtering options can be applied to this command.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects
only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse
format</li>
<li><code>lsjson</code> to list objects and directories in JSON
format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be
human-readable. <code>lsf</code> is designed to be human and
machine-readable. <code>lsjson</code> is designed to be
machine-readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default -
use <code>--max-depth 1</code> to stop the recursion.</p>
<p>The other list commands
<code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by
default - use <code>-R</code> to make them recurse.</p>
<p>Listing a nonexistent directory will produce an error except for
remotes which can't have empty directories (e.g. s3, swift, or gcs - the
bucket-based remotes).</p>
<pre><code>rclone lsf remote:path [flags]</code></pre>
<h2 id="options-59">Options</h2>
<pre><code>      --absolute             Put a leading / in front of path names
      --csv                  Output in CSV format
  -d, --dir-slash            Append a slash to directory names (default true)
      --dirs-only            Only list directories
      --files-only           Only list files
  -F, --format string        Output format - see  help for details (default &quot;p&quot;)
      --hash h               Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default &quot;md5&quot;)
  -h, --help                 help for lsf
  -R, --recursive            Recurse into the listing
  -s, --separator string     Separator for the items in the format (default &quot;;&quot;)
  -t, --time-format string   Specify a custom time format, or &#39;max&#39; for max precision supported by remote (default: 2006-01-02 15:04:05)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-18">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-17">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-59">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-lsjson">rclone lsjson</h1>
<p>List directories and objects in the path in JSON format.</p>
<h2 id="synopsis-53">Synopsis</h2>
<p>List directories and objects in the path in JSON format.</p>
<p>The output is an array of Items, where each Item looks like this:</p>
<div class="sourceCode" id="cb309"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb309-1"><a href="#cb309-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb309-2"><a href="#cb309-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Hashes&quot;</span> <span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb309-3"><a href="#cb309-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;SHA-1&quot;</span> <span class="fu">:</span> <span class="st">&quot;f572d396fae9206628714fb2ce00f72e94f2258f&quot;</span><span class="fu">,</span></span>
<span id="cb309-4"><a href="#cb309-4" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;MD5&quot;</span> <span class="fu">:</span> <span class="st">&quot;b1946ac92492d2347c6235b4d2611184&quot;</span><span class="fu">,</span></span>
<span id="cb309-5"><a href="#cb309-5" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;DropboxHash&quot;</span> <span class="fu">:</span> <span class="st">&quot;ecb65bb98f9d905b70458986c39fcbad7715e5f2fcc3b1f07767d7c83e2438cc&quot;</span></span>
<span id="cb309-6"><a href="#cb309-6" aria-hidden="true" tabindex="-1"></a>  <span class="fu">},</span></span>
<span id="cb309-7"><a href="#cb309-7" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;ID&quot;</span><span class="fu">:</span> <span class="st">&quot;y2djkhiujf83u33&quot;</span><span class="fu">,</span></span>
<span id="cb309-8"><a href="#cb309-8" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;OrigID&quot;</span><span class="fu">:</span> <span class="st">&quot;UYOJVTUW00Q1RzTDA&quot;</span><span class="fu">,</span></span>
<span id="cb309-9"><a href="#cb309-9" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;IsBucket&quot;</span> <span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
<span id="cb309-10"><a href="#cb309-10" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;IsDir&quot;</span> <span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
<span id="cb309-11"><a href="#cb309-11" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;MimeType&quot;</span> <span class="fu">:</span> <span class="st">&quot;application/octet-stream&quot;</span><span class="fu">,</span></span>
<span id="cb309-12"><a href="#cb309-12" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;ModTime&quot;</span> <span class="fu">:</span> <span class="st">&quot;2017-05-31T16:15:57.034468261+01:00&quot;</span><span class="fu">,</span></span>
<span id="cb309-13"><a href="#cb309-13" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Name&quot;</span> <span class="fu">:</span> <span class="st">&quot;file.txt&quot;</span><span class="fu">,</span></span>
<span id="cb309-14"><a href="#cb309-14" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Encrypted&quot;</span> <span class="fu">:</span> <span class="st">&quot;v0qpsdq8anpci8n929v3uu9338&quot;</span><span class="fu">,</span></span>
<span id="cb309-15"><a href="#cb309-15" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;EncryptedPath&quot;</span> <span class="fu">:</span> <span class="st">&quot;kja9098349023498/v0qpsdq8anpci8n929v3uu9338&quot;</span><span class="fu">,</span></span>
<span id="cb309-16"><a href="#cb309-16" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Path&quot;</span> <span class="fu">:</span> <span class="st">&quot;full/path/goes/here/file.txt&quot;</span><span class="fu">,</span></span>
<span id="cb309-17"><a href="#cb309-17" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Size&quot;</span> <span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
<span id="cb309-18"><a href="#cb309-18" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Tier&quot;</span> <span class="fu">:</span> <span class="st">&quot;hot&quot;</span><span class="fu">,</span></span>
<span id="cb309-19"><a href="#cb309-19" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>The exact set of properties included depends on the backend:</p>
<ul>
<li>The property IsBucket will only be included for bucket-based
remotes, and only for directories that are buckets. It will always be
omitted when value is not true.</li>
<li>Properties Encrypted and EncryptedPath will only be included for
encrypted remotes, and (as mentioned below) only if the
<code>--encrypted</code> option is set.</li>
</ul>
<p>Different options may also affect which properties are included:</p>
<ul>
<li>If <code>--hash</code> is not specified, the Hashes property will be
omitted. The types of hash can be specified with the
<code>--hash-type</code> parameter (which may be repeated). If
<code>--hash-type</code> is set then it implies
<code>--hash</code>.</li>
<li>If <code>--no-modtime</code> is specified then ModTime will be
blank. This can speed things up on remotes where reading the ModTime
takes an extra request (e.g. s3, swift).</li>
<li>If <code>--no-mimetype</code> is specified then MimeType will be
blank. This can speed things up on remotes where reading the MimeType
takes an extra request (e.g. s3, swift).</li>
<li>If <code>--encrypted</code> is not specified the Encrypted and
EncryptedPath properties will be omitted - even for encrypted
remotes.</li>
<li>If <code>--metadata</code> is set then an additional Metadata
property will be returned. This will have <a
href="https://rclone.org/docs/#metadata">metadata</a> in rclone standard
format as a JSON object.</li>
</ul>
<p>The default is to list directories and files/objects, but this can be
changed with the following options:</p>
<ul>
<li>If <code>--dirs-only</code> is specified then directories will be
returned only, no files/objects.</li>
<li>If <code>--files-only</code> is specified then files will be
returned only, no directories.</li>
</ul>
<p>If <code>--stat</code> is set then the the output is not an array of
items, but instead a single JSON blob will be returned about the item
pointed to. This will return an error if the item isn't found, however
on bucket based backends (like s3, gcs, b2, azureblob etc) if the item
isn't found it will return an empty directory, as it isn't possible to
tell empty directories from missing directories there.</p>
<p>The Path field will only show folders below the remote path being
listed. If "remote:path" contains the file "subfolder/file.txt", the
Path for "file.txt" will be "subfolder/file.txt", not
"remote:path/subfolder/file.txt". When used without
<code>--recursive</code> the Path will always be the same as Name.</p>
<p>The time is in RFC3339 format with up to nanosecond precision. The
number of decimal digits in the seconds will depend on the precision
that the remote can hold the times, so if times are accurate to the
nearest millisecond (e.g. Google Drive) then 3 digits will always be
shown ("2017-05-31T16:15:57.034+01:00") whereas if the times are
accurate to the nearest second (Dropbox, Box, WebDav, etc.) no digits
will be shown ("2017-05-31T16:15:57+01:00").</p>
<p>The whole output can be processed as a JSON blob, or alternatively it
can be processed line by line as each item is written on individual
lines (except with <code>--stat</code>).</p>
<p>Any of the filtering options can be applied to this command.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects
only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse
format</li>
<li><code>lsjson</code> to list objects and directories in JSON
format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be
human-readable. <code>lsf</code> is designed to be human and
machine-readable. <code>lsjson</code> is designed to be
machine-readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default -
use <code>--max-depth 1</code> to stop the recursion.</p>
<p>The other list commands
<code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by
default - use <code>-R</code> to make them recurse.</p>
<p>Listing a nonexistent directory will produce an error except for
remotes which can't have empty directories (e.g. s3, swift, or gcs - the
bucket-based remotes).</p>
<pre><code>rclone lsjson remote:path [flags]</code></pre>
<h2 id="options-60">Options</h2>
<pre><code>      --dirs-only               Show only directories in the listing
      --encrypted               Show the encrypted names
      --files-only              Show only files in the listing
      --hash                    Include hashes in the output (may take longer)
      --hash-type stringArray   Show only this hash type (may be repeated)
  -h, --help                    help for lsjson
  -M, --metadata                Add metadata to the listing
      --no-mimetype             Don&#39;t read the mime type (can speed things up)
      --no-modtime              Don&#39;t read the modification time (can speed things up)
      --original                Show the ID of the underlying Object
  -R, --recursive               Recurse into the listing
      --stat                    Just return the info for the pointed to file</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-19">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-18">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-60">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-mount">rclone mount</h1>
<p>Mount the remote as file system on a mountpoint.</p>
<h2 id="synopsis-54">Synopsis</h2>
<p>Rclone mount allows Linux, FreeBSD, macOS and Windows to mount any of
Rclone's cloud storage systems as a file system with FUSE.</p>
<p>First set up your remote using <code>rclone config</code>. Check it
works with <code>rclone ls</code> etc.</p>
<p>On Linux and macOS, you can run mount in either foreground or
background (aka daemon) mode. Mount runs in foreground mode by default.
Use the <code>--daemon</code> flag to force background mode. On Windows
you can run mount in foreground only, the flag is ignored.</p>
<p>In background mode rclone acts as a generic Unix mount program: the
main program starts, spawns background rclone process to setup and
maintain the mount, waits until success or timeout and exits with
appropriate code (killing the child process if it fails).</p>
<p>On Linux/macOS/FreeBSD start the mount like this, where
<code>/path/to/local/mount</code> is an <strong>empty</strong>
<strong>existing</strong> directory:</p>
<div class="sourceCode" id="cb314"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb314-1"><a href="#cb314-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files /path/to/local/mount</span></code></pre></div>
<p>On Windows you can start a mount in different ways. See <a
href="#mounting-modes-on-windows">below</a> for details. If foreground
mount is used interactively from a console window, rclone will serve the
mount and occupy the console so another window should be used to work
with the mount until rclone is interrupted e.g. by pressing Ctrl-C.</p>
<p>The following examples will mount to an automatically assigned drive,
to specific drive letter <code>X:</code>, to path
<code>C:\path\parent\mount</code> (where parent directory or drive must
exist, and mount must <strong>not</strong> exist, and is not supported
when <a href="#mounting-modes-on-windows">mounting as a network
drive</a>), and the last example will mount as network share
<code>\\cloud\remote</code> and map it to an automatically assigned
drive:</p>
<div class="sourceCode" id="cb315"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb315-1"><a href="#cb315-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files <span class="pp">*</span></span>
<span id="cb315-2"><a href="#cb315-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files X:</span>
<span id="cb315-3"><a href="#cb315-3" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files C:<span class="dt">\p</span>ath<span class="dt">\p</span>arent<span class="dt">\m</span>ount</span>
<span id="cb315-4"><a href="#cb315-4" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files <span class="dt">\\</span>cloud<span class="dt">\r</span>emote</span></code></pre></div>
<p>When the program ends while in foreground mode, either via Ctrl+C or
receiving a SIGINT or SIGTERM signal, the mount should be automatically
stopped.</p>
<p>When running in background mode the user will have to stop the mount
manually:</p>
<div class="sourceCode" id="cb316"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb316-1"><a href="#cb316-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Linux</span></span>
<span id="cb316-2"><a href="#cb316-2" aria-hidden="true" tabindex="-1"></a><span class="ex">fusermount</span> <span class="at">-u</span> /path/to/local/mount</span>
<span id="cb316-3"><a href="#cb316-3" aria-hidden="true" tabindex="-1"></a><span class="co">#... or on some systems</span></span>
<span id="cb316-4"><a href="#cb316-4" aria-hidden="true" tabindex="-1"></a><span class="ex">fusermount3</span> <span class="at">-u</span> /path/to/local/mount</span>
<span id="cb316-5"><a href="#cb316-5" aria-hidden="true" tabindex="-1"></a><span class="co"># OS X or Linux when using nfsmount</span></span>
<span id="cb316-6"><a href="#cb316-6" aria-hidden="true" tabindex="-1"></a><span class="fu">umount</span> /path/to/local/mount</span></code></pre></div>
<p>The umount operation can fail, for example when the mountpoint is
busy. When that happens, it is the user's responsibility to stop the
mount manually.</p>
<p>The size of the mounted file system will be set according to
information retrieved from the remote, the same as returned by the <a
href="https://rclone.org/commands/rclone_about/">rclone about</a>
command. Remotes with unlimited storage may report the used size only,
then an additional 1 PiB of free space is assumed. If the remote does
not <a href="https://rclone.org/overview/#optional-features">support</a>
the about feature at all, then 1 PiB is set as both the total and the
free size.</p>
<h2 id="installing-on-windows">Installing on Windows</h2>
<p>To run rclone mount on Windows, you will need to download and install
<a href="http://www.secfs.net/winfsp/">WinFsp</a>.</p>
<p><a href="https://github.com/winfsp/winfsp">WinFsp</a> is an
open-source Windows File System Proxy which makes it easy to write user
space file systems for Windows. It provides a FUSE emulation layer which
rclone uses combination with <a
href="https://github.com/winfsp/cgofuse">cgofuse</a>. Both of these
packages are by Bill Zissimopoulos who was very helpful during the
implementation of rclone mount for Windows.</p>
<h3 id="mounting-modes-on-windows">Mounting modes on windows</h3>
<p>Unlike other operating systems, Microsoft Windows provides a
different filesystem type for network and fixed drives. It optimises
access on the assumption fixed disk drives are fast and reliable, while
network drives have relatively high latency and less reliability. Some
settings can also be differentiated between the two types, for example
that Windows Explorer should just display icons and not create preview
thumbnails for image and video files on network drives.</p>
<p>In most cases, rclone will mount the remote as a normal, fixed disk
drive by default. However, you can also choose to mount it as a remote
network drive, often described as a network share. If you mount an
rclone remote using the default, fixed drive mode and experience
unexpected program errors, freezes or other issues, consider mounting as
a network drive instead.</p>
<p>When mounting as a fixed disk drive you can either mount to an unused
drive letter, or to a path representing a <strong>nonexistent</strong>
subdirectory of an <strong>existing</strong> parent directory or drive.
Using the special value <code>*</code> will tell rclone to automatically
assign the next available drive letter, starting with Z: and moving
backward. Examples:</p>
<div class="sourceCode" id="cb317"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb317-1"><a href="#cb317-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files <span class="pp">*</span></span>
<span id="cb317-2"><a href="#cb317-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files X:</span>
<span id="cb317-3"><a href="#cb317-3" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files C:<span class="dt">\p</span>ath<span class="dt">\p</span>arent<span class="dt">\m</span>ount</span>
<span id="cb317-4"><a href="#cb317-4" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files X:</span></code></pre></div>
<p>Option <code>--volname</code> can be used to set a custom volume name
for the mounted file system. The default is to use the remote name and
path.</p>
<p>To mount as network drive, you can add option
<code>--network-mode</code> to your mount command. Mounting to a
directory path is not supported in this mode, it is a limitation Windows
imposes on junctions, so the remote must always be mounted to a drive
letter.</p>
<div class="sourceCode" id="cb318"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb318-1"><a href="#cb318-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files X: <span class="at">--network-mode</span></span></code></pre></div>
<p>A volume name specified with <code>--volname</code> will be used to
create the network share path. A complete UNC path, such as
<code>\\cloud\remote</code>, optionally with path
<code>\\cloud\remote\madeup\path</code>, will be used as is. Any other
string will be used as the share part, after a default prefix
<code>\\server\</code>. If no volume name is specified then
<code>\\server\share</code> will be used. You must make sure the volume
name is unique when you are mounting more than one drive, or else the
mount command will fail. The share name will treated as the volume label
for the mapped drive, shown in Windows Explorer etc, while the complete
<code>\\server\share</code> will be reported as the remote UNC path by
<code>net use</code> etc, just like a normal network drive mapping.</p>
<p>If you specify a full network share UNC path with
<code>--volname</code>, this will implicitly set the
<code>--network-mode</code> option, so the following two examples have
same result:</p>
<div class="sourceCode" id="cb319"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb319-1"><a href="#cb319-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files X: <span class="at">--network-mode</span></span>
<span id="cb319-2"><a href="#cb319-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files X: <span class="at">--volname</span> <span class="dt">\\</span>server<span class="dt">\s</span>hare</span></code></pre></div>
<p>You may also specify the network share UNC path as the mountpoint
itself. Then rclone will automatically assign a drive letter, same as
with <code>*</code> and use that as mountpoint, and instead use the UNC
path specified as the volume name, as if it were specified with the
<code>--volname</code> option. This will also implicitly set the
<code>--network-mode</code> option. This means the following two
examples have same result:</p>
<div class="sourceCode" id="cb320"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb320-1"><a href="#cb320-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files <span class="dt">\\</span>cloud<span class="dt">\r</span>emote</span>
<span id="cb320-2"><a href="#cb320-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mount remote:path/to/files <span class="pp">*</span> <span class="at">--volname</span> <span class="dt">\\</span>cloud<span class="dt">\r</span>emote</span></code></pre></div>
<p>There is yet another way to enable network mode, and to set the share
path, and that is to pass the "native" libfuse/WinFsp option directly:
<code>--fuse-flag --VolumePrefix=\server\share</code>. Note that the
path must be with just a single backslash prefix in this case.</p>
<p><em>Note:</em> In previous versions of rclone this was the only
supported method.</p>
<p><a href="https://en.wikipedia.org/wiki/Drive_mapping">Read more about
drive mapping</a></p>
<p>See also <a href="#limitations">Limitations</a> section below.</p>
<h3 id="windows-filesystem-permissions">Windows filesystem
permissions</h3>
<p>The FUSE emulation layer on Windows must convert between the
POSIX-based permission model used in FUSE, and the permission model used
in Windows, based on access-control lists (ACL).</p>
<p>The mounted filesystem will normally get three entries in its
access-control list (ACL), representing permissions for the POSIX
permission scopes: Owner, group and others. By default, the owner and
group will be taken from the current user, and the built-in group
"Everyone" will be used to represent others. The user/group can be
customized with FUSE options "UserName" and "GroupName", e.g.
<code>-o UserName=user123 -o GroupName="Authenticated Users"</code>. The
permissions on each entry will be set according to <a
href="#options">options</a> <code>--dir-perms</code> and
<code>--file-perms</code>, which takes a value in traditional Unix <a
href="https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation">numeric
notation</a>.</p>
<p>The default permissions corresponds to
<code>--file-perms 0666 --dir-perms 0777</code>, i.e. read and write
permissions to everyone. This means you will not be able to start any
programs from the mount. To be able to do that you must add execute
permissions, e.g. <code>--file-perms 0777 --dir-perms 0777</code> to add
it to everyone. If the program needs to write files, chances are you
will have to enable <a href="#vfs-file-caching">VFS File Caching</a> as
well (see also <a href="#limitations">limitations</a>). Note that the
default write permission have some restrictions for accounts other than
the owner, specifically it lacks the "write extended attributes", as
explained next.</p>
<p>The mapping of permissions is not always trivial, and the result you
see in Windows Explorer may not be exactly like you expected. For
example, when setting a value that includes write access for the group
or others scope, this will be mapped to individual permissions "write
attributes", "write data" and "append data", but not "write extended
attributes". Windows will then show this as basic permission "Special"
instead of "Write", because "Write" also covers the "write extended
attributes" permission. When setting digit 0 for group or others, to
indicate no permissions, they will still get individual permissions
"read attributes", "read extended attributes" and "read permissions".
This is done for compatibility reasons, e.g. to allow users without
additional permissions to be able to read basic metadata about files
like in Unix.</p>
<p>WinFsp 2021 (version 1.9) introduced a new FUSE option
"FileSecurity", that allows the complete specification of file security
descriptors using <a
href="https://docs.microsoft.com/en-us/windows/win32/secauthz/security-descriptor-string-format">SDDL</a>.
With this you get detailed control of the resulting permissions,
compared to use of the POSIX permissions described above, and no
additional permissions will be added automatically for compatibility
with Unix. Some example use cases will following.</p>
<p>If you set POSIX permissions for only allowing access to the owner,
using <code>--file-perms 0600 --dir-perms 0700</code>, the user group
and the built-in "Everyone" group will still be given some special
permissions, as described above. Some programs may then (incorrectly)
interpret this as the file being accessible by everyone, for example an
SSH client may warn about "unprotected private key file". You can work
around this by specifying
<code>-o FileSecurity="D:P(A;;FA;;;OW)"</code>, which sets file all
access (FA) to the owner (OW), and nothing else.</p>
<p>When setting write permissions then, except for the owner, this does
not include the "write extended attributes" permission, as mentioned
above. This may prevent applications from writing to files, giving
permission denied error instead. To set working write permissions for
the built-in "Everyone" group, similar to what it gets by default but
with the addition of the "write extended attributes", you can specify
<code>-o FileSecurity="D:P(A;;FRFW;;;WD)"</code>, which sets file read
(FR) and file write (FW) to everyone (WD). If file execute (FX) is also
needed, then change to
<code>-o FileSecurity="D:P(A;;FRFWFX;;;WD)"</code>, or set file all
access (FA) to get full access permissions, including delete, with
<code>-o FileSecurity="D:P(A;;FA;;;WD)"</code>.</p>
<h3 id="windows-caveats">Windows caveats</h3>
<p>Drives created as Administrator are not visible to other accounts,
not even an account that was elevated to Administrator with the User
Account Control (UAC) feature. A result of this is that if you mount to
a drive letter from a Command Prompt run as Administrator, and then try
to access the same drive from Windows Explorer (which does not run as
Administrator), you will not be able to see the mounted drive.</p>
<p>If you don't need to access the drive from applications running with
administrative privileges, the easiest way around this is to always
create the mount from a non-elevated command prompt.</p>
<p>To make mapped drives available to the user account that created them
regardless if elevated or not, there is a special Windows setting called
<a
href="https://docs.microsoft.com/en-us/troubleshoot/windows-client/networking/mapped-drives-not-available-from-elevated-command#detail-to-configure-the-enablelinkedconnections-registry-entry">linked
connections</a> that can be enabled.</p>
<p>It is also possible to make a drive mount available to everyone on
the system, by running the process creating it as the built-in SYSTEM
account. There are several ways to do this: One is to use the
command-line utility <a
href="https://docs.microsoft.com/en-us/sysinternals/downloads/psexec">PsExec</a>,
from Microsoft's Sysinternals suite, which has option <code>-s</code> to
start processes as the SYSTEM account. Another alternative is to run the
mount command from a Windows Scheduled Task, or a Windows Service,
configured to run as the SYSTEM account. A third alternative is to use
the <a
href="https://github.com/winfsp/winfsp/wiki/WinFsp-Service-Architecture">WinFsp.Launcher
infrastructure</a>). Read more in the <a
href="https://rclone.org/install/">install documentation</a>. Note that
when running rclone as another user, it will not use the configuration
file from your profile unless you tell it to with the <a
href="https://rclone.org/docs/#config-string"><code>--config</code></a>
option. Note also that it is now the SYSTEM account that will have the
owner permissions, and other accounts will have permissions according to
the group or others scopes. As mentioned above, these will then not get
the "write extended attributes" permission, and this may prevent writing
to files. You can work around this with the FileSecurity option, see
example above.</p>
<p>Note that mapping to a directory path, instead of a drive letter,
does not suffer from the same limitations.</p>
<h2 id="mounting-on-macos">Mounting on macOS</h2>
<p>Mounting on macOS can be done either via <a
href="https://rclone.org/commands/rclone_serve_nfs/">built-in NFS
server</a>, <a href="https://osxfuse.github.io/">macFUSE</a> (also known
as osxfuse) or <a href="https://www.fuse-t.org/">FUSE-T</a>.macFUSE is a
traditional FUSE driver utilizing a macOS kernel extension (kext).
FUSE-T is an alternative FUSE system which "mounts" via an NFSv4 local
server.</p>
<h3 id="unicode-normalization">Unicode Normalization</h3>
<p>It is highly recommended to keep the default of
<code>--no-unicode-normalization=false</code> for all <code>mount</code>
and <code>serve</code> commands on macOS. For details, see <a
href="https://rclone.org/commands/rclone_mount/#vfs-case-sensitivity">vfs-case-sensitivity</a>.</p>
<h3 id="nfs-mount">NFS mount</h3>
<p>This method spins up an NFS server using <a
href="https://rclone.org/commands/rclone_serve_nfs/">serve nfs</a>
command and mounts it to the specified mountpoint. If you run this in
background mode using |--daemon|, you will need to send SIGTERM signal
to the rclone process using |kill| command to stop the mount.</p>
<p>Note that <code>--nfs-cache-handle-limit</code> controls the maximum
number of cached file handles stored by the <code>nfsmount</code>
caching handler. This should not be set too low or you may experience
errors when trying to access files. The default is 1000000, but consider
lowering this limit if the server's system resource usage causes
problems.</p>
<h3 id="macfuse-notes">macFUSE Notes</h3>
<p>If installing macFUSE using <a
href="https://github.com/osxfuse/osxfuse/releases">dmg packages</a> from
the website, rclone will locate the macFUSE libraries without any
further intervention. If however, macFUSE is installed using the <a
href="https://www.macports.org/">macports</a> package manager, the
following addition steps are required.</p>
<div class="sourceCode" id="cb321"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb321-1"><a href="#cb321-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> mkdir /usr/local/lib</span>
<span id="cb321-2"><a href="#cb321-2" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> /usr/local/lib</span>
<span id="cb321-3"><a href="#cb321-3" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> ln <span class="at">-s</span> /opt/local/lib/libfuse.2.dylib</span></code></pre></div>
<h3 id="fuse-t-limitations-caveats-and-notes">FUSE-T Limitations,
Caveats, and Notes</h3>
<p>There are some limitations, caveats, and notes about how it works.
These are current as of FUSE-T version 1.0.14.</p>
<h4 id="modtime-update-on-read">ModTime update on read</h4>
<p>As per the <a
href="https://github.com/macos-fuse-t/fuse-t/wiki#caveats">FUSE-T
wiki</a>:</p>
<blockquote>
<p>File access and modification times cannot be set separately as it
seems to be an issue with the NFS client which always modifies both. Can
be reproduced with 'touch -m' and 'touch -a' commands</p>
</blockquote>
<p>This means that viewing files with various tools, notably macOS
Finder, will cause rlcone to update the modification time of the file.
This may make rclone upload a full new copy of the file.</p>
<h4 id="read-only-mounts">Read Only mounts</h4>
<p>When mounting with <code>--read-only</code>, attempts to write to
files will fail <em>silently</em> as opposed to with a clear warning as
in macFUSE.</p>
<h2 id="limitations">Limitations</h2>
<p>Without the use of <code>--vfs-cache-mode</code> this can only write
files sequentially, it can only seek when reading. This means that many
applications won't work with their files on an rclone mount without
<code>--vfs-cache-mode writes</code> or
<code>--vfs-cache-mode full</code>. See the <a
href="#vfs-file-caching">VFS File Caching</a> section for more info.
When using NFS mount on macOS, if you don't specify |--vfs-cache-mode|
the mount point will be read-only.</p>
<p>Bucket-based remotes - Azure Blob, Swift, S3, Google Cloud Storage
and B2 - can't store empty directories. Of these, only Azure Blob,
Google Cloud Storage and S3 can preserve them when you add
<code>--xxx-directory_markers</code>; otherwise, empty directories will
vanish once they drop out of the directory cache.</p>
<p>When <code>rclone mount</code> is invoked on Unix with
<code>--daemon</code> flag, the main rclone program will wait for the
background mount to become ready or until the timeout specified by the
<code>--daemon-wait</code> flag. On Linux it can check mount status
using ProcFS so the flag in fact sets <strong>maximum</strong> time to
wait, while the real wait can be less. On macOS / BSD the time to wait
is constant and the check is performed only at the end. We advise you to
set wait time on macOS reasonably.</p>
<p>Only supported on Linux, FreeBSD, OS X and Windows at the moment.</p>
<h2 id="rclone-mount-vs-rclone-synccopy">rclone mount vs rclone
sync/copy</h2>
<p>File systems expect things to be 100% reliable, whereas cloud storage
systems are a long way from 100% reliable. The rclone sync/copy commands
cope with this with lots of retries. However rclone mount can't use
retries in the same way without making local copies of the uploads. Look
at the <a href="#vfs-file-caching">VFS File Caching</a> for solutions to
make mount more reliable.</p>
<h2 id="attribute-caching">Attribute caching</h2>
<p>You can use the flag <code>--attr-timeout</code> to set the time the
kernel caches the attributes (size, modification time, etc.) for
directory entries.</p>
<p>The default is <code>1s</code> which caches files just long enough to
avoid too many callbacks to rclone from the kernel.</p>
<p>In theory 0s should be the correct value for filesystems which can
change outside the control of the kernel. However this causes quite a
few problems such as <a
href="https://github.com/rclone/rclone/issues/2157">rclone using too
much memory</a>, <a
href="https://forum.rclone.org/t/rclone-1-39-vs-1-40-mount-issue/5112">rclone
not serving files to samba</a> and <a
href="https://github.com/rclone/rclone/issues/2095#issuecomment-371141147">excessive
time listing directories</a>.</p>
<p>The kernel can cache the info about a file for the time given by
<code>--attr-timeout</code>. You may see corruption if the remote file
changes length during this window. It will show up as either a truncated
file or a file with garbage on the end. With
<code>--attr-timeout 1s</code> this is very unlikely but not impossible.
The higher you set <code>--attr-timeout</code> the more likely it is.
The default setting of "1s" is the lowest setting which mitigates the
problems above.</p>
<p>If you set it higher (<code>10s</code> or <code>1m</code> say) then
the kernel will call back to rclone less often making it more efficient,
however there is more chance of the corruption issue above.</p>
<p>If files don't change on the remote outside of the control of rclone
then there is no chance of corruption.</p>
<p>This is the same as setting the attr_timeout option in
mount.fuse.</p>
<h2 id="filters">Filters</h2>
<p>Note that all the rclone filters can be used to select a subset of
the files to be visible in the mount.</p>
<h2 id="systemd">systemd</h2>
<p>When running rclone mount as a systemd service, it is possible to use
Type=notify. In this case the service will enter the started state after
the mountpoint has been successfully set up. Units having the rclone
mount service specified as a requirement will see all files and folders
immediately in this mode.</p>
<p>Note that systemd runs mount units without any environment variables
including <code>PATH</code> or <code>HOME</code>. This means that tilde
(<code>~</code>) expansion will not work and you should provide
<code>--config</code> and <code>--cache-dir</code> explicitly as
absolute paths via rclone arguments. Since mounting requires the
<code>fusermount</code> or <code>fusermount3</code> program, rclone will
use the fallback PATH of <code>/bin:/usr/bin</code> in this scenario.
Please ensure that <code>fusermount</code>/<code>fusermount3</code> is
present on this PATH.</p>
<h2 id="rclone-as-unix-mount-helper">Rclone as Unix mount helper</h2>
<p>The core Unix program <code>/bin/mount</code> normally takes the
<code>-t FSTYPE</code> argument then runs the
<code>/sbin/mount.FSTYPE</code> helper program passing it mount options
as <code>-o key=val,...</code> or <code>--opt=...</code>. Automount
(classic or systemd) behaves in a similar way.</p>
<p>rclone by default expects GNU-style flags <code>--key val</code>. To
run it as a mount helper you should symlink rclone binary to
<code>/sbin/mount.rclone</code> and optionally
<code>/usr/bin/rclonefs</code>, e.g.
<code>ln -s /usr/bin/rclone /sbin/mount.rclone</code>. rclone will
detect it and translate command-line arguments appropriately.</p>
<p>Now you can run classic mounts like this:</p>
<div class="sourceCode" id="cb322"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb322-1"><a href="#cb322-1" aria-hidden="true" tabindex="-1"></a><span class="fu">mount</span> sftp1:subdir /mnt/data <span class="at">-t</span> rclone <span class="at">-o</span> vfs_cache_mode=writes,sftp_key_file=/path/to/pem</span></code></pre></div>
<p>or create systemd mount units:</p>
<div class="sourceCode" id="cb323"><pre
class="sourceCode ini"><code class="sourceCode ini"><span id="cb323-1"><a href="#cb323-1" aria-hidden="true" tabindex="-1"></a><span class="co"># /etc/systemd/system/mnt-data.mount</span></span>
<span id="cb323-2"><a href="#cb323-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[Unit]</span></span>
<span id="cb323-3"><a href="#cb323-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">Mount for /mnt/data</span></span>
<span id="cb323-4"><a href="#cb323-4" aria-hidden="true" tabindex="-1"></a><span class="kw">[Mount]</span></span>
<span id="cb323-5"><a href="#cb323-5" aria-hidden="true" tabindex="-1"></a><span class="dt">Type</span><span class="ot">=</span><span class="st">rclone</span></span>
<span id="cb323-6"><a href="#cb323-6" aria-hidden="true" tabindex="-1"></a><span class="dt">What</span><span class="ot">=</span><span class="st">sftp1:subdir</span></span>
<span id="cb323-7"><a href="#cb323-7" aria-hidden="true" tabindex="-1"></a><span class="dt">Where</span><span class="ot">=</span><span class="st">/mnt/data</span></span>
<span id="cb323-8"><a href="#cb323-8" aria-hidden="true" tabindex="-1"></a><span class="dt">Options</span><span class="ot">=</span><span class="st">rw,_netdev,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone</span></span></code></pre></div>
<p>optionally accompanied by systemd automount unit</p>
<div class="sourceCode" id="cb324"><pre
class="sourceCode ini"><code class="sourceCode ini"><span id="cb324-1"><a href="#cb324-1" aria-hidden="true" tabindex="-1"></a><span class="co"># /etc/systemd/system/mnt-data.automount</span></span>
<span id="cb324-2"><a href="#cb324-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[Unit]</span></span>
<span id="cb324-3"><a href="#cb324-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">AutoMount for /mnt/data</span></span>
<span id="cb324-4"><a href="#cb324-4" aria-hidden="true" tabindex="-1"></a><span class="kw">[Automount]</span></span>
<span id="cb324-5"><a href="#cb324-5" aria-hidden="true" tabindex="-1"></a><span class="dt">Where</span><span class="ot">=</span><span class="st">/mnt/data</span></span>
<span id="cb324-6"><a href="#cb324-6" aria-hidden="true" tabindex="-1"></a><span class="dt">TimeoutIdleSec</span><span class="ot">=</span><span class="dv">600</span></span>
<span id="cb324-7"><a href="#cb324-7" aria-hidden="true" tabindex="-1"></a><span class="kw">[Install]</span></span>
<span id="cb324-8"><a href="#cb324-8" aria-hidden="true" tabindex="-1"></a><span class="dt">WantedBy</span><span class="ot">=</span><span class="st">multi-user.target</span></span></code></pre></div>
<p>or add in <code>/etc/fstab</code> a line like</p>
<div class="sourceCode" id="cb325"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb325-1"><a href="#cb325-1" aria-hidden="true" tabindex="-1"></a><span class="ex">sftp1:subdir</span> /mnt/data rclone rw,noauto,nofail,_netdev,x-systemd.automount,args2env,vfs_cache_mode=writes,config=/etc/rclone.conf,cache_dir=/var/cache/rclone 0 0</span></code></pre></div>
<p>or use classic Automountd. Remember to provide explicit
<code>config=...,cache-dir=...</code> as a workaround for mount units
being run without <code>HOME</code>.</p>
<p>Rclone in the mount helper mode will split <code>-o</code>
argument(s) by comma, replace <code>_</code> by <code>-</code> and
prepend <code>--</code> to get the command-line flags. Options
containing commas or spaces can be wrapped in single or double quotes.
Any inner quotes inside outer quotes of the same type should be
doubled.</p>
<p>Mount option syntax includes a few extra options treated
specially:</p>
<ul>
<li><code>env.NAME=VALUE</code> will set an environment variable for the
mount process. This helps with Automountd and Systemd.mount which don't
allow setting custom environment for mount helpers. Typically you will
use <code>env.HTTPS_PROXY=proxy.host:3128</code> or
<code>env.HOME=/root</code></li>
<li><code>command=cmount</code> can be used to run <code>cmount</code>
or any other rclone command rather than the default
<code>mount</code>.</li>
<li><code>args2env</code> will pass mount options to the mount helper
running in background via environment variables instead of command line
arguments. This allows to hide secrets from such commands as
<code>ps</code> or <code>pgrep</code>.</li>
<li><code>vv...</code> will be transformed into appropriate
<code>--verbose=N</code></li>
<li>standard mount options like <code>x-systemd.automount</code>,
<code>_netdev</code>, <code>nosuid</code> and alike are intended only
for Automountd and ignored by rclone.</li>
</ul>
<h2 id="vfs---virtual-file-system">VFS - Virtual File System</h2>
<p>This command uses the VFS layer. This adapts the cloud storage
objects that rclone uses into something which looks much more like a
disk filing system.</p>
<p>Cloud storage objects have lots of properties which aren't like disk
files - you can't extend them or write to the middle of them, so the VFS
layer has to deal with that. Because there is no one right way of doing
this there are various options explained below.</p>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache">VFS Directory Cache</h2>
<p>Using the <code>--dir-cache-time</code> flag, you can control how
long a directory should be considered up to date and not refreshed from
the backend. Changes made through the VFS will appear immediately or
invalidate the cache.</p>
<pre class="text"><code>    --dir-cache-time duration   Time to cache directory entries for (default 5m0s)
    --poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<p>However, changes made directly on the cloud storage by the web
interface or a different copy of rclone will only be picked up once the
directory cache expires if the backend configured does not support
polling for changes. If the backend supports polling, changes will be
picked up within the polling interval.</p>
<p>You can send a <code>SIGHUP</code> signal to rclone for it to flush
all directory caches, regardless of how old they are. Assuming only one
rclone instance is running, you can reset the cache like this:</p>
<div class="sourceCode" id="cb327"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb327-1"><a href="#cb327-1" aria-hidden="true" tabindex="-1"></a><span class="bu">kill</span> <span class="at">-SIGHUP</span> <span class="va">$(</span><span class="fu">pidof</span> rclone<span class="va">)</span></span></code></pre></div>
<p>If you configure rclone with a <a href="/rc">remote control</a> then
you can use rclone rc to flush the whole directory cache:</p>
<div class="sourceCode" id="cb328"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb328-1"><a href="#cb328-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget</span></code></pre></div>
<p>Or individual files or directories:</p>
<div class="sourceCode" id="cb329"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb329-1"><a href="#cb329-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget file=path/to/file dir=path/to/dir</span></code></pre></div>
<h2 id="vfs-file-buffering">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<p>Each open file will try to keep the specified amount of data in
memory at all times. The buffered data is bound to one open file and
won't be shared.</p>
<p>This flag is a upper limit for the used memory per open file. The
buffer will only use memory for data that is downloaded but not not yet
read. If the buffer is empty, only a small amount of memory will be
used.</p>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching">VFS File Caching</h2>
<p>These flags control the VFS file caching options. File caching is
necessary to make the VFS layer appear compatible with a normal file
system. It can be disabled at the cost of some compatibility.</p>
<p>For example you'll need to enable VFS caching if you want to read and
write simultaneously to a file. See below for more details.</p>
<p>Note that the VFS cache is separate from the cache backend and you
may find that you need one or the other or both.</p>
<pre class="text"><code>    --cache-dir string                     Directory rclone will use for caching.
    --vfs-cache-mode CacheMode             Cache mode off|minimal|writes|full (default off)
    --vfs-cache-max-age duration           Max time since last access of objects in the cache (default 1h0m0s)
    --vfs-cache-max-size SizeSuffix        Max total size of objects in the cache (default off)
    --vfs-cache-min-free-space SizeSuffix  Target minimum free space on the disk containing the cache (default off)
    --vfs-cache-poll-interval duration     Interval to poll the cache for stale objects (default 1m0s)
    --vfs-write-back duration              Time to writeback files after last use when using cache (default 5s)</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the
file cache. The files are stored in the user cache file area which is OS
dependent but can be controlled with <code>--cache-dir</code> or setting
the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by
<code>--vfs-cache-mode</code>. The higher the cache mode the more
compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are
closed and if they haven't been accessed for
<code>--vfs-write-back</code> seconds. If rclone is quit or dies with
files that haven't been uploaded, these will be uploaded next time
rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or
<code>--vfs-cache-min-free-space</code> note that the cache may exceed
these quotas for two reasons. Firstly because it is only checked every
<code>--vfs-cache-poll-interval</code>. Secondly because open files
cannot be evicted from the cache. When <code>--vfs-cache-max-size</code>
or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will
attempt to evict the least accessed files from the cache first. rclone
will start with files that haven't been accessed for the longest. This
cache flushing strategy is efficient and more relevant files are likely
to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache
after the set time since last access has passed. The default value of 1
hour will start evicting files from cache that haven't been accessed for
1 hour. When a cached file is accessed the 1 hour timer is reset to 0
and will wait for 1 more hour before evicting. Specify the time with
standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the
same VFS cache with the same or overlapping remotes if using
<code>--vfs-cache-mode &gt; off</code>. This can potentially cause data
corruption if you do. You can work around this by giving each rclone its
own cache hierarchy with <code>--cache-dir</code>. You don't need to
worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off">--vfs-cache-mode off</h3>
<p>In this mode (the default) the cache will read directly from the
remote and write directly to the remote without caching anything on
disk.</p>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can't be opened for both read AND write</li>
<li>Files opened for write can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal">--vfs-cache-mode minimal</h3>
<p>This is very similar to "off" except that files opened for read AND
write will be buffered to disk. This means that files opened for write
will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes">--vfs-cache-mode writes</h3>
<p>In this mode files opened for read only are still read directly from
the remote, write only and read/write files are buffered to disk
first.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full">--vfs-cache-mode full</h3>
<p>In this mode all reads and writes are buffered to and from disk. When
data is read from the remote this is buffered to disk as well.</p>
<p>In this mode the files in the cache will be sparse files and rclone
will keep track of which bits of the files it has downloaded.</p>
<p>So if an application only reads the starts of each file, then rclone
will only buffer the start of the file. These files will appear to be
their full size in the cache, but they will be sparse files with only
the data that has been downloaded present in them.</p>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<p>When reading a file rclone will read <code>--buffer-size</code> plus
<code>--vfs-read-ahead</code> bytes ahead. The
<code>--buffer-size</code> is buffered in memory whereas the
<code>--vfs-read-ahead</code> is buffered on disk.</p>
<p>When using this mode it is recommended that
<code>--buffer-size</code> is not set too large and
<code>--vfs-read-ahead</code> is set large if required.</p>
<p><strong>IMPORTANT</strong> not all file systems support sparse files.
In particular FAT/exFAT do not. Rclone will perform very badly if the
cache directory is on a filesystem which doesn't support sparse files
and it will log an ERROR message if one is detected.</p>
<h3 id="fingerprinting">Fingerprinting</h3>
<p>Various parts of the VFS use fingerprinting to see if a local file
copy has changed relative to a remote file. Fingerprints are made
from:</p>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<p>On some backends some of these attributes are slow to read (they take
an extra API call per object, or extra work per object).</p>
<p>For example <code>hash</code> is slow with the <code>local</code> and
<code>sftp</code> backends as they have to read the entire file and hash
it, and <code>modtime</code> is slow with the <code>s3</code>,
<code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends
because they need to do an extra API call to fetch it.</p>
<p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone
will not include the slow operations in the fingerprint. This makes the
fingerprinting less accurate but much faster and will improve the
opening time of cached files.</p>
<p>If you are running a vfs cache over <code>local</code>,
<code>s3</code> or <code>swift</code> backends then using this flag is
recommended.</p>
<p>Note that if you change the value of this flag, the fingerprints of
the files in the cache may be invalidated and the files will need to be
downloaded again.</p>
<h2 id="vfs-chunked-reading">VFS Chunked Reading</h2>
<p>When rclone reads files from a remote it reads them in chunks. This
means that rather than requesting the whole file rclone reads the chunk
specified. This can reduce the used download quota for some remotes by
requesting only chunks from the remote that are actually read, at the
cost of an increased number of requests.</p>
<p>These flags control the chunking:</p>
<pre class="text"><code>    --vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
    --vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)
    --vfs-read-chunk-streams int            The number of parallel streams to read at once</code></pre>
<p>The chunking behaves differently depending on the
<code>--vfs-read-chunk-streams</code> parameter.</p>
<h3 id="vfs-read-chunk-streams-0"><code>--vfs-read-chunk-streams</code>
== 0</h3>
<p>Rclone will start reading a chunk of size
<code>--vfs-read-chunk-size</code>, and then double the size for each
read. When <code>--vfs-read-chunk-size-limit</code> is specified, and
greater than <code>--vfs-read-chunk-size</code>, the chunk size for each
open file will get doubled only until the specified value is reached. If
the value is "off", which is the default, the limit is disabled and the
chunk size will grow indefinitely.</p>
<p>With <code>--vfs-read-chunk-size 100M</code> and
<code>--vfs-read-chunk-size-limit 0</code> the following parts will be
downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When
<code>--vfs-read-chunk-size-limit 500M</code> is specified, the result
would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so
on.</p>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off"
disables chunked reading.</p>
<p>The chunks will not be buffered in memory.</p>
<h3
id="vfs-read-chunk-streams-0-1"><code>--vfs-read-chunk-streams</code>
&gt; 0</h3>
<p>Rclone reads <code>--vfs-read-chunk-streams</code> chunks of size
<code>--vfs-read-chunk-size</code> concurrently. The size for each read
will stay constant.</p>
<p>This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.</p>
<p>Some experimentation will be needed to find the optimum values of
<code>--vfs-read-chunk-size</code> and
<code>--vfs-read-chunk-streams</code> as these will depend on the
backend in use and the latency to the backend.</p>
<p>For high performance object stores (eg AWS S3) a reasonable place to
start might be <code>--vfs-read-chunk-streams 16</code> and
<code>--vfs-read-chunk-size 4M</code>. In testing with AWS S3 the
performance scaled roughly as the <code>--vfs-read-chunk-streams</code>
setting.</p>
<p>Similar settings should work for high latency links, but depending on
the latency they may need more <code>--vfs-read-chunk-streams</code> in
order to get the throughput.</p>
<h2 id="vfs-performance">VFS Performance</h2>
<p>These flags may be used to enable/disable features of the VFS for
performance or other reasons. See also the <a
href="#vfs-chunked-reading">chunked reading</a> feature.</p>
<p>In particular S3 and Swift benefit hugely from the
<code>--no-modtime</code> flag (or use <code>--use-server-modtime</code>
for a slightly different effect) as each read of the modification time
takes a transaction.</p>
<pre class="text"><code>    --no-checksum     Don&#39;t compare checksums on up/download.
    --no-modtime      Don&#39;t read/write the modification time (can speed things up).
    --no-seek         Don&#39;t allow seeking in files.
    --read-only       Only allow read-only access.</code></pre>
<p>Sometimes rclone is delivered reads or writes out of order. Rather
than seeking rclone will wait a short time for the in sequence read or
write to come in. These flags only come into effect when not using an on
disk cache file.</p>
<pre class="text"><code>    --vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
    --vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>When using VFS write caching (<code>--vfs-cache-mode</code> with
value writes or full), the global flag <code>--transfers</code> can be
set to adjust the number of parallel uploads of modified files from the
cache (the related global flag <code>--checkers</code> has no effect on
the VFS).</p>
<pre class="text"><code>    --transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="symlinks">Symlinks</h2>
<p>By default the VFS does not support symlinks. However this may be
enabled with either of the following flags:</p>
<pre class="text"><code>    --links      Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension.
    --vfs-links  Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS</code></pre>
<p>As most cloud storage systems do not support symlinks directly,
rclone stores the symlink as a normal file with a special extension. So
a file which appears as a symlink <code>link-to-file.txt</code> would be
stored on cloud storage as <code>link-to-file.txt.rclonelink</code> and
the contents would be the path to the symlink destination.</p>
<p>Note that <code>--links</code> enables symlink translation globally
in rclone - this includes any backend which supports the concept (for
example the local backend). <code>--vfs-links</code> just enables it for
the VFS layer.</p>
<p>This scheme is compatible with that used by the <a
href="https://rclone.org/local/#symlinks-junction-points">local backend
with the --local-links flag</a>.</p>
<p>The <code>--vfs-links</code> flag has been designed for
<code>rclone mount</code>, <code>rclone nfsmount</code> and
<code>rclone serve nfs</code>.</p>
<p>It hasn't been tested with the other <code>rclone serve</code>
commands yet.</p>
<p>A limitation of the current implementation is that it expects the
caller to resolve sub-symlinks. For example given this directory
tree</p>
<pre class="text"><code>.
├── dir
│   └── file.txt
└── linked-dir -&gt; dir</code></pre>
<p>The VFS will correctly resolve <code>linked-dir</code> but not
<code>linked-dir/file.txt</code>. This is not a problem for the tested
commands but may be for other commands.</p>
<p><strong>Note</strong> that there is an outstanding issue with symlink
support <a href="https://github.com/rclone/rclone/issues/8245">issue
#8245</a> with duplicate files being created when symlinks are moved
into directories where there is a file of the same name (or vice
versa).</p>
<h2 id="vfs-case-sensitivity">VFS Case Sensitivity</h2>
<p>Linux file systems are case-sensitive: two files can differ only by
case, and the exact case must be used when opening a file.</p>
<p>File systems in modern Windows are case-insensitive but
case-preserving: although existing files can be opened using any case,
the exact case used to create the file is preserved and available for
programs to query. It is not allowed for two files in the same directory
to differ only by case.</p>
<p>Usually file systems on macOS are case-insensitive. It is possible to
make macOS file systems case-sensitive but that is not the default.</p>
<p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone
handles these two cases. If its value is "false", rclone passes file
names to the remote as-is. If the flag is "true" (or appears without a
value on the command line), rclone may perform a "fixup" as explained
below.</p>
<p>The user may specify a file name to open/delete/rename/etc with a
case different than what is stored on the remote. If an argument refers
to an existing file with exactly the same name, then the case of the
existing file on the disk will be used. However, if a file name with
exactly the same name is not found but a name differing only by case
exists, rclone will transparently fixup the name. This fixup happens
only when an existing file is requested. Case sensitivity of file names
created anew by rclone is controlled by the underlying remote.</p>
<p>Note that case sensitivity of the operating system running rclone
(the target) may differ from case sensitivity of a file system presented
by rclone (the source). The flag controls whether "fixup" is performed
to satisfy the target.</p>
<p>If the flag is not provided on the command line, then its default
value depends on the operating system where rclone runs: "true" on
Windows and macOS, "false" otherwise. If the flag is provided without a
value, then it is "true".</p>
<p>The <code>--no-unicode-normalization</code> flag controls whether a
similar "fixup" is performed for filenames that differ but are <a
href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically
equivalent</a> with respect to unicode. Unicode normalization can be
particularly helpful for users of macOS, which prefers form NFD instead
of the NFC used by most other platforms. It is therefore highly
recommended to keep the default of <code>false</code> on macOS, to avoid
encoding compatibility issues.</p>
<p>In the (probably unlikely) event that a directory has multiple
duplicate filenames after applying case and unicode normalization, the
<code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates.
This comes with a performance tradeoff, as rclone will have to scan the
entire directory for duplicates when listing a directory. For this
reason, it is recommended to leave this disabled if not needed. However,
macOS users may wish to consider using it, as otherwise, if a remote
directory contains both NFC and NFD versions of the same filename, an
odd situation will occur: both versions of the file will be visible in
the mount, and both will appear to be editable, however, editing either
version will actually result in only the NFD version getting edited
under the hood. <code>--vfs-block- norm-dupes</code> prevents this
confusion by detecting this scenario, hiding the duplicates, and logging
an error, similar to how this is handled in
<code>rclone sync</code>.</p>
<h2 id="vfs-disk-options">VFS Disk Options</h2>
<p>This flag allows you to manually set the statistics about the filing
system. It can be useful when those statistics cannot be read correctly
automatically.</p>
<pre class="text"><code>    --vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes">Alternate report of used
bytes</h2>
<p>Some backends, most notably S3, do not report the amount of bytes
used. If you need this information to be available when running
<code>df</code> on the filesystem, then pass the flag
<code>--vfs-used-is-size</code> to rclone. With this flag set, instead
of relying on the backend to report this information, rclone will scan
the whole remote similar to <code>rclone size</code> and compute the
total used space itself.</p>
<p><strong>WARNING</strong>: Contrary to <code>rclone size</code>, this
flag ignores filters so that the result is accurate. However, this is
very inefficient and may cost lots of API calls resulting in extra
charges. Use it as a last resort and only with caching.</p>
<h2 id="vfs-metadata">VFS Metadata</h2>
<p>If you use the <code>--vfs-metadata-extension</code> flag you can get
the VFS to expose files which contain the <a
href="https://rclone.org/docs/#metadata">metadata</a> as a JSON blob.
These files will not appear in the directory listing, but can be
<code>stat</code>-ed and opened and once they have been they
<strong>will</strong> appear in directory listings until the directory
cache expires.</p>
<p>Note that some backends won't create metadata unless you pass in the
<code>--metadata</code> flag.</p>
<p>For example, using <code>rclone mount</code> with
<code>--metadata --vfs-metadata-extension .metadata</code> we get</p>
<div class="sourceCode" id="cb338"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb338-1"><a href="#cb338-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb338-2"><a href="#cb338-2" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048577</span>
<span id="cb338-3"><a href="#cb338-3" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb338-4"><a href="#cb338-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb338-5"><a href="#cb338-5" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> cat /mnt/1G.metadata</span>
<span id="cb338-6"><a href="#cb338-6" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb338-7"><a href="#cb338-7" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;atime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-04T17:34:22.317069787Z&quot;</span>,</span>
<span id="cb338-8"><a href="#cb338-8" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;btime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:37.708253808Z&quot;</span>,</span>
<span id="cb338-9"><a href="#cb338-9" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;gid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span>,</span>
<span id="cb338-10"><a href="#cb338-10" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mode&quot;</span><span class="ex">:</span> <span class="st">&quot;100664&quot;</span>,</span>
<span id="cb338-11"><a href="#cb338-11" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mtime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:39.640238323Z&quot;</span>,</span>
<span id="cb338-12"><a href="#cb338-12" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;uid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span></span>
<span id="cb338-13"><a href="#cb338-13" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span>
<span id="cb338-14"><a href="#cb338-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb338-15"><a href="#cb338-15" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb338-16"><a href="#cb338-16" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048578</span>
<span id="cb338-17"><a href="#cb338-17" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb338-18"><a href="#cb338-18" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user        185 Mar  3 16:03 1G.metadata</span></code></pre></div>
<p>If the file has no metadata it will be returned as <code>{}</code>
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<pre><code>rclone mount remote:path /path/to/mountpoint [flags]</code></pre>
<h2 id="options-61">Options</h2>
<pre><code>      --allow-non-empty                        Allow mounting over a non-empty directory (not supported on Windows)
      --allow-other                            Allow access to other users (not supported on Windows)
      --allow-root                             Allow access to root user (not supported on Windows)
      --async-read                             Use asynchronous reads (not supported on Windows) (default true)
      --attr-timeout Duration                  Time for which file/directory attributes are cached (default 1s)
      --daemon                                 Run mount in background and exit parent process (as background output is suppressed, use --log-file with --log-format=pid,... to monitor) (not supported on Windows)
      --daemon-timeout Duration                Time limit for rclone to respond to kernel (not supported on Windows) (default 0s)
      --daemon-wait Duration                   Time to wait for ready mount from daemon (maximum time on Linux, constant sleep time on OSX/BSD) (not supported on Windows) (default 1m0s)
      --debug-fuse                             Debug the FUSE internals - needs -v
      --default-permissions                    Makes kernel enforce access control based on the file mode (not supported on Windows)
      --devname string                         Set the device name - default is remote:path
      --dir-cache-time Duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 777)
      --direct-io                              Use Direct IO, disables caching of data
      --file-perms FileMode                    File permissions (default 666)
      --fuse-flag stringArray                  Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for mount
      --link-perms FileMode                    Link permissions (default 666)
      --max-read-ahead SizeSuffix              The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki)
      --mount-case-insensitive Tristate        Tell the OS the mount is case insensitive (true) or sensitive (false) regardless of the backend (auto) (default unset)
      --network-mode                           Mount as remote network drive, instead of fixed disk drive (supported on Windows only)
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --noappledouble                          Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true)
      --noapplexattr                           Ignore all &quot;com.apple.*&quot; extended attributes (supported on OSX only)
  -o, --option stringArray                     Option for libfuse/WinFsp (repeat if required)
      --poll-interval Duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask FileMode                         Override the permission bits set by the filesystem (not supported on Windows) (default 002)
      --vfs-block-norm-dupes                   If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
      --vfs-cache-max-age Duration             Max time since last access of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-min-free-space SizeSuffix    Target minimum free space on the disk containing the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval Duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-links                              Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
      --vfs-metadata-extension string          Set the extension to read metadata from
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-chunk-streams int             The number of parallel streams to read at once
      --vfs-read-wait Duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-refresh                            Refreshes the directory cache recursively in the background on start
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back Duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait Duration                Time to wait for in-sequence write before giving error (default 1s)
      --volname string                         Set the volume name (supported on Windows and OSX only)
      --write-back-cache                       Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-20">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h2 id="see-also-61">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-moveto">rclone moveto</h1>
<p>Move file or directory from source to dest.</p>
<h2 id="synopsis-55">Synopsis</h2>
<p>If source:path is a file or directory then it moves it to a file or
directory named dest:path.</p>
<p>This can be used to rename files or upload single files to other than
their existing name. If the source is a directory then it acts exactly
like the <a href="https://rclone.org/commands/rclone_move/">move</a>
command.</p>
<p>So</p>
<div class="sourceCode" id="cb342"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb342-1"><a href="#cb342-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> moveto src dst</span></code></pre></div>
<p>where src and dst are rclone paths, either remote:path or
/path/to/local or C:.</p>
<p>This will:</p>
<pre class="text"><code>if src is file
    move it to dst, overwriting an existing file if it exists
if src is directory
    move it to dst, overwriting existing files if they exist
    see move command for full details</code></pre>
<p>This doesn't transfer files that are identical on src and dst,
testing by size and modification time or MD5SUM. src will be deleted on
successful transfer.</p>
<p><strong>Important</strong>: Since this can cause data loss, test
first with the <code>--dry-run</code> or the
<code>--interactive</code>/<code>-i</code> flag.</p>
<p><strong>Note</strong>: Use the
<code>-P</code>/<code>--progress</code> flag to view real-time transfer
statistics.</p>
<h2 id="logger-flags-4">Logger Flags</h2>
<p>The <code>--differ</code>, <code>--missing-on-dst</code>,
<code>--missing-on-src</code>, <code>--match</code> and
<code>--error</code> flags write paths, one per line, to the file name
(or stdout if it is <code>-</code>) supplied. What they write is
described in the help below. For example <code>--differ</code> will
write all paths which are present on both the source and destination but
different.</p>
<p>The <code>--combined</code> flag will write a file (or stdout) which
contains all file paths with a symbol and then a space and then the path
to tell you what happened to it. These are reminiscent of diff
files.</p>
<ul>
<li><code>= path</code> means path was found in source and destination
and was identical</li>
<li><code>- path</code> means path was missing on the source, so only in
the destination</li>
<li><code>+ path</code> means path was missing on the destination, so
only in the source</li>
<li><code>* path</code> means path was present in source and destination
but different.</li>
<li><code>! path</code> means there was an error reading or hashing the
source or dest.</li>
</ul>
<p>The <code>--dest-after</code> flag writes a list file using the same
format flags as <a
href="https://rclone.org/commands/rclone_lsf/#synopsis"><code>lsf</code></a>
(including <a
href="https://rclone.org/commands/rclone_lsf/#synopsis">customizable
options for hash, modtime, etc.</a>) Conceptually it is similar to
rsync's <code>--itemize-changes</code>, but not identical -- it should
output an accurate list of what will be on the destination after the
command is finished.</p>
<p>When the <code>--no-traverse</code> flag is set, all logs involving
files that exist only on the destination will be incomplete or
completely missing.</p>
<p>Note that these logger flags have a few limitations, and certain
scenarios are not currently supported:</p>
<ul>
<li><code>--max-duration</code> / <code>CutoffModeHard</code></li>
<li><code>--compare-dest</code> / <code>--copy-dest</code></li>
<li>server-side moves of an entire dir at once</li>
<li>High-level retries, because there would be duplicates (use
<code>--retries 1</code> to disable)</li>
<li>Possibly some unusual error scenarios</li>
</ul>
<p>Note also that each file is logged during execution, as opposed to
after, so it is most useful as a predictor of what SHOULD happen to each
file (which may or may not match what actually DID).</p>
<pre><code>rclone moveto source:path dest:path [flags]</code></pre>
<h2 id="options-62">Options</h2>
<pre><code>      --absolute                Put a leading / in front of path names
      --combined string         Make a combined report of changes to this file
      --csv                     Output in CSV format
      --dest-after string       Report all files that exist on the dest post-sync
      --differ string           Report all non-matching files to this file
  -d, --dir-slash               Append a slash to directory names (default true)
      --dirs-only               Only list directories
      --error string            Report all files with errors (hashing or reading) to this file
      --files-only              Only list files (default true)
  -F, --format string           Output format - see lsf help for details (default &quot;p&quot;)
      --hash h                  Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default &quot;md5&quot;)
  -h, --help                    help for moveto
      --match string            Report all matching files to this file
      --missing-on-dst string   Report all files missing from the destination to this file
      --missing-on-src string   Report all files missing from the source to this file
  -s, --separator string        Separator for the items in the format (default &quot;;&quot;)
  -t, --timeformat string       Specify a custom time format, or &#39;max&#39; for max precision supported by remote (default: 2006-01-02 15:04:05)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="copy-options-6">Copy Options</h3>
<p>Flags for anything which can copy a file</p>
<pre class="text"><code>      --check-first                                 Do all the checks before starting transfers
  -c, --checksum                                    Check for changes with size &amp; checksum (if available, or fallback to size only)
      --compare-dest stringArray                    Include additional server-side paths during comparison
      --copy-dest stringArray                       Implies --compare-dest but also copies files from paths into destination
      --cutoff-mode HARD|SOFT|CAUTIOUS              Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
      --ignore-case-sync                            Ignore case when synchronizing
      --ignore-checksum                             Skip post copy check of checksums
      --ignore-existing                             Skip all files that exist on destination
      --ignore-size                                 Ignore size when skipping use modtime or checksum
  -I, --ignore-times                                Don&#39;t skip items that match size and time - transfer all unconditionally
      --immutable                                   Do not modify files, fail if existing files have been modified
      --inplace                                     Download directly to destination file instead of atomic download to temp/rename
  -l, --links                                       Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension
      --max-backlog int                             Maximum number of objects in sync or check backlog (default 10000)
      --max-duration Duration                       Maximum duration rclone will transfer data for (default 0s)
      --max-transfer SizeSuffix                     Maximum size of data to transfer (default off)
  -M, --metadata                                    If set, preserve metadata when copying objects
      --modify-window Duration                      Max time diff to be considered the same (default 1ns)
      --multi-thread-chunk-size SizeSuffix          Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi)
      --multi-thread-cutoff SizeSuffix              Use multi-thread downloads for files above this size (default 256Mi)
      --multi-thread-streams int                    Number of streams to use for multi-thread downloads (default 4)
      --multi-thread-write-buffer-size SizeSuffix   In memory buffer size for writing when in multi-thread mode (default 128Ki)
      --name-transform stringArray                  Transform paths during the copy process
      --no-check-dest                               Don&#39;t check the destination, copy regardless
      --no-traverse                                 Don&#39;t traverse destination file system on copy
      --no-update-dir-modtime                       Don&#39;t update directory modification times
      --no-update-modtime                           Don&#39;t update destination modtime if files identical
      --order-by string                             Instructions on how to order the transfers, e.g. &#39;size,descending&#39;
      --partial-suffix string                       Add partial-suffix to temporary file name when --inplace is not used (default &quot;.partial&quot;)
      --refresh-times                               Refresh the modtime of remote files
      --server-side-across-configs                  Allow server-side operations (e.g. copy) to work across different configs
      --size-only                                   Skip based on size only, not modtime or checksum
      --streaming-upload-cutoff SizeSuffix          Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki)
  -u, --update                                      Skip files that are newer on the destination</code></pre>
<h3 id="important-options-15">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h3 id="filter-options-21">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-19">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-62">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-ncdu">rclone ncdu</h1>
<p>Explore a remote with a text based user interface.</p>
<h2 id="synopsis-56">Synopsis</h2>
<p>This displays a text based user interface allowing the navigation of
a remote. It is most useful for answering the question - "What is using
all my disk space?".</p>
<p>To make the user interface it first scans the entire remote given and
builds an in memory representation. rclone ncdu can be used during this
scanning phase and you will see it building up the directory structure
as it goes along.</p>
<p>You can interact with the user interface using key presses, press '?'
to toggle the help on and off. The supported keys are:</p>
<pre class="text"><code> ↑,↓ or k,j to Move
 →,l to enter
 ←,h to return
 g toggle graph
 c toggle counts
 a toggle average size in directory
 m toggle modified time
 u toggle human-readable format
 n,s,C,A,M sort by name,size,count,asize,mtime
 d delete file/directory
 v select file/directory
 V enter visual select mode
 D delete selected files/directories
 y copy current path to clipboard
 Y display current path
 ^L refresh screen (fix screen corruption)
 r recalculate file sizes
 ? to toggle help on and off
 ESC to close the menu box
 q/^c to quit</code></pre>
<p>Listed files/directories may be prefixed by a one-character flag,
some of them combined with a description in brackets at end of line.
These flags have the following meaning:</p>
<pre class="text"><code>e means this is an empty directory, i.e. contains no files (but
  may contain empty subdirectories)
~ means this is a directory where some of the files (possibly in
  subdirectories) have unknown size, and therefore the directory
  size may be underestimated (and average size inaccurate, as it
  is average of the files with known sizes).
. means an error occurred while reading a subdirectory, and
  therefore the directory size may be underestimated (and average
  size inaccurate)
! means an error occurred while reading this directory</code></pre>
<p>This an homage to the <a href="https://dev.yorhel.nl/ncdu">ncdu
tool</a> but for rclone remotes. It is missing lots of features at the
moment but is useful as it stands. Unlike ncdu it does not show excluded
files.</p>
<p>Note that it might take some time to delete big files/directories.
The UI won't respond in the meantime since the deletion is done
synchronously.</p>
<p>For a non-interactive listing of the remote, see the <a
href="https://rclone.org/commands/rclone_tree/">tree</a> command. To
just get the total size of the remote you can also use the <a
href="https://rclone.org/commands/rclone_size/">size</a> command.</p>
<pre><code>rclone ncdu remote:path [flags]</code></pre>
<h2 id="options-63">Options</h2>
<pre><code>  -h, --help   help for ncdu</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-22">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-20">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-63">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-nfsmount">rclone nfsmount</h1>
<p>Mount the remote as file system on a mountpoint.</p>
<h2 id="synopsis-57">Synopsis</h2>
<p>Rclone nfsmount allows Linux, FreeBSD, macOS and Windows to mount any
of Rclone's cloud storage systems as a file system with FUSE.</p>
<p>First set up your remote using <code>rclone config</code>. Check it
works with <code>rclone ls</code> etc.</p>
<p>On Linux and macOS, you can run mount in either foreground or
background (aka daemon) mode. Mount runs in foreground mode by default.
Use the <code>--daemon</code> flag to force background mode. On Windows
you can run mount in foreground only, the flag is ignored.</p>
<p>In background mode rclone acts as a generic Unix mount program: the
main program starts, spawns background rclone process to setup and
maintain the mount, waits until success or timeout and exits with
appropriate code (killing the child process if it fails).</p>
<p>On Linux/macOS/FreeBSD start the mount like this, where
<code>/path/to/local/mount</code> is an <strong>empty</strong>
<strong>existing</strong> directory:</p>
<div class="sourceCode" id="cb356"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb356-1"><a href="#cb356-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files /path/to/local/mount</span></code></pre></div>
<p>On Windows you can start a mount in different ways. See <a
href="#mounting-modes-on-windows">below</a> for details. If foreground
mount is used interactively from a console window, rclone will serve the
mount and occupy the console so another window should be used to work
with the mount until rclone is interrupted e.g. by pressing Ctrl-C.</p>
<p>The following examples will mount to an automatically assigned drive,
to specific drive letter <code>X:</code>, to path
<code>C:\path\parent\mount</code> (where parent directory or drive must
exist, and mount must <strong>not</strong> exist, and is not supported
when <a href="#mounting-modes-on-windows">mounting as a network
drive</a>), and the last example will mount as network share
<code>\\cloud\remote</code> and map it to an automatically assigned
drive:</p>
<div class="sourceCode" id="cb357"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb357-1"><a href="#cb357-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files <span class="pp">*</span></span>
<span id="cb357-2"><a href="#cb357-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files X:</span>
<span id="cb357-3"><a href="#cb357-3" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files C:<span class="dt">\p</span>ath<span class="dt">\p</span>arent<span class="dt">\m</span>ount</span>
<span id="cb357-4"><a href="#cb357-4" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files <span class="dt">\\</span>cloud<span class="dt">\r</span>emote</span></code></pre></div>
<p>When the program ends while in foreground mode, either via Ctrl+C or
receiving a SIGINT or SIGTERM signal, the mount should be automatically
stopped.</p>
<p>When running in background mode the user will have to stop the mount
manually:</p>
<div class="sourceCode" id="cb358"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb358-1"><a href="#cb358-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Linux</span></span>
<span id="cb358-2"><a href="#cb358-2" aria-hidden="true" tabindex="-1"></a><span class="ex">fusermount</span> <span class="at">-u</span> /path/to/local/mount</span>
<span id="cb358-3"><a href="#cb358-3" aria-hidden="true" tabindex="-1"></a><span class="co">#... or on some systems</span></span>
<span id="cb358-4"><a href="#cb358-4" aria-hidden="true" tabindex="-1"></a><span class="ex">fusermount3</span> <span class="at">-u</span> /path/to/local/mount</span>
<span id="cb358-5"><a href="#cb358-5" aria-hidden="true" tabindex="-1"></a><span class="co"># OS X or Linux when using nfsmount</span></span>
<span id="cb358-6"><a href="#cb358-6" aria-hidden="true" tabindex="-1"></a><span class="fu">umount</span> /path/to/local/mount</span></code></pre></div>
<p>The umount operation can fail, for example when the mountpoint is
busy. When that happens, it is the user's responsibility to stop the
mount manually.</p>
<p>The size of the mounted file system will be set according to
information retrieved from the remote, the same as returned by the <a
href="https://rclone.org/commands/rclone_about/">rclone about</a>
command. Remotes with unlimited storage may report the used size only,
then an additional 1 PiB of free space is assumed. If the remote does
not <a href="https://rclone.org/overview/#optional-features">support</a>
the about feature at all, then 1 PiB is set as both the total and the
free size.</p>
<h2 id="installing-on-windows-1">Installing on Windows</h2>
<p>To run rclone nfsmount on Windows, you will need to download and
install <a href="http://www.secfs.net/winfsp/">WinFsp</a>.</p>
<p><a href="https://github.com/winfsp/winfsp">WinFsp</a> is an
open-source Windows File System Proxy which makes it easy to write user
space file systems for Windows. It provides a FUSE emulation layer which
rclone uses combination with <a
href="https://github.com/winfsp/cgofuse">cgofuse</a>. Both of these
packages are by Bill Zissimopoulos who was very helpful during the
implementation of rclone nfsmount for Windows.</p>
<h3 id="mounting-modes-on-windows-1">Mounting modes on windows</h3>
<p>Unlike other operating systems, Microsoft Windows provides a
different filesystem type for network and fixed drives. It optimises
access on the assumption fixed disk drives are fast and reliable, while
network drives have relatively high latency and less reliability. Some
settings can also be differentiated between the two types, for example
that Windows Explorer should just display icons and not create preview
thumbnails for image and video files on network drives.</p>
<p>In most cases, rclone will mount the remote as a normal, fixed disk
drive by default. However, you can also choose to mount it as a remote
network drive, often described as a network share. If you mount an
rclone remote using the default, fixed drive mode and experience
unexpected program errors, freezes or other issues, consider mounting as
a network drive instead.</p>
<p>When mounting as a fixed disk drive you can either mount to an unused
drive letter, or to a path representing a <strong>nonexistent</strong>
subdirectory of an <strong>existing</strong> parent directory or drive.
Using the special value <code>*</code> will tell rclone to automatically
assign the next available drive letter, starting with Z: and moving
backward. Examples:</p>
<div class="sourceCode" id="cb359"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb359-1"><a href="#cb359-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files <span class="pp">*</span></span>
<span id="cb359-2"><a href="#cb359-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files X:</span>
<span id="cb359-3"><a href="#cb359-3" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files C:<span class="dt">\p</span>ath<span class="dt">\p</span>arent<span class="dt">\m</span>ount</span>
<span id="cb359-4"><a href="#cb359-4" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files X:</span></code></pre></div>
<p>Option <code>--volname</code> can be used to set a custom volume name
for the mounted file system. The default is to use the remote name and
path.</p>
<p>To mount as network drive, you can add option
<code>--network-mode</code> to your nfsmount command. Mounting to a
directory path is not supported in this mode, it is a limitation Windows
imposes on junctions, so the remote must always be mounted to a drive
letter.</p>
<div class="sourceCode" id="cb360"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb360-1"><a href="#cb360-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files X: <span class="at">--network-mode</span></span></code></pre></div>
<p>A volume name specified with <code>--volname</code> will be used to
create the network share path. A complete UNC path, such as
<code>\\cloud\remote</code>, optionally with path
<code>\\cloud\remote\madeup\path</code>, will be used as is. Any other
string will be used as the share part, after a default prefix
<code>\\server\</code>. If no volume name is specified then
<code>\\server\share</code> will be used. You must make sure the volume
name is unique when you are mounting more than one drive, or else the
mount command will fail. The share name will treated as the volume label
for the mapped drive, shown in Windows Explorer etc, while the complete
<code>\\server\share</code> will be reported as the remote UNC path by
<code>net use</code> etc, just like a normal network drive mapping.</p>
<p>If you specify a full network share UNC path with
<code>--volname</code>, this will implicitly set the
<code>--network-mode</code> option, so the following two examples have
same result:</p>
<div class="sourceCode" id="cb361"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb361-1"><a href="#cb361-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files X: <span class="at">--network-mode</span></span>
<span id="cb361-2"><a href="#cb361-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files X: <span class="at">--volname</span> <span class="dt">\\</span>server<span class="dt">\s</span>hare</span></code></pre></div>
<p>You may also specify the network share UNC path as the mountpoint
itself. Then rclone will automatically assign a drive letter, same as
with <code>*</code> and use that as mountpoint, and instead use the UNC
path specified as the volume name, as if it were specified with the
<code>--volname</code> option. This will also implicitly set the
<code>--network-mode</code> option. This means the following two
examples have same result:</p>
<div class="sourceCode" id="cb362"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb362-1"><a href="#cb362-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files <span class="dt">\\</span>cloud<span class="dt">\r</span>emote</span>
<span id="cb362-2"><a href="#cb362-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> nfsmount remote:path/to/files <span class="pp">*</span> <span class="at">--volname</span> <span class="dt">\\</span>cloud<span class="dt">\r</span>emote</span></code></pre></div>
<p>There is yet another way to enable network mode, and to set the share
path, and that is to pass the "native" libfuse/WinFsp option directly:
<code>--fuse-flag --VolumePrefix=\server\share</code>. Note that the
path must be with just a single backslash prefix in this case.</p>
<p><em>Note:</em> In previous versions of rclone this was the only
supported method.</p>
<p><a href="https://en.wikipedia.org/wiki/Drive_mapping">Read more about
drive mapping</a></p>
<p>See also <a href="#limitations">Limitations</a> section below.</p>
<h3 id="windows-filesystem-permissions-1">Windows filesystem
permissions</h3>
<p>The FUSE emulation layer on Windows must convert between the
POSIX-based permission model used in FUSE, and the permission model used
in Windows, based on access-control lists (ACL).</p>
<p>The mounted filesystem will normally get three entries in its
access-control list (ACL), representing permissions for the POSIX
permission scopes: Owner, group and others. By default, the owner and
group will be taken from the current user, and the built-in group
"Everyone" will be used to represent others. The user/group can be
customized with FUSE options "UserName" and "GroupName", e.g.
<code>-o UserName=user123 -o GroupName="Authenticated Users"</code>. The
permissions on each entry will be set according to <a
href="#options">options</a> <code>--dir-perms</code> and
<code>--file-perms</code>, which takes a value in traditional Unix <a
href="https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation">numeric
notation</a>.</p>
<p>The default permissions corresponds to
<code>--file-perms 0666 --dir-perms 0777</code>, i.e. read and write
permissions to everyone. This means you will not be able to start any
programs from the mount. To be able to do that you must add execute
permissions, e.g. <code>--file-perms 0777 --dir-perms 0777</code> to add
it to everyone. If the program needs to write files, chances are you
will have to enable <a href="#vfs-file-caching">VFS File Caching</a> as
well (see also <a href="#limitations">limitations</a>). Note that the
default write permission have some restrictions for accounts other than
the owner, specifically it lacks the "write extended attributes", as
explained next.</p>
<p>The mapping of permissions is not always trivial, and the result you
see in Windows Explorer may not be exactly like you expected. For
example, when setting a value that includes write access for the group
or others scope, this will be mapped to individual permissions "write
attributes", "write data" and "append data", but not "write extended
attributes". Windows will then show this as basic permission "Special"
instead of "Write", because "Write" also covers the "write extended
attributes" permission. When setting digit 0 for group or others, to
indicate no permissions, they will still get individual permissions
"read attributes", "read extended attributes" and "read permissions".
This is done for compatibility reasons, e.g. to allow users without
additional permissions to be able to read basic metadata about files
like in Unix.</p>
<p>WinFsp 2021 (version 1.9) introduced a new FUSE option
"FileSecurity", that allows the complete specification of file security
descriptors using <a
href="https://docs.microsoft.com/en-us/windows/win32/secauthz/security-descriptor-string-format">SDDL</a>.
With this you get detailed control of the resulting permissions,
compared to use of the POSIX permissions described above, and no
additional permissions will be added automatically for compatibility
with Unix. Some example use cases will following.</p>
<p>If you set POSIX permissions for only allowing access to the owner,
using <code>--file-perms 0600 --dir-perms 0700</code>, the user group
and the built-in "Everyone" group will still be given some special
permissions, as described above. Some programs may then (incorrectly)
interpret this as the file being accessible by everyone, for example an
SSH client may warn about "unprotected private key file". You can work
around this by specifying
<code>-o FileSecurity="D:P(A;;FA;;;OW)"</code>, which sets file all
access (FA) to the owner (OW), and nothing else.</p>
<p>When setting write permissions then, except for the owner, this does
not include the "write extended attributes" permission, as mentioned
above. This may prevent applications from writing to files, giving
permission denied error instead. To set working write permissions for
the built-in "Everyone" group, similar to what it gets by default but
with the addition of the "write extended attributes", you can specify
<code>-o FileSecurity="D:P(A;;FRFW;;;WD)"</code>, which sets file read
(FR) and file write (FW) to everyone (WD). If file execute (FX) is also
needed, then change to
<code>-o FileSecurity="D:P(A;;FRFWFX;;;WD)"</code>, or set file all
access (FA) to get full access permissions, including delete, with
<code>-o FileSecurity="D:P(A;;FA;;;WD)"</code>.</p>
<h3 id="windows-caveats-1">Windows caveats</h3>
<p>Drives created as Administrator are not visible to other accounts,
not even an account that was elevated to Administrator with the User
Account Control (UAC) feature. A result of this is that if you mount to
a drive letter from a Command Prompt run as Administrator, and then try
to access the same drive from Windows Explorer (which does not run as
Administrator), you will not be able to see the mounted drive.</p>
<p>If you don't need to access the drive from applications running with
administrative privileges, the easiest way around this is to always
create the mount from a non-elevated command prompt.</p>
<p>To make mapped drives available to the user account that created them
regardless if elevated or not, there is a special Windows setting called
<a
href="https://docs.microsoft.com/en-us/troubleshoot/windows-client/networking/mapped-drives-not-available-from-elevated-command#detail-to-configure-the-enablelinkedconnections-registry-entry">linked
connections</a> that can be enabled.</p>
<p>It is also possible to make a drive mount available to everyone on
the system, by running the process creating it as the built-in SYSTEM
account. There are several ways to do this: One is to use the
command-line utility <a
href="https://docs.microsoft.com/en-us/sysinternals/downloads/psexec">PsExec</a>,
from Microsoft's Sysinternals suite, which has option <code>-s</code> to
start processes as the SYSTEM account. Another alternative is to run the
mount command from a Windows Scheduled Task, or a Windows Service,
configured to run as the SYSTEM account. A third alternative is to use
the <a
href="https://github.com/winfsp/winfsp/wiki/WinFsp-Service-Architecture">WinFsp.Launcher
infrastructure</a>). Read more in the <a
href="https://rclone.org/install/">install documentation</a>. Note that
when running rclone as another user, it will not use the configuration
file from your profile unless you tell it to with the <a
href="https://rclone.org/docs/#config-string"><code>--config</code></a>
option. Note also that it is now the SYSTEM account that will have the
owner permissions, and other accounts will have permissions according to
the group or others scopes. As mentioned above, these will then not get
the "write extended attributes" permission, and this may prevent writing
to files. You can work around this with the FileSecurity option, see
example above.</p>
<p>Note that mapping to a directory path, instead of a drive letter,
does not suffer from the same limitations.</p>
<h2 id="mounting-on-macos-1">Mounting on macOS</h2>
<p>Mounting on macOS can be done either via <a
href="https://rclone.org/commands/rclone_serve_nfs/">built-in NFS
server</a>, <a href="https://osxfuse.github.io/">macFUSE</a> (also known
as osxfuse) or <a href="https://www.fuse-t.org/">FUSE-T</a>.macFUSE is a
traditional FUSE driver utilizing a macOS kernel extension (kext).
FUSE-T is an alternative FUSE system which "mounts" via an NFSv4 local
server.</p>
<h3 id="unicode-normalization-1">Unicode Normalization</h3>
<p>It is highly recommended to keep the default of
<code>--no-unicode-normalization=false</code> for all <code>mount</code>
and <code>serve</code> commands on macOS. For details, see <a
href="https://rclone.org/commands/rclone_mount/#vfs-case-sensitivity">vfs-case-sensitivity</a>.</p>
<h3 id="nfs-mount-1">NFS mount</h3>
<p>This method spins up an NFS server using <a
href="https://rclone.org/commands/rclone_serve_nfs/">serve nfs</a>
command and mounts it to the specified mountpoint. If you run this in
background mode using |--daemon|, you will need to send SIGTERM signal
to the rclone process using |kill| command to stop the mount.</p>
<p>Note that <code>--nfs-cache-handle-limit</code> controls the maximum
number of cached file handles stored by the <code>nfsmount</code>
caching handler. This should not be set too low or you may experience
errors when trying to access files. The default is 1000000, but consider
lowering this limit if the server's system resource usage causes
problems.</p>
<h3 id="macfuse-notes-1">macFUSE Notes</h3>
<p>If installing macFUSE using <a
href="https://github.com/osxfuse/osxfuse/releases">dmg packages</a> from
the website, rclone will locate the macFUSE libraries without any
further intervention. If however, macFUSE is installed using the <a
href="https://www.macports.org/">macports</a> package manager, the
following addition steps are required.</p>
<div class="sourceCode" id="cb363"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb363-1"><a href="#cb363-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> mkdir /usr/local/lib</span>
<span id="cb363-2"><a href="#cb363-2" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> /usr/local/lib</span>
<span id="cb363-3"><a href="#cb363-3" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> ln <span class="at">-s</span> /opt/local/lib/libfuse.2.dylib</span></code></pre></div>
<h3 id="fuse-t-limitations-caveats-and-notes-1">FUSE-T Limitations,
Caveats, and Notes</h3>
<p>There are some limitations, caveats, and notes about how it works.
These are current as of FUSE-T version 1.0.14.</p>
<h4 id="modtime-update-on-read-1">ModTime update on read</h4>
<p>As per the <a
href="https://github.com/macos-fuse-t/fuse-t/wiki#caveats">FUSE-T
wiki</a>:</p>
<blockquote>
<p>File access and modification times cannot be set separately as it
seems to be an issue with the NFS client which always modifies both. Can
be reproduced with 'touch -m' and 'touch -a' commands</p>
</blockquote>
<p>This means that viewing files with various tools, notably macOS
Finder, will cause rlcone to update the modification time of the file.
This may make rclone upload a full new copy of the file.</p>
<h4 id="read-only-mounts-1">Read Only mounts</h4>
<p>When mounting with <code>--read-only</code>, attempts to write to
files will fail <em>silently</em> as opposed to with a clear warning as
in macFUSE.</p>
<h2 id="limitations-1">Limitations</h2>
<p>Without the use of <code>--vfs-cache-mode</code> this can only write
files sequentially, it can only seek when reading. This means that many
applications won't work with their files on an rclone mount without
<code>--vfs-cache-mode writes</code> or
<code>--vfs-cache-mode full</code>. See the <a
href="#vfs-file-caching">VFS File Caching</a> section for more info.
When using NFS mount on macOS, if you don't specify |--vfs-cache-mode|
the mount point will be read-only.</p>
<p>Bucket-based remotes - Azure Blob, Swift, S3, Google Cloud Storage
and B2 - can't store empty directories. Of these, only Azure Blob,
Google Cloud Storage and S3 can preserve them when you add
<code>--xxx-directory_markers</code>; otherwise, empty directories will
vanish once they drop out of the directory cache.</p>
<p>When <code>rclone mount</code> is invoked on Unix with
<code>--daemon</code> flag, the main rclone program will wait for the
background mount to become ready or until the timeout specified by the
<code>--daemon-wait</code> flag. On Linux it can check mount status
using ProcFS so the flag in fact sets <strong>maximum</strong> time to
wait, while the real wait can be less. On macOS / BSD the time to wait
is constant and the check is performed only at the end. We advise you to
set wait time on macOS reasonably.</p>
<p>Only supported on Linux, FreeBSD, OS X and Windows at the moment.</p>
<h2 id="rclone-nfsmount-vs-rclone-synccopy">rclone nfsmount vs rclone
sync/copy</h2>
<p>File systems expect things to be 100% reliable, whereas cloud storage
systems are a long way from 100% reliable. The rclone sync/copy commands
cope with this with lots of retries. However rclone nfsmount can't use
retries in the same way without making local copies of the uploads. Look
at the <a href="#vfs-file-caching">VFS File Caching</a> for solutions to
make nfsmount more reliable.</p>
<h2 id="attribute-caching-1">Attribute caching</h2>
<p>You can use the flag <code>--attr-timeout</code> to set the time the
kernel caches the attributes (size, modification time, etc.) for
directory entries.</p>
<p>The default is <code>1s</code> which caches files just long enough to
avoid too many callbacks to rclone from the kernel.</p>
<p>In theory 0s should be the correct value for filesystems which can
change outside the control of the kernel. However this causes quite a
few problems such as <a
href="https://github.com/rclone/rclone/issues/2157">rclone using too
much memory</a>, <a
href="https://forum.rclone.org/t/rclone-1-39-vs-1-40-mount-issue/5112">rclone
not serving files to samba</a> and <a
href="https://github.com/rclone/rclone/issues/2095#issuecomment-371141147">excessive
time listing directories</a>.</p>
<p>The kernel can cache the info about a file for the time given by
<code>--attr-timeout</code>. You may see corruption if the remote file
changes length during this window. It will show up as either a truncated
file or a file with garbage on the end. With
<code>--attr-timeout 1s</code> this is very unlikely but not impossible.
The higher you set <code>--attr-timeout</code> the more likely it is.
The default setting of "1s" is the lowest setting which mitigates the
problems above.</p>
<p>If you set it higher (<code>10s</code> or <code>1m</code> say) then
the kernel will call back to rclone less often making it more efficient,
however there is more chance of the corruption issue above.</p>
<p>If files don't change on the remote outside of the control of rclone
then there is no chance of corruption.</p>
<p>This is the same as setting the attr_timeout option in
mount.fuse.</p>
<h2 id="filters-1">Filters</h2>
<p>Note that all the rclone filters can be used to select a subset of
the files to be visible in the mount.</p>
<h2 id="systemd-1">systemd</h2>
<p>When running rclone nfsmount as a systemd service, it is possible to
use Type=notify. In this case the service will enter the started state
after the mountpoint has been successfully set up. Units having the
rclone nfsmount service specified as a requirement will see all files
and folders immediately in this mode.</p>
<p>Note that systemd runs mount units without any environment variables
including <code>PATH</code> or <code>HOME</code>. This means that tilde
(<code>~</code>) expansion will not work and you should provide
<code>--config</code> and <code>--cache-dir</code> explicitly as
absolute paths via rclone arguments. Since mounting requires the
<code>fusermount</code> or <code>fusermount3</code> program, rclone will
use the fallback PATH of <code>/bin:/usr/bin</code> in this scenario.
Please ensure that <code>fusermount</code>/<code>fusermount3</code> is
present on this PATH.</p>
<h2 id="rclone-as-unix-mount-helper-1">Rclone as Unix mount helper</h2>
<p>The core Unix program <code>/bin/mount</code> normally takes the
<code>-t FSTYPE</code> argument then runs the
<code>/sbin/mount.FSTYPE</code> helper program passing it mount options
as <code>-o key=val,...</code> or <code>--opt=...</code>. Automount
(classic or systemd) behaves in a similar way.</p>
<p>rclone by default expects GNU-style flags <code>--key val</code>. To
run it as a mount helper you should symlink rclone binary to
<code>/sbin/mount.rclone</code> and optionally
<code>/usr/bin/rclonefs</code>, e.g.
<code>ln -s /usr/bin/rclone /sbin/mount.rclone</code>. rclone will
detect it and translate command-line arguments appropriately.</p>
<p>Now you can run classic mounts like this:</p>
<div class="sourceCode" id="cb364"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb364-1"><a href="#cb364-1" aria-hidden="true" tabindex="-1"></a><span class="fu">mount</span> sftp1:subdir /mnt/data <span class="at">-t</span> rclone <span class="at">-o</span> vfs_cache_mode=writes,sftp_key_file=/path/to/pem</span></code></pre></div>
<p>or create systemd mount units:</p>
<div class="sourceCode" id="cb365"><pre
class="sourceCode ini"><code class="sourceCode ini"><span id="cb365-1"><a href="#cb365-1" aria-hidden="true" tabindex="-1"></a><span class="co"># /etc/systemd/system/mnt-data.mount</span></span>
<span id="cb365-2"><a href="#cb365-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[Unit]</span></span>
<span id="cb365-3"><a href="#cb365-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">Mount for /mnt/data</span></span>
<span id="cb365-4"><a href="#cb365-4" aria-hidden="true" tabindex="-1"></a><span class="kw">[Mount]</span></span>
<span id="cb365-5"><a href="#cb365-5" aria-hidden="true" tabindex="-1"></a><span class="dt">Type</span><span class="ot">=</span><span class="st">rclone</span></span>
<span id="cb365-6"><a href="#cb365-6" aria-hidden="true" tabindex="-1"></a><span class="dt">What</span><span class="ot">=</span><span class="st">sftp1:subdir</span></span>
<span id="cb365-7"><a href="#cb365-7" aria-hidden="true" tabindex="-1"></a><span class="dt">Where</span><span class="ot">=</span><span class="st">/mnt/data</span></span>
<span id="cb365-8"><a href="#cb365-8" aria-hidden="true" tabindex="-1"></a><span class="dt">Options</span><span class="ot">=</span><span class="st">rw,_netdev,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone</span></span></code></pre></div>
<p>optionally accompanied by systemd automount unit</p>
<div class="sourceCode" id="cb366"><pre
class="sourceCode ini"><code class="sourceCode ini"><span id="cb366-1"><a href="#cb366-1" aria-hidden="true" tabindex="-1"></a><span class="co"># /etc/systemd/system/mnt-data.automount</span></span>
<span id="cb366-2"><a href="#cb366-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[Unit]</span></span>
<span id="cb366-3"><a href="#cb366-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">AutoMount for /mnt/data</span></span>
<span id="cb366-4"><a href="#cb366-4" aria-hidden="true" tabindex="-1"></a><span class="kw">[Automount]</span></span>
<span id="cb366-5"><a href="#cb366-5" aria-hidden="true" tabindex="-1"></a><span class="dt">Where</span><span class="ot">=</span><span class="st">/mnt/data</span></span>
<span id="cb366-6"><a href="#cb366-6" aria-hidden="true" tabindex="-1"></a><span class="dt">TimeoutIdleSec</span><span class="ot">=</span><span class="dv">600</span></span>
<span id="cb366-7"><a href="#cb366-7" aria-hidden="true" tabindex="-1"></a><span class="kw">[Install]</span></span>
<span id="cb366-8"><a href="#cb366-8" aria-hidden="true" tabindex="-1"></a><span class="dt">WantedBy</span><span class="ot">=</span><span class="st">multi-user.target</span></span></code></pre></div>
<p>or add in <code>/etc/fstab</code> a line like</p>
<div class="sourceCode" id="cb367"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb367-1"><a href="#cb367-1" aria-hidden="true" tabindex="-1"></a><span class="ex">sftp1:subdir</span> /mnt/data rclone rw,noauto,nofail,_netdev,x-systemd.automount,args2env,vfs_cache_mode=writes,config=/etc/rclone.conf,cache_dir=/var/cache/rclone 0 0</span></code></pre></div>
<p>or use classic Automountd. Remember to provide explicit
<code>config=...,cache-dir=...</code> as a workaround for mount units
being run without <code>HOME</code>.</p>
<p>Rclone in the mount helper mode will split <code>-o</code>
argument(s) by comma, replace <code>_</code> by <code>-</code> and
prepend <code>--</code> to get the command-line flags. Options
containing commas or spaces can be wrapped in single or double quotes.
Any inner quotes inside outer quotes of the same type should be
doubled.</p>
<p>Mount option syntax includes a few extra options treated
specially:</p>
<ul>
<li><code>env.NAME=VALUE</code> will set an environment variable for the
mount process. This helps with Automountd and Systemd.mount which don't
allow setting custom environment for mount helpers. Typically you will
use <code>env.HTTPS_PROXY=proxy.host:3128</code> or
<code>env.HOME=/root</code></li>
<li><code>command=cmount</code> can be used to run <code>cmount</code>
or any other rclone command rather than the default
<code>mount</code>.</li>
<li><code>args2env</code> will pass mount options to the mount helper
running in background via environment variables instead of command line
arguments. This allows to hide secrets from such commands as
<code>ps</code> or <code>pgrep</code>.</li>
<li><code>vv...</code> will be transformed into appropriate
<code>--verbose=N</code></li>
<li>standard mount options like <code>x-systemd.automount</code>,
<code>_netdev</code>, <code>nosuid</code> and alike are intended only
for Automountd and ignored by rclone.</li>
</ul>
<h2 id="vfs---virtual-file-system-1">VFS - Virtual File System</h2>
<p>This command uses the VFS layer. This adapts the cloud storage
objects that rclone uses into something which looks much more like a
disk filing system.</p>
<p>Cloud storage objects have lots of properties which aren't like disk
files - you can't extend them or write to the middle of them, so the VFS
layer has to deal with that. Because there is no one right way of doing
this there are various options explained below.</p>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-1">VFS Directory Cache</h2>
<p>Using the <code>--dir-cache-time</code> flag, you can control how
long a directory should be considered up to date and not refreshed from
the backend. Changes made through the VFS will appear immediately or
invalidate the cache.</p>
<pre class="text"><code>    --dir-cache-time duration   Time to cache directory entries for (default 5m0s)
    --poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<p>However, changes made directly on the cloud storage by the web
interface or a different copy of rclone will only be picked up once the
directory cache expires if the backend configured does not support
polling for changes. If the backend supports polling, changes will be
picked up within the polling interval.</p>
<p>You can send a <code>SIGHUP</code> signal to rclone for it to flush
all directory caches, regardless of how old they are. Assuming only one
rclone instance is running, you can reset the cache like this:</p>
<div class="sourceCode" id="cb369"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb369-1"><a href="#cb369-1" aria-hidden="true" tabindex="-1"></a><span class="bu">kill</span> <span class="at">-SIGHUP</span> <span class="va">$(</span><span class="fu">pidof</span> rclone<span class="va">)</span></span></code></pre></div>
<p>If you configure rclone with a <a href="/rc">remote control</a> then
you can use rclone rc to flush the whole directory cache:</p>
<div class="sourceCode" id="cb370"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb370-1"><a href="#cb370-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget</span></code></pre></div>
<p>Or individual files or directories:</p>
<div class="sourceCode" id="cb371"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb371-1"><a href="#cb371-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget file=path/to/file dir=path/to/dir</span></code></pre></div>
<h2 id="vfs-file-buffering-1">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<p>Each open file will try to keep the specified amount of data in
memory at all times. The buffered data is bound to one open file and
won't be shared.</p>
<p>This flag is a upper limit for the used memory per open file. The
buffer will only use memory for data that is downloaded but not not yet
read. If the buffer is empty, only a small amount of memory will be
used.</p>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-1">VFS File Caching</h2>
<p>These flags control the VFS file caching options. File caching is
necessary to make the VFS layer appear compatible with a normal file
system. It can be disabled at the cost of some compatibility.</p>
<p>For example you'll need to enable VFS caching if you want to read and
write simultaneously to a file. See below for more details.</p>
<p>Note that the VFS cache is separate from the cache backend and you
may find that you need one or the other or both.</p>
<pre class="text"><code>    --cache-dir string                     Directory rclone will use for caching.
    --vfs-cache-mode CacheMode             Cache mode off|minimal|writes|full (default off)
    --vfs-cache-max-age duration           Max time since last access of objects in the cache (default 1h0m0s)
    --vfs-cache-max-size SizeSuffix        Max total size of objects in the cache (default off)
    --vfs-cache-min-free-space SizeSuffix  Target minimum free space on the disk containing the cache (default off)
    --vfs-cache-poll-interval duration     Interval to poll the cache for stale objects (default 1m0s)
    --vfs-write-back duration              Time to writeback files after last use when using cache (default 5s)</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the
file cache. The files are stored in the user cache file area which is OS
dependent but can be controlled with <code>--cache-dir</code> or setting
the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by
<code>--vfs-cache-mode</code>. The higher the cache mode the more
compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are
closed and if they haven't been accessed for
<code>--vfs-write-back</code> seconds. If rclone is quit or dies with
files that haven't been uploaded, these will be uploaded next time
rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or
<code>--vfs-cache-min-free-space</code> note that the cache may exceed
these quotas for two reasons. Firstly because it is only checked every
<code>--vfs-cache-poll-interval</code>. Secondly because open files
cannot be evicted from the cache. When <code>--vfs-cache-max-size</code>
or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will
attempt to evict the least accessed files from the cache first. rclone
will start with files that haven't been accessed for the longest. This
cache flushing strategy is efficient and more relevant files are likely
to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache
after the set time since last access has passed. The default value of 1
hour will start evicting files from cache that haven't been accessed for
1 hour. When a cached file is accessed the 1 hour timer is reset to 0
and will wait for 1 more hour before evicting. Specify the time with
standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the
same VFS cache with the same or overlapping remotes if using
<code>--vfs-cache-mode &gt; off</code>. This can potentially cause data
corruption if you do. You can work around this by giving each rclone its
own cache hierarchy with <code>--cache-dir</code>. You don't need to
worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-1">--vfs-cache-mode off</h3>
<p>In this mode (the default) the cache will read directly from the
remote and write directly to the remote without caching anything on
disk.</p>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can't be opened for both read AND write</li>
<li>Files opened for write can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-1">--vfs-cache-mode minimal</h3>
<p>This is very similar to "off" except that files opened for read AND
write will be buffered to disk. This means that files opened for write
will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-1">--vfs-cache-mode writes</h3>
<p>In this mode files opened for read only are still read directly from
the remote, write only and read/write files are buffered to disk
first.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-1">--vfs-cache-mode full</h3>
<p>In this mode all reads and writes are buffered to and from disk. When
data is read from the remote this is buffered to disk as well.</p>
<p>In this mode the files in the cache will be sparse files and rclone
will keep track of which bits of the files it has downloaded.</p>
<p>So if an application only reads the starts of each file, then rclone
will only buffer the start of the file. These files will appear to be
their full size in the cache, but they will be sparse files with only
the data that has been downloaded present in them.</p>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<p>When reading a file rclone will read <code>--buffer-size</code> plus
<code>--vfs-read-ahead</code> bytes ahead. The
<code>--buffer-size</code> is buffered in memory whereas the
<code>--vfs-read-ahead</code> is buffered on disk.</p>
<p>When using this mode it is recommended that
<code>--buffer-size</code> is not set too large and
<code>--vfs-read-ahead</code> is set large if required.</p>
<p><strong>IMPORTANT</strong> not all file systems support sparse files.
In particular FAT/exFAT do not. Rclone will perform very badly if the
cache directory is on a filesystem which doesn't support sparse files
and it will log an ERROR message if one is detected.</p>
<h3 id="fingerprinting-1">Fingerprinting</h3>
<p>Various parts of the VFS use fingerprinting to see if a local file
copy has changed relative to a remote file. Fingerprints are made
from:</p>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<p>On some backends some of these attributes are slow to read (they take
an extra API call per object, or extra work per object).</p>
<p>For example <code>hash</code> is slow with the <code>local</code> and
<code>sftp</code> backends as they have to read the entire file and hash
it, and <code>modtime</code> is slow with the <code>s3</code>,
<code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends
because they need to do an extra API call to fetch it.</p>
<p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone
will not include the slow operations in the fingerprint. This makes the
fingerprinting less accurate but much faster and will improve the
opening time of cached files.</p>
<p>If you are running a vfs cache over <code>local</code>,
<code>s3</code> or <code>swift</code> backends then using this flag is
recommended.</p>
<p>Note that if you change the value of this flag, the fingerprints of
the files in the cache may be invalidated and the files will need to be
downloaded again.</p>
<h2 id="vfs-chunked-reading-1">VFS Chunked Reading</h2>
<p>When rclone reads files from a remote it reads them in chunks. This
means that rather than requesting the whole file rclone reads the chunk
specified. This can reduce the used download quota for some remotes by
requesting only chunks from the remote that are actually read, at the
cost of an increased number of requests.</p>
<p>These flags control the chunking:</p>
<pre class="text"><code>    --vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
    --vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)
    --vfs-read-chunk-streams int            The number of parallel streams to read at once</code></pre>
<p>The chunking behaves differently depending on the
<code>--vfs-read-chunk-streams</code> parameter.</p>
<h3
id="vfs-read-chunk-streams-0-2"><code>--vfs-read-chunk-streams</code> ==
0</h3>
<p>Rclone will start reading a chunk of size
<code>--vfs-read-chunk-size</code>, and then double the size for each
read. When <code>--vfs-read-chunk-size-limit</code> is specified, and
greater than <code>--vfs-read-chunk-size</code>, the chunk size for each
open file will get doubled only until the specified value is reached. If
the value is "off", which is the default, the limit is disabled and the
chunk size will grow indefinitely.</p>
<p>With <code>--vfs-read-chunk-size 100M</code> and
<code>--vfs-read-chunk-size-limit 0</code> the following parts will be
downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When
<code>--vfs-read-chunk-size-limit 500M</code> is specified, the result
would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so
on.</p>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off"
disables chunked reading.</p>
<p>The chunks will not be buffered in memory.</p>
<h3
id="vfs-read-chunk-streams-0-3"><code>--vfs-read-chunk-streams</code>
&gt; 0</h3>
<p>Rclone reads <code>--vfs-read-chunk-streams</code> chunks of size
<code>--vfs-read-chunk-size</code> concurrently. The size for each read
will stay constant.</p>
<p>This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.</p>
<p>Some experimentation will be needed to find the optimum values of
<code>--vfs-read-chunk-size</code> and
<code>--vfs-read-chunk-streams</code> as these will depend on the
backend in use and the latency to the backend.</p>
<p>For high performance object stores (eg AWS S3) a reasonable place to
start might be <code>--vfs-read-chunk-streams 16</code> and
<code>--vfs-read-chunk-size 4M</code>. In testing with AWS S3 the
performance scaled roughly as the <code>--vfs-read-chunk-streams</code>
setting.</p>
<p>Similar settings should work for high latency links, but depending on
the latency they may need more <code>--vfs-read-chunk-streams</code> in
order to get the throughput.</p>
<h2 id="vfs-performance-1">VFS Performance</h2>
<p>These flags may be used to enable/disable features of the VFS for
performance or other reasons. See also the <a
href="#vfs-chunked-reading">chunked reading</a> feature.</p>
<p>In particular S3 and Swift benefit hugely from the
<code>--no-modtime</code> flag (or use <code>--use-server-modtime</code>
for a slightly different effect) as each read of the modification time
takes a transaction.</p>
<pre class="text"><code>    --no-checksum     Don&#39;t compare checksums on up/download.
    --no-modtime      Don&#39;t read/write the modification time (can speed things up).
    --no-seek         Don&#39;t allow seeking in files.
    --read-only       Only allow read-only access.</code></pre>
<p>Sometimes rclone is delivered reads or writes out of order. Rather
than seeking rclone will wait a short time for the in sequence read or
write to come in. These flags only come into effect when not using an on
disk cache file.</p>
<pre class="text"><code>    --vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
    --vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>When using VFS write caching (<code>--vfs-cache-mode</code> with
value writes or full), the global flag <code>--transfers</code> can be
set to adjust the number of parallel uploads of modified files from the
cache (the related global flag <code>--checkers</code> has no effect on
the VFS).</p>
<pre class="text"><code>    --transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="symlinks-1">Symlinks</h2>
<p>By default the VFS does not support symlinks. However this may be
enabled with either of the following flags:</p>
<pre class="text"><code>    --links      Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension.
    --vfs-links  Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS</code></pre>
<p>As most cloud storage systems do not support symlinks directly,
rclone stores the symlink as a normal file with a special extension. So
a file which appears as a symlink <code>link-to-file.txt</code> would be
stored on cloud storage as <code>link-to-file.txt.rclonelink</code> and
the contents would be the path to the symlink destination.</p>
<p>Note that <code>--links</code> enables symlink translation globally
in rclone - this includes any backend which supports the concept (for
example the local backend). <code>--vfs-links</code> just enables it for
the VFS layer.</p>
<p>This scheme is compatible with that used by the <a
href="https://rclone.org/local/#symlinks-junction-points">local backend
with the --local-links flag</a>.</p>
<p>The <code>--vfs-links</code> flag has been designed for
<code>rclone mount</code>, <code>rclone nfsmount</code> and
<code>rclone serve nfs</code>.</p>
<p>It hasn't been tested with the other <code>rclone serve</code>
commands yet.</p>
<p>A limitation of the current implementation is that it expects the
caller to resolve sub-symlinks. For example given this directory
tree</p>
<pre class="text"><code>.
├── dir
│   └── file.txt
└── linked-dir -&gt; dir</code></pre>
<p>The VFS will correctly resolve <code>linked-dir</code> but not
<code>linked-dir/file.txt</code>. This is not a problem for the tested
commands but may be for other commands.</p>
<p><strong>Note</strong> that there is an outstanding issue with symlink
support <a href="https://github.com/rclone/rclone/issues/8245">issue
#8245</a> with duplicate files being created when symlinks are moved
into directories where there is a file of the same name (or vice
versa).</p>
<h2 id="vfs-case-sensitivity-1">VFS Case Sensitivity</h2>
<p>Linux file systems are case-sensitive: two files can differ only by
case, and the exact case must be used when opening a file.</p>
<p>File systems in modern Windows are case-insensitive but
case-preserving: although existing files can be opened using any case,
the exact case used to create the file is preserved and available for
programs to query. It is not allowed for two files in the same directory
to differ only by case.</p>
<p>Usually file systems on macOS are case-insensitive. It is possible to
make macOS file systems case-sensitive but that is not the default.</p>
<p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone
handles these two cases. If its value is "false", rclone passes file
names to the remote as-is. If the flag is "true" (or appears without a
value on the command line), rclone may perform a "fixup" as explained
below.</p>
<p>The user may specify a file name to open/delete/rename/etc with a
case different than what is stored on the remote. If an argument refers
to an existing file with exactly the same name, then the case of the
existing file on the disk will be used. However, if a file name with
exactly the same name is not found but a name differing only by case
exists, rclone will transparently fixup the name. This fixup happens
only when an existing file is requested. Case sensitivity of file names
created anew by rclone is controlled by the underlying remote.</p>
<p>Note that case sensitivity of the operating system running rclone
(the target) may differ from case sensitivity of a file system presented
by rclone (the source). The flag controls whether "fixup" is performed
to satisfy the target.</p>
<p>If the flag is not provided on the command line, then its default
value depends on the operating system where rclone runs: "true" on
Windows and macOS, "false" otherwise. If the flag is provided without a
value, then it is "true".</p>
<p>The <code>--no-unicode-normalization</code> flag controls whether a
similar "fixup" is performed for filenames that differ but are <a
href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically
equivalent</a> with respect to unicode. Unicode normalization can be
particularly helpful for users of macOS, which prefers form NFD instead
of the NFC used by most other platforms. It is therefore highly
recommended to keep the default of <code>false</code> on macOS, to avoid
encoding compatibility issues.</p>
<p>In the (probably unlikely) event that a directory has multiple
duplicate filenames after applying case and unicode normalization, the
<code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates.
This comes with a performance tradeoff, as rclone will have to scan the
entire directory for duplicates when listing a directory. For this
reason, it is recommended to leave this disabled if not needed. However,
macOS users may wish to consider using it, as otherwise, if a remote
directory contains both NFC and NFD versions of the same filename, an
odd situation will occur: both versions of the file will be visible in
the mount, and both will appear to be editable, however, editing either
version will actually result in only the NFD version getting edited
under the hood. <code>--vfs-block- norm-dupes</code> prevents this
confusion by detecting this scenario, hiding the duplicates, and logging
an error, similar to how this is handled in
<code>rclone sync</code>.</p>
<h2 id="vfs-disk-options-1">VFS Disk Options</h2>
<p>This flag allows you to manually set the statistics about the filing
system. It can be useful when those statistics cannot be read correctly
automatically.</p>
<pre class="text"><code>    --vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-1">Alternate report of used
bytes</h2>
<p>Some backends, most notably S3, do not report the amount of bytes
used. If you need this information to be available when running
<code>df</code> on the filesystem, then pass the flag
<code>--vfs-used-is-size</code> to rclone. With this flag set, instead
of relying on the backend to report this information, rclone will scan
the whole remote similar to <code>rclone size</code> and compute the
total used space itself.</p>
<p><strong>WARNING</strong>: Contrary to <code>rclone size</code>, this
flag ignores filters so that the result is accurate. However, this is
very inefficient and may cost lots of API calls resulting in extra
charges. Use it as a last resort and only with caching.</p>
<h2 id="vfs-metadata-1">VFS Metadata</h2>
<p>If you use the <code>--vfs-metadata-extension</code> flag you can get
the VFS to expose files which contain the <a
href="https://rclone.org/docs/#metadata">metadata</a> as a JSON blob.
These files will not appear in the directory listing, but can be
<code>stat</code>-ed and opened and once they have been they
<strong>will</strong> appear in directory listings until the directory
cache expires.</p>
<p>Note that some backends won't create metadata unless you pass in the
<code>--metadata</code> flag.</p>
<p>For example, using <code>rclone mount</code> with
<code>--metadata --vfs-metadata-extension .metadata</code> we get</p>
<div class="sourceCode" id="cb380"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb380-1"><a href="#cb380-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb380-2"><a href="#cb380-2" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048577</span>
<span id="cb380-3"><a href="#cb380-3" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb380-4"><a href="#cb380-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb380-5"><a href="#cb380-5" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> cat /mnt/1G.metadata</span>
<span id="cb380-6"><a href="#cb380-6" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb380-7"><a href="#cb380-7" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;atime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-04T17:34:22.317069787Z&quot;</span>,</span>
<span id="cb380-8"><a href="#cb380-8" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;btime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:37.708253808Z&quot;</span>,</span>
<span id="cb380-9"><a href="#cb380-9" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;gid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span>,</span>
<span id="cb380-10"><a href="#cb380-10" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mode&quot;</span><span class="ex">:</span> <span class="st">&quot;100664&quot;</span>,</span>
<span id="cb380-11"><a href="#cb380-11" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mtime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:39.640238323Z&quot;</span>,</span>
<span id="cb380-12"><a href="#cb380-12" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;uid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span></span>
<span id="cb380-13"><a href="#cb380-13" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span>
<span id="cb380-14"><a href="#cb380-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb380-15"><a href="#cb380-15" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb380-16"><a href="#cb380-16" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048578</span>
<span id="cb380-17"><a href="#cb380-17" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb380-18"><a href="#cb380-18" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user        185 Mar  3 16:03 1G.metadata</span></code></pre></div>
<p>If the file has no metadata it will be returned as <code>{}</code>
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<pre><code>rclone nfsmount remote:path /path/to/mountpoint [flags]</code></pre>
<h2 id="options-64">Options</h2>
<pre><code>      --addr string                            IPaddress:Port or :Port to bind server to
      --allow-non-empty                        Allow mounting over a non-empty directory (not supported on Windows)
      --allow-other                            Allow access to other users (not supported on Windows)
      --allow-root                             Allow access to root user (not supported on Windows)
      --async-read                             Use asynchronous reads (not supported on Windows) (default true)
      --attr-timeout Duration                  Time for which file/directory attributes are cached (default 1s)
      --daemon                                 Run mount in background and exit parent process (as background output is suppressed, use --log-file with --log-format=pid,... to monitor) (not supported on Windows)
      --daemon-timeout Duration                Time limit for rclone to respond to kernel (not supported on Windows) (default 0s)
      --daemon-wait Duration                   Time to wait for ready mount from daemon (maximum time on Linux, constant sleep time on OSX/BSD) (not supported on Windows) (default 1m0s)
      --debug-fuse                             Debug the FUSE internals - needs -v
      --default-permissions                    Makes kernel enforce access control based on the file mode (not supported on Windows)
      --devname string                         Set the device name - default is remote:path
      --dir-cache-time Duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 777)
      --direct-io                              Use Direct IO, disables caching of data
      --file-perms FileMode                    File permissions (default 666)
      --fuse-flag stringArray                  Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for nfsmount
      --link-perms FileMode                    Link permissions (default 666)
      --max-read-ahead SizeSuffix              The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki)
      --mount-case-insensitive Tristate        Tell the OS the mount is case insensitive (true) or sensitive (false) regardless of the backend (auto) (default unset)
      --network-mode                           Mount as remote network drive, instead of fixed disk drive (supported on Windows only)
      --nfs-cache-dir string                   The directory the NFS handle cache will use if set
      --nfs-cache-handle-limit int             max file handles cached simultaneously (min 5) (default 1000000)
      --nfs-cache-type memory|disk|symlink     Type of NFS handle cache to use (default memory)
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --noappledouble                          Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true)
      --noapplexattr                           Ignore all &quot;com.apple.*&quot; extended attributes (supported on OSX only)
  -o, --option stringArray                     Option for libfuse/WinFsp (repeat if required)
      --poll-interval Duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --sudo                                   Use sudo to run the mount/umount commands as root.
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask FileMode                         Override the permission bits set by the filesystem (not supported on Windows) (default 002)
      --vfs-block-norm-dupes                   If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
      --vfs-cache-max-age Duration             Max time since last access of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-min-free-space SizeSuffix    Target minimum free space on the disk containing the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval Duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-links                              Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
      --vfs-metadata-extension string          Set the extension to read metadata from
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-chunk-streams int             The number of parallel streams to read at once
      --vfs-read-wait Duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-refresh                            Refreshes the directory cache recursively in the background on start
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back Duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait Duration                Time to wait for in-sequence write before giving error (default 1s)
      --volname string                         Set the volume name (supported on Windows and OSX only)
      --write-back-cache                       Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-23">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h2 id="see-also-64">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-obscure">rclone obscure</h1>
<p>Obscure password for use in the rclone config file.</p>
<h2 id="synopsis-58">Synopsis</h2>
<p>In the rclone config file, human-readable passwords are obscured.
Obscuring them is done by encrypting them and writing them out in
base64. This is <strong>not</strong> a secure way of encrypting these
passwords as rclone can decrypt them - it is to prevent "eyedropping" -
namely someone seeing a password in the rclone config file by
accident.</p>
<p>Many equally important things (like access tokens) are not obscured
in the config file. However it is very hard to shoulder surf a 64
character hex token.</p>
<p>This command can also accept a password through STDIN instead of an
argument by passing a hyphen as an argument. This will use the first
line of STDIN as the password not including the trailing newline.</p>
<div class="sourceCode" id="cb384"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb384-1"><a href="#cb384-1" aria-hidden="true" tabindex="-1"></a><span class="bu">echo</span> <span class="st">&quot;secretpassword&quot;</span> <span class="kw">|</span> <span class="ex">rclone</span> obscure <span class="at">-</span></span></code></pre></div>
<p>If there is no data on STDIN to read, rclone obscure will default to
obfuscating the hyphen itself.</p>
<p>If you want to encrypt the config file then please use config file
encryption - see <a
href="https://rclone.org/commands/rclone_config/">rclone config</a> for
more info.</p>
<pre><code>rclone obscure password [flags]</code></pre>
<h2 id="options-65">Options</h2>
<pre><code>  -h, --help   help for obscure</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-65">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-rc">rclone rc</h1>
<p>Run a command against a running rclone.</p>
<h2 id="synopsis-59">Synopsis</h2>
<p>This runs a command against a running rclone. Use the
<code>--url</code> flag to specify an non default URL to connect on.
This can be either a ":port" which is taken to mean <a
href="http://localhost:port" class="uri">http://localhost:port</a> or a
"host:port" which is taken to mean <a href="http://host:port"
class="uri">http://host:port</a>.</p>
<p>A username and password can be passed in with <code>--user</code> and
<code>--pass</code>.</p>
<p>Note that <code>--rc-addr</code>, <code>--rc-user</code>,
<code>--rc-pass</code> will be read also for <code>--url</code>,
<code>--user</code>, <code>--pass</code>.</p>
<p>The <code>--unix-socket</code> flag can be used to connect over a
unix socket like this</p>
<div class="sourceCode" id="cb387"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb387-1"><a href="#cb387-1" aria-hidden="true" tabindex="-1"></a><span class="co"># start server on /tmp/my.socket</span></span>
<span id="cb387-2"><a href="#cb387-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rcd <span class="at">--rc-addr</span> unix:///tmp/my.socket</span>
<span id="cb387-3"><a href="#cb387-3" aria-hidden="true" tabindex="-1"></a><span class="co"># Connect to it</span></span>
<span id="cb387-4"><a href="#cb387-4" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc <span class="at">--unix-socket</span> /tmp/my.socket core/stats</span></code></pre></div>
<p>Arguments should be passed in as parameter=value.</p>
<p>The result will be returned as a JSON object by default.</p>
<p>The <code>--json</code> parameter can be used to pass in a JSON blob
as an input instead of key=value arguments. This is the only way of
passing in more complicated values.</p>
<p>The <code>-o</code>/<code>--opt</code> option can be used to set a
key "opt" with key, value options in the form <code>-o key=value</code>
or <code>-o key</code>. It can be repeated as many times as required.
This is useful for rc commands which take the "opt" parameter which by
convention is a dictionary of strings.</p>
<pre class="text"><code>-o key=value -o key2</code></pre>
<p>Will place this in the "opt" value</p>
<div class="sourceCode" id="cb389"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb389-1"><a href="#cb389-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span><span class="dt">&quot;key&quot;</span><span class="fu">:</span><span class="st">&quot;value&quot;</span><span class="fu">,</span> <span class="dt">&quot;key2&quot;</span><span class="fu">,</span><span class="dt">&quot;&quot;</span><span class="er">)</span></span></code></pre></div>
<p>The <code>-a</code>/<code>--arg</code> option can be used to set
strings in the "arg" value. It can be repeated as many times as
required. This is useful for rc commands which take the "arg" parameter
which by convention is a list of strings.</p>
<pre class="text"><code>-a value -a value2</code></pre>
<p>Will place this in the "arg" value</p>
<div class="sourceCode" id="cb391"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb391-1"><a href="#cb391-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span><span class="st">&quot;value&quot;</span><span class="ot">,</span> <span class="st">&quot;value2&quot;</span><span class="ot">]</span></span></code></pre></div>
<p>Use <code>--loopback</code> to connect to the rclone instance running
<code>rclone rc</code>. This is very useful for testing commands without
having to run an rclone rc server, e.g.:</p>
<div class="sourceCode" id="cb392"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb392-1"><a href="#cb392-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc <span class="at">--loopback</span> operations/about fs=/</span></code></pre></div>
<p>Use <code>rclone rc</code> to see a list of all possible
commands.</p>
<pre><code>rclone rc commands parameter [flags]</code></pre>
<h2 id="options-66">Options</h2>
<pre><code>  -a, --arg stringArray      Argument placed in the &quot;arg&quot; array
  -h, --help                 help for rc
      --json string          Input JSON - use instead of key=value args
      --loopback             If set connect to this rclone instance not via HTTP
      --no-output            If set, don&#39;t output the JSON result
  -o, --opt stringArray      Option in the form name=value or name placed in the &quot;opt&quot; array
      --pass string          Password to use to connect to rclone remote control
      --unix-socket string   Path to a unix domain socket to dial to, instead of opening a TCP connection directly
      --url string           URL to connect to rclone remote control (default &quot;http://localhost:5572/&quot;)
      --user string          Username to use to rclone remote control</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-66">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-rcat">rclone rcat</h1>
<p>Copies standard input to file on remote.</p>
<h2 id="synopsis-60">Synopsis</h2>
<p>Reads from standard input (stdin) and copies it to a single remote
file.</p>
<div class="sourceCode" id="cb395"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb395-1"><a href="#cb395-1" aria-hidden="true" tabindex="-1"></a><span class="bu">echo</span> <span class="st">&quot;hello world&quot;</span> <span class="kw">|</span> <span class="ex">rclone</span> rcat remote:path/to/file</span>
<span id="cb395-2"><a href="#cb395-2" aria-hidden="true" tabindex="-1"></a><span class="ex">ffmpeg</span> <span class="at">-</span> <span class="kw">|</span> <span class="ex">rclone</span> rcat remote:path/to/file</span></code></pre></div>
<p>If the remote file already exists, it will be overwritten.</p>
<p>rcat will try to upload small files in a single request, which is
usually more efficient than the streaming/chunked upload endpoints,
which use multiple requests. Exact behaviour depends on the remote. What
is considered a small file may be set through
<code>--streaming-upload-cutoff</code>. Uploading only starts after the
cutoff is reached or if the file ends before that. The data must fit
into RAM. The cutoff needs to be small enough to adhere the limits of
your remote, please see there. Generally speaking, setting this cutoff
too high will decrease your performance.</p>
<p>Use the <code>--size</code> flag to preallocate the file in advance
at the remote end and actually stream it, even if remote backend doesn't
support streaming.</p>
<p><code>--size</code> should be the exact size of the input stream in
bytes. If the size of the stream is different in length to the
<code>--size</code> passed in then the transfer will likely fail.</p>
<p>Note that the upload cannot be retried because the data is not
stored. If the backend supports multipart uploading then individual
chunks can be retried. If you need to transfer a lot of data, you may be
better off caching it locally and then <code>rclone move</code> it to
the destination which can use retries.</p>
<pre><code>rclone rcat remote:path [flags]</code></pre>
<h2 id="options-67">Options</h2>
<pre><code>  -h, --help       help for rcat
      --size int   File size hint to preallocate (default -1)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="important-options-16">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h2 id="see-also-67">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-rcd">rclone rcd</h1>
<p>Run rclone listening to remote control commands only.</p>
<h2 id="synopsis-61">Synopsis</h2>
<p>This runs rclone so that it only listens to remote control
commands.</p>
<p>This is useful if you are controlling rclone via the rc API.</p>
<p>If you pass in a path to a directory, rclone will serve that
directory for GET requests on the URL passed in. It will also open the
URL in the browser when rclone is run.</p>
<p>See the <a href="https://rclone.org/rc/">rc documentation</a> for
more info on the rc flags.</p>
<h2 id="server-options">Server options</h2>
<p>Use <code>--rc-addr</code> to specify which IP address and port the
server should listen on, eg <code>--rc-addr 1.2.3.4:8000</code> or
<code>--rc-addr :8080</code> to listen to all IPs. By default it only
listens on localhost. You can use port :0 to let the OS choose an
available port.</p>
<p>If you set <code>--rc-addr</code> to listen on a public or LAN
accessible IP address then using Authentication is advised - see the
next section for info.</p>
<p>You can use a unix socket by setting the url to
<code>unix:///path/to/socket</code> or just by using an absolute path
name.</p>
<p><code>--rc-addr</code> may be repeated to listen on multiple
IPs/ports/sockets. Socket activation, described further below, can also
be used to accomplish the same.</p>
<p><code>--rc-server-read-timeout</code> and
<code>--rc-server-write-timeout</code> can be used to control the
timeouts on the server. Note that this is the total time for a
transfer.</p>
<p><code>--rc-max-header-bytes</code> controls the maximum number of
bytes the server will accept in the HTTP header.</p>
<p><code>--rc-baseurl</code> controls the URL prefix that rclone serves
from. By default rclone will serve from the root. If you used
<code>--rc-baseurl "/rclone"</code> then rclone would serve from a URL
starting with "/rclone/". This is useful if you wish to proxy rclone
serve. Rclone automatically inserts leading and trailing "/" on
<code>--rc-baseurl</code>, so <code>--rc-baseurl "rclone"</code>,
<code>--rc-baseurl "/rclone"</code> and
<code>--rc-baseurl "/rclone/"</code> are all treated identically.</p>
<h3 id="tls-ssl">TLS (SSL)</h3>
<p>By default this will serve over http. If you want you can serve over
https. You will need to supply the <code>--rc-cert</code> and
<code>--rc-key</code> flags. If you wish to do client side certificate
validation then you will need to supply <code>--rc-client-ca</code>
also.</p>
<p><code>--rc-cert</code> must be set to the path of a file containing
either a PEM encoded certificate, or a concatenation of that with the CA
certificate. <code>--rc-key</code> must be set to the path of a file
with the PEM encoded private key. If setting
<code>--rc-client-ca</code>, it should be set to the path of a file with
PEM encoded client certificate authority certificates.</p>
<p><code>--rc-min-tls-version</code> is minimum TLS version that is
acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3"
(default "tls1.0").</p>
<h2 id="socket-activation">Socket activation</h2>
<p>Instead of the listening addresses specified above, rclone will
listen to all FDs passed by the service manager, if any (and ignore any
arguments passed by <code>--rc-addr</code>).</p>
<p>This allows rclone to be a socket-activated service. It can be
configured with .socket and .service unit files as described in <a
href="https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html"
class="uri">https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html</a>.</p>
<p>Socket activation can be tested ad-hoc with the
<code>systemd-socket-activate</code>command</p>
<div class="sourceCode" id="cb399"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb399-1"><a href="#cb399-1" aria-hidden="true" tabindex="-1"></a><span class="ex">systemd-socket-activate</span> <span class="at">-l</span> 8000 <span class="at">--</span> rclone serve</span></code></pre></div>
<p>This will socket-activate rclone on the first connection to port 8000
over TCP.</p>
<h3 id="template">Template</h3>
<p><code>--rc-template</code> allows a user to specify a custom markup
template for HTTP and WebDAV serve functions. The server exports the
following markup to be used within the template to server pages:</p>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="header">
<th style="text-align: left;">Parameter</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">.Name</td>
<td style="text-align: left;">The full path of a file/directory.</td>
</tr>
<tr class="even">
<td style="text-align: left;">.Title</td>
<td style="text-align: left;">Directory listing of .Name</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Sort</td>
<td style="text-align: left;">The current sort used. This is changeable
via ?sort= parameter</td>
</tr>
<tr class="even">
<td style="text-align: left;"></td>
<td style="text-align: left;">Sort Options: namedirfirst,name,size,time
(default namedirfirst)</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Order</td>
<td style="text-align: left;">The current ordering used. This is
changeable via ?order= parameter</td>
</tr>
<tr class="even">
<td style="text-align: left;"></td>
<td style="text-align: left;">Order Options: asc,desc (default asc)</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Query</td>
<td style="text-align: left;">Currently unused.</td>
</tr>
<tr class="even">
<td style="text-align: left;">.Breadcrumb</td>
<td style="text-align: left;">Allows for creating a relative
navigation</td>
</tr>
<tr class="odd">
<td style="text-align: left;">-- .Link</td>
<td style="text-align: left;">The relative to the root link of the
Text.</td>
</tr>
<tr class="even">
<td style="text-align: left;">-- .Text</td>
<td style="text-align: left;">The Name of the directory.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Entries</td>
<td style="text-align: left;">Information about a specific
file/directory.</td>
</tr>
<tr class="even">
<td style="text-align: left;">-- .URL</td>
<td style="text-align: left;">The 'url' of an entry.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">-- .Leaf</td>
<td style="text-align: left;">Currently same as 'URL' but intended to be
'just' the name.</td>
</tr>
<tr class="even">
<td style="text-align: left;">-- .IsDir</td>
<td style="text-align: left;">Boolean for if an entry is a directory or
not.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">-- .Size</td>
<td style="text-align: left;">Size in Bytes of the entry.</td>
</tr>
<tr class="even">
<td style="text-align: left;">-- .ModTime</td>
<td style="text-align: left;">The UTC timestamp of an entry.</td>
</tr>
</tbody>
</table>
<p>The server also makes the following functions available so that they
can be used within the template. These functions help extend the options
for dynamic rendering of HTML. They can be used to render HTML based on
specific conditions.</p>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="header">
<th style="text-align: left;">Function</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">afterEpoch</td>
<td style="text-align: left;">Returns the time since the epoch for the
given time.</td>
</tr>
<tr class="even">
<td style="text-align: left;">contains</td>
<td style="text-align: left;">Checks whether a given substring is
present or not in a given string.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">hasPrefix</td>
<td style="text-align: left;">Checks whether the given string begins
with the specified prefix.</td>
</tr>
<tr class="even">
<td style="text-align: left;">hasSuffix</td>
<td style="text-align: left;">Checks whether the given string end with
the specified suffix.</td>
</tr>
</tbody>
</table>
<h3 id="authentication">Authentication</h3>
<p>By default this will serve files without needing a login.</p>
<p>You can either use an htpasswd file which can take lots of users, or
set a single username and password with the <code>--rc-user</code> and
<code>--rc-pass</code> flags.</p>
<p>Alternatively, you can have the reverse proxy manage authentication
and use the username provided in the configured header with
<code>--user-from-header</code> (e.g.,
<code>--rc-user-from-header=x-remote-user</code>). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.</p>
<p>If either of the above authentication methods is not configured and
client certificates are required by the <code>--client-ca</code> flag
passed to the server, the client certificate common name will be
considered as the username.</p>
<p>Use <code>--rc-htpasswd /path/to/htpasswd</code> to provide an
htpasswd file. This is in standard apache format and supports MD5, SHA1
and BCrypt for basic authentication. Bcrypt is recommended.</p>
<p>To create an htpasswd file:</p>
<div class="sourceCode" id="cb400"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb400-1"><a href="#cb400-1" aria-hidden="true" tabindex="-1"></a><span class="fu">touch</span> htpasswd</span>
<span id="cb400-2"><a href="#cb400-2" aria-hidden="true" tabindex="-1"></a><span class="ex">htpasswd</span> <span class="at">-B</span> htpasswd user</span>
<span id="cb400-3"><a href="#cb400-3" aria-hidden="true" tabindex="-1"></a><span class="ex">htpasswd</span> <span class="at">-B</span> htpasswd anotherUser</span></code></pre></div>
<p>The password file can be updated while rclone is running.</p>
<p>Use <code>--rc-realm</code> to set the authentication realm.</p>
<p>Use <code>--rc-salt</code> to change the password hashing salt from
the default.</p>
<pre><code>rclone rcd &lt;path to files to serve&gt;* [flags]</code></pre>
<h2 id="options-68">Options</h2>
<pre><code>  -h, --help   help for rcd</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="rc-options">RC Options</h3>
<p>Flags to control the Remote Control API</p>
<pre class="text"><code>      --rc                                 Enable the remote control server
      --rc-addr stringArray                IPaddress:Port or :Port to bind server to (default localhost:5572)
      --rc-allow-origin string             Origin which cross-domain request (CORS) can be executed from
      --rc-baseurl string                  Prefix for URLs - leave blank for root
      --rc-cert string                     TLS PEM key (concatenation of certificate and CA certificate)
      --rc-client-ca string                Client certificate authority to verify clients with
      --rc-enable-metrics                  Enable the Prometheus metrics path at the remote control server
      --rc-files string                    Path to local files to serve on the HTTP server
      --rc-htpasswd string                 A htpasswd file - if not provided no authentication is done
      --rc-job-expire-duration Duration    Expire finished async jobs older than this value (default 1m0s)
      --rc-job-expire-interval Duration    Interval to check for expired async jobs (default 10s)
      --rc-key string                      TLS PEM Private key
      --rc-max-header-bytes int            Maximum size of request header (default 4096)
      --rc-min-tls-version string          Minimum TLS version that is acceptable (default &quot;tls1.0&quot;)
      --rc-no-auth                         Don&#39;t require auth for certain methods
      --rc-pass string                     Password for authentication
      --rc-realm string                    Realm for authentication
      --rc-salt string                     Password hashing salt (default &quot;dlPL2MqE&quot;)
      --rc-serve                           Enable the serving of remote objects
      --rc-serve-no-modtime                Don&#39;t read the modification time (can speed things up)
      --rc-server-read-timeout Duration    Timeout for server reading data (default 1h0m0s)
      --rc-server-write-timeout Duration   Timeout for server writing data (default 1h0m0s)
      --rc-template string                 User-specified template
      --rc-user string                     User name for authentication
      --rc-user-from-header string         User name from a defined HTTP header
      --rc-web-fetch-url string            URL to fetch the releases for webgui (default &quot;https://api.github.com/repos/rclone/rclone-webui-react/releases/latest&quot;)
      --rc-web-gui                         Launch WebGUI on localhost
      --rc-web-gui-force-update            Force update to latest version of web gui
      --rc-web-gui-no-open-browser         Don&#39;t open the browser automatically
      --rc-web-gui-update                  Check and update to latest version of web gui</code></pre>
<h2 id="see-also-68">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-rmdirs">rclone rmdirs</h1>
<p>Remove empty directories under the path.</p>
<h2 id="synopsis-62">Synopsis</h2>
<p>This recursively removes any empty directories (including directories
that only contain empty directories), that it finds under the path. The
root path itself will also be removed if it is empty, unless you supply
the <code>--leave-root</code> flag.</p>
<p>Use command <a
href="https://rclone.org/commands/rclone_rmdir/">rmdir</a> to delete
just the empty directory given by path, not recurse.</p>
<p>This is useful for tidying up remotes that rclone has left a lot of
empty directories in. For example the <a
href="https://rclone.org/commands/rclone_delete/">delete</a> command
will delete files but leave the directory structure (unless used with
option <code>--rmdirs</code>).</p>
<p>This will delete <code>--checkers</code> directories concurrently so
if you have thousands of empty directories consider increasing this
number.</p>
<p>To delete a path and any objects in it, use the <a
href="https://rclone.org/commands/rclone_purge/">purge</a> command.</p>
<pre><code>rclone rmdirs remote:path [flags]</code></pre>
<h2 id="options-69">Options</h2>
<pre><code>  -h, --help         help for rmdirs
      --leave-root   Do not remove root directory if empty</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="important-options-17">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h2 id="see-also-69">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-selfupdate">rclone selfupdate</h1>
<p>Update the rclone binary.</p>
<h2 id="synopsis-63">Synopsis</h2>
<p>This command downloads the latest release of rclone and replaces the
currently running binary. The download is verified with a hashsum and
cryptographically signed signature; see <a
href="https://rclone.org/release_signing/">the release signing docs</a>
for details.</p>
<p>If used without flags (or with implied <code>--stable</code> flag),
this command will install the latest stable release. However, some
issues may be fixed (or features added) only in the latest beta release.
In such cases you should run the command with the <code>--beta</code>
flag, i.e. <code>rclone selfupdate --beta</code>. You can check in
advance what version would be installed by adding the
<code>--check</code> flag, then repeat the command without it when you
are satisfied.</p>
<p>Sometimes the rclone team may recommend you a concrete beta or stable
rclone release to troubleshoot your issue or add a bleeding edge
feature. The <code>--version VER</code> flag, if given, will update to
the concrete version instead of the latest one. If you omit micro
version from <code>VER</code> (for example <code>1.53</code>), the
latest matching micro version will be used.</p>
<p>Upon successful update rclone will print a message that contains a
previous version number. You will need it if you later decide to revert
your update for some reason. Then you'll have to note the previous
version and run the following command:
<code>rclone selfupdate [--beta] OLDVER</code>. If the old version
contains only dots and digits (for example <code>v1.54.0</code>) then
it's a stable release so you won't need the <code>--beta</code> flag.
Beta releases have an additional information similar to
<code>v1.54.0-beta.5111.06f1c0c61</code>. (if you are a developer and
use a locally built rclone, the version number will end with
<code>-DEV</code>, you will have to rebuild it as it obviously can't be
distributed).</p>
<p>If you previously installed rclone via a package manager, the package
may include local documentation or configure services. You may wish to
update with the flag <code>--package deb</code> or
<code>--package rpm</code> (whichever is correct for your OS) to update
these too. This command with the default <code>--package zip</code> will
update only the rclone executable so the local manual may become
inaccurate after it.</p>
<p>The <a href="https://rclone.org/commands/rclone_mount/">rclone
mount</a> command may or may not support extended FUSE options depending
on the build and OS. <code>selfupdate</code> will refuse to update if
the capability would be discarded.</p>
<p>Note: Windows forbids deletion of a currently running executable so
this command will rename the old executable to 'rclone.old.exe' upon
success.</p>
<p>Please note that this command was not available before rclone version
1.55. If it fails for you with the message
<code>unknown command "selfupdate"</code> then you will need to update
manually following the <a href="https://rclone.org/install/">install
documentation</a>.</p>
<pre><code>rclone selfupdate [flags]</code></pre>
<h2 id="options-70">Options</h2>
<pre><code>      --beta             Install beta release
      --check            Check for latest release, do not download
  -h, --help             help for selfupdate
      --output string    Save the downloaded binary at a given path (default: replace running binary)
      --package string   Package format: zip|deb|rpm (default: zip)
      --stable           Install stable release (this is the default)
      --version string   Install the given rclone version (default: latest)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-70">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-serve">rclone serve</h1>
<p>Serve a remote over a protocol.</p>
<h2 id="synopsis-64">Synopsis</h2>
<p>Serve a remote over a given protocol. Requires the use of a
subcommand to specify the protocol, e.g.</p>
<div class="sourceCode" id="cb409"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb409-1"><a href="#cb409-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> serve http remote:</span></code></pre></div>
<p>Each subcommand has its own options which you can see in their
help.</p>
<pre><code>rclone serve &lt;protocol&gt; [opts] &lt;remote&gt; [flags]</code></pre>
<h2 id="options-71">Options</h2>
<pre><code>  -h, --help   help for serve</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-71">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
<li><a href="https://rclone.org/commands/rclone_serve_dlna/">rclone
serve dlna</a> - Serve remote:path over DLNA</li>
<li><a href="https://rclone.org/commands/rclone_serve_docker/">rclone
serve docker</a> - Serve any remote on docker's volume plugin API.</li>
<li><a href="https://rclone.org/commands/rclone_serve_ftp/">rclone serve
ftp</a> - Serve remote:path over FTP.</li>
<li><a href="https://rclone.org/commands/rclone_serve_http/">rclone
serve http</a> - Serve the remote over HTTP.</li>
<li><a href="https://rclone.org/commands/rclone_serve_nfs/">rclone serve
nfs</a> - Serve the remote as an NFS mount</li>
<li><a href="https://rclone.org/commands/rclone_serve_restic/">rclone
serve restic</a> - Serve the remote for restic's REST API.</li>
<li><a href="https://rclone.org/commands/rclone_serve_s3/">rclone serve
s3</a> - Serve remote:path over s3.</li>
<li><a href="https://rclone.org/commands/rclone_serve_sftp/">rclone
serve sftp</a> - Serve the remote over SFTP.</li>
<li><a href="https://rclone.org/commands/rclone_serve_webdav/">rclone
serve webdav</a> - Serve remote:path over WebDAV.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-dlna">rclone serve dlna</h1>
<p>Serve remote:path over DLNA</p>
<h2 id="synopsis-65">Synopsis</h2>
<p>Run a DLNA media server for media stored in an rclone remote. Many
devices, such as the Xbox and PlayStation, can automatically discover
this server in the LAN and play audio/video from it. VLC is also
supported. Service discovery uses UDP multicast packets (SSDP) and will
thus only work on LANs.</p>
<p>Rclone will list all files present in the remote, without filtering
based on media formats or file extensions. Additionally, there is no
media transcoding support. This means that some players might show files
that they are not able to play back correctly.</p>
<p>Rclone will add external subtitle files (.srt) to videos if they have
the same filename as the video file itself (except the extension),
either in the same directory as the video, or in a "Subs"
subdirectory.</p>
<h2 id="server-options-1">Server options</h2>
<p>Use <code>--addr</code> to specify which IP address and port the
server should listen on, e.g. <code>--addr 1.2.3.4:8000</code> or
<code>--addr :8080</code> to listen to all IPs.</p>
<p>Use <code>--name</code> to choose the friendly server name, which is
by default "rclone (hostname)".</p>
<p>Use <code>--log-trace</code> in conjunction with <code>-vv</code> to
enable additional debug logging of all UPNP traffic.</p>
<h2 id="vfs---virtual-file-system-2">VFS - Virtual File System</h2>
<p>This command uses the VFS layer. This adapts the cloud storage
objects that rclone uses into something which looks much more like a
disk filing system.</p>
<p>Cloud storage objects have lots of properties which aren't like disk
files - you can't extend them or write to the middle of them, so the VFS
layer has to deal with that. Because there is no one right way of doing
this there are various options explained below.</p>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-2">VFS Directory Cache</h2>
<p>Using the <code>--dir-cache-time</code> flag, you can control how
long a directory should be considered up to date and not refreshed from
the backend. Changes made through the VFS will appear immediately or
invalidate the cache.</p>
<pre class="text"><code>    --dir-cache-time duration   Time to cache directory entries for (default 5m0s)
    --poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<p>However, changes made directly on the cloud storage by the web
interface or a different copy of rclone will only be picked up once the
directory cache expires if the backend configured does not support
polling for changes. If the backend supports polling, changes will be
picked up within the polling interval.</p>
<p>You can send a <code>SIGHUP</code> signal to rclone for it to flush
all directory caches, regardless of how old they are. Assuming only one
rclone instance is running, you can reset the cache like this:</p>
<div class="sourceCode" id="cb413"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb413-1"><a href="#cb413-1" aria-hidden="true" tabindex="-1"></a><span class="bu">kill</span> <span class="at">-SIGHUP</span> <span class="va">$(</span><span class="fu">pidof</span> rclone<span class="va">)</span></span></code></pre></div>
<p>If you configure rclone with a <a href="/rc">remote control</a> then
you can use rclone rc to flush the whole directory cache:</p>
<div class="sourceCode" id="cb414"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb414-1"><a href="#cb414-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget</span></code></pre></div>
<p>Or individual files or directories:</p>
<div class="sourceCode" id="cb415"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb415-1"><a href="#cb415-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget file=path/to/file dir=path/to/dir</span></code></pre></div>
<h2 id="vfs-file-buffering-2">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<p>Each open file will try to keep the specified amount of data in
memory at all times. The buffered data is bound to one open file and
won't be shared.</p>
<p>This flag is a upper limit for the used memory per open file. The
buffer will only use memory for data that is downloaded but not not yet
read. If the buffer is empty, only a small amount of memory will be
used.</p>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-2">VFS File Caching</h2>
<p>These flags control the VFS file caching options. File caching is
necessary to make the VFS layer appear compatible with a normal file
system. It can be disabled at the cost of some compatibility.</p>
<p>For example you'll need to enable VFS caching if you want to read and
write simultaneously to a file. See below for more details.</p>
<p>Note that the VFS cache is separate from the cache backend and you
may find that you need one or the other or both.</p>
<pre class="text"><code>    --cache-dir string                     Directory rclone will use for caching.
    --vfs-cache-mode CacheMode             Cache mode off|minimal|writes|full (default off)
    --vfs-cache-max-age duration           Max time since last access of objects in the cache (default 1h0m0s)
    --vfs-cache-max-size SizeSuffix        Max total size of objects in the cache (default off)
    --vfs-cache-min-free-space SizeSuffix  Target minimum free space on the disk containing the cache (default off)
    --vfs-cache-poll-interval duration     Interval to poll the cache for stale objects (default 1m0s)
    --vfs-write-back duration              Time to writeback files after last use when using cache (default 5s)</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the
file cache. The files are stored in the user cache file area which is OS
dependent but can be controlled with <code>--cache-dir</code> or setting
the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by
<code>--vfs-cache-mode</code>. The higher the cache mode the more
compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are
closed and if they haven't been accessed for
<code>--vfs-write-back</code> seconds. If rclone is quit or dies with
files that haven't been uploaded, these will be uploaded next time
rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or
<code>--vfs-cache-min-free-space</code> note that the cache may exceed
these quotas for two reasons. Firstly because it is only checked every
<code>--vfs-cache-poll-interval</code>. Secondly because open files
cannot be evicted from the cache. When <code>--vfs-cache-max-size</code>
or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will
attempt to evict the least accessed files from the cache first. rclone
will start with files that haven't been accessed for the longest. This
cache flushing strategy is efficient and more relevant files are likely
to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache
after the set time since last access has passed. The default value of 1
hour will start evicting files from cache that haven't been accessed for
1 hour. When a cached file is accessed the 1 hour timer is reset to 0
and will wait for 1 more hour before evicting. Specify the time with
standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the
same VFS cache with the same or overlapping remotes if using
<code>--vfs-cache-mode &gt; off</code>. This can potentially cause data
corruption if you do. You can work around this by giving each rclone its
own cache hierarchy with <code>--cache-dir</code>. You don't need to
worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-2">--vfs-cache-mode off</h3>
<p>In this mode (the default) the cache will read directly from the
remote and write directly to the remote without caching anything on
disk.</p>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can't be opened for both read AND write</li>
<li>Files opened for write can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-2">--vfs-cache-mode minimal</h3>
<p>This is very similar to "off" except that files opened for read AND
write will be buffered to disk. This means that files opened for write
will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-2">--vfs-cache-mode writes</h3>
<p>In this mode files opened for read only are still read directly from
the remote, write only and read/write files are buffered to disk
first.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-2">--vfs-cache-mode full</h3>
<p>In this mode all reads and writes are buffered to and from disk. When
data is read from the remote this is buffered to disk as well.</p>
<p>In this mode the files in the cache will be sparse files and rclone
will keep track of which bits of the files it has downloaded.</p>
<p>So if an application only reads the starts of each file, then rclone
will only buffer the start of the file. These files will appear to be
their full size in the cache, but they will be sparse files with only
the data that has been downloaded present in them.</p>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<p>When reading a file rclone will read <code>--buffer-size</code> plus
<code>--vfs-read-ahead</code> bytes ahead. The
<code>--buffer-size</code> is buffered in memory whereas the
<code>--vfs-read-ahead</code> is buffered on disk.</p>
<p>When using this mode it is recommended that
<code>--buffer-size</code> is not set too large and
<code>--vfs-read-ahead</code> is set large if required.</p>
<p><strong>IMPORTANT</strong> not all file systems support sparse files.
In particular FAT/exFAT do not. Rclone will perform very badly if the
cache directory is on a filesystem which doesn't support sparse files
and it will log an ERROR message if one is detected.</p>
<h3 id="fingerprinting-2">Fingerprinting</h3>
<p>Various parts of the VFS use fingerprinting to see if a local file
copy has changed relative to a remote file. Fingerprints are made
from:</p>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<p>On some backends some of these attributes are slow to read (they take
an extra API call per object, or extra work per object).</p>
<p>For example <code>hash</code> is slow with the <code>local</code> and
<code>sftp</code> backends as they have to read the entire file and hash
it, and <code>modtime</code> is slow with the <code>s3</code>,
<code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends
because they need to do an extra API call to fetch it.</p>
<p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone
will not include the slow operations in the fingerprint. This makes the
fingerprinting less accurate but much faster and will improve the
opening time of cached files.</p>
<p>If you are running a vfs cache over <code>local</code>,
<code>s3</code> or <code>swift</code> backends then using this flag is
recommended.</p>
<p>Note that if you change the value of this flag, the fingerprints of
the files in the cache may be invalidated and the files will need to be
downloaded again.</p>
<h2 id="vfs-chunked-reading-2">VFS Chunked Reading</h2>
<p>When rclone reads files from a remote it reads them in chunks. This
means that rather than requesting the whole file rclone reads the chunk
specified. This can reduce the used download quota for some remotes by
requesting only chunks from the remote that are actually read, at the
cost of an increased number of requests.</p>
<p>These flags control the chunking:</p>
<pre class="text"><code>    --vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
    --vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)
    --vfs-read-chunk-streams int            The number of parallel streams to read at once</code></pre>
<p>The chunking behaves differently depending on the
<code>--vfs-read-chunk-streams</code> parameter.</p>
<h3
id="vfs-read-chunk-streams-0-4"><code>--vfs-read-chunk-streams</code> ==
0</h3>
<p>Rclone will start reading a chunk of size
<code>--vfs-read-chunk-size</code>, and then double the size for each
read. When <code>--vfs-read-chunk-size-limit</code> is specified, and
greater than <code>--vfs-read-chunk-size</code>, the chunk size for each
open file will get doubled only until the specified value is reached. If
the value is "off", which is the default, the limit is disabled and the
chunk size will grow indefinitely.</p>
<p>With <code>--vfs-read-chunk-size 100M</code> and
<code>--vfs-read-chunk-size-limit 0</code> the following parts will be
downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When
<code>--vfs-read-chunk-size-limit 500M</code> is specified, the result
would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so
on.</p>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off"
disables chunked reading.</p>
<p>The chunks will not be buffered in memory.</p>
<h3
id="vfs-read-chunk-streams-0-5"><code>--vfs-read-chunk-streams</code>
&gt; 0</h3>
<p>Rclone reads <code>--vfs-read-chunk-streams</code> chunks of size
<code>--vfs-read-chunk-size</code> concurrently. The size for each read
will stay constant.</p>
<p>This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.</p>
<p>Some experimentation will be needed to find the optimum values of
<code>--vfs-read-chunk-size</code> and
<code>--vfs-read-chunk-streams</code> as these will depend on the
backend in use and the latency to the backend.</p>
<p>For high performance object stores (eg AWS S3) a reasonable place to
start might be <code>--vfs-read-chunk-streams 16</code> and
<code>--vfs-read-chunk-size 4M</code>. In testing with AWS S3 the
performance scaled roughly as the <code>--vfs-read-chunk-streams</code>
setting.</p>
<p>Similar settings should work for high latency links, but depending on
the latency they may need more <code>--vfs-read-chunk-streams</code> in
order to get the throughput.</p>
<h2 id="vfs-performance-2">VFS Performance</h2>
<p>These flags may be used to enable/disable features of the VFS for
performance or other reasons. See also the <a
href="#vfs-chunked-reading">chunked reading</a> feature.</p>
<p>In particular S3 and Swift benefit hugely from the
<code>--no-modtime</code> flag (or use <code>--use-server-modtime</code>
for a slightly different effect) as each read of the modification time
takes a transaction.</p>
<pre class="text"><code>    --no-checksum     Don&#39;t compare checksums on up/download.
    --no-modtime      Don&#39;t read/write the modification time (can speed things up).
    --no-seek         Don&#39;t allow seeking in files.
    --read-only       Only allow read-only access.</code></pre>
<p>Sometimes rclone is delivered reads or writes out of order. Rather
than seeking rclone will wait a short time for the in sequence read or
write to come in. These flags only come into effect when not using an on
disk cache file.</p>
<pre class="text"><code>    --vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
    --vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>When using VFS write caching (<code>--vfs-cache-mode</code> with
value writes or full), the global flag <code>--transfers</code> can be
set to adjust the number of parallel uploads of modified files from the
cache (the related global flag <code>--checkers</code> has no effect on
the VFS).</p>
<pre class="text"><code>    --transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="symlinks-2">Symlinks</h2>
<p>By default the VFS does not support symlinks. However this may be
enabled with either of the following flags:</p>
<pre class="text"><code>    --links      Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension.
    --vfs-links  Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS</code></pre>
<p>As most cloud storage systems do not support symlinks directly,
rclone stores the symlink as a normal file with a special extension. So
a file which appears as a symlink <code>link-to-file.txt</code> would be
stored on cloud storage as <code>link-to-file.txt.rclonelink</code> and
the contents would be the path to the symlink destination.</p>
<p>Note that <code>--links</code> enables symlink translation globally
in rclone - this includes any backend which supports the concept (for
example the local backend). <code>--vfs-links</code> just enables it for
the VFS layer.</p>
<p>This scheme is compatible with that used by the <a
href="https://rclone.org/local/#symlinks-junction-points">local backend
with the --local-links flag</a>.</p>
<p>The <code>--vfs-links</code> flag has been designed for
<code>rclone mount</code>, <code>rclone nfsmount</code> and
<code>rclone serve nfs</code>.</p>
<p>It hasn't been tested with the other <code>rclone serve</code>
commands yet.</p>
<p>A limitation of the current implementation is that it expects the
caller to resolve sub-symlinks. For example given this directory
tree</p>
<pre class="text"><code>.
├── dir
│   └── file.txt
└── linked-dir -&gt; dir</code></pre>
<p>The VFS will correctly resolve <code>linked-dir</code> but not
<code>linked-dir/file.txt</code>. This is not a problem for the tested
commands but may be for other commands.</p>
<p><strong>Note</strong> that there is an outstanding issue with symlink
support <a href="https://github.com/rclone/rclone/issues/8245">issue
#8245</a> with duplicate files being created when symlinks are moved
into directories where there is a file of the same name (or vice
versa).</p>
<h2 id="vfs-case-sensitivity-2">VFS Case Sensitivity</h2>
<p>Linux file systems are case-sensitive: two files can differ only by
case, and the exact case must be used when opening a file.</p>
<p>File systems in modern Windows are case-insensitive but
case-preserving: although existing files can be opened using any case,
the exact case used to create the file is preserved and available for
programs to query. It is not allowed for two files in the same directory
to differ only by case.</p>
<p>Usually file systems on macOS are case-insensitive. It is possible to
make macOS file systems case-sensitive but that is not the default.</p>
<p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone
handles these two cases. If its value is "false", rclone passes file
names to the remote as-is. If the flag is "true" (or appears without a
value on the command line), rclone may perform a "fixup" as explained
below.</p>
<p>The user may specify a file name to open/delete/rename/etc with a
case different than what is stored on the remote. If an argument refers
to an existing file with exactly the same name, then the case of the
existing file on the disk will be used. However, if a file name with
exactly the same name is not found but a name differing only by case
exists, rclone will transparently fixup the name. This fixup happens
only when an existing file is requested. Case sensitivity of file names
created anew by rclone is controlled by the underlying remote.</p>
<p>Note that case sensitivity of the operating system running rclone
(the target) may differ from case sensitivity of a file system presented
by rclone (the source). The flag controls whether "fixup" is performed
to satisfy the target.</p>
<p>If the flag is not provided on the command line, then its default
value depends on the operating system where rclone runs: "true" on
Windows and macOS, "false" otherwise. If the flag is provided without a
value, then it is "true".</p>
<p>The <code>--no-unicode-normalization</code> flag controls whether a
similar "fixup" is performed for filenames that differ but are <a
href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically
equivalent</a> with respect to unicode. Unicode normalization can be
particularly helpful for users of macOS, which prefers form NFD instead
of the NFC used by most other platforms. It is therefore highly
recommended to keep the default of <code>false</code> on macOS, to avoid
encoding compatibility issues.</p>
<p>In the (probably unlikely) event that a directory has multiple
duplicate filenames after applying case and unicode normalization, the
<code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates.
This comes with a performance tradeoff, as rclone will have to scan the
entire directory for duplicates when listing a directory. For this
reason, it is recommended to leave this disabled if not needed. However,
macOS users may wish to consider using it, as otherwise, if a remote
directory contains both NFC and NFD versions of the same filename, an
odd situation will occur: both versions of the file will be visible in
the mount, and both will appear to be editable, however, editing either
version will actually result in only the NFD version getting edited
under the hood. <code>--vfs-block- norm-dupes</code> prevents this
confusion by detecting this scenario, hiding the duplicates, and logging
an error, similar to how this is handled in
<code>rclone sync</code>.</p>
<h2 id="vfs-disk-options-2">VFS Disk Options</h2>
<p>This flag allows you to manually set the statistics about the filing
system. It can be useful when those statistics cannot be read correctly
automatically.</p>
<pre class="text"><code>    --vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-2">Alternate report of used
bytes</h2>
<p>Some backends, most notably S3, do not report the amount of bytes
used. If you need this information to be available when running
<code>df</code> on the filesystem, then pass the flag
<code>--vfs-used-is-size</code> to rclone. With this flag set, instead
of relying on the backend to report this information, rclone will scan
the whole remote similar to <code>rclone size</code> and compute the
total used space itself.</p>
<p><strong>WARNING</strong>: Contrary to <code>rclone size</code>, this
flag ignores filters so that the result is accurate. However, this is
very inefficient and may cost lots of API calls resulting in extra
charges. Use it as a last resort and only with caching.</p>
<h2 id="vfs-metadata-2">VFS Metadata</h2>
<p>If you use the <code>--vfs-metadata-extension</code> flag you can get
the VFS to expose files which contain the <a
href="https://rclone.org/docs/#metadata">metadata</a> as a JSON blob.
These files will not appear in the directory listing, but can be
<code>stat</code>-ed and opened and once they have been they
<strong>will</strong> appear in directory listings until the directory
cache expires.</p>
<p>Note that some backends won't create metadata unless you pass in the
<code>--metadata</code> flag.</p>
<p>For example, using <code>rclone mount</code> with
<code>--metadata --vfs-metadata-extension .metadata</code> we get</p>
<div class="sourceCode" id="cb424"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb424-1"><a href="#cb424-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb424-2"><a href="#cb424-2" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048577</span>
<span id="cb424-3"><a href="#cb424-3" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb424-4"><a href="#cb424-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb424-5"><a href="#cb424-5" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> cat /mnt/1G.metadata</span>
<span id="cb424-6"><a href="#cb424-6" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb424-7"><a href="#cb424-7" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;atime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-04T17:34:22.317069787Z&quot;</span>,</span>
<span id="cb424-8"><a href="#cb424-8" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;btime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:37.708253808Z&quot;</span>,</span>
<span id="cb424-9"><a href="#cb424-9" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;gid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span>,</span>
<span id="cb424-10"><a href="#cb424-10" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mode&quot;</span><span class="ex">:</span> <span class="st">&quot;100664&quot;</span>,</span>
<span id="cb424-11"><a href="#cb424-11" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mtime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:39.640238323Z&quot;</span>,</span>
<span id="cb424-12"><a href="#cb424-12" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;uid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span></span>
<span id="cb424-13"><a href="#cb424-13" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span>
<span id="cb424-14"><a href="#cb424-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb424-15"><a href="#cb424-15" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb424-16"><a href="#cb424-16" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048578</span>
<span id="cb424-17"><a href="#cb424-17" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb424-18"><a href="#cb424-18" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user        185 Mar  3 16:03 1G.metadata</span></code></pre></div>
<p>If the file has no metadata it will be returned as <code>{}</code>
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<pre><code>rclone serve dlna remote:path [flags]</code></pre>
<h2 id="options-72">Options</h2>
<pre><code>      --addr string                            The ip:port or :port to bind the DLNA http server to (default &quot;:7879&quot;)
      --announce-interval Duration             The interval between SSDP announcements (default 12m0s)
      --dir-cache-time Duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 777)
      --file-perms FileMode                    File permissions (default 666)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for dlna
      --interface stringArray                  The interface to use for SSDP (repeat as necessary)
      --link-perms FileMode                    Link permissions (default 666)
      --log-trace                              Enable trace logging of SOAP traffic
      --name string                            Name of DLNA server
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --poll-interval Duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask FileMode                         Override the permission bits set by the filesystem (not supported on Windows) (default 002)
      --vfs-block-norm-dupes                   If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
      --vfs-cache-max-age Duration             Max time since last access of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-min-free-space SizeSuffix    Target minimum free space on the disk containing the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval Duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-links                              Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
      --vfs-metadata-extension string          Set the extension to read metadata from
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-chunk-streams int             The number of parallel streams to read at once
      --vfs-read-wait Duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-refresh                            Refreshes the directory cache recursively in the background on start
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back Duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait Duration                Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-24">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h2 id="see-also-72">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-docker">rclone serve docker</h1>
<p>Serve any remote on docker's volume plugin API.</p>
<h2 id="synopsis-66">Synopsis</h2>
<p>This command implements the Docker volume plugin API allowing docker
to use rclone as a data storage mechanism for various cloud providers.
rclone provides <a href="/docker">docker volume plugin</a> based on
it.</p>
<p>To create a docker plugin, one must create a Unix or TCP socket that
Docker will look for when you use the plugin and then it listens for
commands from docker daemon and runs the corresponding code when
necessary. Docker plugins can run as a managed plugin under control of
the docker daemon or as an independent native service. For testing, you
can just run it directly from the command line, for example:</p>
<div class="sourceCode" id="cb428"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb428-1"><a href="#cb428-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> rclone serve docker <span class="at">--base-dir</span> /tmp/rclone-volumes <span class="at">--socket-addr</span> localhost:8787 <span class="at">-vv</span></span></code></pre></div>
<p>Running <code>rclone serve docker</code> will create the said socket,
listening for commands from Docker to create the necessary Volumes.
Normally you need not give the <code>--socket-addr</code> flag. The API
will listen on the unix domain socket at
<code>/run/docker/plugins/rclone.sock</code>. In the example above
rclone will create a TCP socket and a small file
<code>/etc/docker/plugins/rclone.spec</code> containing the socket
address. We use <code>sudo</code> because both paths are writeable only
by the root user.</p>
<p>If you later decide to change listening socket, the docker daemon
must be restarted to reconnect to
<code>/run/docker/plugins/rclone.sock</code> or parse new
<code>/etc/docker/plugins/rclone.spec</code>. Until you restart, any
volume related docker commands will timeout trying to access the old
socket. Running directly is supported on <strong>Linux only</strong>,
not on Windows or MacOS. This is not a problem with managed plugin mode
described in details in the <a href="https://rclone.org/docker">full
documentation</a>.</p>
<p>The command will create volume mounts under the path given by
<code>--base-dir</code> (by default
<code>/var/lib/docker-volumes/rclone</code> available only to root) and
maintain the JSON formatted file <code>docker-plugin.state</code> in the
rclone cache directory with book-keeping records of created and mounted
volumes.</p>
<p>All mount and VFS options are submitted by the docker daemon via API,
but you can also provide defaults on the command line as well as set
path to the config file and cache directory or adjust logging
verbosity.</p>
<h2 id="vfs---virtual-file-system-3">VFS - Virtual File System</h2>
<p>This command uses the VFS layer. This adapts the cloud storage
objects that rclone uses into something which looks much more like a
disk filing system.</p>
<p>Cloud storage objects have lots of properties which aren't like disk
files - you can't extend them or write to the middle of them, so the VFS
layer has to deal with that. Because there is no one right way of doing
this there are various options explained below.</p>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-3">VFS Directory Cache</h2>
<p>Using the <code>--dir-cache-time</code> flag, you can control how
long a directory should be considered up to date and not refreshed from
the backend. Changes made through the VFS will appear immediately or
invalidate the cache.</p>
<pre class="text"><code>    --dir-cache-time duration   Time to cache directory entries for (default 5m0s)
    --poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<p>However, changes made directly on the cloud storage by the web
interface or a different copy of rclone will only be picked up once the
directory cache expires if the backend configured does not support
polling for changes. If the backend supports polling, changes will be
picked up within the polling interval.</p>
<p>You can send a <code>SIGHUP</code> signal to rclone for it to flush
all directory caches, regardless of how old they are. Assuming only one
rclone instance is running, you can reset the cache like this:</p>
<div class="sourceCode" id="cb430"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb430-1"><a href="#cb430-1" aria-hidden="true" tabindex="-1"></a><span class="bu">kill</span> <span class="at">-SIGHUP</span> <span class="va">$(</span><span class="fu">pidof</span> rclone<span class="va">)</span></span></code></pre></div>
<p>If you configure rclone with a <a href="/rc">remote control</a> then
you can use rclone rc to flush the whole directory cache:</p>
<div class="sourceCode" id="cb431"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb431-1"><a href="#cb431-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget</span></code></pre></div>
<p>Or individual files or directories:</p>
<div class="sourceCode" id="cb432"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb432-1"><a href="#cb432-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget file=path/to/file dir=path/to/dir</span></code></pre></div>
<h2 id="vfs-file-buffering-3">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<p>Each open file will try to keep the specified amount of data in
memory at all times. The buffered data is bound to one open file and
won't be shared.</p>
<p>This flag is a upper limit for the used memory per open file. The
buffer will only use memory for data that is downloaded but not not yet
read. If the buffer is empty, only a small amount of memory will be
used.</p>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-3">VFS File Caching</h2>
<p>These flags control the VFS file caching options. File caching is
necessary to make the VFS layer appear compatible with a normal file
system. It can be disabled at the cost of some compatibility.</p>
<p>For example you'll need to enable VFS caching if you want to read and
write simultaneously to a file. See below for more details.</p>
<p>Note that the VFS cache is separate from the cache backend and you
may find that you need one or the other or both.</p>
<pre class="text"><code>    --cache-dir string                     Directory rclone will use for caching.
    --vfs-cache-mode CacheMode             Cache mode off|minimal|writes|full (default off)
    --vfs-cache-max-age duration           Max time since last access of objects in the cache (default 1h0m0s)
    --vfs-cache-max-size SizeSuffix        Max total size of objects in the cache (default off)
    --vfs-cache-min-free-space SizeSuffix  Target minimum free space on the disk containing the cache (default off)
    --vfs-cache-poll-interval duration     Interval to poll the cache for stale objects (default 1m0s)
    --vfs-write-back duration              Time to writeback files after last use when using cache (default 5s)</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the
file cache. The files are stored in the user cache file area which is OS
dependent but can be controlled with <code>--cache-dir</code> or setting
the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by
<code>--vfs-cache-mode</code>. The higher the cache mode the more
compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are
closed and if they haven't been accessed for
<code>--vfs-write-back</code> seconds. If rclone is quit or dies with
files that haven't been uploaded, these will be uploaded next time
rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or
<code>--vfs-cache-min-free-space</code> note that the cache may exceed
these quotas for two reasons. Firstly because it is only checked every
<code>--vfs-cache-poll-interval</code>. Secondly because open files
cannot be evicted from the cache. When <code>--vfs-cache-max-size</code>
or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will
attempt to evict the least accessed files from the cache first. rclone
will start with files that haven't been accessed for the longest. This
cache flushing strategy is efficient and more relevant files are likely
to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache
after the set time since last access has passed. The default value of 1
hour will start evicting files from cache that haven't been accessed for
1 hour. When a cached file is accessed the 1 hour timer is reset to 0
and will wait for 1 more hour before evicting. Specify the time with
standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the
same VFS cache with the same or overlapping remotes if using
<code>--vfs-cache-mode &gt; off</code>. This can potentially cause data
corruption if you do. You can work around this by giving each rclone its
own cache hierarchy with <code>--cache-dir</code>. You don't need to
worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-3">--vfs-cache-mode off</h3>
<p>In this mode (the default) the cache will read directly from the
remote and write directly to the remote without caching anything on
disk.</p>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can't be opened for both read AND write</li>
<li>Files opened for write can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-3">--vfs-cache-mode minimal</h3>
<p>This is very similar to "off" except that files opened for read AND
write will be buffered to disk. This means that files opened for write
will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-3">--vfs-cache-mode writes</h3>
<p>In this mode files opened for read only are still read directly from
the remote, write only and read/write files are buffered to disk
first.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-3">--vfs-cache-mode full</h3>
<p>In this mode all reads and writes are buffered to and from disk. When
data is read from the remote this is buffered to disk as well.</p>
<p>In this mode the files in the cache will be sparse files and rclone
will keep track of which bits of the files it has downloaded.</p>
<p>So if an application only reads the starts of each file, then rclone
will only buffer the start of the file. These files will appear to be
their full size in the cache, but they will be sparse files with only
the data that has been downloaded present in them.</p>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<p>When reading a file rclone will read <code>--buffer-size</code> plus
<code>--vfs-read-ahead</code> bytes ahead. The
<code>--buffer-size</code> is buffered in memory whereas the
<code>--vfs-read-ahead</code> is buffered on disk.</p>
<p>When using this mode it is recommended that
<code>--buffer-size</code> is not set too large and
<code>--vfs-read-ahead</code> is set large if required.</p>
<p><strong>IMPORTANT</strong> not all file systems support sparse files.
In particular FAT/exFAT do not. Rclone will perform very badly if the
cache directory is on a filesystem which doesn't support sparse files
and it will log an ERROR message if one is detected.</p>
<h3 id="fingerprinting-3">Fingerprinting</h3>
<p>Various parts of the VFS use fingerprinting to see if a local file
copy has changed relative to a remote file. Fingerprints are made
from:</p>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<p>On some backends some of these attributes are slow to read (they take
an extra API call per object, or extra work per object).</p>
<p>For example <code>hash</code> is slow with the <code>local</code> and
<code>sftp</code> backends as they have to read the entire file and hash
it, and <code>modtime</code> is slow with the <code>s3</code>,
<code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends
because they need to do an extra API call to fetch it.</p>
<p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone
will not include the slow operations in the fingerprint. This makes the
fingerprinting less accurate but much faster and will improve the
opening time of cached files.</p>
<p>If you are running a vfs cache over <code>local</code>,
<code>s3</code> or <code>swift</code> backends then using this flag is
recommended.</p>
<p>Note that if you change the value of this flag, the fingerprints of
the files in the cache may be invalidated and the files will need to be
downloaded again.</p>
<h2 id="vfs-chunked-reading-3">VFS Chunked Reading</h2>
<p>When rclone reads files from a remote it reads them in chunks. This
means that rather than requesting the whole file rclone reads the chunk
specified. This can reduce the used download quota for some remotes by
requesting only chunks from the remote that are actually read, at the
cost of an increased number of requests.</p>
<p>These flags control the chunking:</p>
<pre class="text"><code>    --vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
    --vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)
    --vfs-read-chunk-streams int            The number of parallel streams to read at once</code></pre>
<p>The chunking behaves differently depending on the
<code>--vfs-read-chunk-streams</code> parameter.</p>
<h3
id="vfs-read-chunk-streams-0-6"><code>--vfs-read-chunk-streams</code> ==
0</h3>
<p>Rclone will start reading a chunk of size
<code>--vfs-read-chunk-size</code>, and then double the size for each
read. When <code>--vfs-read-chunk-size-limit</code> is specified, and
greater than <code>--vfs-read-chunk-size</code>, the chunk size for each
open file will get doubled only until the specified value is reached. If
the value is "off", which is the default, the limit is disabled and the
chunk size will grow indefinitely.</p>
<p>With <code>--vfs-read-chunk-size 100M</code> and
<code>--vfs-read-chunk-size-limit 0</code> the following parts will be
downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When
<code>--vfs-read-chunk-size-limit 500M</code> is specified, the result
would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so
on.</p>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off"
disables chunked reading.</p>
<p>The chunks will not be buffered in memory.</p>
<h3
id="vfs-read-chunk-streams-0-7"><code>--vfs-read-chunk-streams</code>
&gt; 0</h3>
<p>Rclone reads <code>--vfs-read-chunk-streams</code> chunks of size
<code>--vfs-read-chunk-size</code> concurrently. The size for each read
will stay constant.</p>
<p>This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.</p>
<p>Some experimentation will be needed to find the optimum values of
<code>--vfs-read-chunk-size</code> and
<code>--vfs-read-chunk-streams</code> as these will depend on the
backend in use and the latency to the backend.</p>
<p>For high performance object stores (eg AWS S3) a reasonable place to
start might be <code>--vfs-read-chunk-streams 16</code> and
<code>--vfs-read-chunk-size 4M</code>. In testing with AWS S3 the
performance scaled roughly as the <code>--vfs-read-chunk-streams</code>
setting.</p>
<p>Similar settings should work for high latency links, but depending on
the latency they may need more <code>--vfs-read-chunk-streams</code> in
order to get the throughput.</p>
<h2 id="vfs-performance-3">VFS Performance</h2>
<p>These flags may be used to enable/disable features of the VFS for
performance or other reasons. See also the <a
href="#vfs-chunked-reading">chunked reading</a> feature.</p>
<p>In particular S3 and Swift benefit hugely from the
<code>--no-modtime</code> flag (or use <code>--use-server-modtime</code>
for a slightly different effect) as each read of the modification time
takes a transaction.</p>
<pre class="text"><code>    --no-checksum     Don&#39;t compare checksums on up/download.
    --no-modtime      Don&#39;t read/write the modification time (can speed things up).
    --no-seek         Don&#39;t allow seeking in files.
    --read-only       Only allow read-only access.</code></pre>
<p>Sometimes rclone is delivered reads or writes out of order. Rather
than seeking rclone will wait a short time for the in sequence read or
write to come in. These flags only come into effect when not using an on
disk cache file.</p>
<pre class="text"><code>    --vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
    --vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>When using VFS write caching (<code>--vfs-cache-mode</code> with
value writes or full), the global flag <code>--transfers</code> can be
set to adjust the number of parallel uploads of modified files from the
cache (the related global flag <code>--checkers</code> has no effect on
the VFS).</p>
<pre class="text"><code>    --transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="symlinks-3">Symlinks</h2>
<p>By default the VFS does not support symlinks. However this may be
enabled with either of the following flags:</p>
<pre class="text"><code>    --links      Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension.
    --vfs-links  Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS</code></pre>
<p>As most cloud storage systems do not support symlinks directly,
rclone stores the symlink as a normal file with a special extension. So
a file which appears as a symlink <code>link-to-file.txt</code> would be
stored on cloud storage as <code>link-to-file.txt.rclonelink</code> and
the contents would be the path to the symlink destination.</p>
<p>Note that <code>--links</code> enables symlink translation globally
in rclone - this includes any backend which supports the concept (for
example the local backend). <code>--vfs-links</code> just enables it for
the VFS layer.</p>
<p>This scheme is compatible with that used by the <a
href="https://rclone.org/local/#symlinks-junction-points">local backend
with the --local-links flag</a>.</p>
<p>The <code>--vfs-links</code> flag has been designed for
<code>rclone mount</code>, <code>rclone nfsmount</code> and
<code>rclone serve nfs</code>.</p>
<p>It hasn't been tested with the other <code>rclone serve</code>
commands yet.</p>
<p>A limitation of the current implementation is that it expects the
caller to resolve sub-symlinks. For example given this directory
tree</p>
<pre class="text"><code>.
├── dir
│   └── file.txt
└── linked-dir -&gt; dir</code></pre>
<p>The VFS will correctly resolve <code>linked-dir</code> but not
<code>linked-dir/file.txt</code>. This is not a problem for the tested
commands but may be for other commands.</p>
<p><strong>Note</strong> that there is an outstanding issue with symlink
support <a href="https://github.com/rclone/rclone/issues/8245">issue
#8245</a> with duplicate files being created when symlinks are moved
into directories where there is a file of the same name (or vice
versa).</p>
<h2 id="vfs-case-sensitivity-3">VFS Case Sensitivity</h2>
<p>Linux file systems are case-sensitive: two files can differ only by
case, and the exact case must be used when opening a file.</p>
<p>File systems in modern Windows are case-insensitive but
case-preserving: although existing files can be opened using any case,
the exact case used to create the file is preserved and available for
programs to query. It is not allowed for two files in the same directory
to differ only by case.</p>
<p>Usually file systems on macOS are case-insensitive. It is possible to
make macOS file systems case-sensitive but that is not the default.</p>
<p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone
handles these two cases. If its value is "false", rclone passes file
names to the remote as-is. If the flag is "true" (or appears without a
value on the command line), rclone may perform a "fixup" as explained
below.</p>
<p>The user may specify a file name to open/delete/rename/etc with a
case different than what is stored on the remote. If an argument refers
to an existing file with exactly the same name, then the case of the
existing file on the disk will be used. However, if a file name with
exactly the same name is not found but a name differing only by case
exists, rclone will transparently fixup the name. This fixup happens
only when an existing file is requested. Case sensitivity of file names
created anew by rclone is controlled by the underlying remote.</p>
<p>Note that case sensitivity of the operating system running rclone
(the target) may differ from case sensitivity of a file system presented
by rclone (the source). The flag controls whether "fixup" is performed
to satisfy the target.</p>
<p>If the flag is not provided on the command line, then its default
value depends on the operating system where rclone runs: "true" on
Windows and macOS, "false" otherwise. If the flag is provided without a
value, then it is "true".</p>
<p>The <code>--no-unicode-normalization</code> flag controls whether a
similar "fixup" is performed for filenames that differ but are <a
href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically
equivalent</a> with respect to unicode. Unicode normalization can be
particularly helpful for users of macOS, which prefers form NFD instead
of the NFC used by most other platforms. It is therefore highly
recommended to keep the default of <code>false</code> on macOS, to avoid
encoding compatibility issues.</p>
<p>In the (probably unlikely) event that a directory has multiple
duplicate filenames after applying case and unicode normalization, the
<code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates.
This comes with a performance tradeoff, as rclone will have to scan the
entire directory for duplicates when listing a directory. For this
reason, it is recommended to leave this disabled if not needed. However,
macOS users may wish to consider using it, as otherwise, if a remote
directory contains both NFC and NFD versions of the same filename, an
odd situation will occur: both versions of the file will be visible in
the mount, and both will appear to be editable, however, editing either
version will actually result in only the NFD version getting edited
under the hood. <code>--vfs-block- norm-dupes</code> prevents this
confusion by detecting this scenario, hiding the duplicates, and logging
an error, similar to how this is handled in
<code>rclone sync</code>.</p>
<h2 id="vfs-disk-options-3">VFS Disk Options</h2>
<p>This flag allows you to manually set the statistics about the filing
system. It can be useful when those statistics cannot be read correctly
automatically.</p>
<pre class="text"><code>    --vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-3">Alternate report of used
bytes</h2>
<p>Some backends, most notably S3, do not report the amount of bytes
used. If you need this information to be available when running
<code>df</code> on the filesystem, then pass the flag
<code>--vfs-used-is-size</code> to rclone. With this flag set, instead
of relying on the backend to report this information, rclone will scan
the whole remote similar to <code>rclone size</code> and compute the
total used space itself.</p>
<p><strong>WARNING</strong>: Contrary to <code>rclone size</code>, this
flag ignores filters so that the result is accurate. However, this is
very inefficient and may cost lots of API calls resulting in extra
charges. Use it as a last resort and only with caching.</p>
<h2 id="vfs-metadata-3">VFS Metadata</h2>
<p>If you use the <code>--vfs-metadata-extension</code> flag you can get
the VFS to expose files which contain the <a
href="https://rclone.org/docs/#metadata">metadata</a> as a JSON blob.
These files will not appear in the directory listing, but can be
<code>stat</code>-ed and opened and once they have been they
<strong>will</strong> appear in directory listings until the directory
cache expires.</p>
<p>Note that some backends won't create metadata unless you pass in the
<code>--metadata</code> flag.</p>
<p>For example, using <code>rclone mount</code> with
<code>--metadata --vfs-metadata-extension .metadata</code> we get</p>
<div class="sourceCode" id="cb441"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb441-1"><a href="#cb441-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb441-2"><a href="#cb441-2" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048577</span>
<span id="cb441-3"><a href="#cb441-3" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb441-4"><a href="#cb441-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb441-5"><a href="#cb441-5" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> cat /mnt/1G.metadata</span>
<span id="cb441-6"><a href="#cb441-6" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb441-7"><a href="#cb441-7" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;atime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-04T17:34:22.317069787Z&quot;</span>,</span>
<span id="cb441-8"><a href="#cb441-8" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;btime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:37.708253808Z&quot;</span>,</span>
<span id="cb441-9"><a href="#cb441-9" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;gid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span>,</span>
<span id="cb441-10"><a href="#cb441-10" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mode&quot;</span><span class="ex">:</span> <span class="st">&quot;100664&quot;</span>,</span>
<span id="cb441-11"><a href="#cb441-11" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mtime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:39.640238323Z&quot;</span>,</span>
<span id="cb441-12"><a href="#cb441-12" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;uid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span></span>
<span id="cb441-13"><a href="#cb441-13" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span>
<span id="cb441-14"><a href="#cb441-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb441-15"><a href="#cb441-15" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb441-16"><a href="#cb441-16" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048578</span>
<span id="cb441-17"><a href="#cb441-17" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb441-18"><a href="#cb441-18" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user        185 Mar  3 16:03 1G.metadata</span></code></pre></div>
<p>If the file has no metadata it will be returned as <code>{}</code>
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<pre><code>rclone serve docker [flags]</code></pre>
<h2 id="options-73">Options</h2>
<pre><code>      --allow-non-empty                        Allow mounting over a non-empty directory (not supported on Windows)
      --allow-other                            Allow access to other users (not supported on Windows)
      --allow-root                             Allow access to root user (not supported on Windows)
      --async-read                             Use asynchronous reads (not supported on Windows) (default true)
      --attr-timeout Duration                  Time for which file/directory attributes are cached (default 1s)
      --base-dir string                        Base directory for volumes (default &quot;/var/lib/docker-volumes/rclone&quot;)
      --daemon                                 Run mount in background and exit parent process (as background output is suppressed, use --log-file with --log-format=pid,... to monitor) (not supported on Windows)
      --daemon-timeout Duration                Time limit for rclone to respond to kernel (not supported on Windows) (default 0s)
      --daemon-wait Duration                   Time to wait for ready mount from daemon (maximum time on Linux, constant sleep time on OSX/BSD) (not supported on Windows) (default 1m0s)
      --debug-fuse                             Debug the FUSE internals - needs -v
      --default-permissions                    Makes kernel enforce access control based on the file mode (not supported on Windows)
      --devname string                         Set the device name - default is remote:path
      --dir-cache-time Duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 777)
      --direct-io                              Use Direct IO, disables caching of data
      --file-perms FileMode                    File permissions (default 666)
      --forget-state                           Skip restoring previous state
      --fuse-flag stringArray                  Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for docker
      --link-perms FileMode                    Link permissions (default 666)
      --max-read-ahead SizeSuffix              The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki)
      --mount-case-insensitive Tristate        Tell the OS the mount is case insensitive (true) or sensitive (false) regardless of the backend (auto) (default unset)
      --network-mode                           Mount as remote network drive, instead of fixed disk drive (supported on Windows only)
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --no-spec                                Do not write spec file
      --noappledouble                          Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true)
      --noapplexattr                           Ignore all &quot;com.apple.*&quot; extended attributes (supported on OSX only)
  -o, --option stringArray                     Option for libfuse/WinFsp (repeat if required)
      --poll-interval Duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --socket-addr string                     Address &lt;host:port&gt; or absolute path (default: /run/docker/plugins/rclone.sock)
      --socket-gid int                         GID for unix socket (default: current process GID) (default 1000)
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask FileMode                         Override the permission bits set by the filesystem (not supported on Windows) (default 002)
      --vfs-block-norm-dupes                   If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
      --vfs-cache-max-age Duration             Max time since last access of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-min-free-space SizeSuffix    Target minimum free space on the disk containing the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval Duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-links                              Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
      --vfs-metadata-extension string          Set the extension to read metadata from
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-chunk-streams int             The number of parallel streams to read at once
      --vfs-read-wait Duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-refresh                            Refreshes the directory cache recursively in the background on start
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back Duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait Duration                Time to wait for in-sequence write before giving error (default 1s)
      --volname string                         Set the volume name (supported on Windows and OSX only)
      --write-back-cache                       Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-25">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h2 id="see-also-73">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-ftp">rclone serve ftp</h1>
<p>Serve remote:path over FTP.</p>
<h2 id="synopsis-67">Synopsis</h2>
<p>Run a basic FTP server to serve a remote over FTP protocol. This can
be viewed with a FTP client or you can make a remote of type FTP to read
and write it.</p>
<h2 id="server-options-2">Server options</h2>
<p>Use --addr to specify which IP address and port the server should
listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all
IPs. By default it only listens on localhost. You can use port :0 to let
the OS choose an available port.</p>
<p>If you set --addr to listen on a public or LAN accessible IP address
then using Authentication is advised - see the next section for
info.</p>
<h3 id="authentication-1">Authentication</h3>
<p>By default this will serve files without needing a login.</p>
<p>You can set a single username and password with the --user and --pass
flags.</p>
<h2 id="vfs---virtual-file-system-4">VFS - Virtual File System</h2>
<p>This command uses the VFS layer. This adapts the cloud storage
objects that rclone uses into something which looks much more like a
disk filing system.</p>
<p>Cloud storage objects have lots of properties which aren't like disk
files - you can't extend them or write to the middle of them, so the VFS
layer has to deal with that. Because there is no one right way of doing
this there are various options explained below.</p>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-4">VFS Directory Cache</h2>
<p>Using the <code>--dir-cache-time</code> flag, you can control how
long a directory should be considered up to date and not refreshed from
the backend. Changes made through the VFS will appear immediately or
invalidate the cache.</p>
<pre class="text"><code>    --dir-cache-time duration   Time to cache directory entries for (default 5m0s)
    --poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<p>However, changes made directly on the cloud storage by the web
interface or a different copy of rclone will only be picked up once the
directory cache expires if the backend configured does not support
polling for changes. If the backend supports polling, changes will be
picked up within the polling interval.</p>
<p>You can send a <code>SIGHUP</code> signal to rclone for it to flush
all directory caches, regardless of how old they are. Assuming only one
rclone instance is running, you can reset the cache like this:</p>
<div class="sourceCode" id="cb446"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb446-1"><a href="#cb446-1" aria-hidden="true" tabindex="-1"></a><span class="bu">kill</span> <span class="at">-SIGHUP</span> <span class="va">$(</span><span class="fu">pidof</span> rclone<span class="va">)</span></span></code></pre></div>
<p>If you configure rclone with a <a href="/rc">remote control</a> then
you can use rclone rc to flush the whole directory cache:</p>
<div class="sourceCode" id="cb447"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb447-1"><a href="#cb447-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget</span></code></pre></div>
<p>Or individual files or directories:</p>
<div class="sourceCode" id="cb448"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb448-1"><a href="#cb448-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget file=path/to/file dir=path/to/dir</span></code></pre></div>
<h2 id="vfs-file-buffering-4">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<p>Each open file will try to keep the specified amount of data in
memory at all times. The buffered data is bound to one open file and
won't be shared.</p>
<p>This flag is a upper limit for the used memory per open file. The
buffer will only use memory for data that is downloaded but not not yet
read. If the buffer is empty, only a small amount of memory will be
used.</p>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-4">VFS File Caching</h2>
<p>These flags control the VFS file caching options. File caching is
necessary to make the VFS layer appear compatible with a normal file
system. It can be disabled at the cost of some compatibility.</p>
<p>For example you'll need to enable VFS caching if you want to read and
write simultaneously to a file. See below for more details.</p>
<p>Note that the VFS cache is separate from the cache backend and you
may find that you need one or the other or both.</p>
<pre class="text"><code>    --cache-dir string                     Directory rclone will use for caching.
    --vfs-cache-mode CacheMode             Cache mode off|minimal|writes|full (default off)
    --vfs-cache-max-age duration           Max time since last access of objects in the cache (default 1h0m0s)
    --vfs-cache-max-size SizeSuffix        Max total size of objects in the cache (default off)
    --vfs-cache-min-free-space SizeSuffix  Target minimum free space on the disk containing the cache (default off)
    --vfs-cache-poll-interval duration     Interval to poll the cache for stale objects (default 1m0s)
    --vfs-write-back duration              Time to writeback files after last use when using cache (default 5s)</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the
file cache. The files are stored in the user cache file area which is OS
dependent but can be controlled with <code>--cache-dir</code> or setting
the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by
<code>--vfs-cache-mode</code>. The higher the cache mode the more
compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are
closed and if they haven't been accessed for
<code>--vfs-write-back</code> seconds. If rclone is quit or dies with
files that haven't been uploaded, these will be uploaded next time
rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or
<code>--vfs-cache-min-free-space</code> note that the cache may exceed
these quotas for two reasons. Firstly because it is only checked every
<code>--vfs-cache-poll-interval</code>. Secondly because open files
cannot be evicted from the cache. When <code>--vfs-cache-max-size</code>
or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will
attempt to evict the least accessed files from the cache first. rclone
will start with files that haven't been accessed for the longest. This
cache flushing strategy is efficient and more relevant files are likely
to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache
after the set time since last access has passed. The default value of 1
hour will start evicting files from cache that haven't been accessed for
1 hour. When a cached file is accessed the 1 hour timer is reset to 0
and will wait for 1 more hour before evicting. Specify the time with
standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the
same VFS cache with the same or overlapping remotes if using
<code>--vfs-cache-mode &gt; off</code>. This can potentially cause data
corruption if you do. You can work around this by giving each rclone its
own cache hierarchy with <code>--cache-dir</code>. You don't need to
worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-4">--vfs-cache-mode off</h3>
<p>In this mode (the default) the cache will read directly from the
remote and write directly to the remote without caching anything on
disk.</p>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can't be opened for both read AND write</li>
<li>Files opened for write can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-4">--vfs-cache-mode minimal</h3>
<p>This is very similar to "off" except that files opened for read AND
write will be buffered to disk. This means that files opened for write
will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-4">--vfs-cache-mode writes</h3>
<p>In this mode files opened for read only are still read directly from
the remote, write only and read/write files are buffered to disk
first.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-4">--vfs-cache-mode full</h3>
<p>In this mode all reads and writes are buffered to and from disk. When
data is read from the remote this is buffered to disk as well.</p>
<p>In this mode the files in the cache will be sparse files and rclone
will keep track of which bits of the files it has downloaded.</p>
<p>So if an application only reads the starts of each file, then rclone
will only buffer the start of the file. These files will appear to be
their full size in the cache, but they will be sparse files with only
the data that has been downloaded present in them.</p>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<p>When reading a file rclone will read <code>--buffer-size</code> plus
<code>--vfs-read-ahead</code> bytes ahead. The
<code>--buffer-size</code> is buffered in memory whereas the
<code>--vfs-read-ahead</code> is buffered on disk.</p>
<p>When using this mode it is recommended that
<code>--buffer-size</code> is not set too large and
<code>--vfs-read-ahead</code> is set large if required.</p>
<p><strong>IMPORTANT</strong> not all file systems support sparse files.
In particular FAT/exFAT do not. Rclone will perform very badly if the
cache directory is on a filesystem which doesn't support sparse files
and it will log an ERROR message if one is detected.</p>
<h3 id="fingerprinting-4">Fingerprinting</h3>
<p>Various parts of the VFS use fingerprinting to see if a local file
copy has changed relative to a remote file. Fingerprints are made
from:</p>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<p>On some backends some of these attributes are slow to read (they take
an extra API call per object, or extra work per object).</p>
<p>For example <code>hash</code> is slow with the <code>local</code> and
<code>sftp</code> backends as they have to read the entire file and hash
it, and <code>modtime</code> is slow with the <code>s3</code>,
<code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends
because they need to do an extra API call to fetch it.</p>
<p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone
will not include the slow operations in the fingerprint. This makes the
fingerprinting less accurate but much faster and will improve the
opening time of cached files.</p>
<p>If you are running a vfs cache over <code>local</code>,
<code>s3</code> or <code>swift</code> backends then using this flag is
recommended.</p>
<p>Note that if you change the value of this flag, the fingerprints of
the files in the cache may be invalidated and the files will need to be
downloaded again.</p>
<h2 id="vfs-chunked-reading-4">VFS Chunked Reading</h2>
<p>When rclone reads files from a remote it reads them in chunks. This
means that rather than requesting the whole file rclone reads the chunk
specified. This can reduce the used download quota for some remotes by
requesting only chunks from the remote that are actually read, at the
cost of an increased number of requests.</p>
<p>These flags control the chunking:</p>
<pre class="text"><code>    --vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
    --vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)
    --vfs-read-chunk-streams int            The number of parallel streams to read at once</code></pre>
<p>The chunking behaves differently depending on the
<code>--vfs-read-chunk-streams</code> parameter.</p>
<h3
id="vfs-read-chunk-streams-0-8"><code>--vfs-read-chunk-streams</code> ==
0</h3>
<p>Rclone will start reading a chunk of size
<code>--vfs-read-chunk-size</code>, and then double the size for each
read. When <code>--vfs-read-chunk-size-limit</code> is specified, and
greater than <code>--vfs-read-chunk-size</code>, the chunk size for each
open file will get doubled only until the specified value is reached. If
the value is "off", which is the default, the limit is disabled and the
chunk size will grow indefinitely.</p>
<p>With <code>--vfs-read-chunk-size 100M</code> and
<code>--vfs-read-chunk-size-limit 0</code> the following parts will be
downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When
<code>--vfs-read-chunk-size-limit 500M</code> is specified, the result
would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so
on.</p>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off"
disables chunked reading.</p>
<p>The chunks will not be buffered in memory.</p>
<h3
id="vfs-read-chunk-streams-0-9"><code>--vfs-read-chunk-streams</code>
&gt; 0</h3>
<p>Rclone reads <code>--vfs-read-chunk-streams</code> chunks of size
<code>--vfs-read-chunk-size</code> concurrently. The size for each read
will stay constant.</p>
<p>This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.</p>
<p>Some experimentation will be needed to find the optimum values of
<code>--vfs-read-chunk-size</code> and
<code>--vfs-read-chunk-streams</code> as these will depend on the
backend in use and the latency to the backend.</p>
<p>For high performance object stores (eg AWS S3) a reasonable place to
start might be <code>--vfs-read-chunk-streams 16</code> and
<code>--vfs-read-chunk-size 4M</code>. In testing with AWS S3 the
performance scaled roughly as the <code>--vfs-read-chunk-streams</code>
setting.</p>
<p>Similar settings should work for high latency links, but depending on
the latency they may need more <code>--vfs-read-chunk-streams</code> in
order to get the throughput.</p>
<h2 id="vfs-performance-4">VFS Performance</h2>
<p>These flags may be used to enable/disable features of the VFS for
performance or other reasons. See also the <a
href="#vfs-chunked-reading">chunked reading</a> feature.</p>
<p>In particular S3 and Swift benefit hugely from the
<code>--no-modtime</code> flag (or use <code>--use-server-modtime</code>
for a slightly different effect) as each read of the modification time
takes a transaction.</p>
<pre class="text"><code>    --no-checksum     Don&#39;t compare checksums on up/download.
    --no-modtime      Don&#39;t read/write the modification time (can speed things up).
    --no-seek         Don&#39;t allow seeking in files.
    --read-only       Only allow read-only access.</code></pre>
<p>Sometimes rclone is delivered reads or writes out of order. Rather
than seeking rclone will wait a short time for the in sequence read or
write to come in. These flags only come into effect when not using an on
disk cache file.</p>
<pre class="text"><code>    --vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
    --vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>When using VFS write caching (<code>--vfs-cache-mode</code> with
value writes or full), the global flag <code>--transfers</code> can be
set to adjust the number of parallel uploads of modified files from the
cache (the related global flag <code>--checkers</code> has no effect on
the VFS).</p>
<pre class="text"><code>    --transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="symlinks-4">Symlinks</h2>
<p>By default the VFS does not support symlinks. However this may be
enabled with either of the following flags:</p>
<pre class="text"><code>    --links      Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension.
    --vfs-links  Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS</code></pre>
<p>As most cloud storage systems do not support symlinks directly,
rclone stores the symlink as a normal file with a special extension. So
a file which appears as a symlink <code>link-to-file.txt</code> would be
stored on cloud storage as <code>link-to-file.txt.rclonelink</code> and
the contents would be the path to the symlink destination.</p>
<p>Note that <code>--links</code> enables symlink translation globally
in rclone - this includes any backend which supports the concept (for
example the local backend). <code>--vfs-links</code> just enables it for
the VFS layer.</p>
<p>This scheme is compatible with that used by the <a
href="https://rclone.org/local/#symlinks-junction-points">local backend
with the --local-links flag</a>.</p>
<p>The <code>--vfs-links</code> flag has been designed for
<code>rclone mount</code>, <code>rclone nfsmount</code> and
<code>rclone serve nfs</code>.</p>
<p>It hasn't been tested with the other <code>rclone serve</code>
commands yet.</p>
<p>A limitation of the current implementation is that it expects the
caller to resolve sub-symlinks. For example given this directory
tree</p>
<pre class="text"><code>.
├── dir
│   └── file.txt
└── linked-dir -&gt; dir</code></pre>
<p>The VFS will correctly resolve <code>linked-dir</code> but not
<code>linked-dir/file.txt</code>. This is not a problem for the tested
commands but may be for other commands.</p>
<p><strong>Note</strong> that there is an outstanding issue with symlink
support <a href="https://github.com/rclone/rclone/issues/8245">issue
#8245</a> with duplicate files being created when symlinks are moved
into directories where there is a file of the same name (or vice
versa).</p>
<h2 id="vfs-case-sensitivity-4">VFS Case Sensitivity</h2>
<p>Linux file systems are case-sensitive: two files can differ only by
case, and the exact case must be used when opening a file.</p>
<p>File systems in modern Windows are case-insensitive but
case-preserving: although existing files can be opened using any case,
the exact case used to create the file is preserved and available for
programs to query. It is not allowed for two files in the same directory
to differ only by case.</p>
<p>Usually file systems on macOS are case-insensitive. It is possible to
make macOS file systems case-sensitive but that is not the default.</p>
<p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone
handles these two cases. If its value is "false", rclone passes file
names to the remote as-is. If the flag is "true" (or appears without a
value on the command line), rclone may perform a "fixup" as explained
below.</p>
<p>The user may specify a file name to open/delete/rename/etc with a
case different than what is stored on the remote. If an argument refers
to an existing file with exactly the same name, then the case of the
existing file on the disk will be used. However, if a file name with
exactly the same name is not found but a name differing only by case
exists, rclone will transparently fixup the name. This fixup happens
only when an existing file is requested. Case sensitivity of file names
created anew by rclone is controlled by the underlying remote.</p>
<p>Note that case sensitivity of the operating system running rclone
(the target) may differ from case sensitivity of a file system presented
by rclone (the source). The flag controls whether "fixup" is performed
to satisfy the target.</p>
<p>If the flag is not provided on the command line, then its default
value depends on the operating system where rclone runs: "true" on
Windows and macOS, "false" otherwise. If the flag is provided without a
value, then it is "true".</p>
<p>The <code>--no-unicode-normalization</code> flag controls whether a
similar "fixup" is performed for filenames that differ but are <a
href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically
equivalent</a> with respect to unicode. Unicode normalization can be
particularly helpful for users of macOS, which prefers form NFD instead
of the NFC used by most other platforms. It is therefore highly
recommended to keep the default of <code>false</code> on macOS, to avoid
encoding compatibility issues.</p>
<p>In the (probably unlikely) event that a directory has multiple
duplicate filenames after applying case and unicode normalization, the
<code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates.
This comes with a performance tradeoff, as rclone will have to scan the
entire directory for duplicates when listing a directory. For this
reason, it is recommended to leave this disabled if not needed. However,
macOS users may wish to consider using it, as otherwise, if a remote
directory contains both NFC and NFD versions of the same filename, an
odd situation will occur: both versions of the file will be visible in
the mount, and both will appear to be editable, however, editing either
version will actually result in only the NFD version getting edited
under the hood. <code>--vfs-block- norm-dupes</code> prevents this
confusion by detecting this scenario, hiding the duplicates, and logging
an error, similar to how this is handled in
<code>rclone sync</code>.</p>
<h2 id="vfs-disk-options-4">VFS Disk Options</h2>
<p>This flag allows you to manually set the statistics about the filing
system. It can be useful when those statistics cannot be read correctly
automatically.</p>
<pre class="text"><code>    --vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-4">Alternate report of used
bytes</h2>
<p>Some backends, most notably S3, do not report the amount of bytes
used. If you need this information to be available when running
<code>df</code> on the filesystem, then pass the flag
<code>--vfs-used-is-size</code> to rclone. With this flag set, instead
of relying on the backend to report this information, rclone will scan
the whole remote similar to <code>rclone size</code> and compute the
total used space itself.</p>
<p><strong>WARNING</strong>: Contrary to <code>rclone size</code>, this
flag ignores filters so that the result is accurate. However, this is
very inefficient and may cost lots of API calls resulting in extra
charges. Use it as a last resort and only with caching.</p>
<h2 id="vfs-metadata-4">VFS Metadata</h2>
<p>If you use the <code>--vfs-metadata-extension</code> flag you can get
the VFS to expose files which contain the <a
href="https://rclone.org/docs/#metadata">metadata</a> as a JSON blob.
These files will not appear in the directory listing, but can be
<code>stat</code>-ed and opened and once they have been they
<strong>will</strong> appear in directory listings until the directory
cache expires.</p>
<p>Note that some backends won't create metadata unless you pass in the
<code>--metadata</code> flag.</p>
<p>For example, using <code>rclone mount</code> with
<code>--metadata --vfs-metadata-extension .metadata</code> we get</p>
<div class="sourceCode" id="cb457"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb457-1"><a href="#cb457-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb457-2"><a href="#cb457-2" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048577</span>
<span id="cb457-3"><a href="#cb457-3" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb457-4"><a href="#cb457-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb457-5"><a href="#cb457-5" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> cat /mnt/1G.metadata</span>
<span id="cb457-6"><a href="#cb457-6" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb457-7"><a href="#cb457-7" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;atime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-04T17:34:22.317069787Z&quot;</span>,</span>
<span id="cb457-8"><a href="#cb457-8" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;btime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:37.708253808Z&quot;</span>,</span>
<span id="cb457-9"><a href="#cb457-9" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;gid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span>,</span>
<span id="cb457-10"><a href="#cb457-10" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mode&quot;</span><span class="ex">:</span> <span class="st">&quot;100664&quot;</span>,</span>
<span id="cb457-11"><a href="#cb457-11" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mtime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:39.640238323Z&quot;</span>,</span>
<span id="cb457-12"><a href="#cb457-12" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;uid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span></span>
<span id="cb457-13"><a href="#cb457-13" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span>
<span id="cb457-14"><a href="#cb457-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb457-15"><a href="#cb457-15" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb457-16"><a href="#cb457-16" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048578</span>
<span id="cb457-17"><a href="#cb457-17" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb457-18"><a href="#cb457-18" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user        185 Mar  3 16:03 1G.metadata</span></code></pre></div>
<p>If the file has no metadata it will be returned as <code>{}</code>
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<h2 id="auth-proxy">Auth Proxy</h2>
<p>If you supply the parameter
<code>--auth-proxy /path/to/program</code> then rclone will use that
program to generate backends on the fly which then are used to
authenticate incoming requests. This uses a simple JSON based protocol
with input on STDIN and output on STDOUT.</p>
<p><strong>PLEASE NOTE:</strong> <code>--auth-proxy</code> and
<code>--authorized-keys</code> cannot be used together, if
<code>--auth-proxy</code> is set the authorized keys option will be
ignored.</p>
<p>There is an example program <a
href="https://github.com/rclone/rclone/blob/master/bin/test_proxy.py">bin/test_proxy.py</a>
in the rclone source code.</p>
<p>The program's job is to take a <code>user</code> and
<code>pass</code> on the input and turn those into the config for a
backend on STDOUT in JSON format. This config will have any default
parameters for the backend added, but it won't use configuration from
environment variables or command line options - it is the job of the
proxy program to make a complete config.</p>
<p>This config generated must have this extra parameter</p>
<ul>
<li><code>_root</code> - root to use for the backend</li>
</ul>
<p>And it may have this parameter</p>
<ul>
<li><code>_obscure</code> - comma separated strings for parameters to
obscure</li>
</ul>
<p>If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:</p>
<div class="sourceCode" id="cb458"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb458-1"><a href="#cb458-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb458-2"><a href="#cb458-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
<span id="cb458-3"><a href="#cb458-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span></span>
<span id="cb458-4"><a href="#cb458-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:</p>
<div class="sourceCode" id="cb459"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb459-1"><a href="#cb459-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb459-2"><a href="#cb459-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
<span id="cb459-3"><a href="#cb459-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;public_key&quot;</span><span class="fu">:</span> <span class="st">&quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;</span></span>
<span id="cb459-4"><a href="#cb459-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>And as an example return this on STDOUT</p>
<div class="sourceCode" id="cb460"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb460-1"><a href="#cb460-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb460-2"><a href="#cb460-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
<span id="cb460-3"><a href="#cb460-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
<span id="cb460-4"><a href="#cb460-4" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;_obscure&quot;</span><span class="fu">:</span> <span class="st">&quot;pass&quot;</span><span class="fu">,</span></span>
<span id="cb460-5"><a href="#cb460-5" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
<span id="cb460-6"><a href="#cb460-6" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span><span class="fu">,</span></span>
<span id="cb460-7"><a href="#cb460-7" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp.example.com&quot;</span></span>
<span id="cb460-8"><a href="#cb460-8" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>This would mean that an SFTP backend would be created on the fly for
the <code>user</code> and <code>pass</code>/<code>public_key</code>
returned in the output to the host given. Note that since
<code>_obscure</code> is set to <code>pass</code>, rclone will obscure
the <code>pass</code> parameter before creating the backend (which is
required for sftp backends).</p>
<p>The program can manipulate the supplied <code>user</code> in any way,
for example to make proxy to many different sftp backends, you could
make the <code>user</code> be <code>user@example.com</code> and then set
the <code>host</code> to <code>example.com</code> in the output and the
user to <code>user</code>. For security you'd probably want to restrict
the <code>host</code> to a limited list.</p>
<p>Note that an internal cache is keyed on <code>user</code> so only use
that for configuration, don't use <code>pass</code> or
<code>public_key</code>. This also means that if a user's password or
public-key is changed the cache will need to expire (which takes 5 mins)
before it takes effect.</p>
<p>This can be used to build general purpose proxies to any kind of
backend that rclone supports.</p>
<pre><code>rclone serve ftp remote:path [flags]</code></pre>
<h2 id="options-74">Options</h2>
<pre><code>      --addr string                            IPaddress:Port or :Port to bind server to (default &quot;localhost:2121&quot;)
      --auth-proxy string                      A program to use to create the backend from the auth
      --cert string                            TLS PEM key (concatenation of certificate and CA certificate)
      --dir-cache-time Duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 777)
      --file-perms FileMode                    File permissions (default 666)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for ftp
      --key string                             TLS PEM Private key
      --link-perms FileMode                    Link permissions (default 666)
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --pass string                            Password for authentication (empty value allow every password)
      --passive-port string                    Passive port range to use (default &quot;30000-32000&quot;)
      --poll-interval Duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --public-ip string                       Public IP address to advertise for passive connections
      --read-only                              Only allow read-only access
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask FileMode                         Override the permission bits set by the filesystem (not supported on Windows) (default 002)
      --user string                            User name for authentication (default &quot;anonymous&quot;)
      --vfs-block-norm-dupes                   If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
      --vfs-cache-max-age Duration             Max time since last access of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-min-free-space SizeSuffix    Target minimum free space on the disk containing the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval Duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-links                              Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
      --vfs-metadata-extension string          Set the extension to read metadata from
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-chunk-streams int             The number of parallel streams to read at once
      --vfs-read-wait Duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-refresh                            Refreshes the directory cache recursively in the background on start
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back Duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait Duration                Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-26">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h2 id="see-also-74">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-http">rclone serve http</h1>
<p>Serve the remote over HTTP.</p>
<h2 id="synopsis-68">Synopsis</h2>
<p>Run a basic web server to serve a remote over HTTP. This can be
viewed in a web browser or you can make a remote of type http read from
it.</p>
<p>You can use the filter flags (e.g. <code>--include</code>,
<code>--exclude</code>) to control what is served.</p>
<p>The server will log errors. Use <code>-v</code> to see access
logs.</p>
<p><code>--bwlimit</code> will be respected for file transfers. Use
<code>--stats</code> to control the stats printing.</p>
<h2 id="server-options-3">Server options</h2>
<p>Use <code>--addr</code> to specify which IP address and port the
server should listen on, eg <code>--addr 1.2.3.4:8000</code> or
<code>--addr :8080</code> to listen to all IPs. By default it only
listens on localhost. You can use port :0 to let the OS choose an
available port.</p>
<p>If you set <code>--addr</code> to listen on a public or LAN
accessible IP address then using Authentication is advised - see the
next section for info.</p>
<p>You can use a unix socket by setting the url to
<code>unix:///path/to/socket</code> or just by using an absolute path
name.</p>
<p><code>--addr</code> may be repeated to listen on multiple
IPs/ports/sockets. Socket activation, described further below, can also
be used to accomplish the same.</p>
<p><code>--server-read-timeout</code> and
<code>--server-write-timeout</code> can be used to control the timeouts
on the server. Note that this is the total time for a transfer.</p>
<p><code>--max-header-bytes</code> controls the maximum number of bytes
the server will accept in the HTTP header.</p>
<p><code>--baseurl</code> controls the URL prefix that rclone serves
from. By default rclone will serve from the root. If you used
<code>--baseurl "/rclone"</code> then rclone would serve from a URL
starting with "/rclone/". This is useful if you wish to proxy rclone
serve. Rclone automatically inserts leading and trailing "/" on
<code>--baseurl</code>, so <code>--baseurl "rclone"</code>,
<code>--baseurl "/rclone"</code> and <code>--baseurl "/rclone/"</code>
are all treated identically.</p>
<h3 id="tls-ssl-1">TLS (SSL)</h3>
<p>By default this will serve over http. If you want you can serve over
https. You will need to supply the <code>--cert</code> and
<code>--key</code> flags. If you wish to do client side certificate
validation then you will need to supply <code>--client-ca</code>
also.</p>
<p><code>--cert</code> must be set to the path of a file containing
either a PEM encoded certificate, or a concatenation of that with the CA
certificate. <code>--key</code> must be set to the path of a file with
the PEM encoded private key. If setting <code>--client-ca</code>, it
should be set to the path of a file with PEM encoded client certificate
authority certificates.</p>
<p><code>--min-tls-version</code> is minimum TLS version that is
acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3"
(default "tls1.0").</p>
<h2 id="socket-activation-1">Socket activation</h2>
<p>Instead of the listening addresses specified above, rclone will
listen to all FDs passed by the service manager, if any (and ignore any
arguments passed by <code>--addr</code>).</p>
<p>This allows rclone to be a socket-activated service. It can be
configured with .socket and .service unit files as described in <a
href="https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html"
class="uri">https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html</a>.</p>
<p>Socket activation can be tested ad-hoc with the
<code>systemd-socket-activate</code>command</p>
<div class="sourceCode" id="cb464"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb464-1"><a href="#cb464-1" aria-hidden="true" tabindex="-1"></a><span class="ex">systemd-socket-activate</span> <span class="at">-l</span> 8000 <span class="at">--</span> rclone serve</span></code></pre></div>
<p>This will socket-activate rclone on the first connection to port 8000
over TCP.</p>
<h3 id="template-1">Template</h3>
<p><code>--template</code> allows a user to specify a custom markup
template for HTTP and WebDAV serve functions. The server exports the
following markup to be used within the template to server pages:</p>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="header">
<th style="text-align: left;">Parameter</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">.Name</td>
<td style="text-align: left;">The full path of a file/directory.</td>
</tr>
<tr class="even">
<td style="text-align: left;">.Title</td>
<td style="text-align: left;">Directory listing of .Name</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Sort</td>
<td style="text-align: left;">The current sort used. This is changeable
via ?sort= parameter</td>
</tr>
<tr class="even">
<td style="text-align: left;"></td>
<td style="text-align: left;">Sort Options: namedirfirst,name,size,time
(default namedirfirst)</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Order</td>
<td style="text-align: left;">The current ordering used. This is
changeable via ?order= parameter</td>
</tr>
<tr class="even">
<td style="text-align: left;"></td>
<td style="text-align: left;">Order Options: asc,desc (default asc)</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Query</td>
<td style="text-align: left;">Currently unused.</td>
</tr>
<tr class="even">
<td style="text-align: left;">.Breadcrumb</td>
<td style="text-align: left;">Allows for creating a relative
navigation</td>
</tr>
<tr class="odd">
<td style="text-align: left;">-- .Link</td>
<td style="text-align: left;">The relative to the root link of the
Text.</td>
</tr>
<tr class="even">
<td style="text-align: left;">-- .Text</td>
<td style="text-align: left;">The Name of the directory.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Entries</td>
<td style="text-align: left;">Information about a specific
file/directory.</td>
</tr>
<tr class="even">
<td style="text-align: left;">-- .URL</td>
<td style="text-align: left;">The 'url' of an entry.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">-- .Leaf</td>
<td style="text-align: left;">Currently same as 'URL' but intended to be
'just' the name.</td>
</tr>
<tr class="even">
<td style="text-align: left;">-- .IsDir</td>
<td style="text-align: left;">Boolean for if an entry is a directory or
not.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">-- .Size</td>
<td style="text-align: left;">Size in Bytes of the entry.</td>
</tr>
<tr class="even">
<td style="text-align: left;">-- .ModTime</td>
<td style="text-align: left;">The UTC timestamp of an entry.</td>
</tr>
</tbody>
</table>
<p>The server also makes the following functions available so that they
can be used within the template. These functions help extend the options
for dynamic rendering of HTML. They can be used to render HTML based on
specific conditions.</p>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="header">
<th style="text-align: left;">Function</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">afterEpoch</td>
<td style="text-align: left;">Returns the time since the epoch for the
given time.</td>
</tr>
<tr class="even">
<td style="text-align: left;">contains</td>
<td style="text-align: left;">Checks whether a given substring is
present or not in a given string.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">hasPrefix</td>
<td style="text-align: left;">Checks whether the given string begins
with the specified prefix.</td>
</tr>
<tr class="even">
<td style="text-align: left;">hasSuffix</td>
<td style="text-align: left;">Checks whether the given string end with
the specified suffix.</td>
</tr>
</tbody>
</table>
<h3 id="authentication-2">Authentication</h3>
<p>By default this will serve files without needing a login.</p>
<p>You can either use an htpasswd file which can take lots of users, or
set a single username and password with the <code>--user</code> and
<code>--pass</code> flags.</p>
<p>Alternatively, you can have the reverse proxy manage authentication
and use the username provided in the configured header with
<code>--user-from-header</code> (e.g.,
<code>--user-from-header=x-remote-user</code>). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.</p>
<p>If either of the above authentication methods is not configured and
client certificates are required by the <code>--client-ca</code> flag
passed to the server, the client certificate common name will be
considered as the username.</p>
<p>Use <code>--htpasswd /path/to/htpasswd</code> to provide an htpasswd
file. This is in standard apache format and supports MD5, SHA1 and
BCrypt for basic authentication. Bcrypt is recommended.</p>
<p>To create an htpasswd file:</p>
<div class="sourceCode" id="cb465"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb465-1"><a href="#cb465-1" aria-hidden="true" tabindex="-1"></a><span class="fu">touch</span> htpasswd</span>
<span id="cb465-2"><a href="#cb465-2" aria-hidden="true" tabindex="-1"></a><span class="ex">htpasswd</span> <span class="at">-B</span> htpasswd user</span>
<span id="cb465-3"><a href="#cb465-3" aria-hidden="true" tabindex="-1"></a><span class="ex">htpasswd</span> <span class="at">-B</span> htpasswd anotherUser</span></code></pre></div>
<p>The password file can be updated while rclone is running.</p>
<p>Use <code>--realm</code> to set the authentication realm.</p>
<p>Use <code>--salt</code> to change the password hashing salt from the
default.</p>
<h2 id="vfs---virtual-file-system-5">VFS - Virtual File System</h2>
<p>This command uses the VFS layer. This adapts the cloud storage
objects that rclone uses into something which looks much more like a
disk filing system.</p>
<p>Cloud storage objects have lots of properties which aren't like disk
files - you can't extend them or write to the middle of them, so the VFS
layer has to deal with that. Because there is no one right way of doing
this there are various options explained below.</p>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-5">VFS Directory Cache</h2>
<p>Using the <code>--dir-cache-time</code> flag, you can control how
long a directory should be considered up to date and not refreshed from
the backend. Changes made through the VFS will appear immediately or
invalidate the cache.</p>
<pre class="text"><code>    --dir-cache-time duration   Time to cache directory entries for (default 5m0s)
    --poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<p>However, changes made directly on the cloud storage by the web
interface or a different copy of rclone will only be picked up once the
directory cache expires if the backend configured does not support
polling for changes. If the backend supports polling, changes will be
picked up within the polling interval.</p>
<p>You can send a <code>SIGHUP</code> signal to rclone for it to flush
all directory caches, regardless of how old they are. Assuming only one
rclone instance is running, you can reset the cache like this:</p>
<div class="sourceCode" id="cb467"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb467-1"><a href="#cb467-1" aria-hidden="true" tabindex="-1"></a><span class="bu">kill</span> <span class="at">-SIGHUP</span> <span class="va">$(</span><span class="fu">pidof</span> rclone<span class="va">)</span></span></code></pre></div>
<p>If you configure rclone with a <a href="/rc">remote control</a> then
you can use rclone rc to flush the whole directory cache:</p>
<div class="sourceCode" id="cb468"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb468-1"><a href="#cb468-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget</span></code></pre></div>
<p>Or individual files or directories:</p>
<div class="sourceCode" id="cb469"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb469-1"><a href="#cb469-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget file=path/to/file dir=path/to/dir</span></code></pre></div>
<h2 id="vfs-file-buffering-5">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<p>Each open file will try to keep the specified amount of data in
memory at all times. The buffered data is bound to one open file and
won't be shared.</p>
<p>This flag is a upper limit for the used memory per open file. The
buffer will only use memory for data that is downloaded but not not yet
read. If the buffer is empty, only a small amount of memory will be
used.</p>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-5">VFS File Caching</h2>
<p>These flags control the VFS file caching options. File caching is
necessary to make the VFS layer appear compatible with a normal file
system. It can be disabled at the cost of some compatibility.</p>
<p>For example you'll need to enable VFS caching if you want to read and
write simultaneously to a file. See below for more details.</p>
<p>Note that the VFS cache is separate from the cache backend and you
may find that you need one or the other or both.</p>
<pre class="text"><code>    --cache-dir string                     Directory rclone will use for caching.
    --vfs-cache-mode CacheMode             Cache mode off|minimal|writes|full (default off)
    --vfs-cache-max-age duration           Max time since last access of objects in the cache (default 1h0m0s)
    --vfs-cache-max-size SizeSuffix        Max total size of objects in the cache (default off)
    --vfs-cache-min-free-space SizeSuffix  Target minimum free space on the disk containing the cache (default off)
    --vfs-cache-poll-interval duration     Interval to poll the cache for stale objects (default 1m0s)
    --vfs-write-back duration              Time to writeback files after last use when using cache (default 5s)</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the
file cache. The files are stored in the user cache file area which is OS
dependent but can be controlled with <code>--cache-dir</code> or setting
the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by
<code>--vfs-cache-mode</code>. The higher the cache mode the more
compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are
closed and if they haven't been accessed for
<code>--vfs-write-back</code> seconds. If rclone is quit or dies with
files that haven't been uploaded, these will be uploaded next time
rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or
<code>--vfs-cache-min-free-space</code> note that the cache may exceed
these quotas for two reasons. Firstly because it is only checked every
<code>--vfs-cache-poll-interval</code>. Secondly because open files
cannot be evicted from the cache. When <code>--vfs-cache-max-size</code>
or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will
attempt to evict the least accessed files from the cache first. rclone
will start with files that haven't been accessed for the longest. This
cache flushing strategy is efficient and more relevant files are likely
to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache
after the set time since last access has passed. The default value of 1
hour will start evicting files from cache that haven't been accessed for
1 hour. When a cached file is accessed the 1 hour timer is reset to 0
and will wait for 1 more hour before evicting. Specify the time with
standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the
same VFS cache with the same or overlapping remotes if using
<code>--vfs-cache-mode &gt; off</code>. This can potentially cause data
corruption if you do. You can work around this by giving each rclone its
own cache hierarchy with <code>--cache-dir</code>. You don't need to
worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-5">--vfs-cache-mode off</h3>
<p>In this mode (the default) the cache will read directly from the
remote and write directly to the remote without caching anything on
disk.</p>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can't be opened for both read AND write</li>
<li>Files opened for write can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-5">--vfs-cache-mode minimal</h3>
<p>This is very similar to "off" except that files opened for read AND
write will be buffered to disk. This means that files opened for write
will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-5">--vfs-cache-mode writes</h3>
<p>In this mode files opened for read only are still read directly from
the remote, write only and read/write files are buffered to disk
first.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-5">--vfs-cache-mode full</h3>
<p>In this mode all reads and writes are buffered to and from disk. When
data is read from the remote this is buffered to disk as well.</p>
<p>In this mode the files in the cache will be sparse files and rclone
will keep track of which bits of the files it has downloaded.</p>
<p>So if an application only reads the starts of each file, then rclone
will only buffer the start of the file. These files will appear to be
their full size in the cache, but they will be sparse files with only
the data that has been downloaded present in them.</p>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<p>When reading a file rclone will read <code>--buffer-size</code> plus
<code>--vfs-read-ahead</code> bytes ahead. The
<code>--buffer-size</code> is buffered in memory whereas the
<code>--vfs-read-ahead</code> is buffered on disk.</p>
<p>When using this mode it is recommended that
<code>--buffer-size</code> is not set too large and
<code>--vfs-read-ahead</code> is set large if required.</p>
<p><strong>IMPORTANT</strong> not all file systems support sparse files.
In particular FAT/exFAT do not. Rclone will perform very badly if the
cache directory is on a filesystem which doesn't support sparse files
and it will log an ERROR message if one is detected.</p>
<h3 id="fingerprinting-5">Fingerprinting</h3>
<p>Various parts of the VFS use fingerprinting to see if a local file
copy has changed relative to a remote file. Fingerprints are made
from:</p>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<p>On some backends some of these attributes are slow to read (they take
an extra API call per object, or extra work per object).</p>
<p>For example <code>hash</code> is slow with the <code>local</code> and
<code>sftp</code> backends as they have to read the entire file and hash
it, and <code>modtime</code> is slow with the <code>s3</code>,
<code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends
because they need to do an extra API call to fetch it.</p>
<p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone
will not include the slow operations in the fingerprint. This makes the
fingerprinting less accurate but much faster and will improve the
opening time of cached files.</p>
<p>If you are running a vfs cache over <code>local</code>,
<code>s3</code> or <code>swift</code> backends then using this flag is
recommended.</p>
<p>Note that if you change the value of this flag, the fingerprints of
the files in the cache may be invalidated and the files will need to be
downloaded again.</p>
<h2 id="vfs-chunked-reading-5">VFS Chunked Reading</h2>
<p>When rclone reads files from a remote it reads them in chunks. This
means that rather than requesting the whole file rclone reads the chunk
specified. This can reduce the used download quota for some remotes by
requesting only chunks from the remote that are actually read, at the
cost of an increased number of requests.</p>
<p>These flags control the chunking:</p>
<pre class="text"><code>    --vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
    --vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)
    --vfs-read-chunk-streams int            The number of parallel streams to read at once</code></pre>
<p>The chunking behaves differently depending on the
<code>--vfs-read-chunk-streams</code> parameter.</p>
<h3
id="vfs-read-chunk-streams-0-10"><code>--vfs-read-chunk-streams</code>
== 0</h3>
<p>Rclone will start reading a chunk of size
<code>--vfs-read-chunk-size</code>, and then double the size for each
read. When <code>--vfs-read-chunk-size-limit</code> is specified, and
greater than <code>--vfs-read-chunk-size</code>, the chunk size for each
open file will get doubled only until the specified value is reached. If
the value is "off", which is the default, the limit is disabled and the
chunk size will grow indefinitely.</p>
<p>With <code>--vfs-read-chunk-size 100M</code> and
<code>--vfs-read-chunk-size-limit 0</code> the following parts will be
downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When
<code>--vfs-read-chunk-size-limit 500M</code> is specified, the result
would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so
on.</p>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off"
disables chunked reading.</p>
<p>The chunks will not be buffered in memory.</p>
<h3
id="vfs-read-chunk-streams-0-11"><code>--vfs-read-chunk-streams</code>
&gt; 0</h3>
<p>Rclone reads <code>--vfs-read-chunk-streams</code> chunks of size
<code>--vfs-read-chunk-size</code> concurrently. The size for each read
will stay constant.</p>
<p>This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.</p>
<p>Some experimentation will be needed to find the optimum values of
<code>--vfs-read-chunk-size</code> and
<code>--vfs-read-chunk-streams</code> as these will depend on the
backend in use and the latency to the backend.</p>
<p>For high performance object stores (eg AWS S3) a reasonable place to
start might be <code>--vfs-read-chunk-streams 16</code> and
<code>--vfs-read-chunk-size 4M</code>. In testing with AWS S3 the
performance scaled roughly as the <code>--vfs-read-chunk-streams</code>
setting.</p>
<p>Similar settings should work for high latency links, but depending on
the latency they may need more <code>--vfs-read-chunk-streams</code> in
order to get the throughput.</p>
<h2 id="vfs-performance-5">VFS Performance</h2>
<p>These flags may be used to enable/disable features of the VFS for
performance or other reasons. See also the <a
href="#vfs-chunked-reading">chunked reading</a> feature.</p>
<p>In particular S3 and Swift benefit hugely from the
<code>--no-modtime</code> flag (or use <code>--use-server-modtime</code>
for a slightly different effect) as each read of the modification time
takes a transaction.</p>
<pre class="text"><code>    --no-checksum     Don&#39;t compare checksums on up/download.
    --no-modtime      Don&#39;t read/write the modification time (can speed things up).
    --no-seek         Don&#39;t allow seeking in files.
    --read-only       Only allow read-only access.</code></pre>
<p>Sometimes rclone is delivered reads or writes out of order. Rather
than seeking rclone will wait a short time for the in sequence read or
write to come in. These flags only come into effect when not using an on
disk cache file.</p>
<pre class="text"><code>    --vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
    --vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>When using VFS write caching (<code>--vfs-cache-mode</code> with
value writes or full), the global flag <code>--transfers</code> can be
set to adjust the number of parallel uploads of modified files from the
cache (the related global flag <code>--checkers</code> has no effect on
the VFS).</p>
<pre class="text"><code>    --transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="symlinks-5">Symlinks</h2>
<p>By default the VFS does not support symlinks. However this may be
enabled with either of the following flags:</p>
<pre class="text"><code>    --links      Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension.
    --vfs-links  Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS</code></pre>
<p>As most cloud storage systems do not support symlinks directly,
rclone stores the symlink as a normal file with a special extension. So
a file which appears as a symlink <code>link-to-file.txt</code> would be
stored on cloud storage as <code>link-to-file.txt.rclonelink</code> and
the contents would be the path to the symlink destination.</p>
<p>Note that <code>--links</code> enables symlink translation globally
in rclone - this includes any backend which supports the concept (for
example the local backend). <code>--vfs-links</code> just enables it for
the VFS layer.</p>
<p>This scheme is compatible with that used by the <a
href="https://rclone.org/local/#symlinks-junction-points">local backend
with the --local-links flag</a>.</p>
<p>The <code>--vfs-links</code> flag has been designed for
<code>rclone mount</code>, <code>rclone nfsmount</code> and
<code>rclone serve nfs</code>.</p>
<p>It hasn't been tested with the other <code>rclone serve</code>
commands yet.</p>
<p>A limitation of the current implementation is that it expects the
caller to resolve sub-symlinks. For example given this directory
tree</p>
<pre class="text"><code>.
├── dir
│   └── file.txt
└── linked-dir -&gt; dir</code></pre>
<p>The VFS will correctly resolve <code>linked-dir</code> but not
<code>linked-dir/file.txt</code>. This is not a problem for the tested
commands but may be for other commands.</p>
<p><strong>Note</strong> that there is an outstanding issue with symlink
support <a href="https://github.com/rclone/rclone/issues/8245">issue
#8245</a> with duplicate files being created when symlinks are moved
into directories where there is a file of the same name (or vice
versa).</p>
<h2 id="vfs-case-sensitivity-5">VFS Case Sensitivity</h2>
<p>Linux file systems are case-sensitive: two files can differ only by
case, and the exact case must be used when opening a file.</p>
<p>File systems in modern Windows are case-insensitive but
case-preserving: although existing files can be opened using any case,
the exact case used to create the file is preserved and available for
programs to query. It is not allowed for two files in the same directory
to differ only by case.</p>
<p>Usually file systems on macOS are case-insensitive. It is possible to
make macOS file systems case-sensitive but that is not the default.</p>
<p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone
handles these two cases. If its value is "false", rclone passes file
names to the remote as-is. If the flag is "true" (or appears without a
value on the command line), rclone may perform a "fixup" as explained
below.</p>
<p>The user may specify a file name to open/delete/rename/etc with a
case different than what is stored on the remote. If an argument refers
to an existing file with exactly the same name, then the case of the
existing file on the disk will be used. However, if a file name with
exactly the same name is not found but a name differing only by case
exists, rclone will transparently fixup the name. This fixup happens
only when an existing file is requested. Case sensitivity of file names
created anew by rclone is controlled by the underlying remote.</p>
<p>Note that case sensitivity of the operating system running rclone
(the target) may differ from case sensitivity of a file system presented
by rclone (the source). The flag controls whether "fixup" is performed
to satisfy the target.</p>
<p>If the flag is not provided on the command line, then its default
value depends on the operating system where rclone runs: "true" on
Windows and macOS, "false" otherwise. If the flag is provided without a
value, then it is "true".</p>
<p>The <code>--no-unicode-normalization</code> flag controls whether a
similar "fixup" is performed for filenames that differ but are <a
href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically
equivalent</a> with respect to unicode. Unicode normalization can be
particularly helpful for users of macOS, which prefers form NFD instead
of the NFC used by most other platforms. It is therefore highly
recommended to keep the default of <code>false</code> on macOS, to avoid
encoding compatibility issues.</p>
<p>In the (probably unlikely) event that a directory has multiple
duplicate filenames after applying case and unicode normalization, the
<code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates.
This comes with a performance tradeoff, as rclone will have to scan the
entire directory for duplicates when listing a directory. For this
reason, it is recommended to leave this disabled if not needed. However,
macOS users may wish to consider using it, as otherwise, if a remote
directory contains both NFC and NFD versions of the same filename, an
odd situation will occur: both versions of the file will be visible in
the mount, and both will appear to be editable, however, editing either
version will actually result in only the NFD version getting edited
under the hood. <code>--vfs-block- norm-dupes</code> prevents this
confusion by detecting this scenario, hiding the duplicates, and logging
an error, similar to how this is handled in
<code>rclone sync</code>.</p>
<h2 id="vfs-disk-options-5">VFS Disk Options</h2>
<p>This flag allows you to manually set the statistics about the filing
system. It can be useful when those statistics cannot be read correctly
automatically.</p>
<pre class="text"><code>    --vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-5">Alternate report of used
bytes</h2>
<p>Some backends, most notably S3, do not report the amount of bytes
used. If you need this information to be available when running
<code>df</code> on the filesystem, then pass the flag
<code>--vfs-used-is-size</code> to rclone. With this flag set, instead
of relying on the backend to report this information, rclone will scan
the whole remote similar to <code>rclone size</code> and compute the
total used space itself.</p>
<p><strong>WARNING</strong>: Contrary to <code>rclone size</code>, this
flag ignores filters so that the result is accurate. However, this is
very inefficient and may cost lots of API calls resulting in extra
charges. Use it as a last resort and only with caching.</p>
<h2 id="vfs-metadata-5">VFS Metadata</h2>
<p>If you use the <code>--vfs-metadata-extension</code> flag you can get
the VFS to expose files which contain the <a
href="https://rclone.org/docs/#metadata">metadata</a> as a JSON blob.
These files will not appear in the directory listing, but can be
<code>stat</code>-ed and opened and once they have been they
<strong>will</strong> appear in directory listings until the directory
cache expires.</p>
<p>Note that some backends won't create metadata unless you pass in the
<code>--metadata</code> flag.</p>
<p>For example, using <code>rclone mount</code> with
<code>--metadata --vfs-metadata-extension .metadata</code> we get</p>
<div class="sourceCode" id="cb478"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb478-1"><a href="#cb478-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb478-2"><a href="#cb478-2" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048577</span>
<span id="cb478-3"><a href="#cb478-3" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb478-4"><a href="#cb478-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb478-5"><a href="#cb478-5" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> cat /mnt/1G.metadata</span>
<span id="cb478-6"><a href="#cb478-6" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb478-7"><a href="#cb478-7" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;atime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-04T17:34:22.317069787Z&quot;</span>,</span>
<span id="cb478-8"><a href="#cb478-8" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;btime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:37.708253808Z&quot;</span>,</span>
<span id="cb478-9"><a href="#cb478-9" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;gid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span>,</span>
<span id="cb478-10"><a href="#cb478-10" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mode&quot;</span><span class="ex">:</span> <span class="st">&quot;100664&quot;</span>,</span>
<span id="cb478-11"><a href="#cb478-11" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mtime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:39.640238323Z&quot;</span>,</span>
<span id="cb478-12"><a href="#cb478-12" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;uid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span></span>
<span id="cb478-13"><a href="#cb478-13" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span>
<span id="cb478-14"><a href="#cb478-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb478-15"><a href="#cb478-15" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb478-16"><a href="#cb478-16" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048578</span>
<span id="cb478-17"><a href="#cb478-17" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb478-18"><a href="#cb478-18" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user        185 Mar  3 16:03 1G.metadata</span></code></pre></div>
<p>If the file has no metadata it will be returned as <code>{}</code>
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<h2 id="auth-proxy-1">Auth Proxy</h2>
<p>If you supply the parameter
<code>--auth-proxy /path/to/program</code> then rclone will use that
program to generate backends on the fly which then are used to
authenticate incoming requests. This uses a simple JSON based protocol
with input on STDIN and output on STDOUT.</p>
<p><strong>PLEASE NOTE:</strong> <code>--auth-proxy</code> and
<code>--authorized-keys</code> cannot be used together, if
<code>--auth-proxy</code> is set the authorized keys option will be
ignored.</p>
<p>There is an example program <a
href="https://github.com/rclone/rclone/blob/master/bin/test_proxy.py">bin/test_proxy.py</a>
in the rclone source code.</p>
<p>The program's job is to take a <code>user</code> and
<code>pass</code> on the input and turn those into the config for a
backend on STDOUT in JSON format. This config will have any default
parameters for the backend added, but it won't use configuration from
environment variables or command line options - it is the job of the
proxy program to make a complete config.</p>
<p>This config generated must have this extra parameter</p>
<ul>
<li><code>_root</code> - root to use for the backend</li>
</ul>
<p>And it may have this parameter</p>
<ul>
<li><code>_obscure</code> - comma separated strings for parameters to
obscure</li>
</ul>
<p>If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:</p>
<div class="sourceCode" id="cb479"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb479-1"><a href="#cb479-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb479-2"><a href="#cb479-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
<span id="cb479-3"><a href="#cb479-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span></span>
<span id="cb479-4"><a href="#cb479-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:</p>
<div class="sourceCode" id="cb480"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb480-1"><a href="#cb480-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb480-2"><a href="#cb480-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
<span id="cb480-3"><a href="#cb480-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;public_key&quot;</span><span class="fu">:</span> <span class="st">&quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;</span></span>
<span id="cb480-4"><a href="#cb480-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>And as an example return this on STDOUT</p>
<div class="sourceCode" id="cb481"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb481-1"><a href="#cb481-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb481-2"><a href="#cb481-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
<span id="cb481-3"><a href="#cb481-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
<span id="cb481-4"><a href="#cb481-4" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;_obscure&quot;</span><span class="fu">:</span> <span class="st">&quot;pass&quot;</span><span class="fu">,</span></span>
<span id="cb481-5"><a href="#cb481-5" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
<span id="cb481-6"><a href="#cb481-6" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span><span class="fu">,</span></span>
<span id="cb481-7"><a href="#cb481-7" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp.example.com&quot;</span></span>
<span id="cb481-8"><a href="#cb481-8" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>This would mean that an SFTP backend would be created on the fly for
the <code>user</code> and <code>pass</code>/<code>public_key</code>
returned in the output to the host given. Note that since
<code>_obscure</code> is set to <code>pass</code>, rclone will obscure
the <code>pass</code> parameter before creating the backend (which is
required for sftp backends).</p>
<p>The program can manipulate the supplied <code>user</code> in any way,
for example to make proxy to many different sftp backends, you could
make the <code>user</code> be <code>user@example.com</code> and then set
the <code>host</code> to <code>example.com</code> in the output and the
user to <code>user</code>. For security you'd probably want to restrict
the <code>host</code> to a limited list.</p>
<p>Note that an internal cache is keyed on <code>user</code> so only use
that for configuration, don't use <code>pass</code> or
<code>public_key</code>. This also means that if a user's password or
public-key is changed the cache will need to expire (which takes 5 mins)
before it takes effect.</p>
<p>This can be used to build general purpose proxies to any kind of
backend that rclone supports.</p>
<pre><code>rclone serve http remote:path [flags]</code></pre>
<h2 id="options-75">Options</h2>
<pre><code>      --addr stringArray                       IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080)
      --allow-origin string                    Origin which cross-domain request (CORS) can be executed from
      --auth-proxy string                      A program to use to create the backend from the auth
      --baseurl string                         Prefix for URLs - leave blank for root
      --cert string                            TLS PEM key (concatenation of certificate and CA certificate)
      --client-ca string                       Client certificate authority to verify clients with
      --dir-cache-time Duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 777)
      --file-perms FileMode                    File permissions (default 666)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for http
      --htpasswd string                        A htpasswd file - if not provided no authentication is done
      --key string                             TLS PEM Private key
      --link-perms FileMode                    Link permissions (default 666)
      --max-header-bytes int                   Maximum size of request header (default 4096)
      --min-tls-version string                 Minimum TLS version that is acceptable (default &quot;tls1.0&quot;)
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --pass string                            Password for authentication
      --poll-interval Duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --realm string                           Realm for authentication
      --salt string                            Password hashing salt (default &quot;dlPL2MqE&quot;)
      --server-read-timeout Duration           Timeout for server reading data (default 1h0m0s)
      --server-write-timeout Duration          Timeout for server writing data (default 1h0m0s)
      --template string                        User-specified template
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask FileMode                         Override the permission bits set by the filesystem (not supported on Windows) (default 002)
      --user string                            User name for authentication
      --user-from-header string                User name from a defined HTTP header
      --vfs-block-norm-dupes                   If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
      --vfs-cache-max-age Duration             Max time since last access of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-min-free-space SizeSuffix    Target minimum free space on the disk containing the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval Duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-links                              Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
      --vfs-metadata-extension string          Set the extension to read metadata from
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-chunk-streams int             The number of parallel streams to read at once
      --vfs-read-wait Duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-refresh                            Refreshes the directory cache recursively in the background on start
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back Duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait Duration                Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-27">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h2 id="see-also-75">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-nfs">rclone serve nfs</h1>
<p>Serve the remote as an NFS mount</p>
<h2 id="synopsis-69">Synopsis</h2>
<p>Create an NFS server that serves the given remote over the
network.</p>
<p>This implements an NFSv3 server to serve any rclone remote via
NFS.</p>
<p>The primary purpose for this command is to enable the <a
href="https://rclone.org/commands/rclone_mount/">mount command</a> on
recent macOS versions where installing FUSE is very cumbersome.</p>
<p>This server does not implement any authentication so any client will
be able to access the data. To limit access, you can use
<code>serve nfs</code> on the loopback address or rely on secure tunnels
(such as SSH) or use firewalling.</p>
<p>For this reason, by default, a random TCP port is chosen and the
loopback interface is used for the listening address by default; meaning
that it is only available to the local machine. If you want other
machines to access the NFS mount over local network, you need to specify
the listening address and port using the <code>--addr</code> flag.</p>
<p>Modifying files through the NFS protocol requires VFS caching.
Usually you will need to specify <code>--vfs-cache-mode</code> in order
to be able to write to the mountpoint (<code>full</code> is
recommended). If you don't specify VFS cache mode, the mount will be
read-only.</p>
<p><code>--nfs-cache-type</code> controls the type of the NFS handle
cache. By default this is <code>memory</code> where new handles will be
randomly allocated when needed. These are stored in memory. If the
server is restarted the handle cache will be lost and connected NFS
clients will get stale handle errors.</p>
<p><code>--nfs-cache-type disk</code> uses an on disk NFS handle cache.
Rclone hashes the path of the object and stores it in a file named after
the hash. These hashes are stored on disk the directory controlled by
<code>--cache-dir</code> or the exact directory may be specified with
<code>--nfs-cache-dir</code>. Using this means that the NFS server can
be restarted at will without affecting the connected clients.</p>
<p><code>--nfs-cache-type symlink</code> is similar to
<code>--nfs-cache-type disk</code> in that it uses an on disk cache, but
the cache entries are held as symlinks. Rclone will use the handle of
the underlying file as the NFS handle which improves performance. This
sort of cache can't be backed up and restored as the underlying handles
will change. This is Linux only. It requires running rclone as root or
with <code>CAP_DAC_READ_SEARCH</code>. You can run rclone with this
extra permission by doing this to the rclone binary
<code>sudo setcap cap_dac_read_search+ep /path/to/rclone</code>.</p>
<p><code>--nfs-cache-handle-limit</code> controls the maximum number of
cached NFS handles stored by the caching handler. This should not be set
too low or you may experience errors when trying to access files. The
default is <code>1000000</code>, but consider lowering this limit if the
server's system resource usage causes problems. This is only used by the
<code>memory</code> type cache.</p>
<p>To serve NFS over the network use following command:</p>
<div class="sourceCode" id="cb485"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb485-1"><a href="#cb485-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> serve nfs remote: <span class="at">--addr</span> 0.0.0.0:<span class="va">$PORT</span> <span class="at">--vfs-cache-mode</span><span class="op">=</span>full</span></code></pre></div>
<p>This specifies a port that can be used in the mount command. To mount
the server under Linux/macOS, use the following command:</p>
<div class="sourceCode" id="cb486"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb486-1"><a href="#cb486-1" aria-hidden="true" tabindex="-1"></a><span class="fu">mount</span> <span class="at">-t</span> nfs <span class="at">-o</span> port=<span class="va">$PORT</span>,mountport=<span class="va">$PORT</span>,tcp <span class="va">$HOSTNAME</span>:/ path/to/mountpoint</span></code></pre></div>
<p>Where <code>$PORT</code> is the same port number used in the
<code>serve nfs</code> command and <code>$HOSTNAME</code> is the network
address of the machine that <code>serve nfs</code> was run on.</p>
<p>If <code>--vfs-metadata-extension</code> is in use then for the
<code>--nfs-cache-type disk</code> and
<code>--nfs-cache-type cache</code> the metadata files will have the
file handle of their parent file suffixed with
<code>0x00, 0x00, 0x00, 0x01</code>. This means they can be looked up
directly from the parent file handle is desired.</p>
<p>This command is only available on Unix platforms.</p>
<h2 id="vfs---virtual-file-system-6">VFS - Virtual File System</h2>
<p>This command uses the VFS layer. This adapts the cloud storage
objects that rclone uses into something which looks much more like a
disk filing system.</p>
<p>Cloud storage objects have lots of properties which aren't like disk
files - you can't extend them or write to the middle of them, so the VFS
layer has to deal with that. Because there is no one right way of doing
this there are various options explained below.</p>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-6">VFS Directory Cache</h2>
<p>Using the <code>--dir-cache-time</code> flag, you can control how
long a directory should be considered up to date and not refreshed from
the backend. Changes made through the VFS will appear immediately or
invalidate the cache.</p>
<pre class="text"><code>    --dir-cache-time duration   Time to cache directory entries for (default 5m0s)
    --poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<p>However, changes made directly on the cloud storage by the web
interface or a different copy of rclone will only be picked up once the
directory cache expires if the backend configured does not support
polling for changes. If the backend supports polling, changes will be
picked up within the polling interval.</p>
<p>You can send a <code>SIGHUP</code> signal to rclone for it to flush
all directory caches, regardless of how old they are. Assuming only one
rclone instance is running, you can reset the cache like this:</p>
<div class="sourceCode" id="cb488"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb488-1"><a href="#cb488-1" aria-hidden="true" tabindex="-1"></a><span class="bu">kill</span> <span class="at">-SIGHUP</span> <span class="va">$(</span><span class="fu">pidof</span> rclone<span class="va">)</span></span></code></pre></div>
<p>If you configure rclone with a <a href="/rc">remote control</a> then
you can use rclone rc to flush the whole directory cache:</p>
<div class="sourceCode" id="cb489"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb489-1"><a href="#cb489-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget</span></code></pre></div>
<p>Or individual files or directories:</p>
<div class="sourceCode" id="cb490"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb490-1"><a href="#cb490-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget file=path/to/file dir=path/to/dir</span></code></pre></div>
<h2 id="vfs-file-buffering-6">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<p>Each open file will try to keep the specified amount of data in
memory at all times. The buffered data is bound to one open file and
won't be shared.</p>
<p>This flag is a upper limit for the used memory per open file. The
buffer will only use memory for data that is downloaded but not not yet
read. If the buffer is empty, only a small amount of memory will be
used.</p>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-6">VFS File Caching</h2>
<p>These flags control the VFS file caching options. File caching is
necessary to make the VFS layer appear compatible with a normal file
system. It can be disabled at the cost of some compatibility.</p>
<p>For example you'll need to enable VFS caching if you want to read and
write simultaneously to a file. See below for more details.</p>
<p>Note that the VFS cache is separate from the cache backend and you
may find that you need one or the other or both.</p>
<pre class="text"><code>    --cache-dir string                     Directory rclone will use for caching.
    --vfs-cache-mode CacheMode             Cache mode off|minimal|writes|full (default off)
    --vfs-cache-max-age duration           Max time since last access of objects in the cache (default 1h0m0s)
    --vfs-cache-max-size SizeSuffix        Max total size of objects in the cache (default off)
    --vfs-cache-min-free-space SizeSuffix  Target minimum free space on the disk containing the cache (default off)
    --vfs-cache-poll-interval duration     Interval to poll the cache for stale objects (default 1m0s)
    --vfs-write-back duration              Time to writeback files after last use when using cache (default 5s)</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the
file cache. The files are stored in the user cache file area which is OS
dependent but can be controlled with <code>--cache-dir</code> or setting
the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by
<code>--vfs-cache-mode</code>. The higher the cache mode the more
compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are
closed and if they haven't been accessed for
<code>--vfs-write-back</code> seconds. If rclone is quit or dies with
files that haven't been uploaded, these will be uploaded next time
rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or
<code>--vfs-cache-min-free-space</code> note that the cache may exceed
these quotas for two reasons. Firstly because it is only checked every
<code>--vfs-cache-poll-interval</code>. Secondly because open files
cannot be evicted from the cache. When <code>--vfs-cache-max-size</code>
or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will
attempt to evict the least accessed files from the cache first. rclone
will start with files that haven't been accessed for the longest. This
cache flushing strategy is efficient and more relevant files are likely
to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache
after the set time since last access has passed. The default value of 1
hour will start evicting files from cache that haven't been accessed for
1 hour. When a cached file is accessed the 1 hour timer is reset to 0
and will wait for 1 more hour before evicting. Specify the time with
standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the
same VFS cache with the same or overlapping remotes if using
<code>--vfs-cache-mode &gt; off</code>. This can potentially cause data
corruption if you do. You can work around this by giving each rclone its
own cache hierarchy with <code>--cache-dir</code>. You don't need to
worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-6">--vfs-cache-mode off</h3>
<p>In this mode (the default) the cache will read directly from the
remote and write directly to the remote without caching anything on
disk.</p>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can't be opened for both read AND write</li>
<li>Files opened for write can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-6">--vfs-cache-mode minimal</h3>
<p>This is very similar to "off" except that files opened for read AND
write will be buffered to disk. This means that files opened for write
will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-6">--vfs-cache-mode writes</h3>
<p>In this mode files opened for read only are still read directly from
the remote, write only and read/write files are buffered to disk
first.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-6">--vfs-cache-mode full</h3>
<p>In this mode all reads and writes are buffered to and from disk. When
data is read from the remote this is buffered to disk as well.</p>
<p>In this mode the files in the cache will be sparse files and rclone
will keep track of which bits of the files it has downloaded.</p>
<p>So if an application only reads the starts of each file, then rclone
will only buffer the start of the file. These files will appear to be
their full size in the cache, but they will be sparse files with only
the data that has been downloaded present in them.</p>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<p>When reading a file rclone will read <code>--buffer-size</code> plus
<code>--vfs-read-ahead</code> bytes ahead. The
<code>--buffer-size</code> is buffered in memory whereas the
<code>--vfs-read-ahead</code> is buffered on disk.</p>
<p>When using this mode it is recommended that
<code>--buffer-size</code> is not set too large and
<code>--vfs-read-ahead</code> is set large if required.</p>
<p><strong>IMPORTANT</strong> not all file systems support sparse files.
In particular FAT/exFAT do not. Rclone will perform very badly if the
cache directory is on a filesystem which doesn't support sparse files
and it will log an ERROR message if one is detected.</p>
<h3 id="fingerprinting-6">Fingerprinting</h3>
<p>Various parts of the VFS use fingerprinting to see if a local file
copy has changed relative to a remote file. Fingerprints are made
from:</p>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<p>On some backends some of these attributes are slow to read (they take
an extra API call per object, or extra work per object).</p>
<p>For example <code>hash</code> is slow with the <code>local</code> and
<code>sftp</code> backends as they have to read the entire file and hash
it, and <code>modtime</code> is slow with the <code>s3</code>,
<code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends
because they need to do an extra API call to fetch it.</p>
<p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone
will not include the slow operations in the fingerprint. This makes the
fingerprinting less accurate but much faster and will improve the
opening time of cached files.</p>
<p>If you are running a vfs cache over <code>local</code>,
<code>s3</code> or <code>swift</code> backends then using this flag is
recommended.</p>
<p>Note that if you change the value of this flag, the fingerprints of
the files in the cache may be invalidated and the files will need to be
downloaded again.</p>
<h2 id="vfs-chunked-reading-6">VFS Chunked Reading</h2>
<p>When rclone reads files from a remote it reads them in chunks. This
means that rather than requesting the whole file rclone reads the chunk
specified. This can reduce the used download quota for some remotes by
requesting only chunks from the remote that are actually read, at the
cost of an increased number of requests.</p>
<p>These flags control the chunking:</p>
<pre class="text"><code>    --vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
    --vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)
    --vfs-read-chunk-streams int            The number of parallel streams to read at once</code></pre>
<p>The chunking behaves differently depending on the
<code>--vfs-read-chunk-streams</code> parameter.</p>
<h3
id="vfs-read-chunk-streams-0-12"><code>--vfs-read-chunk-streams</code>
== 0</h3>
<p>Rclone will start reading a chunk of size
<code>--vfs-read-chunk-size</code>, and then double the size for each
read. When <code>--vfs-read-chunk-size-limit</code> is specified, and
greater than <code>--vfs-read-chunk-size</code>, the chunk size for each
open file will get doubled only until the specified value is reached. If
the value is "off", which is the default, the limit is disabled and the
chunk size will grow indefinitely.</p>
<p>With <code>--vfs-read-chunk-size 100M</code> and
<code>--vfs-read-chunk-size-limit 0</code> the following parts will be
downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When
<code>--vfs-read-chunk-size-limit 500M</code> is specified, the result
would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so
on.</p>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off"
disables chunked reading.</p>
<p>The chunks will not be buffered in memory.</p>
<h3
id="vfs-read-chunk-streams-0-13"><code>--vfs-read-chunk-streams</code>
&gt; 0</h3>
<p>Rclone reads <code>--vfs-read-chunk-streams</code> chunks of size
<code>--vfs-read-chunk-size</code> concurrently. The size for each read
will stay constant.</p>
<p>This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.</p>
<p>Some experimentation will be needed to find the optimum values of
<code>--vfs-read-chunk-size</code> and
<code>--vfs-read-chunk-streams</code> as these will depend on the
backend in use and the latency to the backend.</p>
<p>For high performance object stores (eg AWS S3) a reasonable place to
start might be <code>--vfs-read-chunk-streams 16</code> and
<code>--vfs-read-chunk-size 4M</code>. In testing with AWS S3 the
performance scaled roughly as the <code>--vfs-read-chunk-streams</code>
setting.</p>
<p>Similar settings should work for high latency links, but depending on
the latency they may need more <code>--vfs-read-chunk-streams</code> in
order to get the throughput.</p>
<h2 id="vfs-performance-6">VFS Performance</h2>
<p>These flags may be used to enable/disable features of the VFS for
performance or other reasons. See also the <a
href="#vfs-chunked-reading">chunked reading</a> feature.</p>
<p>In particular S3 and Swift benefit hugely from the
<code>--no-modtime</code> flag (or use <code>--use-server-modtime</code>
for a slightly different effect) as each read of the modification time
takes a transaction.</p>
<pre class="text"><code>    --no-checksum     Don&#39;t compare checksums on up/download.
    --no-modtime      Don&#39;t read/write the modification time (can speed things up).
    --no-seek         Don&#39;t allow seeking in files.
    --read-only       Only allow read-only access.</code></pre>
<p>Sometimes rclone is delivered reads or writes out of order. Rather
than seeking rclone will wait a short time for the in sequence read or
write to come in. These flags only come into effect when not using an on
disk cache file.</p>
<pre class="text"><code>    --vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
    --vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>When using VFS write caching (<code>--vfs-cache-mode</code> with
value writes or full), the global flag <code>--transfers</code> can be
set to adjust the number of parallel uploads of modified files from the
cache (the related global flag <code>--checkers</code> has no effect on
the VFS).</p>
<pre class="text"><code>    --transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="symlinks-6">Symlinks</h2>
<p>By default the VFS does not support symlinks. However this may be
enabled with either of the following flags:</p>
<pre class="text"><code>    --links      Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension.
    --vfs-links  Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS</code></pre>
<p>As most cloud storage systems do not support symlinks directly,
rclone stores the symlink as a normal file with a special extension. So
a file which appears as a symlink <code>link-to-file.txt</code> would be
stored on cloud storage as <code>link-to-file.txt.rclonelink</code> and
the contents would be the path to the symlink destination.</p>
<p>Note that <code>--links</code> enables symlink translation globally
in rclone - this includes any backend which supports the concept (for
example the local backend). <code>--vfs-links</code> just enables it for
the VFS layer.</p>
<p>This scheme is compatible with that used by the <a
href="https://rclone.org/local/#symlinks-junction-points">local backend
with the --local-links flag</a>.</p>
<p>The <code>--vfs-links</code> flag has been designed for
<code>rclone mount</code>, <code>rclone nfsmount</code> and
<code>rclone serve nfs</code>.</p>
<p>It hasn't been tested with the other <code>rclone serve</code>
commands yet.</p>
<p>A limitation of the current implementation is that it expects the
caller to resolve sub-symlinks. For example given this directory
tree</p>
<pre class="text"><code>.
├── dir
│   └── file.txt
└── linked-dir -&gt; dir</code></pre>
<p>The VFS will correctly resolve <code>linked-dir</code> but not
<code>linked-dir/file.txt</code>. This is not a problem for the tested
commands but may be for other commands.</p>
<p><strong>Note</strong> that there is an outstanding issue with symlink
support <a href="https://github.com/rclone/rclone/issues/8245">issue
#8245</a> with duplicate files being created when symlinks are moved
into directories where there is a file of the same name (or vice
versa).</p>
<h2 id="vfs-case-sensitivity-6">VFS Case Sensitivity</h2>
<p>Linux file systems are case-sensitive: two files can differ only by
case, and the exact case must be used when opening a file.</p>
<p>File systems in modern Windows are case-insensitive but
case-preserving: although existing files can be opened using any case,
the exact case used to create the file is preserved and available for
programs to query. It is not allowed for two files in the same directory
to differ only by case.</p>
<p>Usually file systems on macOS are case-insensitive. It is possible to
make macOS file systems case-sensitive but that is not the default.</p>
<p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone
handles these two cases. If its value is "false", rclone passes file
names to the remote as-is. If the flag is "true" (or appears without a
value on the command line), rclone may perform a "fixup" as explained
below.</p>
<p>The user may specify a file name to open/delete/rename/etc with a
case different than what is stored on the remote. If an argument refers
to an existing file with exactly the same name, then the case of the
existing file on the disk will be used. However, if a file name with
exactly the same name is not found but a name differing only by case
exists, rclone will transparently fixup the name. This fixup happens
only when an existing file is requested. Case sensitivity of file names
created anew by rclone is controlled by the underlying remote.</p>
<p>Note that case sensitivity of the operating system running rclone
(the target) may differ from case sensitivity of a file system presented
by rclone (the source). The flag controls whether "fixup" is performed
to satisfy the target.</p>
<p>If the flag is not provided on the command line, then its default
value depends on the operating system where rclone runs: "true" on
Windows and macOS, "false" otherwise. If the flag is provided without a
value, then it is "true".</p>
<p>The <code>--no-unicode-normalization</code> flag controls whether a
similar "fixup" is performed for filenames that differ but are <a
href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically
equivalent</a> with respect to unicode. Unicode normalization can be
particularly helpful for users of macOS, which prefers form NFD instead
of the NFC used by most other platforms. It is therefore highly
recommended to keep the default of <code>false</code> on macOS, to avoid
encoding compatibility issues.</p>
<p>In the (probably unlikely) event that a directory has multiple
duplicate filenames after applying case and unicode normalization, the
<code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates.
This comes with a performance tradeoff, as rclone will have to scan the
entire directory for duplicates when listing a directory. For this
reason, it is recommended to leave this disabled if not needed. However,
macOS users may wish to consider using it, as otherwise, if a remote
directory contains both NFC and NFD versions of the same filename, an
odd situation will occur: both versions of the file will be visible in
the mount, and both will appear to be editable, however, editing either
version will actually result in only the NFD version getting edited
under the hood. <code>--vfs-block- norm-dupes</code> prevents this
confusion by detecting this scenario, hiding the duplicates, and logging
an error, similar to how this is handled in
<code>rclone sync</code>.</p>
<h2 id="vfs-disk-options-6">VFS Disk Options</h2>
<p>This flag allows you to manually set the statistics about the filing
system. It can be useful when those statistics cannot be read correctly
automatically.</p>
<pre class="text"><code>    --vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-6">Alternate report of used
bytes</h2>
<p>Some backends, most notably S3, do not report the amount of bytes
used. If you need this information to be available when running
<code>df</code> on the filesystem, then pass the flag
<code>--vfs-used-is-size</code> to rclone. With this flag set, instead
of relying on the backend to report this information, rclone will scan
the whole remote similar to <code>rclone size</code> and compute the
total used space itself.</p>
<p><strong>WARNING</strong>: Contrary to <code>rclone size</code>, this
flag ignores filters so that the result is accurate. However, this is
very inefficient and may cost lots of API calls resulting in extra
charges. Use it as a last resort and only with caching.</p>
<h2 id="vfs-metadata-6">VFS Metadata</h2>
<p>If you use the <code>--vfs-metadata-extension</code> flag you can get
the VFS to expose files which contain the <a
href="https://rclone.org/docs/#metadata">metadata</a> as a JSON blob.
These files will not appear in the directory listing, but can be
<code>stat</code>-ed and opened and once they have been they
<strong>will</strong> appear in directory listings until the directory
cache expires.</p>
<p>Note that some backends won't create metadata unless you pass in the
<code>--metadata</code> flag.</p>
<p>For example, using <code>rclone mount</code> with
<code>--metadata --vfs-metadata-extension .metadata</code> we get</p>
<div class="sourceCode" id="cb499"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb499-1"><a href="#cb499-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb499-2"><a href="#cb499-2" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048577</span>
<span id="cb499-3"><a href="#cb499-3" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb499-4"><a href="#cb499-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb499-5"><a href="#cb499-5" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> cat /mnt/1G.metadata</span>
<span id="cb499-6"><a href="#cb499-6" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb499-7"><a href="#cb499-7" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;atime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-04T17:34:22.317069787Z&quot;</span>,</span>
<span id="cb499-8"><a href="#cb499-8" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;btime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:37.708253808Z&quot;</span>,</span>
<span id="cb499-9"><a href="#cb499-9" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;gid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span>,</span>
<span id="cb499-10"><a href="#cb499-10" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mode&quot;</span><span class="ex">:</span> <span class="st">&quot;100664&quot;</span>,</span>
<span id="cb499-11"><a href="#cb499-11" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mtime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:39.640238323Z&quot;</span>,</span>
<span id="cb499-12"><a href="#cb499-12" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;uid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span></span>
<span id="cb499-13"><a href="#cb499-13" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span>
<span id="cb499-14"><a href="#cb499-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb499-15"><a href="#cb499-15" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb499-16"><a href="#cb499-16" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048578</span>
<span id="cb499-17"><a href="#cb499-17" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb499-18"><a href="#cb499-18" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user        185 Mar  3 16:03 1G.metadata</span></code></pre></div>
<p>If the file has no metadata it will be returned as <code>{}</code>
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<pre><code>rclone serve nfs remote:path [flags]</code></pre>
<h2 id="options-76">Options</h2>
<pre><code>      --addr string                            IPaddress:Port or :Port to bind server to
      --dir-cache-time Duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 777)
      --file-perms FileMode                    File permissions (default 666)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for nfs
      --link-perms FileMode                    Link permissions (default 666)
      --nfs-cache-dir string                   The directory the NFS handle cache will use if set
      --nfs-cache-handle-limit int             max file handles cached simultaneously (min 5) (default 1000000)
      --nfs-cache-type memory|disk|symlink     Type of NFS handle cache to use (default memory)
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --poll-interval Duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask FileMode                         Override the permission bits set by the filesystem (not supported on Windows) (default 002)
      --vfs-block-norm-dupes                   If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
      --vfs-cache-max-age Duration             Max time since last access of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-min-free-space SizeSuffix    Target minimum free space on the disk containing the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval Duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-links                              Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
      --vfs-metadata-extension string          Set the extension to read metadata from
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-chunk-streams int             The number of parallel streams to read at once
      --vfs-read-wait Duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-refresh                            Refreshes the directory cache recursively in the background on start
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back Duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait Duration                Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-28">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h2 id="see-also-76">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-restic">rclone serve restic</h1>
<p>Serve the remote for restic's REST API.</p>
<h2 id="synopsis-70">Synopsis</h2>
<p>Run a basic web server to serve a remote over restic's REST backend
API over HTTP. This allows restic to use rclone as a data storage
mechanism for cloud providers that restic does not support directly.</p>
<p><a href="https://restic.net/">Restic</a> is a command-line program
for doing backups.</p>
<p>The server will log errors. Use -v to see access logs.</p>
<p><code>--bwlimit</code> will be respected for file transfers. Use
<code>--stats</code> to control the stats printing.</p>
<h2 id="setting-up-rclone-for-use-by-restic">Setting up rclone for use
by restic</h2>
<p>First <a href="https://rclone.org/docs/#configure">set up a remote
for your chosen cloud provider</a>.</p>
<p>Once you have set up the remote, check it is working with, for
example "rclone lsd remote:". You may have called the remote something
other than "remote:" - just substitute whatever you called it in the
following instructions.</p>
<p>Now start the rclone restic server</p>
<div class="sourceCode" id="cb503"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb503-1"><a href="#cb503-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> serve restic <span class="at">-v</span> remote:backup</span></code></pre></div>
<p>Where you can replace "backup" in the above by whatever path in the
remote you wish to use.</p>
<p>By default this will serve on "localhost:8080" you can change this
with use of the <code>--addr</code> flag.</p>
<p>You might wish to start this server on boot.</p>
<p>Adding <code>--cache-objects=false</code> will cause rclone to stop
caching objects returned from the List call. Caching is normally
desirable as it speeds up downloading objects, saves transactions and
uses very little memory.</p>
<h2 id="setting-up-restic-to-use-rclone">Setting up restic to use
rclone</h2>
<p>Now you can <a
href="http://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server">follow
the restic instructions</a> on setting up restic.</p>
<p>Note that you will need restic 0.8.2 or later to interoperate with
rclone.</p>
<p>For the example above you will want to use "http://localhost:8080/"
as the URL for the REST server.</p>
<p>For example:</p>
<div class="sourceCode" id="cb504"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb504-1"><a href="#cb504-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> export RESTIC_REPOSITORY=rest:http://localhost:8080/</span>
<span id="cb504-2"><a href="#cb504-2" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> export RESTIC_PASSWORD=yourpassword</span>
<span id="cb504-3"><a href="#cb504-3" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> restic init</span>
<span id="cb504-4"><a href="#cb504-4" aria-hidden="true" tabindex="-1"></a><span class="ex">created</span> restic backend 8b1a4b56ae at rest:http://localhost:8080/</span>
<span id="cb504-5"><a href="#cb504-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb504-6"><a href="#cb504-6" aria-hidden="true" tabindex="-1"></a><span class="ex">Please</span> note that knowledge of your password is required to access</span>
<span id="cb504-7"><a href="#cb504-7" aria-hidden="true" tabindex="-1"></a><span class="ex">the</span> repository. Losing your password means that your data is</span>
<span id="cb504-8"><a href="#cb504-8" aria-hidden="true" tabindex="-1"></a><span class="ex">irrecoverably</span> lost.</span>
<span id="cb504-9"><a href="#cb504-9" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> restic backup /path/to/files/to/backup</span>
<span id="cb504-10"><a href="#cb504-10" aria-hidden="true" tabindex="-1"></a><span class="ex">scan</span> <span class="pp">[</span><span class="ss">/path/to/files/to/backup</span><span class="pp">]</span></span>
<span id="cb504-11"><a href="#cb504-11" aria-hidden="true" tabindex="-1"></a><span class="ex">scanned</span> 189 directories, 312 files in 0:00</span>
<span id="cb504-12"><a href="#cb504-12" aria-hidden="true" tabindex="-1"></a><span class="ex">[0:00]</span> 100.00%  38.128 MiB / 38.128 MiB  501 / 501 items  0 errors  ETA 0:00</span>
<span id="cb504-13"><a href="#cb504-13" aria-hidden="true" tabindex="-1"></a><span class="ex">duration:</span> 0:00</span>
<span id="cb504-14"><a href="#cb504-14" aria-hidden="true" tabindex="-1"></a><span class="ex">snapshot</span> 45c8fdd8 saved</span></code></pre></div>
<h3 id="multiple-repositories">Multiple repositories</h3>
<p>Note that you can use the endpoint to host multiple repositories. Do
this by adding a directory name or path after the URL. Note that these
<strong>must</strong> end with /. Eg</p>
<div class="sourceCode" id="cb505"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb505-1"><a href="#cb505-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> export RESTIC_REPOSITORY=rest:http://localhost:8080/user1repo/</span>
<span id="cb505-2"><a href="#cb505-2" aria-hidden="true" tabindex="-1"></a><span class="co"># backup user1 stuff</span></span>
<span id="cb505-3"><a href="#cb505-3" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/</span>
<span id="cb505-4"><a href="#cb505-4" aria-hidden="true" tabindex="-1"></a><span class="co"># backup user2 stuff</span></span></code></pre></div>
<h3 id="private-repositories">Private repositories</h3>
<p>The<code>--private-repos</code> flag can be used to limit users to
repositories starting with a path of
<code>/&lt;username&gt;/</code>.</p>
<h2 id="server-options-4">Server options</h2>
<p>Use <code>--addr</code> to specify which IP address and port the
server should listen on, eg <code>--addr 1.2.3.4:8000</code> or
<code>--addr :8080</code> to listen to all IPs. By default it only
listens on localhost. You can use port :0 to let the OS choose an
available port.</p>
<p>If you set <code>--addr</code> to listen on a public or LAN
accessible IP address then using Authentication is advised - see the
next section for info.</p>
<p>You can use a unix socket by setting the url to
<code>unix:///path/to/socket</code> or just by using an absolute path
name.</p>
<p><code>--addr</code> may be repeated to listen on multiple
IPs/ports/sockets. Socket activation, described further below, can also
be used to accomplish the same.</p>
<p><code>--server-read-timeout</code> and
<code>--server-write-timeout</code> can be used to control the timeouts
on the server. Note that this is the total time for a transfer.</p>
<p><code>--max-header-bytes</code> controls the maximum number of bytes
the server will accept in the HTTP header.</p>
<p><code>--baseurl</code> controls the URL prefix that rclone serves
from. By default rclone will serve from the root. If you used
<code>--baseurl "/rclone"</code> then rclone would serve from a URL
starting with "/rclone/". This is useful if you wish to proxy rclone
serve. Rclone automatically inserts leading and trailing "/" on
<code>--baseurl</code>, so <code>--baseurl "rclone"</code>,
<code>--baseurl "/rclone"</code> and <code>--baseurl "/rclone/"</code>
are all treated identically.</p>
<h3 id="tls-ssl-2">TLS (SSL)</h3>
<p>By default this will serve over http. If you want you can serve over
https. You will need to supply the <code>--cert</code> and
<code>--key</code> flags. If you wish to do client side certificate
validation then you will need to supply <code>--client-ca</code>
also.</p>
<p><code>--cert</code> must be set to the path of a file containing
either a PEM encoded certificate, or a concatenation of that with the CA
certificate. <code>--key</code> must be set to the path of a file with
the PEM encoded private key. If setting <code>--client-ca</code>, it
should be set to the path of a file with PEM encoded client certificate
authority certificates.</p>
<p><code>--min-tls-version</code> is minimum TLS version that is
acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3"
(default "tls1.0").</p>
<h2 id="socket-activation-2">Socket activation</h2>
<p>Instead of the listening addresses specified above, rclone will
listen to all FDs passed by the service manager, if any (and ignore any
arguments passed by <code>--addr</code>).</p>
<p>This allows rclone to be a socket-activated service. It can be
configured with .socket and .service unit files as described in <a
href="https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html"
class="uri">https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html</a>.</p>
<p>Socket activation can be tested ad-hoc with the
<code>systemd-socket-activate</code>command</p>
<div class="sourceCode" id="cb506"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb506-1"><a href="#cb506-1" aria-hidden="true" tabindex="-1"></a><span class="ex">systemd-socket-activate</span> <span class="at">-l</span> 8000 <span class="at">--</span> rclone serve</span></code></pre></div>
<p>This will socket-activate rclone on the first connection to port 8000
over TCP.</p>
<h3 id="authentication-3">Authentication</h3>
<p>By default this will serve files without needing a login.</p>
<p>You can either use an htpasswd file which can take lots of users, or
set a single username and password with the <code>--user</code> and
<code>--pass</code> flags.</p>
<p>Alternatively, you can have the reverse proxy manage authentication
and use the username provided in the configured header with
<code>--user-from-header</code> (e.g.,
<code>--user-from-header=x-remote-user</code>). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.</p>
<p>If either of the above authentication methods is not configured and
client certificates are required by the <code>--client-ca</code> flag
passed to the server, the client certificate common name will be
considered as the username.</p>
<p>Use <code>--htpasswd /path/to/htpasswd</code> to provide an htpasswd
file. This is in standard apache format and supports MD5, SHA1 and
BCrypt for basic authentication. Bcrypt is recommended.</p>
<p>To create an htpasswd file:</p>
<div class="sourceCode" id="cb507"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb507-1"><a href="#cb507-1" aria-hidden="true" tabindex="-1"></a><span class="fu">touch</span> htpasswd</span>
<span id="cb507-2"><a href="#cb507-2" aria-hidden="true" tabindex="-1"></a><span class="ex">htpasswd</span> <span class="at">-B</span> htpasswd user</span>
<span id="cb507-3"><a href="#cb507-3" aria-hidden="true" tabindex="-1"></a><span class="ex">htpasswd</span> <span class="at">-B</span> htpasswd anotherUser</span></code></pre></div>
<p>The password file can be updated while rclone is running.</p>
<p>Use <code>--realm</code> to set the authentication realm.</p>
<p>Use <code>--salt</code> to change the password hashing salt from the
default.</p>
<pre><code>rclone serve restic remote:path [flags]</code></pre>
<h2 id="options-77">Options</h2>
<pre><code>      --addr stringArray                IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080)
      --allow-origin string             Origin which cross-domain request (CORS) can be executed from
      --append-only                     Disallow deletion of repository data
      --baseurl string                  Prefix for URLs - leave blank for root
      --cache-objects                   Cache listed objects (default true)
      --cert string                     TLS PEM key (concatenation of certificate and CA certificate)
      --client-ca string                Client certificate authority to verify clients with
  -h, --help                            help for restic
      --htpasswd string                 A htpasswd file - if not provided no authentication is done
      --key string                      TLS PEM Private key
      --max-header-bytes int            Maximum size of request header (default 4096)
      --min-tls-version string          Minimum TLS version that is acceptable (default &quot;tls1.0&quot;)
      --pass string                     Password for authentication
      --private-repos                   Users can only access their private repo
      --realm string                    Realm for authentication
      --salt string                     Password hashing salt (default &quot;dlPL2MqE&quot;)
      --server-read-timeout Duration    Timeout for server reading data (default 1h0m0s)
      --server-write-timeout Duration   Timeout for server writing data (default 1h0m0s)
      --stdio                           Run an HTTP2 server on stdin/stdout
      --user string                     User name for authentication
      --user-from-header string         User name from a defined HTTP header</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-77">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-s3">rclone serve s3</h1>
<p>Serve remote:path over s3.</p>
<h2 id="synopsis-71">Synopsis</h2>
<p><code>serve s3</code> implements a basic s3 server that serves a
remote via s3. This can be viewed with an s3 client, or you can make an
<a href="https://rclone.org/s3/">s3 type remote</a> to read and write to
it with rclone.</p>
<p><code>serve s3</code> is considered <strong>Experimental</strong> so
use with care.</p>
<p>S3 server supports Signature Version 4 authentication. Just use
<code>--auth-key accessKey,secretKey</code> and set the
<code>Authorization</code> header correctly in the request. (See the <a
href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">AWS
docs</a>).</p>
<p><code>--auth-key</code> can be repeated for multiple auth pairs. If
<code>--auth-key</code> is not provided then <code>serve s3</code> will
allow anonymous access.</p>
<p>Please note that some clients may require HTTPS endpoints. See <a
href="#tls-ssl">the SSL docs</a> for more information.</p>
<p>This command uses the <a href="#vfs-virtual-file-system">VFS
directory cache</a>. All the functionality will work with
<code>--vfs-cache-mode off</code>. Using
<code>--vfs-cache-mode full</code> (or <code>writes</code>) can be used
to cache objects locally to improve performance.</p>
<p>Use <code>--force-path-style=false</code> if you want to use the
bucket name as a part of the hostname (such as mybucket.local)</p>
<p>Use <code>--etag-hash</code> if you want to change the hash uses for
the <code>ETag</code>. Note that using anything other than
<code>MD5</code> (the default) is likely to cause problems for S3
clients which rely on the Etag being the MD5.</p>
<h2 id="quickstart-1">Quickstart</h2>
<p>For a simple set up, to serve <code>remote:path</code> over s3, run
the server like this:</p>
<div class="sourceCode" id="cb510"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb510-1"><a href="#cb510-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> serve s3 <span class="at">--auth-key</span> ACCESS_KEY_ID,SECRET_ACCESS_KEY remote:path</span></code></pre></div>
<p>For example, to use a simple folder in the filesystem, run the server
with a command like this:</p>
<div class="sourceCode" id="cb511"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb511-1"><a href="#cb511-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> serve s3 <span class="at">--auth-key</span> ACCESS_KEY_ID,SECRET_ACCESS_KEY local:/path/to/folder</span></code></pre></div>
<p>The <code>rclone.conf</code> for the server could look like this:</p>
<div class="sourceCode" id="cb512"><pre
class="sourceCode ini"><code class="sourceCode ini"><span id="cb512-1"><a href="#cb512-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[local]</span></span>
<span id="cb512-2"><a href="#cb512-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> local</span></span></code></pre></div>
<p>The <code>local</code> configuration is optional though. If you run
the server with a <code>remote:path</code> like
<code>/path/to/folder</code> (without the <code>local:</code> prefix and
without an <code>rclone.conf</code> file), rclone will fall back to a
default configuration, which will be visible as a warning in the logs.
But it will run nonetheless.</p>
<p>This will be compatible with an rclone (client) remote configuration
which is defined like this:</p>
<div class="sourceCode" id="cb513"><pre
class="sourceCode ini"><code class="sourceCode ini"><span id="cb513-1"><a href="#cb513-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[serves3]</span></span>
<span id="cb513-2"><a href="#cb513-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
<span id="cb513-3"><a href="#cb513-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Rclone</span></span>
<span id="cb513-4"><a href="#cb513-4" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> http://127.0.0.1:8080/</span></span>
<span id="cb513-5"><a href="#cb513-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY_ID</span></span>
<span id="cb513-6"><a href="#cb513-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
<span id="cb513-7"><a href="#cb513-7" aria-hidden="true" tabindex="-1"></a><span class="dt">use_multipart_uploads </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span></code></pre></div>
<p>Note that setting <code>use_multipart_uploads = false</code> is to
work around <a href="#bugs">a bug</a> which will be fixed in due
course.</p>
<h2 id="bugs">Bugs</h2>
<p>When uploading multipart files <code>serve s3</code> holds all the
parts in memory (see <a
href="https://github.com/rclone/rclone/issues/7453">#7453</a>). This is
a limitaton of the library rclone uses for serving S3 and will hopefully
be fixed at some point.</p>
<p>Multipart server side copies do not work (see <a
href="https://github.com/rclone/rclone/issues/7454">#7454</a>). These
take a very long time and eventually fail. The default threshold for
multipart server side copies is 5G which is the maximum it can be, so
files above this side will fail to be server side copied.</p>
<p>For a current list of <code>serve s3</code> bugs see the <a
href="https://github.com/rclone/rclone/labels/serve%20s3">serve s3</a>
bug category on GitHub.</p>
<h2 id="limitations-2">Limitations</h2>
<p><code>serve s3</code> will treat all directories in the root as
buckets and ignore all files in the root. You can use
<code>CreateBucket</code> to create folders under the root, but you
can't create empty folders under other folders not in the root.</p>
<p>When using <code>PutObject</code> or <code>DeleteObject</code>,
rclone will automatically create or clean up empty folders. If you don't
want to clean up empty folders automatically, use
<code>--no-cleanup</code>.</p>
<p>When using <code>ListObjects</code>, rclone will use <code>/</code>
when the delimiter is empty. This reduces backend requests with no
effect on most operations, but if the delimiter is something other than
<code>/</code> and empty, rclone will do a full recursive search of the
backend, which can take some time.</p>
<p>Versioning is not currently supported.</p>
<p>Metadata will only be saved in memory other than the rclone
<code>mtime</code> metadata which will be set as the modification time
of the file.</p>
<h2 id="supported-operations">Supported operations</h2>
<p><code>serve s3</code> currently supports the following
operations.</p>
<ul>
<li>Bucket
<ul>
<li><code>ListBuckets</code></li>
<li><code>CreateBucket</code></li>
<li><code>DeleteBucket</code></li>
</ul></li>
<li>Object
<ul>
<li><code>HeadObject</code></li>
<li><code>ListObjects</code></li>
<li><code>GetObject</code></li>
<li><code>PutObject</code></li>
<li><code>DeleteObject</code></li>
<li><code>DeleteObjects</code></li>
<li><code>CreateMultipartUpload</code></li>
<li><code>CompleteMultipartUpload</code></li>
<li><code>AbortMultipartUpload</code></li>
<li><code>CopyObject</code></li>
<li><code>UploadPart</code></li>
</ul></li>
</ul>
<p>Other operations will return error <code>Unimplemented</code>.</p>
<h3 id="authentication-4">Authentication</h3>
<p>By default this will serve files without needing a login.</p>
<p>You can either use an htpasswd file which can take lots of users, or
set a single username and password with the <code>--user</code> and
<code>--pass</code> flags.</p>
<p>Alternatively, you can have the reverse proxy manage authentication
and use the username provided in the configured header with
<code>--user-from-header</code> (e.g.,
<code>--user-from-header=x-remote-user</code>). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.</p>
<p>If either of the above authentication methods is not configured and
client certificates are required by the <code>--client-ca</code> flag
passed to the server, the client certificate common name will be
considered as the username.</p>
<p>Use <code>--htpasswd /path/to/htpasswd</code> to provide an htpasswd
file. This is in standard apache format and supports MD5, SHA1 and
BCrypt for basic authentication. Bcrypt is recommended.</p>
<p>To create an htpasswd file:</p>
<div class="sourceCode" id="cb514"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb514-1"><a href="#cb514-1" aria-hidden="true" tabindex="-1"></a><span class="fu">touch</span> htpasswd</span>
<span id="cb514-2"><a href="#cb514-2" aria-hidden="true" tabindex="-1"></a><span class="ex">htpasswd</span> <span class="at">-B</span> htpasswd user</span>
<span id="cb514-3"><a href="#cb514-3" aria-hidden="true" tabindex="-1"></a><span class="ex">htpasswd</span> <span class="at">-B</span> htpasswd anotherUser</span></code></pre></div>
<p>The password file can be updated while rclone is running.</p>
<p>Use <code>--realm</code> to set the authentication realm.</p>
<p>Use <code>--salt</code> to change the password hashing salt from the
default.</p>
<h2 id="server-options-5">Server options</h2>
<p>Use <code>--addr</code> to specify which IP address and port the
server should listen on, eg <code>--addr 1.2.3.4:8000</code> or
<code>--addr :8080</code> to listen to all IPs. By default it only
listens on localhost. You can use port :0 to let the OS choose an
available port.</p>
<p>If you set <code>--addr</code> to listen on a public or LAN
accessible IP address then using Authentication is advised - see the
next section for info.</p>
<p>You can use a unix socket by setting the url to
<code>unix:///path/to/socket</code> or just by using an absolute path
name.</p>
<p><code>--addr</code> may be repeated to listen on multiple
IPs/ports/sockets. Socket activation, described further below, can also
be used to accomplish the same.</p>
<p><code>--server-read-timeout</code> and
<code>--server-write-timeout</code> can be used to control the timeouts
on the server. Note that this is the total time for a transfer.</p>
<p><code>--max-header-bytes</code> controls the maximum number of bytes
the server will accept in the HTTP header.</p>
<p><code>--baseurl</code> controls the URL prefix that rclone serves
from. By default rclone will serve from the root. If you used
<code>--baseurl "/rclone"</code> then rclone would serve from a URL
starting with "/rclone/". This is useful if you wish to proxy rclone
serve. Rclone automatically inserts leading and trailing "/" on
<code>--baseurl</code>, so <code>--baseurl "rclone"</code>,
<code>--baseurl "/rclone"</code> and <code>--baseurl "/rclone/"</code>
are all treated identically.</p>
<h3 id="tls-ssl-3">TLS (SSL)</h3>
<p>By default this will serve over http. If you want you can serve over
https. You will need to supply the <code>--cert</code> and
<code>--key</code> flags. If you wish to do client side certificate
validation then you will need to supply <code>--client-ca</code>
also.</p>
<p><code>--cert</code> must be set to the path of a file containing
either a PEM encoded certificate, or a concatenation of that with the CA
certificate. <code>--key</code> must be set to the path of a file with
the PEM encoded private key. If setting <code>--client-ca</code>, it
should be set to the path of a file with PEM encoded client certificate
authority certificates.</p>
<p><code>--min-tls-version</code> is minimum TLS version that is
acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3"
(default "tls1.0").</p>
<h2 id="socket-activation-3">Socket activation</h2>
<p>Instead of the listening addresses specified above, rclone will
listen to all FDs passed by the service manager, if any (and ignore any
arguments passed by <code>--addr</code>).</p>
<p>This allows rclone to be a socket-activated service. It can be
configured with .socket and .service unit files as described in <a
href="https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html"
class="uri">https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html</a>.</p>
<p>Socket activation can be tested ad-hoc with the
<code>systemd-socket-activate</code>command</p>
<div class="sourceCode" id="cb515"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb515-1"><a href="#cb515-1" aria-hidden="true" tabindex="-1"></a><span class="ex">systemd-socket-activate</span> <span class="at">-l</span> 8000 <span class="at">--</span> rclone serve</span></code></pre></div>
<p>This will socket-activate rclone on the first connection to port 8000
over TCP.</p>
<h2 id="vfs---virtual-file-system-7">VFS - Virtual File System</h2>
<p>This command uses the VFS layer. This adapts the cloud storage
objects that rclone uses into something which looks much more like a
disk filing system.</p>
<p>Cloud storage objects have lots of properties which aren't like disk
files - you can't extend them or write to the middle of them, so the VFS
layer has to deal with that. Because there is no one right way of doing
this there are various options explained below.</p>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-7">VFS Directory Cache</h2>
<p>Using the <code>--dir-cache-time</code> flag, you can control how
long a directory should be considered up to date and not refreshed from
the backend. Changes made through the VFS will appear immediately or
invalidate the cache.</p>
<pre class="text"><code>    --dir-cache-time duration   Time to cache directory entries for (default 5m0s)
    --poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<p>However, changes made directly on the cloud storage by the web
interface or a different copy of rclone will only be picked up once the
directory cache expires if the backend configured does not support
polling for changes. If the backend supports polling, changes will be
picked up within the polling interval.</p>
<p>You can send a <code>SIGHUP</code> signal to rclone for it to flush
all directory caches, regardless of how old they are. Assuming only one
rclone instance is running, you can reset the cache like this:</p>
<div class="sourceCode" id="cb517"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb517-1"><a href="#cb517-1" aria-hidden="true" tabindex="-1"></a><span class="bu">kill</span> <span class="at">-SIGHUP</span> <span class="va">$(</span><span class="fu">pidof</span> rclone<span class="va">)</span></span></code></pre></div>
<p>If you configure rclone with a <a href="/rc">remote control</a> then
you can use rclone rc to flush the whole directory cache:</p>
<div class="sourceCode" id="cb518"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb518-1"><a href="#cb518-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget</span></code></pre></div>
<p>Or individual files or directories:</p>
<div class="sourceCode" id="cb519"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb519-1"><a href="#cb519-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget file=path/to/file dir=path/to/dir</span></code></pre></div>
<h2 id="vfs-file-buffering-7">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<p>Each open file will try to keep the specified amount of data in
memory at all times. The buffered data is bound to one open file and
won't be shared.</p>
<p>This flag is a upper limit for the used memory per open file. The
buffer will only use memory for data that is downloaded but not not yet
read. If the buffer is empty, only a small amount of memory will be
used.</p>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-7">VFS File Caching</h2>
<p>These flags control the VFS file caching options. File caching is
necessary to make the VFS layer appear compatible with a normal file
system. It can be disabled at the cost of some compatibility.</p>
<p>For example you'll need to enable VFS caching if you want to read and
write simultaneously to a file. See below for more details.</p>
<p>Note that the VFS cache is separate from the cache backend and you
may find that you need one or the other or both.</p>
<pre class="text"><code>    --cache-dir string                     Directory rclone will use for caching.
    --vfs-cache-mode CacheMode             Cache mode off|minimal|writes|full (default off)
    --vfs-cache-max-age duration           Max time since last access of objects in the cache (default 1h0m0s)
    --vfs-cache-max-size SizeSuffix        Max total size of objects in the cache (default off)
    --vfs-cache-min-free-space SizeSuffix  Target minimum free space on the disk containing the cache (default off)
    --vfs-cache-poll-interval duration     Interval to poll the cache for stale objects (default 1m0s)
    --vfs-write-back duration              Time to writeback files after last use when using cache (default 5s)</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the
file cache. The files are stored in the user cache file area which is OS
dependent but can be controlled with <code>--cache-dir</code> or setting
the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by
<code>--vfs-cache-mode</code>. The higher the cache mode the more
compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are
closed and if they haven't been accessed for
<code>--vfs-write-back</code> seconds. If rclone is quit or dies with
files that haven't been uploaded, these will be uploaded next time
rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or
<code>--vfs-cache-min-free-space</code> note that the cache may exceed
these quotas for two reasons. Firstly because it is only checked every
<code>--vfs-cache-poll-interval</code>. Secondly because open files
cannot be evicted from the cache. When <code>--vfs-cache-max-size</code>
or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will
attempt to evict the least accessed files from the cache first. rclone
will start with files that haven't been accessed for the longest. This
cache flushing strategy is efficient and more relevant files are likely
to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache
after the set time since last access has passed. The default value of 1
hour will start evicting files from cache that haven't been accessed for
1 hour. When a cached file is accessed the 1 hour timer is reset to 0
and will wait for 1 more hour before evicting. Specify the time with
standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the
same VFS cache with the same or overlapping remotes if using
<code>--vfs-cache-mode &gt; off</code>. This can potentially cause data
corruption if you do. You can work around this by giving each rclone its
own cache hierarchy with <code>--cache-dir</code>. You don't need to
worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-7">--vfs-cache-mode off</h3>
<p>In this mode (the default) the cache will read directly from the
remote and write directly to the remote without caching anything on
disk.</p>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can't be opened for both read AND write</li>
<li>Files opened for write can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-7">--vfs-cache-mode minimal</h3>
<p>This is very similar to "off" except that files opened for read AND
write will be buffered to disk. This means that files opened for write
will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-7">--vfs-cache-mode writes</h3>
<p>In this mode files opened for read only are still read directly from
the remote, write only and read/write files are buffered to disk
first.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-7">--vfs-cache-mode full</h3>
<p>In this mode all reads and writes are buffered to and from disk. When
data is read from the remote this is buffered to disk as well.</p>
<p>In this mode the files in the cache will be sparse files and rclone
will keep track of which bits of the files it has downloaded.</p>
<p>So if an application only reads the starts of each file, then rclone
will only buffer the start of the file. These files will appear to be
their full size in the cache, but they will be sparse files with only
the data that has been downloaded present in them.</p>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<p>When reading a file rclone will read <code>--buffer-size</code> plus
<code>--vfs-read-ahead</code> bytes ahead. The
<code>--buffer-size</code> is buffered in memory whereas the
<code>--vfs-read-ahead</code> is buffered on disk.</p>
<p>When using this mode it is recommended that
<code>--buffer-size</code> is not set too large and
<code>--vfs-read-ahead</code> is set large if required.</p>
<p><strong>IMPORTANT</strong> not all file systems support sparse files.
In particular FAT/exFAT do not. Rclone will perform very badly if the
cache directory is on a filesystem which doesn't support sparse files
and it will log an ERROR message if one is detected.</p>
<h3 id="fingerprinting-7">Fingerprinting</h3>
<p>Various parts of the VFS use fingerprinting to see if a local file
copy has changed relative to a remote file. Fingerprints are made
from:</p>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<p>On some backends some of these attributes are slow to read (they take
an extra API call per object, or extra work per object).</p>
<p>For example <code>hash</code> is slow with the <code>local</code> and
<code>sftp</code> backends as they have to read the entire file and hash
it, and <code>modtime</code> is slow with the <code>s3</code>,
<code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends
because they need to do an extra API call to fetch it.</p>
<p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone
will not include the slow operations in the fingerprint. This makes the
fingerprinting less accurate but much faster and will improve the
opening time of cached files.</p>
<p>If you are running a vfs cache over <code>local</code>,
<code>s3</code> or <code>swift</code> backends then using this flag is
recommended.</p>
<p>Note that if you change the value of this flag, the fingerprints of
the files in the cache may be invalidated and the files will need to be
downloaded again.</p>
<h2 id="vfs-chunked-reading-7">VFS Chunked Reading</h2>
<p>When rclone reads files from a remote it reads them in chunks. This
means that rather than requesting the whole file rclone reads the chunk
specified. This can reduce the used download quota for some remotes by
requesting only chunks from the remote that are actually read, at the
cost of an increased number of requests.</p>
<p>These flags control the chunking:</p>
<pre class="text"><code>    --vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
    --vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)
    --vfs-read-chunk-streams int            The number of parallel streams to read at once</code></pre>
<p>The chunking behaves differently depending on the
<code>--vfs-read-chunk-streams</code> parameter.</p>
<h3
id="vfs-read-chunk-streams-0-14"><code>--vfs-read-chunk-streams</code>
== 0</h3>
<p>Rclone will start reading a chunk of size
<code>--vfs-read-chunk-size</code>, and then double the size for each
read. When <code>--vfs-read-chunk-size-limit</code> is specified, and
greater than <code>--vfs-read-chunk-size</code>, the chunk size for each
open file will get doubled only until the specified value is reached. If
the value is "off", which is the default, the limit is disabled and the
chunk size will grow indefinitely.</p>
<p>With <code>--vfs-read-chunk-size 100M</code> and
<code>--vfs-read-chunk-size-limit 0</code> the following parts will be
downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When
<code>--vfs-read-chunk-size-limit 500M</code> is specified, the result
would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so
on.</p>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off"
disables chunked reading.</p>
<p>The chunks will not be buffered in memory.</p>
<h3
id="vfs-read-chunk-streams-0-15"><code>--vfs-read-chunk-streams</code>
&gt; 0</h3>
<p>Rclone reads <code>--vfs-read-chunk-streams</code> chunks of size
<code>--vfs-read-chunk-size</code> concurrently. The size for each read
will stay constant.</p>
<p>This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.</p>
<p>Some experimentation will be needed to find the optimum values of
<code>--vfs-read-chunk-size</code> and
<code>--vfs-read-chunk-streams</code> as these will depend on the
backend in use and the latency to the backend.</p>
<p>For high performance object stores (eg AWS S3) a reasonable place to
start might be <code>--vfs-read-chunk-streams 16</code> and
<code>--vfs-read-chunk-size 4M</code>. In testing with AWS S3 the
performance scaled roughly as the <code>--vfs-read-chunk-streams</code>
setting.</p>
<p>Similar settings should work for high latency links, but depending on
the latency they may need more <code>--vfs-read-chunk-streams</code> in
order to get the throughput.</p>
<h2 id="vfs-performance-7">VFS Performance</h2>
<p>These flags may be used to enable/disable features of the VFS for
performance or other reasons. See also the <a
href="#vfs-chunked-reading">chunked reading</a> feature.</p>
<p>In particular S3 and Swift benefit hugely from the
<code>--no-modtime</code> flag (or use <code>--use-server-modtime</code>
for a slightly different effect) as each read of the modification time
takes a transaction.</p>
<pre class="text"><code>    --no-checksum     Don&#39;t compare checksums on up/download.
    --no-modtime      Don&#39;t read/write the modification time (can speed things up).
    --no-seek         Don&#39;t allow seeking in files.
    --read-only       Only allow read-only access.</code></pre>
<p>Sometimes rclone is delivered reads or writes out of order. Rather
than seeking rclone will wait a short time for the in sequence read or
write to come in. These flags only come into effect when not using an on
disk cache file.</p>
<pre class="text"><code>    --vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
    --vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>When using VFS write caching (<code>--vfs-cache-mode</code> with
value writes or full), the global flag <code>--transfers</code> can be
set to adjust the number of parallel uploads of modified files from the
cache (the related global flag <code>--checkers</code> has no effect on
the VFS).</p>
<pre class="text"><code>    --transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="symlinks-7">Symlinks</h2>
<p>By default the VFS does not support symlinks. However this may be
enabled with either of the following flags:</p>
<pre class="text"><code>    --links      Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension.
    --vfs-links  Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS</code></pre>
<p>As most cloud storage systems do not support symlinks directly,
rclone stores the symlink as a normal file with a special extension. So
a file which appears as a symlink <code>link-to-file.txt</code> would be
stored on cloud storage as <code>link-to-file.txt.rclonelink</code> and
the contents would be the path to the symlink destination.</p>
<p>Note that <code>--links</code> enables symlink translation globally
in rclone - this includes any backend which supports the concept (for
example the local backend). <code>--vfs-links</code> just enables it for
the VFS layer.</p>
<p>This scheme is compatible with that used by the <a
href="https://rclone.org/local/#symlinks-junction-points">local backend
with the --local-links flag</a>.</p>
<p>The <code>--vfs-links</code> flag has been designed for
<code>rclone mount</code>, <code>rclone nfsmount</code> and
<code>rclone serve nfs</code>.</p>
<p>It hasn't been tested with the other <code>rclone serve</code>
commands yet.</p>
<p>A limitation of the current implementation is that it expects the
caller to resolve sub-symlinks. For example given this directory
tree</p>
<pre class="text"><code>.
├── dir
│   └── file.txt
└── linked-dir -&gt; dir</code></pre>
<p>The VFS will correctly resolve <code>linked-dir</code> but not
<code>linked-dir/file.txt</code>. This is not a problem for the tested
commands but may be for other commands.</p>
<p><strong>Note</strong> that there is an outstanding issue with symlink
support <a href="https://github.com/rclone/rclone/issues/8245">issue
#8245</a> with duplicate files being created when symlinks are moved
into directories where there is a file of the same name (or vice
versa).</p>
<h2 id="vfs-case-sensitivity-7">VFS Case Sensitivity</h2>
<p>Linux file systems are case-sensitive: two files can differ only by
case, and the exact case must be used when opening a file.</p>
<p>File systems in modern Windows are case-insensitive but
case-preserving: although existing files can be opened using any case,
the exact case used to create the file is preserved and available for
programs to query. It is not allowed for two files in the same directory
to differ only by case.</p>
<p>Usually file systems on macOS are case-insensitive. It is possible to
make macOS file systems case-sensitive but that is not the default.</p>
<p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone
handles these two cases. If its value is "false", rclone passes file
names to the remote as-is. If the flag is "true" (or appears without a
value on the command line), rclone may perform a "fixup" as explained
below.</p>
<p>The user may specify a file name to open/delete/rename/etc with a
case different than what is stored on the remote. If an argument refers
to an existing file with exactly the same name, then the case of the
existing file on the disk will be used. However, if a file name with
exactly the same name is not found but a name differing only by case
exists, rclone will transparently fixup the name. This fixup happens
only when an existing file is requested. Case sensitivity of file names
created anew by rclone is controlled by the underlying remote.</p>
<p>Note that case sensitivity of the operating system running rclone
(the target) may differ from case sensitivity of a file system presented
by rclone (the source). The flag controls whether "fixup" is performed
to satisfy the target.</p>
<p>If the flag is not provided on the command line, then its default
value depends on the operating system where rclone runs: "true" on
Windows and macOS, "false" otherwise. If the flag is provided without a
value, then it is "true".</p>
<p>The <code>--no-unicode-normalization</code> flag controls whether a
similar "fixup" is performed for filenames that differ but are <a
href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically
equivalent</a> with respect to unicode. Unicode normalization can be
particularly helpful for users of macOS, which prefers form NFD instead
of the NFC used by most other platforms. It is therefore highly
recommended to keep the default of <code>false</code> on macOS, to avoid
encoding compatibility issues.</p>
<p>In the (probably unlikely) event that a directory has multiple
duplicate filenames after applying case and unicode normalization, the
<code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates.
This comes with a performance tradeoff, as rclone will have to scan the
entire directory for duplicates when listing a directory. For this
reason, it is recommended to leave this disabled if not needed. However,
macOS users may wish to consider using it, as otherwise, if a remote
directory contains both NFC and NFD versions of the same filename, an
odd situation will occur: both versions of the file will be visible in
the mount, and both will appear to be editable, however, editing either
version will actually result in only the NFD version getting edited
under the hood. <code>--vfs-block- norm-dupes</code> prevents this
confusion by detecting this scenario, hiding the duplicates, and logging
an error, similar to how this is handled in
<code>rclone sync</code>.</p>
<h2 id="vfs-disk-options-7">VFS Disk Options</h2>
<p>This flag allows you to manually set the statistics about the filing
system. It can be useful when those statistics cannot be read correctly
automatically.</p>
<pre class="text"><code>    --vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-7">Alternate report of used
bytes</h2>
<p>Some backends, most notably S3, do not report the amount of bytes
used. If you need this information to be available when running
<code>df</code> on the filesystem, then pass the flag
<code>--vfs-used-is-size</code> to rclone. With this flag set, instead
of relying on the backend to report this information, rclone will scan
the whole remote similar to <code>rclone size</code> and compute the
total used space itself.</p>
<p><strong>WARNING</strong>: Contrary to <code>rclone size</code>, this
flag ignores filters so that the result is accurate. However, this is
very inefficient and may cost lots of API calls resulting in extra
charges. Use it as a last resort and only with caching.</p>
<h2 id="vfs-metadata-7">VFS Metadata</h2>
<p>If you use the <code>--vfs-metadata-extension</code> flag you can get
the VFS to expose files which contain the <a
href="https://rclone.org/docs/#metadata">metadata</a> as a JSON blob.
These files will not appear in the directory listing, but can be
<code>stat</code>-ed and opened and once they have been they
<strong>will</strong> appear in directory listings until the directory
cache expires.</p>
<p>Note that some backends won't create metadata unless you pass in the
<code>--metadata</code> flag.</p>
<p>For example, using <code>rclone mount</code> with
<code>--metadata --vfs-metadata-extension .metadata</code> we get</p>
<div class="sourceCode" id="cb528"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb528-1"><a href="#cb528-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb528-2"><a href="#cb528-2" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048577</span>
<span id="cb528-3"><a href="#cb528-3" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb528-4"><a href="#cb528-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb528-5"><a href="#cb528-5" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> cat /mnt/1G.metadata</span>
<span id="cb528-6"><a href="#cb528-6" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb528-7"><a href="#cb528-7" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;atime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-04T17:34:22.317069787Z&quot;</span>,</span>
<span id="cb528-8"><a href="#cb528-8" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;btime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:37.708253808Z&quot;</span>,</span>
<span id="cb528-9"><a href="#cb528-9" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;gid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span>,</span>
<span id="cb528-10"><a href="#cb528-10" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mode&quot;</span><span class="ex">:</span> <span class="st">&quot;100664&quot;</span>,</span>
<span id="cb528-11"><a href="#cb528-11" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mtime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:39.640238323Z&quot;</span>,</span>
<span id="cb528-12"><a href="#cb528-12" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;uid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span></span>
<span id="cb528-13"><a href="#cb528-13" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span>
<span id="cb528-14"><a href="#cb528-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb528-15"><a href="#cb528-15" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb528-16"><a href="#cb528-16" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048578</span>
<span id="cb528-17"><a href="#cb528-17" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb528-18"><a href="#cb528-18" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user        185 Mar  3 16:03 1G.metadata</span></code></pre></div>
<p>If the file has no metadata it will be returned as <code>{}</code>
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<pre><code>rclone serve s3 remote:path [flags]</code></pre>
<h2 id="options-78">Options</h2>
<pre><code>      --addr stringArray                       IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080)
      --allow-origin string                    Origin which cross-domain request (CORS) can be executed from
      --auth-key stringArray                   Set key pair for v4 authorization: access_key_id,secret_access_key
      --auth-proxy string                      A program to use to create the backend from the auth
      --baseurl string                         Prefix for URLs - leave blank for root
      --cert string                            TLS PEM key (concatenation of certificate and CA certificate)
      --client-ca string                       Client certificate authority to verify clients with
      --dir-cache-time Duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 777)
      --etag-hash string                       Which hash to use for the ETag, or auto or blank for off (default &quot;MD5&quot;)
      --file-perms FileMode                    File permissions (default 666)
      --force-path-style                       If true use path style access if false use virtual hosted style (default true)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for s3
      --htpasswd string                        A htpasswd file - if not provided no authentication is done
      --key string                             TLS PEM Private key
      --link-perms FileMode                    Link permissions (default 666)
      --max-header-bytes int                   Maximum size of request header (default 4096)
      --min-tls-version string                 Minimum TLS version that is acceptable (default &quot;tls1.0&quot;)
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-cleanup                             Not to cleanup empty folder after object is deleted
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --pass string                            Password for authentication
      --poll-interval Duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --realm string                           Realm for authentication
      --salt string                            Password hashing salt (default &quot;dlPL2MqE&quot;)
      --server-read-timeout Duration           Timeout for server reading data (default 1h0m0s)
      --server-write-timeout Duration          Timeout for server writing data (default 1h0m0s)
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask FileMode                         Override the permission bits set by the filesystem (not supported on Windows) (default 002)
      --user string                            User name for authentication
      --user-from-header string                User name from a defined HTTP header
      --vfs-block-norm-dupes                   If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
      --vfs-cache-max-age Duration             Max time since last access of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-min-free-space SizeSuffix    Target minimum free space on the disk containing the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval Duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-links                              Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
      --vfs-metadata-extension string          Set the extension to read metadata from
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-chunk-streams int             The number of parallel streams to read at once
      --vfs-read-wait Duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-refresh                            Refreshes the directory cache recursively in the background on start
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back Duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait Duration                Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-29">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h2 id="see-also-78">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-sftp">rclone serve sftp</h1>
<p>Serve the remote over SFTP.</p>
<h2 id="synopsis-72">Synopsis</h2>
<p>Run an SFTP server to serve a remote over SFTP. This can be used with
an SFTP client or you can make a remote of type <a href="/sftp">sftp</a>
to use with it.</p>
<p>You can use the <a href="/filtering">filter</a> flags (e.g.
<code>--include</code>, <code>--exclude</code>) to control what is
served.</p>
<p>The server will respond to a small number of shell commands, mainly
md5sum, sha1sum and df, which enable it to provide support for checksums
and the about feature when accessed from an sftp remote.</p>
<p>Note that this server uses standard 32 KiB packet payload size, which
means you must not configure the client to expect anything else, e.g.
with the <a
href="https://rclone.org/sftp/#sftp-chunk-size">chunk_size</a> option on
an sftp remote.</p>
<p>The server will log errors. Use <code>-v</code> to see access
logs.</p>
<p><code>--bwlimit</code> will be respected for file transfers. Use
<code>--stats</code> to control the stats printing.</p>
<p>You must provide some means of authentication, either with
<code>--user</code>/<code>--pass</code>, an authorized keys file
(specify location with <code>--authorized-keys</code> - the default is
the same as ssh), an <code>--auth-proxy</code>, or set the
<code>--no-auth</code> flag for no authentication when logging in.</p>
<p>If you don't supply a host <code>--key</code> then rclone will
generate rsa, ecdsa and ed25519 variants, and cache them for later use
in rclone's cache directory (see
<code>rclone help flags cache-dir</code>) in the "serve-sftp"
directory.</p>
<p>By default the server binds to localhost:2022 - if you want it to be
reachable externally then supply <code>--addr :2022</code> for
example.</p>
<p>This also supports being run with socket activation, in which case it
will listen on the first passed FD. It can be configured with .socket
and .service unit files as described in <a
href="https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html"
class="uri">https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html</a>.</p>
<p>Socket activation can be tested ad-hoc with the
<code>systemd-socket-activate</code>command:</p>
<div class="sourceCode" id="cb532"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb532-1"><a href="#cb532-1" aria-hidden="true" tabindex="-1"></a><span class="ex">systemd-socket-activate</span> <span class="at">-l</span> 2222 <span class="at">--</span> rclone serve sftp :local:vfs/</span></code></pre></div>
<p>This will socket-activate rclone on the first connection to port 2222
over TCP.</p>
<p>Note that the default of <code>--vfs-cache-mode off</code> is fine
for the rclone sftp backend, but it may not be with other SFTP
clients.</p>
<p>If <code>--stdio</code> is specified, rclone will serve SFTP over
stdio, which can be used with sshd via ~/.ssh/authorized_keys, for
example:</p>
<pre class="text"><code>restrict,command=&quot;rclone serve sftp --stdio ./photos&quot; ssh-rsa ...</code></pre>
<p>On the client you need to set <code>--transfers 1</code> when using
<code>--stdio</code>. Otherwise multiple instances of the rclone server
are started by OpenSSH which can lead to "corrupted on transfer" errors.
This is the case because the client chooses indiscriminately which
server to send commands to while the servers all have different views of
the state of the filing system.</p>
<p>The "restrict" in authorized_keys prevents SHA1SUMs and MD5SUMs from
being used. Omitting "restrict" and using
<code>--sftp-path-override</code> to enable checksumming is possible but
less secure and you could use the SFTP server provided by OpenSSH in
this case.</p>
<h2 id="vfs---virtual-file-system-8">VFS - Virtual File System</h2>
<p>This command uses the VFS layer. This adapts the cloud storage
objects that rclone uses into something which looks much more like a
disk filing system.</p>
<p>Cloud storage objects have lots of properties which aren't like disk
files - you can't extend them or write to the middle of them, so the VFS
layer has to deal with that. Because there is no one right way of doing
this there are various options explained below.</p>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-8">VFS Directory Cache</h2>
<p>Using the <code>--dir-cache-time</code> flag, you can control how
long a directory should be considered up to date and not refreshed from
the backend. Changes made through the VFS will appear immediately or
invalidate the cache.</p>
<pre class="text"><code>    --dir-cache-time duration   Time to cache directory entries for (default 5m0s)
    --poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<p>However, changes made directly on the cloud storage by the web
interface or a different copy of rclone will only be picked up once the
directory cache expires if the backend configured does not support
polling for changes. If the backend supports polling, changes will be
picked up within the polling interval.</p>
<p>You can send a <code>SIGHUP</code> signal to rclone for it to flush
all directory caches, regardless of how old they are. Assuming only one
rclone instance is running, you can reset the cache like this:</p>
<div class="sourceCode" id="cb535"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb535-1"><a href="#cb535-1" aria-hidden="true" tabindex="-1"></a><span class="bu">kill</span> <span class="at">-SIGHUP</span> <span class="va">$(</span><span class="fu">pidof</span> rclone<span class="va">)</span></span></code></pre></div>
<p>If you configure rclone with a <a href="/rc">remote control</a> then
you can use rclone rc to flush the whole directory cache:</p>
<div class="sourceCode" id="cb536"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb536-1"><a href="#cb536-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget</span></code></pre></div>
<p>Or individual files or directories:</p>
<div class="sourceCode" id="cb537"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb537-1"><a href="#cb537-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget file=path/to/file dir=path/to/dir</span></code></pre></div>
<h2 id="vfs-file-buffering-8">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<p>Each open file will try to keep the specified amount of data in
memory at all times. The buffered data is bound to one open file and
won't be shared.</p>
<p>This flag is a upper limit for the used memory per open file. The
buffer will only use memory for data that is downloaded but not not yet
read. If the buffer is empty, only a small amount of memory will be
used.</p>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-8">VFS File Caching</h2>
<p>These flags control the VFS file caching options. File caching is
necessary to make the VFS layer appear compatible with a normal file
system. It can be disabled at the cost of some compatibility.</p>
<p>For example you'll need to enable VFS caching if you want to read and
write simultaneously to a file. See below for more details.</p>
<p>Note that the VFS cache is separate from the cache backend and you
may find that you need one or the other or both.</p>
<pre class="text"><code>    --cache-dir string                     Directory rclone will use for caching.
    --vfs-cache-mode CacheMode             Cache mode off|minimal|writes|full (default off)
    --vfs-cache-max-age duration           Max time since last access of objects in the cache (default 1h0m0s)
    --vfs-cache-max-size SizeSuffix        Max total size of objects in the cache (default off)
    --vfs-cache-min-free-space SizeSuffix  Target minimum free space on the disk containing the cache (default off)
    --vfs-cache-poll-interval duration     Interval to poll the cache for stale objects (default 1m0s)
    --vfs-write-back duration              Time to writeback files after last use when using cache (default 5s)</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the
file cache. The files are stored in the user cache file area which is OS
dependent but can be controlled with <code>--cache-dir</code> or setting
the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by
<code>--vfs-cache-mode</code>. The higher the cache mode the more
compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are
closed and if they haven't been accessed for
<code>--vfs-write-back</code> seconds. If rclone is quit or dies with
files that haven't been uploaded, these will be uploaded next time
rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or
<code>--vfs-cache-min-free-space</code> note that the cache may exceed
these quotas for two reasons. Firstly because it is only checked every
<code>--vfs-cache-poll-interval</code>. Secondly because open files
cannot be evicted from the cache. When <code>--vfs-cache-max-size</code>
or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will
attempt to evict the least accessed files from the cache first. rclone
will start with files that haven't been accessed for the longest. This
cache flushing strategy is efficient and more relevant files are likely
to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache
after the set time since last access has passed. The default value of 1
hour will start evicting files from cache that haven't been accessed for
1 hour. When a cached file is accessed the 1 hour timer is reset to 0
and will wait for 1 more hour before evicting. Specify the time with
standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the
same VFS cache with the same or overlapping remotes if using
<code>--vfs-cache-mode &gt; off</code>. This can potentially cause data
corruption if you do. You can work around this by giving each rclone its
own cache hierarchy with <code>--cache-dir</code>. You don't need to
worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-8">--vfs-cache-mode off</h3>
<p>In this mode (the default) the cache will read directly from the
remote and write directly to the remote without caching anything on
disk.</p>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can't be opened for both read AND write</li>
<li>Files opened for write can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-8">--vfs-cache-mode minimal</h3>
<p>This is very similar to "off" except that files opened for read AND
write will be buffered to disk. This means that files opened for write
will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-8">--vfs-cache-mode writes</h3>
<p>In this mode files opened for read only are still read directly from
the remote, write only and read/write files are buffered to disk
first.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-8">--vfs-cache-mode full</h3>
<p>In this mode all reads and writes are buffered to and from disk. When
data is read from the remote this is buffered to disk as well.</p>
<p>In this mode the files in the cache will be sparse files and rclone
will keep track of which bits of the files it has downloaded.</p>
<p>So if an application only reads the starts of each file, then rclone
will only buffer the start of the file. These files will appear to be
their full size in the cache, but they will be sparse files with only
the data that has been downloaded present in them.</p>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<p>When reading a file rclone will read <code>--buffer-size</code> plus
<code>--vfs-read-ahead</code> bytes ahead. The
<code>--buffer-size</code> is buffered in memory whereas the
<code>--vfs-read-ahead</code> is buffered on disk.</p>
<p>When using this mode it is recommended that
<code>--buffer-size</code> is not set too large and
<code>--vfs-read-ahead</code> is set large if required.</p>
<p><strong>IMPORTANT</strong> not all file systems support sparse files.
In particular FAT/exFAT do not. Rclone will perform very badly if the
cache directory is on a filesystem which doesn't support sparse files
and it will log an ERROR message if one is detected.</p>
<h3 id="fingerprinting-8">Fingerprinting</h3>
<p>Various parts of the VFS use fingerprinting to see if a local file
copy has changed relative to a remote file. Fingerprints are made
from:</p>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<p>On some backends some of these attributes are slow to read (they take
an extra API call per object, or extra work per object).</p>
<p>For example <code>hash</code> is slow with the <code>local</code> and
<code>sftp</code> backends as they have to read the entire file and hash
it, and <code>modtime</code> is slow with the <code>s3</code>,
<code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends
because they need to do an extra API call to fetch it.</p>
<p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone
will not include the slow operations in the fingerprint. This makes the
fingerprinting less accurate but much faster and will improve the
opening time of cached files.</p>
<p>If you are running a vfs cache over <code>local</code>,
<code>s3</code> or <code>swift</code> backends then using this flag is
recommended.</p>
<p>Note that if you change the value of this flag, the fingerprints of
the files in the cache may be invalidated and the files will need to be
downloaded again.</p>
<h2 id="vfs-chunked-reading-8">VFS Chunked Reading</h2>
<p>When rclone reads files from a remote it reads them in chunks. This
means that rather than requesting the whole file rclone reads the chunk
specified. This can reduce the used download quota for some remotes by
requesting only chunks from the remote that are actually read, at the
cost of an increased number of requests.</p>
<p>These flags control the chunking:</p>
<pre class="text"><code>    --vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
    --vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)
    --vfs-read-chunk-streams int            The number of parallel streams to read at once</code></pre>
<p>The chunking behaves differently depending on the
<code>--vfs-read-chunk-streams</code> parameter.</p>
<h3
id="vfs-read-chunk-streams-0-16"><code>--vfs-read-chunk-streams</code>
== 0</h3>
<p>Rclone will start reading a chunk of size
<code>--vfs-read-chunk-size</code>, and then double the size for each
read. When <code>--vfs-read-chunk-size-limit</code> is specified, and
greater than <code>--vfs-read-chunk-size</code>, the chunk size for each
open file will get doubled only until the specified value is reached. If
the value is "off", which is the default, the limit is disabled and the
chunk size will grow indefinitely.</p>
<p>With <code>--vfs-read-chunk-size 100M</code> and
<code>--vfs-read-chunk-size-limit 0</code> the following parts will be
downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When
<code>--vfs-read-chunk-size-limit 500M</code> is specified, the result
would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so
on.</p>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off"
disables chunked reading.</p>
<p>The chunks will not be buffered in memory.</p>
<h3
id="vfs-read-chunk-streams-0-17"><code>--vfs-read-chunk-streams</code>
&gt; 0</h3>
<p>Rclone reads <code>--vfs-read-chunk-streams</code> chunks of size
<code>--vfs-read-chunk-size</code> concurrently. The size for each read
will stay constant.</p>
<p>This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.</p>
<p>Some experimentation will be needed to find the optimum values of
<code>--vfs-read-chunk-size</code> and
<code>--vfs-read-chunk-streams</code> as these will depend on the
backend in use and the latency to the backend.</p>
<p>For high performance object stores (eg AWS S3) a reasonable place to
start might be <code>--vfs-read-chunk-streams 16</code> and
<code>--vfs-read-chunk-size 4M</code>. In testing with AWS S3 the
performance scaled roughly as the <code>--vfs-read-chunk-streams</code>
setting.</p>
<p>Similar settings should work for high latency links, but depending on
the latency they may need more <code>--vfs-read-chunk-streams</code> in
order to get the throughput.</p>
<h2 id="vfs-performance-8">VFS Performance</h2>
<p>These flags may be used to enable/disable features of the VFS for
performance or other reasons. See also the <a
href="#vfs-chunked-reading">chunked reading</a> feature.</p>
<p>In particular S3 and Swift benefit hugely from the
<code>--no-modtime</code> flag (or use <code>--use-server-modtime</code>
for a slightly different effect) as each read of the modification time
takes a transaction.</p>
<pre class="text"><code>    --no-checksum     Don&#39;t compare checksums on up/download.
    --no-modtime      Don&#39;t read/write the modification time (can speed things up).
    --no-seek         Don&#39;t allow seeking in files.
    --read-only       Only allow read-only access.</code></pre>
<p>Sometimes rclone is delivered reads or writes out of order. Rather
than seeking rclone will wait a short time for the in sequence read or
write to come in. These flags only come into effect when not using an on
disk cache file.</p>
<pre class="text"><code>    --vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
    --vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>When using VFS write caching (<code>--vfs-cache-mode</code> with
value writes or full), the global flag <code>--transfers</code> can be
set to adjust the number of parallel uploads of modified files from the
cache (the related global flag <code>--checkers</code> has no effect on
the VFS).</p>
<pre class="text"><code>    --transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="symlinks-8">Symlinks</h2>
<p>By default the VFS does not support symlinks. However this may be
enabled with either of the following flags:</p>
<pre class="text"><code>    --links      Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension.
    --vfs-links  Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS</code></pre>
<p>As most cloud storage systems do not support symlinks directly,
rclone stores the symlink as a normal file with a special extension. So
a file which appears as a symlink <code>link-to-file.txt</code> would be
stored on cloud storage as <code>link-to-file.txt.rclonelink</code> and
the contents would be the path to the symlink destination.</p>
<p>Note that <code>--links</code> enables symlink translation globally
in rclone - this includes any backend which supports the concept (for
example the local backend). <code>--vfs-links</code> just enables it for
the VFS layer.</p>
<p>This scheme is compatible with that used by the <a
href="https://rclone.org/local/#symlinks-junction-points">local backend
with the --local-links flag</a>.</p>
<p>The <code>--vfs-links</code> flag has been designed for
<code>rclone mount</code>, <code>rclone nfsmount</code> and
<code>rclone serve nfs</code>.</p>
<p>It hasn't been tested with the other <code>rclone serve</code>
commands yet.</p>
<p>A limitation of the current implementation is that it expects the
caller to resolve sub-symlinks. For example given this directory
tree</p>
<pre class="text"><code>.
├── dir
│   └── file.txt
└── linked-dir -&gt; dir</code></pre>
<p>The VFS will correctly resolve <code>linked-dir</code> but not
<code>linked-dir/file.txt</code>. This is not a problem for the tested
commands but may be for other commands.</p>
<p><strong>Note</strong> that there is an outstanding issue with symlink
support <a href="https://github.com/rclone/rclone/issues/8245">issue
#8245</a> with duplicate files being created when symlinks are moved
into directories where there is a file of the same name (or vice
versa).</p>
<h2 id="vfs-case-sensitivity-8">VFS Case Sensitivity</h2>
<p>Linux file systems are case-sensitive: two files can differ only by
case, and the exact case must be used when opening a file.</p>
<p>File systems in modern Windows are case-insensitive but
case-preserving: although existing files can be opened using any case,
the exact case used to create the file is preserved and available for
programs to query. It is not allowed for two files in the same directory
to differ only by case.</p>
<p>Usually file systems on macOS are case-insensitive. It is possible to
make macOS file systems case-sensitive but that is not the default.</p>
<p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone
handles these two cases. If its value is "false", rclone passes file
names to the remote as-is. If the flag is "true" (or appears without a
value on the command line), rclone may perform a "fixup" as explained
below.</p>
<p>The user may specify a file name to open/delete/rename/etc with a
case different than what is stored on the remote. If an argument refers
to an existing file with exactly the same name, then the case of the
existing file on the disk will be used. However, if a file name with
exactly the same name is not found but a name differing only by case
exists, rclone will transparently fixup the name. This fixup happens
only when an existing file is requested. Case sensitivity of file names
created anew by rclone is controlled by the underlying remote.</p>
<p>Note that case sensitivity of the operating system running rclone
(the target) may differ from case sensitivity of a file system presented
by rclone (the source). The flag controls whether "fixup" is performed
to satisfy the target.</p>
<p>If the flag is not provided on the command line, then its default
value depends on the operating system where rclone runs: "true" on
Windows and macOS, "false" otherwise. If the flag is provided without a
value, then it is "true".</p>
<p>The <code>--no-unicode-normalization</code> flag controls whether a
similar "fixup" is performed for filenames that differ but are <a
href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically
equivalent</a> with respect to unicode. Unicode normalization can be
particularly helpful for users of macOS, which prefers form NFD instead
of the NFC used by most other platforms. It is therefore highly
recommended to keep the default of <code>false</code> on macOS, to avoid
encoding compatibility issues.</p>
<p>In the (probably unlikely) event that a directory has multiple
duplicate filenames after applying case and unicode normalization, the
<code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates.
This comes with a performance tradeoff, as rclone will have to scan the
entire directory for duplicates when listing a directory. For this
reason, it is recommended to leave this disabled if not needed. However,
macOS users may wish to consider using it, as otherwise, if a remote
directory contains both NFC and NFD versions of the same filename, an
odd situation will occur: both versions of the file will be visible in
the mount, and both will appear to be editable, however, editing either
version will actually result in only the NFD version getting edited
under the hood. <code>--vfs-block- norm-dupes</code> prevents this
confusion by detecting this scenario, hiding the duplicates, and logging
an error, similar to how this is handled in
<code>rclone sync</code>.</p>
<h2 id="vfs-disk-options-8">VFS Disk Options</h2>
<p>This flag allows you to manually set the statistics about the filing
system. It can be useful when those statistics cannot be read correctly
automatically.</p>
<pre class="text"><code>    --vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-8">Alternate report of used
bytes</h2>
<p>Some backends, most notably S3, do not report the amount of bytes
used. If you need this information to be available when running
<code>df</code> on the filesystem, then pass the flag
<code>--vfs-used-is-size</code> to rclone. With this flag set, instead
of relying on the backend to report this information, rclone will scan
the whole remote similar to <code>rclone size</code> and compute the
total used space itself.</p>
<p><strong>WARNING</strong>: Contrary to <code>rclone size</code>, this
flag ignores filters so that the result is accurate. However, this is
very inefficient and may cost lots of API calls resulting in extra
charges. Use it as a last resort and only with caching.</p>
<h2 id="vfs-metadata-8">VFS Metadata</h2>
<p>If you use the <code>--vfs-metadata-extension</code> flag you can get
the VFS to expose files which contain the <a
href="https://rclone.org/docs/#metadata">metadata</a> as a JSON blob.
These files will not appear in the directory listing, but can be
<code>stat</code>-ed and opened and once they have been they
<strong>will</strong> appear in directory listings until the directory
cache expires.</p>
<p>Note that some backends won't create metadata unless you pass in the
<code>--metadata</code> flag.</p>
<p>For example, using <code>rclone mount</code> with
<code>--metadata --vfs-metadata-extension .metadata</code> we get</p>
<div class="sourceCode" id="cb546"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb546-1"><a href="#cb546-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb546-2"><a href="#cb546-2" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048577</span>
<span id="cb546-3"><a href="#cb546-3" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb546-4"><a href="#cb546-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb546-5"><a href="#cb546-5" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> cat /mnt/1G.metadata</span>
<span id="cb546-6"><a href="#cb546-6" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb546-7"><a href="#cb546-7" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;atime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-04T17:34:22.317069787Z&quot;</span>,</span>
<span id="cb546-8"><a href="#cb546-8" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;btime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:37.708253808Z&quot;</span>,</span>
<span id="cb546-9"><a href="#cb546-9" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;gid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span>,</span>
<span id="cb546-10"><a href="#cb546-10" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mode&quot;</span><span class="ex">:</span> <span class="st">&quot;100664&quot;</span>,</span>
<span id="cb546-11"><a href="#cb546-11" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mtime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:39.640238323Z&quot;</span>,</span>
<span id="cb546-12"><a href="#cb546-12" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;uid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span></span>
<span id="cb546-13"><a href="#cb546-13" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span>
<span id="cb546-14"><a href="#cb546-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb546-15"><a href="#cb546-15" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb546-16"><a href="#cb546-16" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048578</span>
<span id="cb546-17"><a href="#cb546-17" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb546-18"><a href="#cb546-18" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user        185 Mar  3 16:03 1G.metadata</span></code></pre></div>
<p>If the file has no metadata it will be returned as <code>{}</code>
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<h2 id="auth-proxy-2">Auth Proxy</h2>
<p>If you supply the parameter
<code>--auth-proxy /path/to/program</code> then rclone will use that
program to generate backends on the fly which then are used to
authenticate incoming requests. This uses a simple JSON based protocol
with input on STDIN and output on STDOUT.</p>
<p><strong>PLEASE NOTE:</strong> <code>--auth-proxy</code> and
<code>--authorized-keys</code> cannot be used together, if
<code>--auth-proxy</code> is set the authorized keys option will be
ignored.</p>
<p>There is an example program <a
href="https://github.com/rclone/rclone/blob/master/bin/test_proxy.py">bin/test_proxy.py</a>
in the rclone source code.</p>
<p>The program's job is to take a <code>user</code> and
<code>pass</code> on the input and turn those into the config for a
backend on STDOUT in JSON format. This config will have any default
parameters for the backend added, but it won't use configuration from
environment variables or command line options - it is the job of the
proxy program to make a complete config.</p>
<p>This config generated must have this extra parameter</p>
<ul>
<li><code>_root</code> - root to use for the backend</li>
</ul>
<p>And it may have this parameter</p>
<ul>
<li><code>_obscure</code> - comma separated strings for parameters to
obscure</li>
</ul>
<p>If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:</p>
<div class="sourceCode" id="cb547"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb547-1"><a href="#cb547-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb547-2"><a href="#cb547-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
<span id="cb547-3"><a href="#cb547-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span></span>
<span id="cb547-4"><a href="#cb547-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:</p>
<div class="sourceCode" id="cb548"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb548-1"><a href="#cb548-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb548-2"><a href="#cb548-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
<span id="cb548-3"><a href="#cb548-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;public_key&quot;</span><span class="fu">:</span> <span class="st">&quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;</span></span>
<span id="cb548-4"><a href="#cb548-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>And as an example return this on STDOUT</p>
<div class="sourceCode" id="cb549"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb549-1"><a href="#cb549-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb549-2"><a href="#cb549-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
<span id="cb549-3"><a href="#cb549-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
<span id="cb549-4"><a href="#cb549-4" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;_obscure&quot;</span><span class="fu">:</span> <span class="st">&quot;pass&quot;</span><span class="fu">,</span></span>
<span id="cb549-5"><a href="#cb549-5" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
<span id="cb549-6"><a href="#cb549-6" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span><span class="fu">,</span></span>
<span id="cb549-7"><a href="#cb549-7" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp.example.com&quot;</span></span>
<span id="cb549-8"><a href="#cb549-8" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>This would mean that an SFTP backend would be created on the fly for
the <code>user</code> and <code>pass</code>/<code>public_key</code>
returned in the output to the host given. Note that since
<code>_obscure</code> is set to <code>pass</code>, rclone will obscure
the <code>pass</code> parameter before creating the backend (which is
required for sftp backends).</p>
<p>The program can manipulate the supplied <code>user</code> in any way,
for example to make proxy to many different sftp backends, you could
make the <code>user</code> be <code>user@example.com</code> and then set
the <code>host</code> to <code>example.com</code> in the output and the
user to <code>user</code>. For security you'd probably want to restrict
the <code>host</code> to a limited list.</p>
<p>Note that an internal cache is keyed on <code>user</code> so only use
that for configuration, don't use <code>pass</code> or
<code>public_key</code>. This also means that if a user's password or
public-key is changed the cache will need to expire (which takes 5 mins)
before it takes effect.</p>
<p>This can be used to build general purpose proxies to any kind of
backend that rclone supports.</p>
<pre><code>rclone serve sftp remote:path [flags]</code></pre>
<h2 id="options-79">Options</h2>
<pre><code>      --addr string                            IPaddress:Port or :Port to bind server to (default &quot;localhost:2022&quot;)
      --auth-proxy string                      A program to use to create the backend from the auth
      --authorized-keys string                 Authorized keys file (default &quot;~/.ssh/authorized_keys&quot;)
      --dir-cache-time Duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 777)
      --file-perms FileMode                    File permissions (default 666)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for sftp
      --key stringArray                        SSH private host key file (Can be multi-valued, leave blank to auto generate)
      --link-perms FileMode                    Link permissions (default 666)
      --no-auth                                Allow connections with no authentication if set
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --pass string                            Password for authentication
      --poll-interval Duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --stdio                                  Run an sftp server on stdin/stdout
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask FileMode                         Override the permission bits set by the filesystem (not supported on Windows) (default 002)
      --user string                            User name for authentication
      --vfs-block-norm-dupes                   If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
      --vfs-cache-max-age Duration             Max time since last access of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-min-free-space SizeSuffix    Target minimum free space on the disk containing the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval Duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-links                              Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
      --vfs-metadata-extension string          Set the extension to read metadata from
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-chunk-streams int             The number of parallel streams to read at once
      --vfs-read-wait Duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-refresh                            Refreshes the directory cache recursively in the background on start
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back Duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait Duration                Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-30">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h2 id="see-also-79">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-webdav">rclone serve webdav</h1>
<p>Serve remote:path over WebDAV.</p>
<h2 id="synopsis-73">Synopsis</h2>
<p>Run a basic WebDAV server to serve a remote over HTTP via the WebDAV
protocol. This can be viewed with a WebDAV client, through a web
browser, or you can make a remote of type WebDAV to read and write
it.</p>
<h2 id="webdav-options">WebDAV options</h2>
<h3 id="etag-hash">--etag-hash</h3>
<p>This controls the ETag header. Without this flag the ETag will be
based on the ModTime and Size of the object.</p>
<p>If this flag is set to "auto" then rclone will choose the first
supported hash on the backend or you can use a named hash such as "MD5"
or "SHA-1". Use the <a
href="https://rclone.org/commands/rclone_hashsum/">hashsum</a> command
to see the full list.</p>
<h2 id="access-webdav-on-windows">Access WebDAV on Windows</h2>
<p>WebDAV shared folder can be mapped as a drive on Windows, however the
default settings prevent it. Windows will fail to connect to the server
using insecure Basic authentication. It will not even display any login
dialog. Windows requires SSL / HTTPS connection to be used with Basic.
If you try to connect via Add Network Location Wizard you will get the
following error: "The folder you entered does not appear to be valid.
Please choose another". However, you still can connect if you set the
following registry key on a client machine:
<code>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters\BasicAuthLevel</code>
to 2. The BasicAuthLevel can be set to the following values:</p>
<pre class="text"><code>0 - Basic authentication disabled
1 - Basic authentication enabled for SSL connections only
2 - Basic authentication enabled for SSL connections and for non-SSL connections</code></pre>
<p>If required, increase the FileSizeLimitInBytes to a higher value.
Navigate to the Services interface, then restart the WebClient
service.</p>
<h2 id="access-office-applications-on-webdav">Access Office applications
on WebDAV</h2>
<p>Navigate to following registry
<code>HKEY_CURRENT_USER\Software\Microsoft\Office\[14.0/15.0/16.0]\Common\Internet</code>
Create a new DWORD BasicAuthLevel with value 2.</p>
<pre class="text"><code>0 - Basic authentication disabled
1 - Basic authentication enabled for SSL connections only
2 - Basic authentication enabled for SSL and for non-SSL connections</code></pre>
<p><a
href="https://learn.microsoft.com/en-us/office/troubleshoot/powerpoint/office-opens-blank-from-sharepoint"
class="uri">https://learn.microsoft.com/en-us/office/troubleshoot/powerpoint/office-opens-blank-from-sharepoint</a></p>
<h2 id="serving-over-a-unix-socket">Serving over a unix socket</h2>
<p>You can serve the webdav on a unix socket like this:</p>
<div class="sourceCode" id="cb555"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb555-1"><a href="#cb555-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> serve webdav <span class="at">--addr</span> unix:///tmp/my.socket remote:path</span></code></pre></div>
<p>and connect to it like this using rclone and the webdav backend:</p>
<div class="sourceCode" id="cb556"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb556-1"><a href="#cb556-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">--webdav-unix-socket</span> /tmp/my.socket <span class="at">--webdav-url</span> http://localhost lsf :webdav:</span></code></pre></div>
<p>Note that there is no authentication on http protocol - this is
expected to be done by the permissions on the socket.</p>
<h2 id="server-options-6">Server options</h2>
<p>Use <code>--addr</code> to specify which IP address and port the
server should listen on, eg <code>--addr 1.2.3.4:8000</code> or
<code>--addr :8080</code> to listen to all IPs. By default it only
listens on localhost. You can use port :0 to let the OS choose an
available port.</p>
<p>If you set <code>--addr</code> to listen on a public or LAN
accessible IP address then using Authentication is advised - see the
next section for info.</p>
<p>You can use a unix socket by setting the url to
<code>unix:///path/to/socket</code> or just by using an absolute path
name.</p>
<p><code>--addr</code> may be repeated to listen on multiple
IPs/ports/sockets. Socket activation, described further below, can also
be used to accomplish the same.</p>
<p><code>--server-read-timeout</code> and
<code>--server-write-timeout</code> can be used to control the timeouts
on the server. Note that this is the total time for a transfer.</p>
<p><code>--max-header-bytes</code> controls the maximum number of bytes
the server will accept in the HTTP header.</p>
<p><code>--baseurl</code> controls the URL prefix that rclone serves
from. By default rclone will serve from the root. If you used
<code>--baseurl "/rclone"</code> then rclone would serve from a URL
starting with "/rclone/". This is useful if you wish to proxy rclone
serve. Rclone automatically inserts leading and trailing "/" on
<code>--baseurl</code>, so <code>--baseurl "rclone"</code>,
<code>--baseurl "/rclone"</code> and <code>--baseurl "/rclone/"</code>
are all treated identically.</p>
<h3 id="tls-ssl-4">TLS (SSL)</h3>
<p>By default this will serve over http. If you want you can serve over
https. You will need to supply the <code>--cert</code> and
<code>--key</code> flags. If you wish to do client side certificate
validation then you will need to supply <code>--client-ca</code>
also.</p>
<p><code>--cert</code> must be set to the path of a file containing
either a PEM encoded certificate, or a concatenation of that with the CA
certificate. <code>--key</code> must be set to the path of a file with
the PEM encoded private key. If setting <code>--client-ca</code>, it
should be set to the path of a file with PEM encoded client certificate
authority certificates.</p>
<p><code>--min-tls-version</code> is minimum TLS version that is
acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3"
(default "tls1.0").</p>
<h2 id="socket-activation-4">Socket activation</h2>
<p>Instead of the listening addresses specified above, rclone will
listen to all FDs passed by the service manager, if any (and ignore any
arguments passed by <code>--addr</code>).</p>
<p>This allows rclone to be a socket-activated service. It can be
configured with .socket and .service unit files as described in <a
href="https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html"
class="uri">https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html</a>.</p>
<p>Socket activation can be tested ad-hoc with the
<code>systemd-socket-activate</code>command</p>
<div class="sourceCode" id="cb557"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb557-1"><a href="#cb557-1" aria-hidden="true" tabindex="-1"></a><span class="ex">systemd-socket-activate</span> <span class="at">-l</span> 8000 <span class="at">--</span> rclone serve</span></code></pre></div>
<p>This will socket-activate rclone on the first connection to port 8000
over TCP.</p>
<h3 id="template-2">Template</h3>
<p><code>--template</code> allows a user to specify a custom markup
template for HTTP and WebDAV serve functions. The server exports the
following markup to be used within the template to server pages:</p>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="header">
<th style="text-align: left;">Parameter</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">.Name</td>
<td style="text-align: left;">The full path of a file/directory.</td>
</tr>
<tr class="even">
<td style="text-align: left;">.Title</td>
<td style="text-align: left;">Directory listing of .Name</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Sort</td>
<td style="text-align: left;">The current sort used. This is changeable
via ?sort= parameter</td>
</tr>
<tr class="even">
<td style="text-align: left;"></td>
<td style="text-align: left;">Sort Options: namedirfirst,name,size,time
(default namedirfirst)</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Order</td>
<td style="text-align: left;">The current ordering used. This is
changeable via ?order= parameter</td>
</tr>
<tr class="even">
<td style="text-align: left;"></td>
<td style="text-align: left;">Order Options: asc,desc (default asc)</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Query</td>
<td style="text-align: left;">Currently unused.</td>
</tr>
<tr class="even">
<td style="text-align: left;">.Breadcrumb</td>
<td style="text-align: left;">Allows for creating a relative
navigation</td>
</tr>
<tr class="odd">
<td style="text-align: left;">-- .Link</td>
<td style="text-align: left;">The relative to the root link of the
Text.</td>
</tr>
<tr class="even">
<td style="text-align: left;">-- .Text</td>
<td style="text-align: left;">The Name of the directory.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Entries</td>
<td style="text-align: left;">Information about a specific
file/directory.</td>
</tr>
<tr class="even">
<td style="text-align: left;">-- .URL</td>
<td style="text-align: left;">The 'url' of an entry.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">-- .Leaf</td>
<td style="text-align: left;">Currently same as 'URL' but intended to be
'just' the name.</td>
</tr>
<tr class="even">
<td style="text-align: left;">-- .IsDir</td>
<td style="text-align: left;">Boolean for if an entry is a directory or
not.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">-- .Size</td>
<td style="text-align: left;">Size in Bytes of the entry.</td>
</tr>
<tr class="even">
<td style="text-align: left;">-- .ModTime</td>
<td style="text-align: left;">The UTC timestamp of an entry.</td>
</tr>
</tbody>
</table>
<p>The server also makes the following functions available so that they
can be used within the template. These functions help extend the options
for dynamic rendering of HTML. They can be used to render HTML based on
specific conditions.</p>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="header">
<th style="text-align: left;">Function</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">afterEpoch</td>
<td style="text-align: left;">Returns the time since the epoch for the
given time.</td>
</tr>
<tr class="even">
<td style="text-align: left;">contains</td>
<td style="text-align: left;">Checks whether a given substring is
present or not in a given string.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">hasPrefix</td>
<td style="text-align: left;">Checks whether the given string begins
with the specified prefix.</td>
</tr>
<tr class="even">
<td style="text-align: left;">hasSuffix</td>
<td style="text-align: left;">Checks whether the given string end with
the specified suffix.</td>
</tr>
</tbody>
</table>
<h3 id="authentication-5">Authentication</h3>
<p>By default this will serve files without needing a login.</p>
<p>You can either use an htpasswd file which can take lots of users, or
set a single username and password with the <code>--user</code> and
<code>--pass</code> flags.</p>
<p>Alternatively, you can have the reverse proxy manage authentication
and use the username provided in the configured header with
<code>--user-from-header</code> (e.g.,
<code>--user-from-header=x-remote-user</code>). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.</p>
<p>If either of the above authentication methods is not configured and
client certificates are required by the <code>--client-ca</code> flag
passed to the server, the client certificate common name will be
considered as the username.</p>
<p>Use <code>--htpasswd /path/to/htpasswd</code> to provide an htpasswd
file. This is in standard apache format and supports MD5, SHA1 and
BCrypt for basic authentication. Bcrypt is recommended.</p>
<p>To create an htpasswd file:</p>
<div class="sourceCode" id="cb558"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb558-1"><a href="#cb558-1" aria-hidden="true" tabindex="-1"></a><span class="fu">touch</span> htpasswd</span>
<span id="cb558-2"><a href="#cb558-2" aria-hidden="true" tabindex="-1"></a><span class="ex">htpasswd</span> <span class="at">-B</span> htpasswd user</span>
<span id="cb558-3"><a href="#cb558-3" aria-hidden="true" tabindex="-1"></a><span class="ex">htpasswd</span> <span class="at">-B</span> htpasswd anotherUser</span></code></pre></div>
<p>The password file can be updated while rclone is running.</p>
<p>Use <code>--realm</code> to set the authentication realm.</p>
<p>Use <code>--salt</code> to change the password hashing salt from the
default.</p>
<h2 id="vfs---virtual-file-system-9">VFS - Virtual File System</h2>
<p>This command uses the VFS layer. This adapts the cloud storage
objects that rclone uses into something which looks much more like a
disk filing system.</p>
<p>Cloud storage objects have lots of properties which aren't like disk
files - you can't extend them or write to the middle of them, so the VFS
layer has to deal with that. Because there is no one right way of doing
this there are various options explained below.</p>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-9">VFS Directory Cache</h2>
<p>Using the <code>--dir-cache-time</code> flag, you can control how
long a directory should be considered up to date and not refreshed from
the backend. Changes made through the VFS will appear immediately or
invalidate the cache.</p>
<pre class="text"><code>    --dir-cache-time duration   Time to cache directory entries for (default 5m0s)
    --poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<p>However, changes made directly on the cloud storage by the web
interface or a different copy of rclone will only be picked up once the
directory cache expires if the backend configured does not support
polling for changes. If the backend supports polling, changes will be
picked up within the polling interval.</p>
<p>You can send a <code>SIGHUP</code> signal to rclone for it to flush
all directory caches, regardless of how old they are. Assuming only one
rclone instance is running, you can reset the cache like this:</p>
<div class="sourceCode" id="cb560"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb560-1"><a href="#cb560-1" aria-hidden="true" tabindex="-1"></a><span class="bu">kill</span> <span class="at">-SIGHUP</span> <span class="va">$(</span><span class="fu">pidof</span> rclone<span class="va">)</span></span></code></pre></div>
<p>If you configure rclone with a <a href="/rc">remote control</a> then
you can use rclone rc to flush the whole directory cache:</p>
<div class="sourceCode" id="cb561"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb561-1"><a href="#cb561-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget</span></code></pre></div>
<p>Or individual files or directories:</p>
<div class="sourceCode" id="cb562"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb562-1"><a href="#cb562-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc vfs/forget file=path/to/file dir=path/to/dir</span></code></pre></div>
<h2 id="vfs-file-buffering-9">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<p>Each open file will try to keep the specified amount of data in
memory at all times. The buffered data is bound to one open file and
won't be shared.</p>
<p>This flag is a upper limit for the used memory per open file. The
buffer will only use memory for data that is downloaded but not not yet
read. If the buffer is empty, only a small amount of memory will be
used.</p>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-9">VFS File Caching</h2>
<p>These flags control the VFS file caching options. File caching is
necessary to make the VFS layer appear compatible with a normal file
system. It can be disabled at the cost of some compatibility.</p>
<p>For example you'll need to enable VFS caching if you want to read and
write simultaneously to a file. See below for more details.</p>
<p>Note that the VFS cache is separate from the cache backend and you
may find that you need one or the other or both.</p>
<pre class="text"><code>    --cache-dir string                     Directory rclone will use for caching.
    --vfs-cache-mode CacheMode             Cache mode off|minimal|writes|full (default off)
    --vfs-cache-max-age duration           Max time since last access of objects in the cache (default 1h0m0s)
    --vfs-cache-max-size SizeSuffix        Max total size of objects in the cache (default off)
    --vfs-cache-min-free-space SizeSuffix  Target minimum free space on the disk containing the cache (default off)
    --vfs-cache-poll-interval duration     Interval to poll the cache for stale objects (default 1m0s)
    --vfs-write-back duration              Time to writeback files after last use when using cache (default 5s)</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the
file cache. The files are stored in the user cache file area which is OS
dependent but can be controlled with <code>--cache-dir</code> or setting
the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by
<code>--vfs-cache-mode</code>. The higher the cache mode the more
compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are
closed and if they haven't been accessed for
<code>--vfs-write-back</code> seconds. If rclone is quit or dies with
files that haven't been uploaded, these will be uploaded next time
rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or
<code>--vfs-cache-min-free-space</code> note that the cache may exceed
these quotas for two reasons. Firstly because it is only checked every
<code>--vfs-cache-poll-interval</code>. Secondly because open files
cannot be evicted from the cache. When <code>--vfs-cache-max-size</code>
or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will
attempt to evict the least accessed files from the cache first. rclone
will start with files that haven't been accessed for the longest. This
cache flushing strategy is efficient and more relevant files are likely
to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache
after the set time since last access has passed. The default value of 1
hour will start evicting files from cache that haven't been accessed for
1 hour. When a cached file is accessed the 1 hour timer is reset to 0
and will wait for 1 more hour before evicting. Specify the time with
standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the
same VFS cache with the same or overlapping remotes if using
<code>--vfs-cache-mode &gt; off</code>. This can potentially cause data
corruption if you do. You can work around this by giving each rclone its
own cache hierarchy with <code>--cache-dir</code>. You don't need to
worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-9">--vfs-cache-mode off</h3>
<p>In this mode (the default) the cache will read directly from the
remote and write directly to the remote without caching anything on
disk.</p>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can't be opened for both read AND write</li>
<li>Files opened for write can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-9">--vfs-cache-mode minimal</h3>
<p>This is very similar to "off" except that files opened for read AND
write will be buffered to disk. This means that files opened for write
will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-9">--vfs-cache-mode writes</h3>
<p>In this mode files opened for read only are still read directly from
the remote, write only and read/write files are buffered to disk
first.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-9">--vfs-cache-mode full</h3>
<p>In this mode all reads and writes are buffered to and from disk. When
data is read from the remote this is buffered to disk as well.</p>
<p>In this mode the files in the cache will be sparse files and rclone
will keep track of which bits of the files it has downloaded.</p>
<p>So if an application only reads the starts of each file, then rclone
will only buffer the start of the file. These files will appear to be
their full size in the cache, but they will be sparse files with only
the data that has been downloaded present in them.</p>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<p>When reading a file rclone will read <code>--buffer-size</code> plus
<code>--vfs-read-ahead</code> bytes ahead. The
<code>--buffer-size</code> is buffered in memory whereas the
<code>--vfs-read-ahead</code> is buffered on disk.</p>
<p>When using this mode it is recommended that
<code>--buffer-size</code> is not set too large and
<code>--vfs-read-ahead</code> is set large if required.</p>
<p><strong>IMPORTANT</strong> not all file systems support sparse files.
In particular FAT/exFAT do not. Rclone will perform very badly if the
cache directory is on a filesystem which doesn't support sparse files
and it will log an ERROR message if one is detected.</p>
<h3 id="fingerprinting-9">Fingerprinting</h3>
<p>Various parts of the VFS use fingerprinting to see if a local file
copy has changed relative to a remote file. Fingerprints are made
from:</p>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<p>On some backends some of these attributes are slow to read (they take
an extra API call per object, or extra work per object).</p>
<p>For example <code>hash</code> is slow with the <code>local</code> and
<code>sftp</code> backends as they have to read the entire file and hash
it, and <code>modtime</code> is slow with the <code>s3</code>,
<code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends
because they need to do an extra API call to fetch it.</p>
<p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone
will not include the slow operations in the fingerprint. This makes the
fingerprinting less accurate but much faster and will improve the
opening time of cached files.</p>
<p>If you are running a vfs cache over <code>local</code>,
<code>s3</code> or <code>swift</code> backends then using this flag is
recommended.</p>
<p>Note that if you change the value of this flag, the fingerprints of
the files in the cache may be invalidated and the files will need to be
downloaded again.</p>
<h2 id="vfs-chunked-reading-9">VFS Chunked Reading</h2>
<p>When rclone reads files from a remote it reads them in chunks. This
means that rather than requesting the whole file rclone reads the chunk
specified. This can reduce the used download quota for some remotes by
requesting only chunks from the remote that are actually read, at the
cost of an increased number of requests.</p>
<p>These flags control the chunking:</p>
<pre class="text"><code>    --vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
    --vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)
    --vfs-read-chunk-streams int            The number of parallel streams to read at once</code></pre>
<p>The chunking behaves differently depending on the
<code>--vfs-read-chunk-streams</code> parameter.</p>
<h3
id="vfs-read-chunk-streams-0-18"><code>--vfs-read-chunk-streams</code>
== 0</h3>
<p>Rclone will start reading a chunk of size
<code>--vfs-read-chunk-size</code>, and then double the size for each
read. When <code>--vfs-read-chunk-size-limit</code> is specified, and
greater than <code>--vfs-read-chunk-size</code>, the chunk size for each
open file will get doubled only until the specified value is reached. If
the value is "off", which is the default, the limit is disabled and the
chunk size will grow indefinitely.</p>
<p>With <code>--vfs-read-chunk-size 100M</code> and
<code>--vfs-read-chunk-size-limit 0</code> the following parts will be
downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When
<code>--vfs-read-chunk-size-limit 500M</code> is specified, the result
would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so
on.</p>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off"
disables chunked reading.</p>
<p>The chunks will not be buffered in memory.</p>
<h3
id="vfs-read-chunk-streams-0-19"><code>--vfs-read-chunk-streams</code>
&gt; 0</h3>
<p>Rclone reads <code>--vfs-read-chunk-streams</code> chunks of size
<code>--vfs-read-chunk-size</code> concurrently. The size for each read
will stay constant.</p>
<p>This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.</p>
<p>Some experimentation will be needed to find the optimum values of
<code>--vfs-read-chunk-size</code> and
<code>--vfs-read-chunk-streams</code> as these will depend on the
backend in use and the latency to the backend.</p>
<p>For high performance object stores (eg AWS S3) a reasonable place to
start might be <code>--vfs-read-chunk-streams 16</code> and
<code>--vfs-read-chunk-size 4M</code>. In testing with AWS S3 the
performance scaled roughly as the <code>--vfs-read-chunk-streams</code>
setting.</p>
<p>Similar settings should work for high latency links, but depending on
the latency they may need more <code>--vfs-read-chunk-streams</code> in
order to get the throughput.</p>
<h2 id="vfs-performance-9">VFS Performance</h2>
<p>These flags may be used to enable/disable features of the VFS for
performance or other reasons. See also the <a
href="#vfs-chunked-reading">chunked reading</a> feature.</p>
<p>In particular S3 and Swift benefit hugely from the
<code>--no-modtime</code> flag (or use <code>--use-server-modtime</code>
for a slightly different effect) as each read of the modification time
takes a transaction.</p>
<pre class="text"><code>    --no-checksum     Don&#39;t compare checksums on up/download.
    --no-modtime      Don&#39;t read/write the modification time (can speed things up).
    --no-seek         Don&#39;t allow seeking in files.
    --read-only       Only allow read-only access.</code></pre>
<p>Sometimes rclone is delivered reads or writes out of order. Rather
than seeking rclone will wait a short time for the in sequence read or
write to come in. These flags only come into effect when not using an on
disk cache file.</p>
<pre class="text"><code>    --vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
    --vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>When using VFS write caching (<code>--vfs-cache-mode</code> with
value writes or full), the global flag <code>--transfers</code> can be
set to adjust the number of parallel uploads of modified files from the
cache (the related global flag <code>--checkers</code> has no effect on
the VFS).</p>
<pre class="text"><code>    --transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="symlinks-9">Symlinks</h2>
<p>By default the VFS does not support symlinks. However this may be
enabled with either of the following flags:</p>
<pre class="text"><code>    --links      Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension.
    --vfs-links  Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS</code></pre>
<p>As most cloud storage systems do not support symlinks directly,
rclone stores the symlink as a normal file with a special extension. So
a file which appears as a symlink <code>link-to-file.txt</code> would be
stored on cloud storage as <code>link-to-file.txt.rclonelink</code> and
the contents would be the path to the symlink destination.</p>
<p>Note that <code>--links</code> enables symlink translation globally
in rclone - this includes any backend which supports the concept (for
example the local backend). <code>--vfs-links</code> just enables it for
the VFS layer.</p>
<p>This scheme is compatible with that used by the <a
href="https://rclone.org/local/#symlinks-junction-points">local backend
with the --local-links flag</a>.</p>
<p>The <code>--vfs-links</code> flag has been designed for
<code>rclone mount</code>, <code>rclone nfsmount</code> and
<code>rclone serve nfs</code>.</p>
<p>It hasn't been tested with the other <code>rclone serve</code>
commands yet.</p>
<p>A limitation of the current implementation is that it expects the
caller to resolve sub-symlinks. For example given this directory
tree</p>
<pre class="text"><code>.
├── dir
│   └── file.txt
└── linked-dir -&gt; dir</code></pre>
<p>The VFS will correctly resolve <code>linked-dir</code> but not
<code>linked-dir/file.txt</code>. This is not a problem for the tested
commands but may be for other commands.</p>
<p><strong>Note</strong> that there is an outstanding issue with symlink
support <a href="https://github.com/rclone/rclone/issues/8245">issue
#8245</a> with duplicate files being created when symlinks are moved
into directories where there is a file of the same name (or vice
versa).</p>
<h2 id="vfs-case-sensitivity-9">VFS Case Sensitivity</h2>
<p>Linux file systems are case-sensitive: two files can differ only by
case, and the exact case must be used when opening a file.</p>
<p>File systems in modern Windows are case-insensitive but
case-preserving: although existing files can be opened using any case,
the exact case used to create the file is preserved and available for
programs to query. It is not allowed for two files in the same directory
to differ only by case.</p>
<p>Usually file systems on macOS are case-insensitive. It is possible to
make macOS file systems case-sensitive but that is not the default.</p>
<p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone
handles these two cases. If its value is "false", rclone passes file
names to the remote as-is. If the flag is "true" (or appears without a
value on the command line), rclone may perform a "fixup" as explained
below.</p>
<p>The user may specify a file name to open/delete/rename/etc with a
case different than what is stored on the remote. If an argument refers
to an existing file with exactly the same name, then the case of the
existing file on the disk will be used. However, if a file name with
exactly the same name is not found but a name differing only by case
exists, rclone will transparently fixup the name. This fixup happens
only when an existing file is requested. Case sensitivity of file names
created anew by rclone is controlled by the underlying remote.</p>
<p>Note that case sensitivity of the operating system running rclone
(the target) may differ from case sensitivity of a file system presented
by rclone (the source). The flag controls whether "fixup" is performed
to satisfy the target.</p>
<p>If the flag is not provided on the command line, then its default
value depends on the operating system where rclone runs: "true" on
Windows and macOS, "false" otherwise. If the flag is provided without a
value, then it is "true".</p>
<p>The <code>--no-unicode-normalization</code> flag controls whether a
similar "fixup" is performed for filenames that differ but are <a
href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically
equivalent</a> with respect to unicode. Unicode normalization can be
particularly helpful for users of macOS, which prefers form NFD instead
of the NFC used by most other platforms. It is therefore highly
recommended to keep the default of <code>false</code> on macOS, to avoid
encoding compatibility issues.</p>
<p>In the (probably unlikely) event that a directory has multiple
duplicate filenames after applying case and unicode normalization, the
<code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates.
This comes with a performance tradeoff, as rclone will have to scan the
entire directory for duplicates when listing a directory. For this
reason, it is recommended to leave this disabled if not needed. However,
macOS users may wish to consider using it, as otherwise, if a remote
directory contains both NFC and NFD versions of the same filename, an
odd situation will occur: both versions of the file will be visible in
the mount, and both will appear to be editable, however, editing either
version will actually result in only the NFD version getting edited
under the hood. <code>--vfs-block- norm-dupes</code> prevents this
confusion by detecting this scenario, hiding the duplicates, and logging
an error, similar to how this is handled in
<code>rclone sync</code>.</p>
<h2 id="vfs-disk-options-9">VFS Disk Options</h2>
<p>This flag allows you to manually set the statistics about the filing
system. It can be useful when those statistics cannot be read correctly
automatically.</p>
<pre class="text"><code>    --vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-9">Alternate report of used
bytes</h2>
<p>Some backends, most notably S3, do not report the amount of bytes
used. If you need this information to be available when running
<code>df</code> on the filesystem, then pass the flag
<code>--vfs-used-is-size</code> to rclone. With this flag set, instead
of relying on the backend to report this information, rclone will scan
the whole remote similar to <code>rclone size</code> and compute the
total used space itself.</p>
<p><strong>WARNING</strong>: Contrary to <code>rclone size</code>, this
flag ignores filters so that the result is accurate. However, this is
very inefficient and may cost lots of API calls resulting in extra
charges. Use it as a last resort and only with caching.</p>
<h2 id="vfs-metadata-9">VFS Metadata</h2>
<p>If you use the <code>--vfs-metadata-extension</code> flag you can get
the VFS to expose files which contain the <a
href="https://rclone.org/docs/#metadata">metadata</a> as a JSON blob.
These files will not appear in the directory listing, but can be
<code>stat</code>-ed and opened and once they have been they
<strong>will</strong> appear in directory listings until the directory
cache expires.</p>
<p>Note that some backends won't create metadata unless you pass in the
<code>--metadata</code> flag.</p>
<p>For example, using <code>rclone mount</code> with
<code>--metadata --vfs-metadata-extension .metadata</code> we get</p>
<div class="sourceCode" id="cb571"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb571-1"><a href="#cb571-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb571-2"><a href="#cb571-2" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048577</span>
<span id="cb571-3"><a href="#cb571-3" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb571-4"><a href="#cb571-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb571-5"><a href="#cb571-5" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> cat /mnt/1G.metadata</span>
<span id="cb571-6"><a href="#cb571-6" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb571-7"><a href="#cb571-7" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;atime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-04T17:34:22.317069787Z&quot;</span>,</span>
<span id="cb571-8"><a href="#cb571-8" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;btime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:37.708253808Z&quot;</span>,</span>
<span id="cb571-9"><a href="#cb571-9" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;gid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span>,</span>
<span id="cb571-10"><a href="#cb571-10" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mode&quot;</span><span class="ex">:</span> <span class="st">&quot;100664&quot;</span>,</span>
<span id="cb571-11"><a href="#cb571-11" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;mtime&quot;</span><span class="ex">:</span> <span class="st">&quot;2025-03-03T16:03:39.640238323Z&quot;</span>,</span>
<span id="cb571-12"><a href="#cb571-12" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;uid&quot;</span><span class="ex">:</span> <span class="st">&quot;1000&quot;</span></span>
<span id="cb571-13"><a href="#cb571-13" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span>
<span id="cb571-14"><a href="#cb571-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb571-15"><a href="#cb571-15" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /mnt/</span>
<span id="cb571-16"><a href="#cb571-16" aria-hidden="true" tabindex="-1"></a><span class="ex">total</span> 1048578</span>
<span id="cb571-17"><a href="#cb571-17" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user 1073741824 Mar  3 16:03 1G</span>
<span id="cb571-18"><a href="#cb571-18" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 user user        185 Mar  3 16:03 1G.metadata</span></code></pre></div>
<p>If the file has no metadata it will be returned as <code>{}</code>
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<h2 id="auth-proxy-3">Auth Proxy</h2>
<p>If you supply the parameter
<code>--auth-proxy /path/to/program</code> then rclone will use that
program to generate backends on the fly which then are used to
authenticate incoming requests. This uses a simple JSON based protocol
with input on STDIN and output on STDOUT.</p>
<p><strong>PLEASE NOTE:</strong> <code>--auth-proxy</code> and
<code>--authorized-keys</code> cannot be used together, if
<code>--auth-proxy</code> is set the authorized keys option will be
ignored.</p>
<p>There is an example program <a
href="https://github.com/rclone/rclone/blob/master/bin/test_proxy.py">bin/test_proxy.py</a>
in the rclone source code.</p>
<p>The program's job is to take a <code>user</code> and
<code>pass</code> on the input and turn those into the config for a
backend on STDOUT in JSON format. This config will have any default
parameters for the backend added, but it won't use configuration from
environment variables or command line options - it is the job of the
proxy program to make a complete config.</p>
<p>This config generated must have this extra parameter</p>
<ul>
<li><code>_root</code> - root to use for the backend</li>
</ul>
<p>And it may have this parameter</p>
<ul>
<li><code>_obscure</code> - comma separated strings for parameters to
obscure</li>
</ul>
<p>If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:</p>
<div class="sourceCode" id="cb572"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb572-1"><a href="#cb572-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb572-2"><a href="#cb572-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
<span id="cb572-3"><a href="#cb572-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span></span>
<span id="cb572-4"><a href="#cb572-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:</p>
<div class="sourceCode" id="cb573"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb573-1"><a href="#cb573-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb573-2"><a href="#cb573-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
<span id="cb573-3"><a href="#cb573-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;public_key&quot;</span><span class="fu">:</span> <span class="st">&quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;</span></span>
<span id="cb573-4"><a href="#cb573-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>And as an example return this on STDOUT</p>
<div class="sourceCode" id="cb574"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb574-1"><a href="#cb574-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb574-2"><a href="#cb574-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
<span id="cb574-3"><a href="#cb574-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
<span id="cb574-4"><a href="#cb574-4" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;_obscure&quot;</span><span class="fu">:</span> <span class="st">&quot;pass&quot;</span><span class="fu">,</span></span>
<span id="cb574-5"><a href="#cb574-5" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
<span id="cb574-6"><a href="#cb574-6" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span><span class="fu">,</span></span>
<span id="cb574-7"><a href="#cb574-7" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp.example.com&quot;</span></span>
<span id="cb574-8"><a href="#cb574-8" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>This would mean that an SFTP backend would be created on the fly for
the <code>user</code> and <code>pass</code>/<code>public_key</code>
returned in the output to the host given. Note that since
<code>_obscure</code> is set to <code>pass</code>, rclone will obscure
the <code>pass</code> parameter before creating the backend (which is
required for sftp backends).</p>
<p>The program can manipulate the supplied <code>user</code> in any way,
for example to make proxy to many different sftp backends, you could
make the <code>user</code> be <code>user@example.com</code> and then set
the <code>host</code> to <code>example.com</code> in the output and the
user to <code>user</code>. For security you'd probably want to restrict
the <code>host</code> to a limited list.</p>
<p>Note that an internal cache is keyed on <code>user</code> so only use
that for configuration, don't use <code>pass</code> or
<code>public_key</code>. This also means that if a user's password or
public-key is changed the cache will need to expire (which takes 5 mins)
before it takes effect.</p>
<p>This can be used to build general purpose proxies to any kind of
backend that rclone supports.</p>
<pre><code>rclone serve webdav remote:path [flags]</code></pre>
<h2 id="options-80">Options</h2>
<pre><code>      --addr stringArray                       IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080)
      --allow-origin string                    Origin which cross-domain request (CORS) can be executed from
      --auth-proxy string                      A program to use to create the backend from the auth
      --baseurl string                         Prefix for URLs - leave blank for root
      --cert string                            TLS PEM key (concatenation of certificate and CA certificate)
      --client-ca string                       Client certificate authority to verify clients with
      --dir-cache-time Duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 777)
      --disable-dir-list                       Disable HTML directory list on GET request for a directory
      --etag-hash string                       Which hash to use for the ETag, or auto or blank for off
      --file-perms FileMode                    File permissions (default 666)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for webdav
      --htpasswd string                        A htpasswd file - if not provided no authentication is done
      --key string                             TLS PEM Private key
      --link-perms FileMode                    Link permissions (default 666)
      --max-header-bytes int                   Maximum size of request header (default 4096)
      --min-tls-version string                 Minimum TLS version that is acceptable (default &quot;tls1.0&quot;)
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --pass string                            Password for authentication
      --poll-interval Duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --realm string                           Realm for authentication
      --salt string                            Password hashing salt (default &quot;dlPL2MqE&quot;)
      --server-read-timeout Duration           Timeout for server reading data (default 1h0m0s)
      --server-write-timeout Duration          Timeout for server writing data (default 1h0m0s)
      --template string                        User-specified template
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask FileMode                         Override the permission bits set by the filesystem (not supported on Windows) (default 002)
      --user string                            User name for authentication
      --user-from-header string                User name from a defined HTTP header
      --vfs-block-norm-dupes                   If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
      --vfs-cache-max-age Duration             Max time since last access of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-min-free-space SizeSuffix    Target minimum free space on the disk containing the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval Duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-links                              Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
      --vfs-metadata-extension string          Set the extension to read metadata from
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-chunk-streams int             The number of parallel streams to read at once
      --vfs-read-wait Duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-refresh                            Refreshes the directory cache recursively in the background on start
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back Duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait Duration                Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-31">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h2 id="see-also-80">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-settier">rclone settier</h1>
<p>Changes storage class/tier of objects in remote.</p>
<h2 id="synopsis-74">Synopsis</h2>
<p>Changes storage tier or class at remote if supported. Few cloud
storage services provides different storage classes on objects, for
example AWS S3 and Glacier, Azure Blob storage - Hot, Cool and Archive,
Google Cloud Storage, Regional Storage, Nearline, Coldline etc.</p>
<p>Note that, certain tier changes make objects not available to access
immediately. For example tiering to archive in azure blob storage makes
objects in frozen state, user can restore by setting tier to Hot/Cool,
similarly S3 to Glacier makes object inaccessible.true</p>
<p>You can use it to tier single object</p>
<div class="sourceCode" id="cb578"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb578-1"><a href="#cb578-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> settier Cool remote:path/file</span></code></pre></div>
<p>Or use rclone filters to set tier on only specific files</p>
<div class="sourceCode" id="cb579"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb579-1"><a href="#cb579-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">--include</span> <span class="st">&quot;*.txt&quot;</span> settier Hot remote:path/dir</span></code></pre></div>
<p>Or just provide remote directory and all files in directory will be
tiered</p>
<div class="sourceCode" id="cb580"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb580-1"><a href="#cb580-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> settier tier remote:path/dir</span></code></pre></div>
<pre><code>rclone settier tier remote:path [flags]</code></pre>
<h2 id="options-81">Options</h2>
<pre><code>  -h, --help   help for settier</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-81">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-test">rclone test</h1>
<p>Run a test command</p>
<h2 id="synopsis-75">Synopsis</h2>
<p>Rclone test is used to run test commands.</p>
<p>Select which test command you want with the subcommand, eg</p>
<div class="sourceCode" id="cb583"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb583-1"><a href="#cb583-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> test memory remote:</span></code></pre></div>
<p>Each subcommand has its own options which you can see in their
help.</p>
<p><strong>NB</strong> Be careful running these commands, they may do
strange things so reading their documentation first is recommended.</p>
<h2 id="options-82">Options</h2>
<pre><code>  -h, --help   help for test</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-82">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
<li><a
href="https://rclone.org/commands/rclone_test_changenotify/">rclone test
changenotify</a> - Log any change notify requests for the remote passed
in.</li>
<li><a href="https://rclone.org/commands/rclone_test_histogram/">rclone
test histogram</a> - Makes a histogram of file name characters.</li>
<li><a href="https://rclone.org/commands/rclone_test_info/">rclone test
info</a> - Discovers file name or other limitations for paths.</li>
<li><a href="https://rclone.org/commands/rclone_test_makefile/">rclone
test makefile</a> - Make files with random contents of the size
given</li>
<li><a href="https://rclone.org/commands/rclone_test_makefiles/">rclone
test makefiles</a> - Make a random file hierarchy in a directory</li>
<li><a href="https://rclone.org/commands/rclone_test_memory/">rclone
test memory</a> - Load all the objects at remote:path into memory and
report memory stats.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-test-changenotify">rclone test changenotify</h1>
<p>Log any change notify requests for the remote passed in.</p>
<pre><code>rclone test changenotify remote: [flags]</code></pre>
<h2 id="options-83">Options</h2>
<pre><code>  -h, --help                     help for changenotify
      --poll-interval Duration   Time to wait between polling for changes (default 10s)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-83">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> -
Run a test command</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-test-histogram">rclone test histogram</h1>
<p>Makes a histogram of file name characters.</p>
<h2 id="synopsis-76">Synopsis</h2>
<p>This command outputs JSON which shows the histogram of characters
used in filenames in the remote:path specified.</p>
<p>The data doesn't contain any identifying information but is useful
for the rclone developers when developing filename compression.</p>
<pre><code>rclone test histogram [remote:path] [flags]</code></pre>
<h2 id="options-84">Options</h2>
<pre><code>  -h, --help   help for histogram</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-84">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> -
Run a test command</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-test-info">rclone test info</h1>
<p>Discovers file name or other limitations for paths.</p>
<h2 id="synopsis-77">Synopsis</h2>
<p>Discovers what filenames and upload methods are possible to write to
the paths passed in and how long they can be. It can take some time. It
will write test files into the remote:path passed in. It outputs a bit
of go code for each one.</p>
<p><strong>NB</strong> this can create undeletable files and other
hazards - use with care!</p>
<pre><code>rclone test info [remote:path]+ [flags]</code></pre>
<h2 id="options-85">Options</h2>
<pre><code>      --all                    Run all tests
      --check-base32768        Check can store all possible base32768 characters
      --check-control          Check control characters
      --check-length           Check max filename length
      --check-normalization    Check UTF-8 Normalization
      --check-streaming        Check uploads with indeterminate file size
  -h, --help                   help for info
      --keep-test-files        Keep test files after execution
      --upload-wait Duration   Wait after writing a file (default 0s)
      --write-json string      Write results to file</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-85">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> -
Run a test command</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-test-makefile">rclone test makefile</h1>
<p>Make files with random contents of the size given</p>
<pre><code>rclone test makefile &lt;size&gt; [&lt;file&gt;]+ [flags]</code></pre>
<h2 id="options-86">Options</h2>
<pre><code>      --ascii      Fill files with random ASCII printable bytes only
      --chargen    Fill files with a ASCII chargen pattern
  -h, --help       help for makefile
      --pattern    Fill files with a periodic pattern
      --seed int   Seed for the random number generator (0 for random) (default 1)
      --sparse     Make the files sparse (appear to be filled with ASCII 0x00)
      --zero       Fill files with ASCII 0x00</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-86">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> -
Run a test command</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-test-makefiles">rclone test makefiles</h1>
<p>Make a random file hierarchy in a directory</p>
<pre><code>rclone test makefiles &lt;dir&gt; [flags]</code></pre>
<h2 id="options-87">Options</h2>
<pre><code>      --ascii                      Fill files with random ASCII printable bytes only
      --chargen                    Fill files with a ASCII chargen pattern
      --files int                  Number of files to create (default 1000)
      --files-per-directory int    Average number of files per directory (default 10)
      --flat                       If set create all files in the root directory
  -h, --help                       help for makefiles
      --max-depth int              Maximum depth of directory hierarchy (default 10)
      --max-file-size SizeSuffix   Maximum size of files to create (default 100)
      --max-name-length int        Maximum size of file names (default 12)
      --min-file-size SizeSuffix   Minimum size of file to create
      --min-name-length int        Minimum size of file names (default 4)
      --pattern                    Fill files with a periodic pattern
      --seed int                   Seed for the random number generator (0 for random) (default 1)
      --sparse                     Make the files sparse (appear to be filled with ASCII 0x00)
      --zero                       Fill files with ASCII 0x00</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-87">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> -
Run a test command</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-test-memory">rclone test memory</h1>
<p>Load all the objects at remote:path into memory and report memory
stats.</p>
<pre><code>rclone test memory remote:path [flags]</code></pre>
<h2 id="options-88">Options</h2>
<pre><code>  -h, --help   help for memory</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-88">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> -
Run a test command</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-touch">rclone touch</h1>
<p>Create new file or change file modification time.</p>
<h2 id="synopsis-78">Synopsis</h2>
<p>Set the modification time on file(s) as specified by remote:path to
have the current time.</p>
<p>If remote:path does not exist then a zero sized file will be created,
unless <code>--no-create</code> or <code>--recursive</code> is
provided.</p>
<p>If <code>--recursive</code> is used then recursively sets the
modification time on all existing files that is found under the path.
Filters are supported, and you can test with the <code>--dry-run</code>
or the <code>--interactive</code>/<code>-i</code> flag. This will touch
<code>--transfers</code> files concurrently.</p>
<p>If <code>--timestamp</code> is used then sets the modification time
to that time instead of the current time. Times may be specified as one
of:</p>
<ul>
<li>'YYMMDD' - e.g. 17.10.30</li>
<li>'YYYY-MM-DDTHH:MM:SS' - e.g. 2006-01-02T15:04:05</li>
<li>'YYYY-MM-DDTHH:MM:SS.SSS' - e.g. 2006-01-02T15:04:05.123456789</li>
</ul>
<p>Note that value of <code>--timestamp</code> is in UTC. If you want
local time then add the <code>--localtime</code> flag.</p>
<pre><code>rclone touch remote:path [flags]</code></pre>
<h2 id="options-89">Options</h2>
<pre><code>  -h, --help               help for touch
      --localtime          Use localtime for timestamp, not UTC
  -C, --no-create          Do not create the file if it does not exist (implied with --recursive)
  -R, --recursive          Recursively touch all files
  -t, --timestamp string   Use specified time instead of the current time of day</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="important-options-18">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h3 id="filter-options-32">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-21">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-89">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h1 id="rclone-tree">rclone tree</h1>
<p>List the contents of the remote in a tree like fashion.</p>
<h2 id="synopsis-79">Synopsis</h2>
<p>Lists the contents of a remote in a similar way to the unix tree
command.</p>
<p>For example</p>
<pre class="text"><code>$ rclone tree remote:path
/
├── file1
├── file2
├── file3
└── subdir
    ├── file4
    └── file5

1 directories, 5 files</code></pre>
<p>You can use any of the filtering options with the tree command (e.g.
<code>--include</code> and <code>--exclude</code>. You can also use
<code>--fast-list</code>.</p>
<p>The tree command has many options for controlling the listing which
are compatible with the tree command, for example you can include file
sizes with <code>--size</code>. Note that not all of them have short
options as they conflict with rclone's short options.</p>
<p>For a more interactive navigation of the remote see the <a
href="https://rclone.org/commands/rclone_ncdu/">ncdu</a> command.</p>
<pre><code>rclone tree remote:path [flags]</code></pre>
<h2 id="options-90">Options</h2>
<pre><code>  -a, --all             All files are listed (list . files too)
  -d, --dirs-only       List directories only
      --dirsfirst       List directories before files (-U disables)
      --full-path       Print the full path prefix for each file
  -h, --help            help for tree
      --level int       Descend only level directories deep
  -D, --modtime         Print the date of last modification.
      --noindent        Don&#39;t print indentation lines
      --noreport        Turn off file/directory count at end of tree listing
  -o, --output string   Output to file instead of stdout
  -p, --protections     Print the protections for each file.
  -Q, --quote           Quote filenames with double quotes.
  -s, --size            Print the size in bytes of each file.
      --sort string     Select sort: name,version,size,mtime,ctime
      --sort-ctime      Sort files by last status change time
  -t, --sort-modtime    Sort files by last modification time
  -r, --sort-reverse    Reverse the order of the sort
  -U, --unsorted        Leave files unsorted
      --version         Sort files alphanumerically by version</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
<h3 id="filter-options-33">Filter Options</h3>
<p>Flags for filtering directory listings</p>
<pre class="text"><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h3 id="listing-options-22">Listing Options</h3>
<p>Flags for listing directories</p>
<pre class="text"><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="see-also-90">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
<h2 id="copying-single-files">Copying single files</h2>
<p>rclone normally syncs or copies directories. However, if the source
remote points to a file, rclone will just copy that file. The
destination remote must point to a directory - rclone will give the
error
<code>Failed to create file system for "remote:file": is a file not a directory</code>
if it isn't.</p>
<p>For example, suppose you have a remote with a file in called
<code>test.jpg</code>, then you could copy just that file like this</p>
<div class="sourceCode" id="cb607"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb607-1"><a href="#cb607-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy remote:test.jpg /tmp/download</span></code></pre></div>
<p>The file <code>test.jpg</code> will be placed inside
<code>/tmp/download</code>.</p>
<p>This is equivalent to specifying</p>
<div class="sourceCode" id="cb608"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb608-1"><a href="#cb608-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="at">--files-from</span> /tmp/files remote: /tmp/download</span></code></pre></div>
<p>Where <code>/tmp/files</code> contains the single line</p>
<div class="sourceCode" id="cb609"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb609-1"><a href="#cb609-1" aria-hidden="true" tabindex="-1"></a><span class="ex">test.jpg</span></span></code></pre></div>
<p>It is recommended to use <code>copy</code> when copying individual
files, not <code>sync</code>. They have pretty much the same effect but
<code>copy</code> will use a lot less memory.</p>
<h2 id="syntax-of-remote-paths">Syntax of remote paths</h2>
<p>The syntax of the paths passed to the rclone command are as
follows.</p>
<h3 id="pathtodir">/path/to/dir</h3>
<p>This refers to the local file system.</p>
<p>On Windows <code>\</code> may be used instead of <code>/</code> in
local paths <strong>only</strong>, non local paths must use
<code>/</code>. See <a
href="https://rclone.org/local/#paths-on-windows">local filesystem</a>
documentation for more about Windows-specific paths.</p>
<p>These paths needn't start with a leading <code>/</code> - if they
don't then they will be relative to the current directory.</p>
<h3 id="remotepathtodir">remote:path/to/dir</h3>
<p>This refers to a directory <code>path/to/dir</code> on
<code>remote:</code> as defined in the config file (configured with
<code>rclone config</code>).</p>
<h3 id="remotepathtodir-1">remote:/path/to/dir</h3>
<p>On most backends this is refers to the same directory as
<code>remote:path/to/dir</code> and that format should be preferred. On
a very small number of remotes (FTP, SFTP, Dropbox for business) this
will refer to a different directory. On these, paths without a leading
<code>/</code> will refer to your "home" directory and paths with a
leading <code>/</code> will refer to the root.</p>
<h3 id="backendpathtodir">:backend:path/to/dir</h3>
<p>This is an advanced form for creating remotes on the fly.
<code>backend</code> should be the name or prefix of a backend (the
<code>type</code> in the config file) and all the configuration for the
backend should be provided on the command line (or in environment
variables).</p>
<p>Here are some examples:</p>
<div class="sourceCode" id="cb610"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb610-1"><a href="#cb610-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsd <span class="at">--http-url</span> https://pub.rclone.org :http:</span></code></pre></div>
<p>To list all the directories in the root of
<code>https://pub.rclone.org/</code>.</p>
<div class="sourceCode" id="cb611"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb611-1"><a href="#cb611-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf <span class="at">--http-url</span> https://example.com :http:path/to/dir</span></code></pre></div>
<p>To list files and directories in
<code>https://example.com/path/to/dir/</code></p>
<div class="sourceCode" id="cb612"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb612-1"><a href="#cb612-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="at">--http-url</span> https://example.com :http:path/to/dir /tmp/dir</span></code></pre></div>
<p>To copy files and directories in
<code>https://example.com/path/to/dir</code> to
<code>/tmp/dir</code>.</p>
<div class="sourceCode" id="cb613"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb613-1"><a href="#cb613-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="at">--sftp-host</span> example.com :sftp:path/to/dir /tmp/dir</span></code></pre></div>
<p>To copy files and directories from <code>example.com</code> in the
relative directory <code>path/to/dir</code> to <code>/tmp/dir</code>
using sftp.</p>
<h3 id="connection-strings">Connection strings</h3>
<p>The above examples can also be written using a connection string
syntax, so instead of providing the arguments as command line parameters
<code>--http-url https://pub.rclone.org</code> they are provided as part
of the remote specification as a kind of connection string.</p>
<div class="sourceCode" id="cb614"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb614-1"><a href="#cb614-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsd <span class="st">&quot;:http,url=&#39;https://pub.rclone.org&#39;:&quot;</span></span>
<span id="cb614-2"><a href="#cb614-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf <span class="st">&quot;:http,url=&#39;https://example.com&#39;:path/to/dir&quot;</span></span>
<span id="cb614-3"><a href="#cb614-3" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="st">&quot;:http,url=&#39;https://example.com&#39;:path/to/dir&quot;</span> /tmp/dir</span>
<span id="cb614-4"><a href="#cb614-4" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy :sftp,host=example.com:path/to/dir /tmp/dir</span></code></pre></div>
<p>These can apply to modify existing remotes as well as create new
remotes with the on the fly syntax. This example is equivalent to adding
the <code>--drive-shared-with-me</code> parameter to the remote
<code>gdrive:</code>.</p>
<div class="sourceCode" id="cb615"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb615-1"><a href="#cb615-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf <span class="st">&quot;gdrive,shared_with_me:path/to/dir&quot;</span></span></code></pre></div>
<p>The major advantage to using the connection string style syntax is
that it only applies to the remote, not to all the remotes of that type
of the command line. A common confusion is this attempt to copy a file
shared on google drive to the normal drive which <strong>does not
work</strong> because the <code>--drive-shared-with-me</code> flag
applies to both the source and the destination.</p>
<div class="sourceCode" id="cb616"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb616-1"><a href="#cb616-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="at">--drive-shared-with-me</span> gdrive:shared-file.txt gdrive:</span></code></pre></div>
<p>However using the connection string syntax, this does work.</p>
<div class="sourceCode" id="cb617"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb617-1"><a href="#cb617-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="st">&quot;gdrive,shared_with_me:shared-file.txt&quot;</span> gdrive:</span></code></pre></div>
<p>Note that the connection string only affects the options of the
immediate backend. If for example gdriveCrypt is a crypt based on
gdrive, then the following command <strong>will not work</strong> as
intended, because <code>shared_with_me</code> is ignored by the crypt
backend:</p>
<div class="sourceCode" id="cb618"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb618-1"><a href="#cb618-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="st">&quot;gdriveCrypt,shared_with_me:shared-file.txt&quot;</span> gdriveCrypt:</span></code></pre></div>
<p>The connection strings have the following syntax</p>
<div class="sourceCode" id="cb619"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb619-1"><a href="#cb619-1" aria-hidden="true" tabindex="-1"></a><span class="ex">remote,parameter=value,parameter2=value2:path/to/dir</span></span>
<span id="cb619-2"><a href="#cb619-2" aria-hidden="true" tabindex="-1"></a><span class="ex">:backend,parameter=value,parameter2=value2:path/to/dir</span></span></code></pre></div>
<p>If the <code>parameter</code> has a <code>:</code> or <code>,</code>
then it must be placed in quotes <code>"</code> or <code>'</code>,
so</p>
<div class="sourceCode" id="cb620"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb620-1"><a href="#cb620-1" aria-hidden="true" tabindex="-1"></a><span class="ex">remote,parameter=</span><span class="st">&quot;colon:value&quot;</span><span class="ex">,parameter2=</span><span class="st">&quot;comma,value&quot;</span><span class="ex">:path/to/dir</span></span>
<span id="cb620-2"><a href="#cb620-2" aria-hidden="true" tabindex="-1"></a><span class="ex">:backend,parameter=</span><span class="st">&#39;colon:value&#39;</span><span class="ex">,parameter2=</span><span class="st">&#39;comma,value&#39;</span><span class="ex">:path/to/dir</span></span></code></pre></div>
<p>If a quoted value needs to include that quote, then it should be
doubled, so</p>
<div class="sourceCode" id="cb621"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb621-1"><a href="#cb621-1" aria-hidden="true" tabindex="-1"></a><span class="ex">remote,parameter=</span><span class="st">&quot;with&quot;&quot;quote&quot;</span><span class="ex">,parameter2=</span><span class="st">&#39;with&#39;&#39;quote&#39;</span><span class="ex">:path/to/dir</span></span></code></pre></div>
<p>This will make <code>parameter</code> be <code>with"quote</code> and
<code>parameter2</code> be <code>with'quote</code>.</p>
<p>If you leave off the <code>=parameter</code> then rclone will
substitute <code>=true</code> which works very well with flags. For
example, to use s3 configured in the environment you could use:</p>
<div class="sourceCode" id="cb622"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb622-1"><a href="#cb622-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsd :s3,env_auth:</span></code></pre></div>
<p>Which is equivalent to</p>
<div class="sourceCode" id="cb623"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb623-1"><a href="#cb623-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsd :s3,env_auth=true:</span></code></pre></div>
<p>Note that on the command line you might need to surround these
connection strings with <code>"</code> or <code>'</code> to stop the
shell interpreting any special characters within them.</p>
<p>If you are a shell master then you'll know which strings are OK and
which aren't, but if you aren't sure then enclose them in <code>"</code>
and use <code>'</code> as the inside quote. This syntax works on all
OSes.</p>
<div class="sourceCode" id="cb624"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb624-1"><a href="#cb624-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="st">&quot;:http,url=&#39;https://example.com&#39;:path/to/dir&quot;</span> /tmp/dir</span></code></pre></div>
<p>On Linux/macOS some characters are still interpreted inside
<code>"</code> strings in the shell (notably <code>\</code> and
<code>$</code> and <code>"</code>) so if your strings contain those you
can swap the roles of <code>"</code> and <code>'</code> thus. (This
syntax does not work on Windows.)</p>
<div class="sourceCode" id="cb625"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb625-1"><a href="#cb625-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="st">&#39;:http,url=&quot;https://example.com&quot;:path/to/dir&#39;</span> /tmp/dir</span></code></pre></div>
<h4 id="connection-strings-config-and-logging">Connection strings,
config and logging</h4>
<p>If you supply extra configuration to a backend by command line flag,
environment variable or connection string then rclone will add a suffix
based on the hash of the config to the name of the remote, eg</p>
<div class="sourceCode" id="cb626"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb626-1"><a href="#cb626-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">-vv</span> lsf <span class="at">--s3-chunk-size</span> 20M s3:</span></code></pre></div>
<p>Has the log message</p>
<div class="sourceCode" id="cb627"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb627-1"><a href="#cb627-1" aria-hidden="true" tabindex="-1"></a><span class="ex">DEBUG</span> : s3: detected overridden config <span class="at">-</span> adding <span class="st">&quot;{Srj1p}&quot;</span> suffix to name</span></code></pre></div>
<p>This is so rclone can tell the modified remote apart from the
unmodified remote when caching the backends.</p>
<p>This should only be noticeable in the logs.</p>
<p>This means that on the fly backends such as</p>
<div class="sourceCode" id="cb628"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb628-1"><a href="#cb628-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">-vv</span> lsf :s3,env_auth:</span></code></pre></div>
<p>Will get their own names</p>
<div class="sourceCode" id="cb629"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb629-1"><a href="#cb629-1" aria-hidden="true" tabindex="-1"></a><span class="ex">DEBUG</span> : :s3: detected overridden config <span class="at">-</span> adding <span class="st">&quot;{YTu53}&quot;</span> suffix to name</span></code></pre></div>
<h3 id="valid-remote-names">Valid remote names</h3>
<p>Remote names are case sensitive, and must adhere to the following
rules:</p>
<ul>
<li>May contain number, letter, <code>_</code>, <code>-</code>,
<code>.</code>, <code>+</code>, <code>@</code> and space.</li>
<li>May not start with <code>-</code> or space.</li>
<li>May not end with space.</li>
</ul>
<p>Starting with rclone version 1.61, any Unicode numbers and letters
are allowed, while in older versions it was limited to plain ASCII (0-9,
A-Z, a-z). If you use the same rclone configuration from different
shells, which may be configured with different character encoding, you
must be cautious to use characters that are possible to write in all of
them. This is mostly a problem on Windows, where the console
traditionally uses a non-Unicode character set - defined by the
so-called "code page".</p>
<p>Do not use single character names on Windows as it creates ambiguity
with Windows drives' names, e.g.: remote called <code>C</code> is
indistinguishable from <code>C</code> drive. Rclone will always assume
that single letter name refers to a drive.</p>
<h2 id="globalconfig">Adding global configuration to a remote</h2>
<p>It is possible to add global configuration to the remote
configuration which will be applied just before the remote is
created.</p>
<p>This can be done in two ways. The first is to use
<code>override.var = value</code> in the config file or the connection
string for a temporary change, and the second is to use
<code>global.var = value</code> in the config file or connection string
for a permanent change.</p>
<p>This is explained fully below.</p>
<h3 id="override.var">override.var</h3>
<p>This is used to override a global variable <strong>just</strong> for
the duration of the remote creation. It won't affect other remotes even
if they are created at the same time.</p>
<p>This is very useful for overriding networking config needed for just
for that remote. For example, say you have a remote which needs
<code>--no-check-certificate</code> as it is running on test
infrastructure without a proper certificate. You could supply the
<code>--no-check-certificate</code> flag to rclone, but this will affect
<strong>all</strong> the remotes. To make it just affect this remote you
use an override. You could put this in the config file:</p>
<div class="sourceCode" id="cb630"><pre
class="sourceCode ini"><code class="sourceCode ini"><span id="cb630-1"><a href="#cb630-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
<span id="cb630-2"><a href="#cb630-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> XXX</span></span>
<span id="cb630-3"><a href="#cb630-3" aria-hidden="true" tabindex="-1"></a><span class="dt">...</span></span>
<span id="cb630-4"><a href="#cb630-4" aria-hidden="true" tabindex="-1"></a><span class="dt">override.no_check_certificate </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span></code></pre></div>
<p>or use it in the connection string
<code>remote,override.no_check_certificate=true:</code> (or just
<code>remote,override.no_check_certificate:</code>).</p>
<p>Note how the global flag name loses its initial <code>--</code> and
gets <code>-</code> replaced with <code>_</code> and gets an
<code>override.</code> prefix.</p>
<p>Not all global variables make sense to be overridden like this as the
config is only applied during the remote creation. Here is a non
exhaustive list of ones which might be useful:</p>
<ul>
<li><code>bind_addr</code></li>
<li><code>ca_cert</code></li>
<li><code>client_cert</code></li>
<li><code>client_key</code></li>
<li><code>connect_timeout</code></li>
<li><code>disable_http2</code></li>
<li><code>disable_http_keep_alives</code></li>
<li><code>dump</code></li>
<li><code>expect_continue_timeout</code></li>
<li><code>headers</code></li>
<li><code>http_proxy</code></li>
<li><code>low_level_retries</code></li>
<li><code>max_connections</code></li>
<li><code>no_check_certificate</code></li>
<li><code>no_gzip</code></li>
<li><code>timeout</code></li>
<li><code>traffic_class</code></li>
<li><code>use_cookies</code></li>
<li><code>use_server_modtime</code></li>
<li><code>user_agent</code></li>
</ul>
<p>An <code>override.var</code> will override all other config methods,
but <strong>just</strong> for the duration of the creation of the
remote.</p>
<h3 id="global.var">global.var</h3>
<p>This is used to set a global variable <strong>for
everything</strong>. The global variable is set just before the remote
is created.</p>
<p>This is useful for parameters (eg sync parameters) which can't be set
as an <code>override</code>. For example, say you have a remote where
you would always like to use the <code>--checksum</code> flag. You could
supply the <code>--checksum</code> flag to rclone on every command line,
but instead you could put this in the config file:</p>
<div class="sourceCode" id="cb631"><pre
class="sourceCode ini"><code class="sourceCode ini"><span id="cb631-1"><a href="#cb631-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
<span id="cb631-2"><a href="#cb631-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> XXX</span></span>
<span id="cb631-3"><a href="#cb631-3" aria-hidden="true" tabindex="-1"></a><span class="dt">...</span></span>
<span id="cb631-4"><a href="#cb631-4" aria-hidden="true" tabindex="-1"></a><span class="dt">global.checksum </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span></code></pre></div>
<p>or use it in the connection string
<code>remote,global.checksum=true:</code> (or just
<code>remote,global.checksum:</code>). This is equivalent to using the
<code>--checksum</code> flag.</p>
<p>Note how the global flag name loses its initial <code>--</code> and
gets <code>-</code> replaced with <code>_</code> and gets a
<code>global.</code> prefix.</p>
<p>Any global variable can be set like this and it is exactly equivalent
to using the equivalent flag on the command line. This means it will
affect all uses of rclone.</p>
<p>If two remotes set the same global variable then the first one
instantiated will be overridden by the second one. A
<code>global.var</code> will override all other config methods when the
remote is created.</p>
<h2 id="quoting-and-the-shell">Quoting and the shell</h2>
<p>When you are typing commands to your computer you are using something
called the command line shell. This interprets various characters in an
OS specific way.</p>
<p>Here are some gotchas which may help users unfamiliar with the shell
rules</p>
<h3 id="linux-macos">Linux / macOS</h3>
<p>If your names have spaces or shell metacharacters (e.g.
<code>*</code>, <code>?</code>, <code>$</code>, <code>'</code>,
<code>"</code>, etc.) then you must quote them. Use single quotes
<code>'</code> by default.</p>
<div class="sourceCode" id="cb632"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb632-1"><a href="#cb632-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="st">&#39;Important files?&#39;</span> remote:backup</span></code></pre></div>
<p>If you want to send a <code>'</code> you will need to use
<code>"</code>, e.g.</p>
<div class="sourceCode" id="cb633"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb633-1"><a href="#cb633-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="st">&quot;O&#39;Reilly Reviews&quot;</span> remote:backup</span></code></pre></div>
<p>The rules for quoting metacharacters are complicated and if you want
the full details you'll have to consult the manual page for your
shell.</p>
<h3 id="windows-1">Windows</h3>
<p>If your names have spaces in you need to put them in <code>"</code>,
e.g.</p>
<div class="sourceCode" id="cb634"><pre
class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb634-1"><a href="#cb634-1" aria-hidden="true" tabindex="-1"></a>rclone copy <span class="st">&quot;E:\folder name\folder name\folder name&quot;</span> remote:backup</span></code></pre></div>
<p>If you are using the root directory on its own then don't quote it
(see <a href="https://github.com/rclone/rclone/issues/464">#464</a> for
why), e.g.</p>
<div class="sourceCode" id="cb635"><pre
class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb635-1"><a href="#cb635-1" aria-hidden="true" tabindex="-1"></a>rclone copy E:\ remote:backup</span></code></pre></div>
<h2 id="copying-files-or-directories-with-in-the-names">Copying files or
directories with <code>:</code> in the names</h2>
<p>rclone uses <code>:</code> to mark a remote name. This is, however, a
valid filename component in non-Windows OSes. The remote name parser
will only search for a <code>:</code> up to the first <code>/</code> so
if you need to act on a file or directory like this then use the full
path starting with a <code>/</code>, or use <code>./</code> as a current
directory prefix.</p>
<p>So to sync a directory called <code>sync:me</code> to a remote called
<code>remote:</code> use</p>
<div class="sourceCode" id="cb636"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb636-1"><a href="#cb636-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--interactive</span> ./sync:me remote:path</span></code></pre></div>
<p>or</p>
<div class="sourceCode" id="cb637"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb637-1"><a href="#cb637-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--interactive</span> /full/path/to/sync:me remote:path</span></code></pre></div>
<h2 id="server-side-copy">Server-side copy</h2>
<p>Most remotes (but not all - see <a
href="https://rclone.org/overview/#optional-features">the overview</a>)
support server-side copy.</p>
<p>This means if you want to copy one folder to another then rclone
won't download all the files and re-upload them; it will instruct the
server to copy them in place.</p>
<p>Eg</p>
<div class="sourceCode" id="cb638"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb638-1"><a href="#cb638-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy s3:oldbucket s3:newbucket</span></code></pre></div>
<p>Will copy the contents of <code>oldbucket</code> to
<code>newbucket</code> without downloading and re-uploading.</p>
<p>Remotes which don't support server-side copy <strong>will</strong>
download and re-upload in this case.</p>
<p>Server-side copies are used with <code>sync</code> and
<code>copy</code> and will be identified in the log when using the
<code>-v</code> flag. The <code>move</code> command may also use them if
remote doesn't support server-side move directly. This is done by
issuing a server-side copy then a delete which is much quicker than a
download and re-upload.</p>
<p>Server-side copies will only be attempted if the remote names are the
same.</p>
<p>This can be used when scripting to make aged backups efficiently,
e.g.</p>
<div class="sourceCode" id="cb639"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb639-1"><a href="#cb639-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--interactive</span> remote:current-backup remote:previous-backup</span>
<span id="cb639-2"><a href="#cb639-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--interactive</span> /path/to/files remote:current-backup</span></code></pre></div>
<h2 id="metadata">Metadata support</h2>
<p>Metadata is data about a file (or directory) which isn't the contents
of the file (or directory). Normally rclone only preserves the
modification time and the content (MIME) type where possible.</p>
<p>Rclone supports preserving all the available metadata on files and
directories when using the <code>--metadata</code> or <code>-M</code>
flag.</p>
<p>Exactly what metadata is supported and what that support means
depends on the backend. Backends that support metadata have a metadata
section in their docs and are listed in the <a
href="https://rclone.org/overview/#features">features table</a> (Eg <a
href="https://rclone.org/local/#metadata">local</a>, <a
href="/s3/#metadata">s3</a>)</p>
<p>Some backends don't support metadata, some only support metadata on
files and some support metadata on both files and directories.</p>
<p>Rclone only supports a one-time sync of metadata. This means that
metadata will be synced from the source object to the destination object
only when the source object has changed and needs to be re-uploaded. If
the metadata subsequently changes on the source object without changing
the object itself then it won't be synced to the destination object.
This is in line with the way rclone syncs <code>Content-Type</code>
without the <code>--metadata</code> flag.</p>
<p>Using <code>--metadata</code> when syncing from local to local will
preserve file attributes such as file mode, owner, extended attributes
(not Windows).</p>
<p>Note that arbitrary metadata may be added to objects using the
<code>--metadata-set key=value</code> flag when the object is first
uploaded. This flag can be repeated as many times as necessary.</p>
<p>The <a href="#metadata-mapper">--metadata-mapper</a> flag can be used
to pass the name of a program in which can transform metadata when it is
being copied from source to destination.</p>
<p>Rclone supports <code>--metadata-set</code> and
<code>--metadata-mapper</code> when doing server-side <code>Move</code>
and server-side <code>Copy</code>, but not when doing server side
<code>DirMove</code> (renaming a directory) as this would involve
recursing into the directory. Note that you can disable
<code>DirMove</code> with <code>--disable DirMove</code> and rclone will
revert back to using <code>Move</code> for each individual object where
<code>--metadata-set</code> and <code>--metadata-mapper</code> are
supported.</p>
<h3 id="types-of-metadata">Types of metadata</h3>
<p>Metadata is divided into two type. System metadata and User
metadata.</p>
<p>Metadata which the backend uses itself is called system metadata. For
example on the local backend the system metadata <code>uid</code> will
store the user ID of the file when used on a unix based platform.</p>
<p>Arbitrary metadata is called user metadata and this can be set
however is desired.</p>
<p>When objects are copied from backend to backend, they will attempt to
interpret system metadata if it is supplied. Metadata may change from
being user metadata to system metadata as objects are copied between
different backends. For example copying an object from s3 sets the
<code>content-type</code> metadata. In a backend which understands this
(like <code>azureblob</code>) this will become the Content-Type of the
object. In a backend which doesn't understand this (like the
<code>local</code> backend) this will become user metadata. However
should the local object be copied back to s3, the Content-Type will be
set correctly.</p>
<h3 id="metadata-framework">Metadata framework</h3>
<p>Rclone implements a metadata framework which can read metadata from
an object and write it to the object when (and only when) it is being
uploaded.</p>
<p>This metadata is stored as a dictionary with string keys and string
values.</p>
<p>There are some limits on the names of the keys (these may be
clarified further in the future).</p>
<ul>
<li>must be lower case</li>
<li>may be <code>a-z</code> <code>0-9</code> containing <code>.</code>
<code>-</code> or <code>_</code></li>
<li>length is backend dependent</li>
</ul>
<p>Each backend can provide system metadata that it understands. Some
backends can also store arbitrary user metadata.</p>
<p>Where possible the key names are standardized, so, for example, it is
possible to copy object metadata from s3 to azureblob for example and
metadata will be translated appropriately.</p>
<p>Some backends have limits on the size of the metadata and rclone will
give errors on upload if they are exceeded.</p>
<h3 id="metadata-preservation">Metadata preservation</h3>
<p>The goal of the implementation is to</p>
<ol type="1">
<li>Preserve metadata if at all possible</li>
<li>Interpret metadata if at all possible</li>
</ol>
<p>The consequences of 1 is that you can copy an S3 object to a local
disk then back to S3 losslessly. Likewise you can copy a local file with
file attributes and xattrs from local disk to s3 and back again
losslessly.</p>
<p>The consequence of 2 is that you can copy an S3 object with metadata
to Azureblob (say) and have the metadata appear on the Azureblob object
also.</p>
<h3 id="standard-system-metadata">Standard system metadata</h3>
<p>Here is a table of standard system metadata which, if appropriate, a
backend may implement.</p>
<table>
<colgroup>
<col style="width: 48%" />
<col style="width: 30%" />
<col style="width: 20%" />
</colgroup>
<thead>
<tr class="header">
<th>key</th>
<th>description</th>
<th>example</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>mode</td>
<td>File type and mode: octal, unix style</td>
<td>0100664</td>
</tr>
<tr class="even">
<td>uid</td>
<td>User ID of owner: decimal number</td>
<td>500</td>
</tr>
<tr class="odd">
<td>gid</td>
<td>Group ID of owner: decimal number</td>
<td>500</td>
</tr>
<tr class="even">
<td>rdev</td>
<td>Device ID (if special file) =&gt; hexadecimal</td>
<td>0</td>
</tr>
<tr class="odd">
<td>atime</td>
<td>Time of last access: RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
</tr>
<tr class="even">
<td>mtime</td>
<td>Time of last modification: RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
</tr>
<tr class="odd">
<td>btime</td>
<td>Time of file creation (birth): RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
</tr>
<tr class="even">
<td>utime</td>
<td>Time of file upload: RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
</tr>
<tr class="odd">
<td>cache-control</td>
<td>Cache-Control header</td>
<td>no-cache</td>
</tr>
<tr class="even">
<td>content-disposition</td>
<td>Content-Disposition header</td>
<td>inline</td>
</tr>
<tr class="odd">
<td>content-encoding</td>
<td>Content-Encoding header</td>
<td>gzip</td>
</tr>
<tr class="even">
<td>content-language</td>
<td>Content-Language header</td>
<td>en-US</td>
</tr>
<tr class="odd">
<td>content-type</td>
<td>Content-Type header</td>
<td>text/plain</td>
</tr>
</tbody>
</table>
<p>The metadata keys <code>mtime</code> and <code>content-type</code>
will take precedence if supplied in the metadata over reading the
<code>Content-Type</code> or modification time of the source object.</p>
<p>Hashes are not included in system metadata as there is a well defined
way of reading those already.</p>
<h2 id="options-91">Options</h2>
<p>Rclone has a number of options to control its behaviour. These are
documented below, and in the <a href="/flags">flags</a> page.</p>
<p>Options that take parameters can have the values passed in two ways,
<code>--option=value</code> or <code>--option value</code>. However
boolean (true/false) options behave slightly differently to the other
options in that <code>--boolean</code> sets the option to
<code>true</code> and the absence of the flag sets it to
<code>false</code>. It is also possible to specify
<code>--boolean=false</code> or <code>--boolean=true</code>. Note that
<code>--boolean false</code> is not valid - this is parsed as
<code>--boolean</code> and the <code>false</code> is parsed as an extra
command line argument for rclone.</p>
<p>String values that are recognized as special identifiers, e.g. the
name of the log level to set with option <code>--log-level</code>, are
case insensitive, e.g. <code>--log-level ERROR</code> and
<code>--log-level error</code> are identical.</p>
<p>Options documented to take a <code>stringArray</code> parameter
accept multiple values. To pass more than one value, repeat the option;
for example: <code>--include value1 --include value2</code>. Other
options may only accept a single value, and should only be specified
once, but where the specified parameter may indicate a list of values
separated by space or comma. Such options are documented to take a
<code>CommaSepList</code> parameter, if comma separated, and
<code>SpaceSepList</code> if space separated, although some may also
have different parameters such as <code>DumpFlags</code> or just
<code>string</code> and the help text explains that this will be
interpreted as a list.</p>
<p>Floating-point values with fractional part must use period
(<code>.</code>) as decimal separator, common in English-speaking
countries, regardless of your configured system locale. Parameter type
<code>float</code> accepts decimal and hexadecimal floating-point
numbers as defined by the Go syntax for <a
href="https://go.dev/ref/spec#Floating-point_literals">floating-point
literals</a>.</p>
<h3 id="time-options">Time and duration options</h3>
<p>Options that take a <code>Time</code> or <code>Duration</code>
parameter must be specified as a formatted string describing an absolute
or relative time. Note that both <code>Time</code> and
<code>Duration</code> parameter types can be expressed as either
absolute or relative time, just with different interpretations, e.g. a
relative time will be treated as an offset from the current time when
passed as a <code>Time</code> value.</p>
<p>An absolute time can be specified as a string in one of the following
formats:</p>
<ul>
<li>RFC3339 - e.g. <code>2006-01-02T15:04:05Z</code> or
<code>2006-01-02T15:04:05+07:00</code></li>
<li>ISO8601 Date and time, local timezone -
<code>2006-01-02T15:04:05</code></li>
<li>ISO8601 Date and time, local timezone -
<code>2006-01-02 15:04:05</code></li>
<li>ISO8601 Date - <code>2006-01-02</code> (YYYY-MM-DD)</li>
</ul>
<p>A relative time is a string with a, possibly signed, sequence of
decimal numbers, each with optional fraction, and each with a unit
suffix. If the string only contains a single number, then the unit
suffix is optional and will default to seconds, i.e. a plain decimal
value will be treated as a number of seconds. The following suffixes are
valid:</p>
<ul>
<li><code>ms</code> - Milliseconds</li>
<li><code>s</code> - Seconds</li>
<li><code>m</code> - Minutes</li>
<li><code>h</code> - Hours</li>
<li><code>d</code> - Days</li>
<li><code>w</code> - Weeks</li>
<li><code>M</code> - Months</li>
<li><code>y</code> - Years</li>
</ul>
<p>Examples: "10", "300ms", "-1.5h" or "2h45m".</p>
<h3 id="size-options">Size options</h3>
<p>Options that take a SizeSuffix parameter can be specified as an
integer value, which will then be assumed to represent a KiB value
(multiples of 1024 bytes) by default. The interpretation can be changed
by appending a suffix: <code>B</code> for Byte, <code>K</code> for KiB,
<code>M</code> for MiB, <code>G</code> for GiB, <code>T</code> for TiB
and <code>P</code> for PiB. These are the binary units, e.g. 1, 2**10,
2**20, 2**30 respectively.</p>
<p>See also <a href="#human-readable">--human-readable</a>.</p>
<h2 id="main-options">Main options</h2>
<h3 id="backup-dir-string">--backup-dir string</h3>
<p>When using <a
href="https://rclone.org/commands/rclone_sync/">sync</a>, <a
href="https://rclone.org/commands/rclone_copy/">copy</a> or <a
href="https://rclone.org/commands/rclone_move/">move</a>, any files
which would have been overwritten or deleted are moved in their original
hierarchy into this directory.</p>
<p>If <code>--suffix</code> is set, then the moved files will have the
suffix added to them. If there is a file with the same path (after the
suffix has been added) in the directory, then it will be
overwritten.</p>
<p>The remote in use must support server-side move or copy and you must
use the same remote as the destination of the sync. The backup directory
must not overlap the destination directory without it being excluded by
a filter rule.</p>
<p>For example</p>
<div class="sourceCode" id="cb640"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb640-1"><a href="#cb640-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--interactive</span> /path/to/local remote:current <span class="at">--backup-dir</span> remote:old</span></code></pre></div>
<p>will sync <code>/path/to/local</code> to <code>remote:current</code>,
but for any files which would have been updated or deleted will be
stored in <code>remote:old</code>.</p>
<p>If running rclone from a script you might want to use today's date as
the directory name passed to <code>--backup-dir</code> to store the old
files, or you might want to pass <code>--suffix</code> with today's
date. This can be done with <code>--suffix $(date +%F)</code> in bash,
and <code>--suffix $(Get-Date -Format 'yyyy-MM-dd')</code> in
PowerShell.</p>
<p>See <code>--compare-dest</code> and <code>--copy-dest</code>.</p>
<h3 id="bind-string">--bind string</h3>
<p>Local address to bind to for outgoing connections. This can be an
IPv4 address (1.2.3.4), an IPv6 address (1234::789A) or host name. If
the host name doesn't resolve or resolves to more than one IP address it
will give an error.</p>
<p>You can use <code>--bind 0.0.0.0</code> to force rclone to use IPv4
addresses and <code>--bind ::0</code> to force rclone to use IPv6
addresses.</p>
<h3 id="bwlimit-bwtimetable">--bwlimit BwTimetable</h3>
<p>This option controls the bandwidth limit. For example</p>
<div class="sourceCode" id="cb641"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb641-1"><a href="#cb641-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--bwlimit</span> 10M</span></code></pre></div>
<p>would mean limit the upload and download bandwidth to 10 MiB/s.
<strong>NB</strong> this is <strong>bytes</strong> per second not
<strong>bits</strong> per second. To use a single limit, specify the
desired bandwidth in KiB/s, or use a suffix B|K|M|G|T|P. The default is
<code>0</code> which means to not limit bandwidth.</p>
<p>The upload and download bandwidth can be specified separately, as
<code>--bwlimit UP:DOWN</code>, so</p>
<div class="sourceCode" id="cb642"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb642-1"><a href="#cb642-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--bwlimit</span> 10M:100k</span></code></pre></div>
<p>would mean limit the upload bandwidth to 10 MiB/s and the download
bandwidth to 100 KiB/s. Either limit can be "off" meaning no limit, so
to just limit the upload bandwidth you would use</p>
<div class="sourceCode" id="cb643"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb643-1"><a href="#cb643-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--bwlimit</span> 10M:off</span></code></pre></div>
<p>this would limit the upload bandwidth to 10 MiB/s but the download
bandwidth would be unlimited.</p>
<p>When specified as above the bandwidth limits last for the duration of
run of the rclone binary.</p>
<p>It is also possible to specify a "timetable" of limits, which will
cause certain limits to be applied at certain times. To specify a
timetable, format your entries as
<code>WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH...</code> where:
<code>WEEKDAY</code> is optional element.</p>
<ul>
<li><code>BANDWIDTH</code> can be a single number, e.g.<code>100k</code>
or a pair of numbers for upload:download, e.g.<code>10M:1M</code>.</li>
<li><code>WEEKDAY</code> can be written as the whole word or only using
the first 3 characters. It is optional.</li>
<li><code>HH:MM</code> is an hour from 00:00 to 23:59.</li>
</ul>
<p>Entries can be separated by spaces or semicolons.</p>
<p><strong>Note:</strong> Semicolons can be used as separators instead
of spaces to avoid parsing issues in environments like Docker.</p>
<p>An example of a typical timetable to avoid link saturation during
daytime working hours could be:</p>
<p>Using spaces as separators:
<code>--bwlimit "08:00,512k 12:00,10M 13:00,512k 18:00,30M 23:00,off"</code></p>
<p>Using semicolons as separators:
<code>--bwlimit "08:00,512k;12:00,10M;13:00,512k;18:00,30M;23:00,off"</code></p>
<p>In these examples, the transfer bandwidth will be set to 512 KiB/s at
8am every day. At noon, it will rise to 10 MiB/s, and drop back to 512
KiB/sec at 1pm. At 6pm, the bandwidth limit will be set to 30 MiB/s, and
at 11pm it will be completely disabled (full speed). Anything between
11pm and 8am will remain unlimited.</p>
<p>An example of timetable with <code>WEEKDAY</code> could be:</p>
<p>Using spaces as separators:
<code>--bwlimit "Mon-00:00,512 Fri-23:59,10M Sat-10:00,1M Sun-20:00,off"</code></p>
<p>Using semicolons as separators:
<code>--bwlimit "Mon-00:00,512;Fri-23:59,10M;Sat-10:00,1M;Sun-20:00,off"</code></p>
<p>It means that, the transfer bandwidth will be set to 512 KiB/s on
Monday. It will rise to 10 MiB/s before the end of Friday. At 10:00 on
Saturday it will be set to 1 MiB/s. From 20:00 on Sunday it will be
unlimited.</p>
<p>Timeslots without <code>WEEKDAY</code> are extended to the whole
week. So this example:</p>
<div class="sourceCode" id="cb644"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb644-1"><a href="#cb644-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--bwlimit</span> <span class="st">&quot;Mon-00:00,512 12:00,1M Sun-20:00,off&quot;</span></span></code></pre></div>
<p>Is equivalent to this:</p>
<div class="sourceCode" id="cb645"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb645-1"><a href="#cb645-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--bwlimit</span> <span class="st">&quot;Mon-00:00,512Mon-12:00,1M Tue-12:00,1M Wed-12:00,1M Thu-12:00,1M Fri-12:00,1M Sat-12:00,1M Sun-12:00,1M Sun-20:00,off&quot;</span></span></code></pre></div>
<p>Bandwidth limit apply to the data transfer for all backends. For most
backends the directory listing bandwidth is also included (exceptions
being the non HTTP backends, <code>ftp</code>, <code>sftp</code> and
<code>storj</code>).</p>
<p>Note that the units are <strong>Byte/s</strong>, not
<strong>bit/s</strong>. Typically connections are measured in bit/s - to
convert divide by 8. For example, let's say you have a 10 Mbit/s
connection and you wish rclone to use half of it - 5 Mbit/s. This is 5/8
= 0.625 MiB/s so you would use a <code>--bwlimit 0.625M</code> parameter
for rclone.</p>
<p>On Unix systems (Linux, macOS, …) the bandwidth limiter can be
toggled by sending a <code>SIGUSR2</code> signal to rclone. This allows
to remove the limitations of a long running rclone transfer and to
restore it back to the value specified with <code>--bwlimit</code>
quickly when needed. Assuming there is only one rclone instance running,
you can toggle the limiter like this:</p>
<div class="sourceCode" id="cb646"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb646-1"><a href="#cb646-1" aria-hidden="true" tabindex="-1"></a><span class="bu">kill</span> <span class="at">-SIGUSR2</span> <span class="va">$(</span><span class="fu">pidof</span> rclone<span class="va">)</span></span></code></pre></div>
<p>If you configure rclone with a <a href="/rc">remote control</a> then
you can use change the bwlimit dynamically:</p>
<div class="sourceCode" id="cb647"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb647-1"><a href="#cb647-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc core/bwlimit rate=1M</span></code></pre></div>
<h3 id="bwlimit-file-bwtimetable">--bwlimit-file BwTimetable</h3>
<p>This option controls per file bandwidth limit. For the options see
the <code>--bwlimit</code> flag.</p>
<p>For example use this to allow no transfers to be faster than 1
MiB/s</p>
<div class="sourceCode" id="cb648"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb648-1"><a href="#cb648-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--bwlimit-file</span> 1M</span></code></pre></div>
<p>This can be used in conjunction with <code>--bwlimit</code>.</p>
<p>Note that if a schedule is provided the file will use the schedule in
effect at the start of the transfer.</p>
<h3 id="buffer-size-sizesuffix">--buffer-size SizeSuffix</h3>
<p>Use this sized buffer to speed up file transfers. Each
<code>--transfer</code> will use this much memory for buffering.</p>
<p>When using <code>mount</code> or <code>cmount</code> each open file
descriptor will use this much memory for buffering. See the <a
href="https://rclone.org/commands/rclone_mount/#file-buffering">mount</a>
documentation for more details.</p>
<p>Set to <code>0</code> to disable the buffering for the minimum memory
usage.</p>
<p>Note that the memory allocation of the buffers is influenced by the
<a href="#use-mmap">--use-mmap</a> flag.</p>
<h3 id="cache-dir-string">--cache-dir string</h3>
<p>Specify the directory rclone will use for caching, to override the
default.</p>
<p>Default value is depending on operating system:</p>
<ul>
<li>Windows <code>%LocalAppData%\rclone</code>, if
<code>LocalAppData</code> is defined.</li>
<li>macOS <code>$HOME/Library/Caches/rclone</code> if <code>HOME</code>
is defined.</li>
<li>Unix <code>$XDG_CACHE_HOME/rclone</code> if
<code>XDG_CACHE_HOME</code> is defined, else
<code>$HOME/.cache/rclone</code> if <code>HOME</code> is defined.</li>
<li>Fallback (on all OS) to <code>$TMPDIR/rclone</code>, where
<code>TMPDIR</code> is the value from <a
href="#temp-dir-string">--temp-dir</a>.</li>
</ul>
<p>You can use the <a
href="https://rclone.org/commands/rclone_config_paths/">config paths</a>
command to see the current value.</p>
<p>Cache directory is heavily used by the <a
href="https://rclone.org/commands/rclone_mount/#vfs-file-caching">VFS
File Caching</a> mount feature, but also by <a
href="https://rclone.org/commands/rclone_serve/">serve</a>, <a
href="/gui">GUI</a> and other parts of rclone.</p>
<h3 id="check-first">--check-first</h3>
<p>If this flag is set then in a <a
href="https://rclone.org/commands/rclone_sync/">sync</a>, <a
href="https://rclone.org/commands/rclone_copy/">copy</a> or <a
href="https://rclone.org/commands/rclone_move/">move</a>, rclone will do
all the checks to see whether files need to be transferred before doing
any of the transfers. Normally rclone would start running transfers as
soon as possible.</p>
<p>This flag can be useful on IO limited systems where transfers
interfere with checking.</p>
<p>It can also be useful to ensure perfect ordering when using
<code>--order-by</code>.</p>
<p>If both <code>--check-first</code> and <code>--order-by</code> are
set when doing <code>rclone move</code> then rclone will use the
transfer thread to delete source files which don't need transferring.
This will enable perfect ordering of the transfers and deletes but will
cause the transfer stats to have more items in than expected.</p>
<p>Using this flag can use more memory as it effectively sets
<code>--max-backlog</code> to infinite. This means that all the info on
the objects to transfer is held in memory before the transfers
start.</p>
<h3 id="checkers-int">--checkers int</h3>
<p>Originally controlling just the number of file checkers to run in
parallel, e.g. by <code>rclone copy</code>. Now a fairly universal
parallelism control used by <code>rclone</code> in several places.</p>
<p>Note: checkers do the equality checking of files during a sync. For
some storage systems (e.g. S3, Swift, Dropbox) this can take a
significant amount of time so they are run in parallel.</p>
<p>The default is to run 8 checkers in parallel. However, in case of
slow-reacting backends you may need to lower (rather than increase) this
default by setting <code>--checkers</code> to 4 or less threads. This is
especially advised if you are experiencing backend server crashes during
file checking phase (e.g. on subsequent or top-up backups where little
or no file copying is done and checking takes up most of the time).
Increase this setting only with utmost care, while monitoring your
server health and file checking throughput.</p>
<h3 id="c---checksum">-c, --checksum</h3>
<p>Normally rclone will look at modification time and size of files to
see if they are equal. If you set this flag then rclone will check the
file hash and size to determine if files are equal.</p>
<p>This is useful when the remote doesn't support setting modified time
and a more accurate sync is desired than just checking the file
size.</p>
<p>This is very useful when transferring between remotes which store the
same hash type on the object, e.g. Drive and Swift. For details of which
remotes support which hash type see the table in the <a
href="https://rclone.org/overview/">overview section</a>.</p>
<p>Eg <code>rclone --checksum sync s3:/bucket swift:/bucket</code> would
run much quicker than without the <code>--checksum</code> flag.</p>
<p>When using this flag, rclone won't update mtimes of remote files if
they are incorrect as it would normally.</p>
<h3 id="color-autoneveralways">--color AUTO|NEVER|ALWAYS</h3>
<p>Specify when colors (and other ANSI codes) should be added to the
output.</p>
<p><code>AUTO</code> only allows ANSI codes when the output is a
terminal. This is the default.</p>
<p><code>NEVER</code> never allow ANSI codes.</p>
<p><code>ALWAYS</code> always add ANSI codes, regardless of the output
format (terminal or file).</p>
<h3 id="compare-dest-stringarray">--compare-dest stringArray</h3>
<p>When using <a
href="https://rclone.org/commands/rclone_sync/">sync</a>, <a
href="https://rclone.org/commands/rclone_copy/">copy</a> or <a
href="https://rclone.org/commands/rclone_move/">move</a>, the specified
paths are checked in addition to the destination for files. If a file
identical to the source is found, that file is <strong>not</strong>
copied from source. This is useful to copy just files that have changed
since the last backup.</p>
<p>You must use the same remote as the destination of the sync. The
compare directory must not overlap the destination directory.</p>
<p>See <code>--copy-dest</code> and <code>--backup-dir</code>.</p>
<h3 id="config-string">--config string</h3>
<p>Specify the location of the rclone configuration file, to override
the default. E.g. <code>rclone config --config="rclone.conf"</code>.</p>
<p>The exact default is a bit complex to describe, due to changes
introduced through different versions of rclone while preserving
backwards compatibility, but in most cases it is as simple as:</p>
<ul>
<li><code>%APPDATA%/rclone/rclone.conf</code> on Windows</li>
<li><code>~/.config/rclone/rclone.conf</code> on other</li>
</ul>
<p>The complete logic is as follows: Rclone will look for an existing
configuration file in any of the following locations, in priority
order:</p>
<ol type="1">
<li><code>rclone.conf</code> (in program directory, where rclone
executable is)</li>
<li><code>%APPDATA%/rclone/rclone.conf</code> (only on Windows)</li>
<li><code>$XDG_CONFIG_HOME/rclone/rclone.conf</code> (on all systems,
including Windows)</li>
<li><code>~/.config/rclone/rclone.conf</code> (see below for explanation
of ~ symbol)</li>
<li><code>~/.rclone.conf</code></li>
</ol>
<p>If no existing configuration file is found, then a new one will be
created in the following location:</p>
<ul>
<li>On Windows: Location 2 listed above, except in the unlikely event
that <code>APPDATA</code> is not defined, then location 4 is used
instead.</li>
<li>On Unix: Location 3 if <code>XDG_CONFIG_HOME</code> is defined, else
location 4.</li>
<li>Fallback to location 5 (on all OS), when the rclone directory cannot
be created, but if also a home directory was not found then path
<code>.rclone.conf</code> relative to current working directory will be
used as a final resort.</li>
</ul>
<p>The <code>~</code> symbol in paths above represent the home directory
of the current user on any OS, and the value is defined as
following:</p>
<ul>
<li>On Windows: <code>%HOME%</code> if defined, else
<code>%USERPROFILE%</code>, or else
<code>%HOMEDRIVE%\%HOMEPATH%</code>.</li>
<li>On Unix: <code>$HOME</code> if defined, else by looking up current
user in OS-specific user database (e.g. passwd file), or else use the
result from shell command <code>cd &amp;&amp; pwd</code>.</li>
</ul>
<p>If you run <code>rclone config file</code> you will see where the
default location is for you. Running <code>rclone config touch</code>
will ensure a configuration file exists, creating an empty one in the
default location if there is none.</p>
<p>The fact that an existing file <code>rclone.conf</code> in the same
directory as the rclone executable is always preferred, means that it is
easy to run in "portable" mode by downloading rclone executable to a
writable directory and then create an empty file
<code>rclone.conf</code> in the same directory.</p>
<p>If the location is set to empty string <code>""</code> or path to a
file with name <code>notfound</code>, or the os null device represented
by value <code>NUL</code> on Windows and <code>/dev/null</code> on Unix
systems, then rclone will keep the configuration file in memory
only.</p>
<p>You may see a log message "Config file not found - using defaults" if
there is no configuration file. This can be supressed, e.g. if you are
using rclone entirely with <a
href="https://rclone.org/docs/#backend-path-to-dir">on the fly
remotes</a>, by using memory-only configuration file or by creating an
empty configuration file, as described above.</p>
<p>The file format is basic <a
href="https://en.wikipedia.org/wiki/INI_file#Format">INI</a>: Sections
of text, led by a <code>[section]</code> header and followed by
<code>key=value</code> entries on separate lines. In rclone each remote
is represented by its own section, where the section name defines the
name of the remote. Options are specified as the <code>key=value</code>
entries, where the key is the option name without the
<code>--backend-</code> prefix, in lowercase and with <code>_</code>
instead of <code>-</code>. E.g. option <code>--mega-hard-delete</code>
corresponds to key <code>hard_delete</code>. Only backend options can be
specified. A special, and required, key <code>type</code> identifies the
<a href="https://rclone.org/overview/">storage system</a>, where the
value is the internal lowercase name as returned by command
<code>rclone help backends</code>. Comments are indicated by
<code>;</code> or <code>#</code> at the beginning of a line.</p>
<p>Example:</p>
<div class="sourceCode" id="cb649"><pre
class="sourceCode ini"><code class="sourceCode ini"><span id="cb649-1"><a href="#cb649-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[megaremote]</span></span>
<span id="cb649-2"><a href="#cb649-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> mega</span></span>
<span id="cb649-3"><a href="#cb649-3" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> you@example.com</span></span>
<span id="cb649-4"><a href="#cb649-4" aria-hidden="true" tabindex="-1"></a><span class="dt">pass </span><span class="ot">=</span><span class="st"> PDPcQVVjVtzFY-GTdDFozqBhTdsPg3qH</span></span></code></pre></div>
<p>Note that passwords are in <a
href="https://rclone.org/commands/rclone_obscure/">obscured</a> form.
Also, many storage systems uses token-based authentication instead of
passwords, and this requires additional steps. It is easier, and safer,
to use the interactive command <code>rclone config</code> instead of
manually editing the configuration file.</p>
<p>The configuration file will typically contain login information, and
should therefore have restricted permissions so that only the current
user can read it. Rclone tries to ensure this when it writes the file.
You may also choose to <a href="#configuration-encryption">encrypt</a>
the file.</p>
<p>When token-based authentication are used, the configuration file must
be writable, because rclone needs to update the tokens inside it.</p>
<p>To reduce risk of corrupting an existing configuration file, rclone
will not write directly to it when saving changes. Instead it will first
write to a new, temporary, file. If a configuration file already
existed, it will (on Unix systems) try to mirror its permissions to the
new file. Then it will rename the existing file to a temporary name as
backup. Next, rclone will rename the new file to the correct name,
before finally cleaning up by deleting the backup file.</p>
<p>If the configuration file path used by rclone is a symbolic link,
then this will be evaluated and rclone will write to the resolved path,
instead of overwriting the symbolic link. Temporary files used in the
process (described above) will be written to the same parent directory
as that of the resolved configuration file, but if this directory is
also a symbolic link it will not be resolved and the temporary files
will be written to the location of the directory symbolic link.</p>
<h3 id="contimeout-duration">--contimeout Duration</h3>
<p>Set the connection timeout. This should be in go time format which
looks like <code>5s</code> for 5 seconds, <code>10m</code> for 10
minutes, or <code>3h30m</code>.</p>
<p>The connection timeout is the amount of time rclone will wait for a
connection to go through to a remote object storage system. It is
<code>1m</code> by default.</p>
<h3 id="copy-dest-stringarray">--copy-dest stringArray</h3>
<p>When using <a
href="https://rclone.org/commands/rclone_sync/">sync</a>, <a
href="https://rclone.org/commands/rclone_copy/">copy</a> or <a
href="https://rclone.org/commands/rclone_move/">move</a>, the specified
paths are checked in addition to the destination for files. This part is
the same as <code>--compare-dest</code>, but the difference is that with
<code>--copy-dest</code>, if a file identical to the source is found,
that file is server-side copied from the specified paths to the
destination. This is useful for incremental backup.</p>
<p>The remote in use must support server-side copy and you must use the
same remote as the destination of the sync. The compare directory must
not overlap the destination directory.</p>
<p>See <code>--compare-dest</code> and <code>--backup-dir</code>.</p>
<h3
id="dedupe-mode-interactiveskipfirstnewestoldestlargestsmallestrenamelist">--dedupe-mode
interactive|skip|first|newest|oldest|largest|smallest|rename|list</h3>
<p>Mode to run dedupe command in. One of <code>interactive</code>,
<code>skip</code>, <code>first</code>, <code>newest</code>,
<code>oldest</code>, <code>largest</code>, <code>smallest</code>,
<code>rename</code> <code>list</code>. The default is
<code>interactive</code>. See the <a
href="https://rclone.org/commands/rclone_dedupe/">dedupe</a> command for
more information as to what these options mean.</p>
<h3 id="default-time-time">--default-time Time</h3>
<p>If a file or directory does have a modification time rclone can read
then rclone will display this fixed time instead.</p>
<p>The default is <code>2000-01-01 00:00:00 UTC</code>. This can be
configured in any of the ways shown in <a href="#time-options">time
options</a>.</p>
<p>For example <code>--default-time 2020-06-01</code> to set the default
time to the 1st of June 2020 or <code>--default-time 0s</code> to set
the default time to the time rclone started up.</p>
<h3 id="disable-string">--disable string</h3>
<p>This disables a comma separated list of optional features. For
example to disable server-side move and server-side copy use:</p>
<div class="sourceCode" id="cb650"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb650-1"><a href="#cb650-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--disable</span> move,copy</span></code></pre></div>
<p>The features can be put in any case.</p>
<p>To see a list of which features can be disabled use:</p>
<div class="sourceCode" id="cb651"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb651-1"><a href="#cb651-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--disable</span> help</span></code></pre></div>
<p>The features a remote has can be seen in JSON format with:</p>
<div class="sourceCode" id="cb652"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb652-1"><a href="#cb652-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> backend features remote:</span></code></pre></div>
<p>See the overview <a
href="https://rclone.org/overview/#features">features</a> and <a
href="https://rclone.org/overview/#optional-features">optional
features</a> to get an idea of which feature does what.</p>
<p>Note that some features can be set to <code>true</code> if they are
<code>true</code>/<code>false</code> feature flag features by prefixing
them with <code>!</code>. For example the <code>CaseInsensitive</code>
feature can be forced to <code>false</code> with
<code>--disable CaseInsensitive</code> and forced to <code>true</code>
with <code>--disable '!CaseInsensitive'</code>. In general it isn't a
good idea doing this but it may be useful in extremis.</p>
<p>(Note that <code>!</code> is a shell command which you will need to
escape with single quotes or a backslash on unix like platforms.)</p>
<p>This flag can be useful for debugging and in exceptional
circumstances (e.g. Google Drive limiting the total volume of
server-side copies to 100 GiB/day).</p>
<h3 id="disable-http2">--disable-http2</h3>
<p>This stops rclone from trying to use HTTP/2 if available. This can
sometimes speed up transfers due to a <a
href="https://github.com/golang/go/issues/37373">problem in the Go
standard library</a>.</p>
<h3 id="dscp-string">--dscp string</h3>
<p>Specify a DSCP value or name to use in connections. This could help
QoS system to identify traffic class. BE, EF, DF, LE, CSx and AFxx are
allowed.</p>
<p>See the description of <a
href="https://en.wikipedia.org/wiki/Differentiated_services">differentiated
services</a> to get an idea of this field. Setting this to 1 (LE) to
identify the flow to SCAVENGER class can avoid occupying too much
bandwidth in a network with DiffServ support (<a
href="https://tools.ietf.org/html/rfc8622">RFC 8622</a>).</p>
<p>For example, if you configured QoS on router to handle LE properly.
Running:</p>
<div class="sourceCode" id="cb653"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb653-1"><a href="#cb653-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="at">--dscp</span> LE from:/from to:/to</span></code></pre></div>
<p>would make the priority lower than usual internet flows.</p>
<p>This option has no effect on Windows (see <a
href="https://github.com/golang/go/issues/42728">golang/go#42728</a>).</p>
<h3 id="n---dry-run">-n, --dry-run</h3>
<p>Do a trial run with no permanent changes. Use this to see what rclone
would do without actually doing it. Useful when setting up the <a
href="https://rclone.org/commands/rclone_sync/">sync</a> command which
deletes files in the destination.</p>
<h3 id="expect-continue-timeout-duration">--expect-continue-timeout
Duration</h3>
<p>This specifies the amount of time to wait for a server's first
response headers after fully writing the request headers if the request
has an "Expect: 100-continue" header. Not all backends support using
this.</p>
<p>Zero means no timeout and causes the body to be sent immediately,
without waiting for the server to approve. This time does not include
the time to send the request header.</p>
<p>The default is <code>1s</code>. Set to <code>0</code> to disable.</p>
<h3 id="error-on-no-transfer">--error-on-no-transfer</h3>
<p>By default, rclone will exit with return code 0 if there were no
errors.</p>
<p>This option allows rclone to return exit code 9 if no files were
transferred between the source and destination. This allows using rclone
in scripts, and triggering follow-on actions if data was copied, or
skipping if not.</p>
<p>NB: Enabling this option turns a usually non-fatal error into a
potentially fatal one - please check and adjust your scripts
accordingly!</p>
<h3 id="fix-case">--fix-case</h3>
<p>Normally, a sync to a case insensitive dest (such as macOS / Windows)
will not result in a matching filename if the source and dest filenames
have casing differences but are otherwise identical. For example,
syncing <code>hello.txt</code> to <code>HELLO.txt</code> will normally
result in the dest filename remaining <code>HELLO.txt</code>. If
<code>--fix-case</code> is set, then <code>HELLO.txt</code> will be
renamed to <code>hello.txt</code> to match the source.</p>
<p>NB:</p>
<ul>
<li>directory names with incorrect casing will also be fixed</li>
<li><code>--fix-case</code> will be ignored if <code>--immutable</code>
is set</li>
<li>using <code>--local-case-sensitive</code> instead is not advisable;
it will cause <code>HELLO.txt</code> to get deleted!</li>
<li>the old dest filename must not be excluded by filters. Be especially
careful with <a
href="https://rclone.org/filtering/#files-from-read-list-of-source-file-names"><code>--files-from</code></a>,
which does not respect <a
href="https://rclone.org/filtering/#ignore-case-make-searches-case-insensitive"><code>--ignore-case</code></a>!</li>
<li>on remotes that do not support server-side move,
<code>--fix-case</code> will require downloading the file and
re-uploading it. To avoid this, do not use <code>--fix-case</code>.</li>
</ul>
<h3 id="fs-cache-expire-duration-duration">--fs-cache-expire-duration
Duration</h3>
<p>When using rclone via the API rclone caches created remotes for 5
minutes by default in the "fs cache". This means that if you do repeated
actions on the same remote then rclone won't have to build it again from
scratch, which makes it more efficient.</p>
<p>This flag sets the time that the remotes are cached for. If you set
it to <code>0</code> (or negative) then rclone won't cache the remotes
at all.</p>
<p>Note that if you use some flags, eg <code>--backup-dir</code> and if
this is set to <code>0</code> rclone may build two remotes (one for the
source or destination and one for the <code>--backup-dir</code> where it
may have only built one before.</p>
<h3 id="fs-cache-expire-interval-duration">--fs-cache-expire-interval
Duration</h3>
<p>This controls how often rclone checks for cached remotes to expire.
See the <code>--fs-cache-expire-duration</code> documentation above for
more info. The default is 60s, set to 0 to disable expiry.</p>
<h3 id="header-stringarray">--header stringArray</h3>
<p>Add an HTTP header for all transactions. The flag can be repeated to
add multiple headers.</p>
<p>If you want to add headers only for uploads use
<code>--header-upload</code> and if you want to add headers only for
downloads use <code>--header-download</code>.</p>
<p>This flag is supported for all HTTP based backends even those not
supported by <code>--header-upload</code> and
<code>--header-download</code> so may be used as a workaround for those
with care.</p>
<div class="sourceCode" id="cb654"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb654-1"><a href="#cb654-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> ls remote:test <span class="at">--header</span> <span class="st">&quot;X-Rclone: Foo&quot;</span> <span class="at">--header</span> <span class="st">&quot;X-LetMeIn: Yes&quot;</span></span></code></pre></div>
<h3 id="header-download-stringarray">--header-download stringArray</h3>
<p>Add an HTTP header for all download transactions. The flag can be
repeated to add multiple headers.</p>
<div class="sourceCode" id="cb655"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb655-1"><a href="#cb655-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--interactive</span> s3:test/src ~/dst <span class="at">--header-download</span> <span class="st">&quot;X-Amz-Meta-Test: Foo&quot;</span> <span class="at">--header-download</span> <span class="st">&quot;X-Amz-Meta-Test2: Bar&quot;</span></span></code></pre></div>
<p>See GitHub issue <a
href="https://github.com/rclone/rclone/issues/59">#59</a> for currently
supported backends.</p>
<h3 id="header-upload-stringarray">--header-upload stringArray</h3>
<p>Add an HTTP header for all upload transactions. The flag can be
repeated to add multiple headers.</p>
<div class="sourceCode" id="cb656"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb656-1"><a href="#cb656-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--interactive</span> ~/src s3:test/dst <span class="at">--header-upload</span> <span class="st">&quot;Content-Disposition: attachment; filename=&#39;cool.html&#39;&quot;</span> <span class="at">--header-upload</span> <span class="st">&quot;X-Amz-Meta-Test: FooBar&quot;</span></span></code></pre></div>
<p>See GitHub issue <a
href="https://github.com/rclone/rclone/issues/59">#59</a> for currently
supported backends.</p>
<h3 id="http-proxy-string">--http-proxy string</h3>
<p>Use this option to set an HTTP proxy for all HTTP based services to
use.</p>
<p>Rclone also supports the standard HTTP proxy environment variables
which it will pick up automatically. The is the way the HTTP proxy will
normally be set but this flag can be used to override it.</p>
<h3 id="human-readable">--human-readable</h3>
<p>Rclone commands output values for sizes (e.g. number of bytes) and
counts (e.g. number of files) either as <em>raw</em> numbers, or in
<em>human-readable</em> format.</p>
<p>In human-readable format the values are scaled to larger units,
indicated with a suffix shown after the value, and rounded to three
decimals. Rclone consistently uses binary units (powers of 2) for sizes
and decimal units (powers of 10) for counts. The unit prefix for size is
according to IEC standard notation, e.g. <code>Ki</code> for kibi. Used
with byte unit, <code>1 KiB</code> means 1024 Byte. In list type of
output, only the unit prefix appended to the value (e.g.
<code>9.762Ki</code>), while in more textual output the full unit is
shown (e.g. <code>9.762 KiB</code>). For counts the SI standard notation
is used, e.g. prefix <code>k</code> for kilo. Used with file counts,
<code>1k</code> means 1000 files.</p>
<p>The various <a href="https://rclone.org/commands/rclone_ls/">list</a>
commands output raw numbers by default. Option
<code>--human-readable</code> will make them output values in
human-readable format instead (with the short unit prefix).</p>
<p>The <a href="https://rclone.org/commands/rclone_about/">about</a>
command outputs human-readable by default, with a command-specific
option <code>--full</code> to output the raw numbers instead.</p>
<p>Command <a href="https://rclone.org/commands/rclone_size/">size</a>
outputs both human-readable and raw numbers in the same output.</p>
<p>The <a href="https://rclone.org/commands/rclone_tree/">tree</a>
command also considers <code>--human-readable</code>, but it will not
use the exact same notation as the other commands: It rounds to one
decimal, and uses single letter suffix, e.g. <code>K</code> instead of
<code>Ki</code>. The reason for this is that it relies on an external
library.</p>
<p>The interactive command <a
href="https://rclone.org/commands/rclone_ncdu/">ncdu</a> shows
human-readable by default, and responds to key <code>u</code> for
toggling human-readable format.</p>
<h3 id="ignore-case-sync">--ignore-case-sync</h3>
<p>Using this option will cause rclone to ignore the case of the files
when synchronizing so files will not be copied/synced when the existing
filenames are the same, even if the casing is different.</p>
<h3 id="ignore-checksum">--ignore-checksum</h3>
<p>Normally rclone will check that the checksums of transferred files
match, and give an error "corrupted on transfer" if they don't.</p>
<p>You can use this option to skip that check. You should only use it if
you have had the "corrupted on transfer" error message and you are sure
you might want to transfer potentially corrupted data.</p>
<h3 id="ignore-existing">--ignore-existing</h3>
<p>Using this option will make rclone unconditionally skip all files
that exist on the destination, no matter the content of these files.</p>
<p>While this isn't a generally recommended option, it can be useful in
cases where your files change due to encryption. However, it cannot
correct partial transfers in case a transfer was interrupted.</p>
<p>When performing a <code>move</code>/<code>moveto</code> command, this
flag will leave skipped files in the source location unchanged when a
file with the same name exists on the destination.</p>
<h3 id="ignore-size">--ignore-size</h3>
<p>Normally rclone will look at modification time and size of files to
see if they are equal. If you set this flag then rclone will check only
the modification time. If <code>--checksum</code> is set then it only
checks the checksum.</p>
<p>It will also cause rclone to skip verifying the sizes are the same
after transfer.</p>
<p>This can be useful for transferring files to and from OneDrive which
occasionally misreports the size of image files (see <a
href="https://github.com/rclone/rclone/issues/399">#399</a> for more
info).</p>
<h3 id="i---ignore-times">-I, --ignore-times</h3>
<p>Using this option will cause rclone to unconditionally upload all
files regardless of the state of files on the destination.</p>
<p>Normally rclone would skip any files that have the same modification
time and are the same size (or have the same checksum if using
<code>--checksum</code>).</p>
<h3 id="immutable">--immutable</h3>
<p>Treat source and destination files as immutable and disallow
modification.</p>
<p>With this option set, files will be created and deleted as requested,
but existing files will never be updated. If an existing file does not
match between the source and destination, rclone will give the error
<code>Source and destination exist but do not match: immutable file modified</code>.</p>
<p>Note that only commands which transfer files (e.g. <a
href="https://rclone.org/commands/rclone_sync/">sync</a>, <a
href="https://rclone.org/commands/rclone_copy/">copy</a> or <a
href="https://rclone.org/commands/rclone_move/">move</a>) are affected
by this behavior, and only modification is disallowed. Files may still
be deleted explicitly (e.g. <a
href="https://rclone.org/commands/rclone_delete/">delete</a>, <a
href="https://rclone.org/commands/rclone_purge/">purge</a>) or
implicitly (e.g. <a
href="https://rclone.org/commands/rclone_sync/">sync</a>, <a
href="https://rclone.org/commands/rclone_move/">move</a>). Use
<code>copy --immutable</code> if it is desired to avoid deletion as well
as modification.</p>
<p>This can be useful as an additional layer of protection for immutable
or append-only data sets (notably backup archives), where modification
implies corruption and should not be propagated.</p>
<h3 id="inplace">--inplace</h3>
<p>The <code>--inplace</code> flag changes the behaviour of rclone when
uploading files to some backends (backends with the
<code>PartialUploads</code> feature flag set) such as:</p>
<ul>
<li>local</li>
<li>ftp</li>
<li>sftp</li>
<li>pcloud</li>
</ul>
<p>Without <code>--inplace</code> (the default) rclone will first upload
to a temporary file with an extension like this, where
<code>XXXXXX</code> represents a hash of the source file's fingerprint
and <code>.partial</code> is <a
href="#partial-suffix">--partial-suffix</a> value (<code>.partial</code>
by default).</p>
<pre class="text"><code>original-file-name.XXXXXX.partial</code></pre>
<p>(rclone will make sure the final name is no longer than 100
characters by truncating the <code>original-file-name</code> part if
necessary).</p>
<p>When the upload is complete, rclone will rename the
<code>.partial</code> file to the correct name, overwriting any existing
file at that point. If the upload fails then the <code>.partial</code>
file will be deleted.</p>
<p>This prevents other users of the backend from seeing partially
uploaded files in their new names and prevents overwriting the old file
until the new one is completely uploaded.</p>
<p>If the <code>--inplace</code> flag is supplied, rclone will upload
directly to the final name without creating a <code>.partial</code>
file.</p>
<p>This means that an incomplete file will be visible in the directory
listings while the upload is in progress and any existing files will be
overwritten as soon as the upload starts. If the transfer fails then the
file will be deleted. This can cause data loss of the existing file if
the transfer fails.</p>
<p>Note that on the local file system if you don't use
<code>--inplace</code> hard links (Unix only) will be broken. And if you
do use <code>--inplace</code> you won't be able to update in use
executables.</p>
<p>Note also that versions of rclone prior to v1.63.0 behave as if the
<code>--inplace</code> flag is always supplied.</p>
<h3 id="interactive">-i, --interactive</h3>
<p>This flag can be used to tell rclone that you wish a manual
confirmation before destructive operations.</p>
<p>It is <strong>recommended</strong> that you use this flag while
learning rclone especially with <code>rclone sync</code>.</p>
<p>For example</p>
<div class="sourceCode" id="cb658"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb658-1"><a href="#cb658-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone delete <span class="at">--interactive</span> /tmp/dir</span>
<span id="cb658-2"><a href="#cb658-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone:</span> delete <span class="st">&quot;important-file.txt&quot;</span><span class="pp">?</span></span>
<span id="cb658-3"><a href="#cb658-3" aria-hidden="true" tabindex="-1"></a><span class="ex">y</span><span class="er">)</span> <span class="ex">Yes,</span> this is OK <span class="er">(</span><span class="ex">default</span><span class="kw">)</span></span>
<span id="cb658-4"><a href="#cb658-4" aria-hidden="true" tabindex="-1"></a><span class="ex">n</span><span class="er">)</span> <span class="ex">No,</span> skip this</span>
<span id="cb658-5"><a href="#cb658-5" aria-hidden="true" tabindex="-1"></a><span class="ex">s</span><span class="er">)</span> <span class="ex">Skip</span> all delete operations with no more questions</span>
<span id="cb658-6"><a href="#cb658-6" aria-hidden="true" tabindex="-1"></a><span class="ex">!</span><span class="er">)</span> <span class="ex">Do</span> all delete operations with no more questions</span>
<span id="cb658-7"><a href="#cb658-7" aria-hidden="true" tabindex="-1"></a><span class="ex">q</span><span class="er">)</span> <span class="ex">Exit</span> rclone now.</span>
<span id="cb658-8"><a href="#cb658-8" aria-hidden="true" tabindex="-1"></a><span class="ex">y/n/s/!/q</span><span class="op">&gt;</span> n</span></code></pre></div>
<p>The options mean</p>
<ul>
<li><code>y</code>: <strong>Yes</strong>, this operation should go
ahead. You can also press Return for this to happen. You'll be asked
every time unless you choose <code>s</code> or <code>!</code>.</li>
<li><code>n</code>: <strong>No</strong>, do not do this operation.
You'll be asked every time unless you choose <code>s</code> or
<code>!</code>.</li>
<li><code>s</code>: <strong>Skip</strong> all the following operations
of this type with no more questions. This takes effect until rclone
exits. If there are any different kind of operations you'll be prompted
for them.</li>
<li><code>!</code>: <strong>Do all</strong> the following operations
with no more questions. Useful if you've decided that you don't mind
rclone doing that kind of operation. This takes effect until rclone
exits . If there are any different kind of operations you'll be prompted
for them.</li>
<li><code>q</code>: <strong>Quit</strong> rclone now, just in case!</li>
</ul>
<h3 id="leave-root">--leave-root</h3>
<p>During rmdirs it will not remove root directory, even if it's
empty.</p>
<h3 id="l---links">-l, --links</h3>
<p>Normally rclone will ignore symlinks or junction points (which behave
like symlinks under Windows). Ignored files won't be copied, moved or
deleted in a sync.</p>
<p>If you supply this flag then rclone will copy symbolic links from any
supported backend backend, and store them as text files, with a
<code>.rclonelink</code> suffix in the destination.</p>
<p>The text file will contain the target of the symbolic link.</p>
<p>The <code>--links</code> / <code>-l</code> flag enables this feature
for all supported backends and the VFS. There are individual flags for
just enabling it for the VFS <code>--vfs-links</code> and the local
backend <code>--local-links</code> if required.</p>
<h3 id="list-cutoff">--list-cutoff int</h3>
<p>When syncing rclone needs to sort directory entries before comparing
them. Below this threshold (1,000,000) by default, rclone will store the
directory entries in memory. 1,000,000 entries will take approx 1GB of
RAM to store. Above this threshold rclone will store directory entries
on disk and sort them without using a lot of memory.</p>
<p>Doing this is slightly less efficient then sorting them in memory and
will only work well for the bucket based backends (eg s3, b2, azureblob,
swift) but these are the only backends likely to have millions of
entries in a directory.</p>
<h3 id="log-file-string">--log-file string</h3>
<p>Log all of rclone's output to a file. This is not active by default.
This can be useful for tracking down problems with syncs in combination
with the <code>-v</code> flag. See the <a href="#logging">logging</a>
section for more info.</p>
<p>If the file exists, then rclone will append to it.</p>
<p>Note that if you are using the <code>logrotate</code> program to
manage rclone's logs, then you should use the <code>copytruncate</code>
option as rclone doesn't have a signal to rotate logs.</p>
<p>Alternatively you can use the options below to manage rclone's built
in log rotation.</p>
<h3 id="log-file-max-size-sizesuffix">--log-file-max-size
SizeSuffix</h3>
<p>Maximum size of the log file before it's rotated (eg
<code>10M</code>). This SizeSuffix is rounded to the nearest MiB or 1
MiB if lower.</p>
<p>If <code>--log-file</code> is not set then this option will be
ignored.</p>
<p>If this option is not set, then the other log rotation options will
be ignored.</p>
<p>For example if the following flags are in use</p>
<div class="sourceCode" id="cb659"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb659-1"><a href="#cb659-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">--log-file</span> rclone.log <span class="at">--log-file-max-size</span> 1M <span class="at">--log-file-max-backups</span> 3</span></code></pre></div>
<p>Then this will create log files which look like this</p>
<pre class="console"><code>$ ls -l
-rw-------  1 user user  1048491 Apr 11 17:15 rclone-2025-04-11T17-15-29.998.log
-rw-------  1 user user  1048511 Apr 11 17:15 rclone-2025-04-11T17-15-30.467.log
-rw-------  1 user user  1048559 Apr 11 17:15 rclone-2025-04-11T17-15-30.543.log
-rw-------  1 user user   521602 Apr 11 17:15 rclone.log</code></pre>
<p>The file <code>rclone.log</code> being the current one.</p>
<h3 id="log-file-compress">--log-file-compress</h3>
<p>If set, compress rotated log files using gzip. This changes the
extension of the old log files to <code>.log.gz</code>.</p>
<p>Defaults to false - don't compress log files.</p>
<h3 id="log-file-max-age-duration">--log-file-max-age Duration</h3>
<p>Maximum duration to retain old log files (eg <code>7d</code>). This
is rounded to the dearest day, or 1 day if lower.</p>
<p>The default is to retain all old log files.</p>
<h3 id="log-file-max-backups-int">--log-file-max-backups int</h3>
<p>Maximum number of old log files to retain</p>
<p>The default is to retain all old log files.</p>
<h3 id="log-format-string">--log-format string</h3>
<p>Comma separated list of log format options. The accepted options
are:</p>
<ul>
<li><code>date</code> - Add a date in the format YYYY/MM/YY to the
log.</li>
<li><code>time</code> - Add a time to the log in format HH:MM:SS.</li>
<li><code>microseconds</code> - Add microseconds to the time in format
HH:MM:SS.SSSSSS.</li>
<li><code>UTC</code> - Make the logs in UTC not localtime.</li>
<li><code>longfile</code> - Adds the source file and line number of the
log statement.</li>
<li><code>shortfile</code> - Adds the source file and line number of the
log statement.</li>
<li><code>pid</code> - Add the process ID to the log - useful with
<code>rclone mount --daemon</code>.</li>
<li><code>nolevel</code> - Don't add the level to the log.</li>
<li><code>json</code> - Equivalent to adding
<code>--use-json-log</code></li>
</ul>
<p>They are added to the log line in the order above.</p>
<p>The default log format is <code>"date,time"</code>.</p>
<h3 id="log-level-loglevel">--log-level LogLevel</h3>
<p>This sets the log level for rclone. The default log level is
<code>NOTICE</code>.</p>
<p><code>DEBUG</code> is equivalent to <code>-vv</code>. It outputs lots
of debug info - useful for bug reports and really finding out what
rclone is doing.</p>
<p><code>INFO</code> is equivalent to <code>-v</code>. It outputs
information about each transfer and prints stats once a minute by
default.</p>
<p><code>NOTICE</code> is the default log level if no logging flags are
supplied. It outputs very little when things are working normally. It
outputs warnings and significant events.</p>
<p><code>ERROR</code> is equivalent to <code>-q</code>. It only outputs
error messages.</p>
<p>See also the <a href="#logging">logging</a> section.</p>
<h3 id="windows-event-log-loglevel">--windows-event-log LogLevel</h3>
<p>If this is configured (the default is <code>OFF</code>) then logs of
this level and above will be logged to the Windows event log in
<strong>addition</strong> to the normal logs. These will be logged in
JSON format as described below regardless of what format the main logs
are configured for.</p>
<p>The Windows event log only has 3 levels of severity
<code>Info</code>, <code>Warning</code> and <code>Error</code>. If
enabled we map rclone levels like this.</p>
<ul>
<li><code>Error</code> ← <code>ERROR</code> (and above)</li>
<li><code>Warning</code> ← <code>WARNING</code> (note that this level is
defined but not currently used).</li>
<li><code>Info</code> ← <code>NOTICE</code>, <code>INFO</code> and
<code>DEBUG</code>.</li>
</ul>
<p>Rclone will declare its log source as "rclone" if it is has enough
permissions to create the registry key needed. If not then logs will
appear as "Application". You can run
<code>rclone version --windows-event-log DEBUG</code> once as
administrator to create the registry key in advance.</p>
<p><strong>Note</strong> that the <code>--windows-event-log</code> level
must be greater (more severe) than or equal to the
<code>--log-level</code>. For example to log DEBUG to a log file but
ERRORs to the event log you would use</p>
<div class="sourceCode" id="cb661"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb661-1"><a href="#cb661-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--log-file</span> rclone.log <span class="at">--log-level</span> DEBUG <span class="at">--windows-event-log</span> ERROR</span></code></pre></div>
<p>This option is only supported Windows platforms.</p>
<h3 id="use-json-log">--use-json-log</h3>
<p>This switches the log format to JSON. The log messages are then
streamed as individual JSON objects, with fields: <code>level</code>,
<code>msg</code>, <code>source</code>, and <code>time</code>. The
resulting format is what is sometimes referred to as <a
href="https://en.wikipedia.org/wiki/JSON_streaming#Newline-delimited_JSON">newline-delimited
JSON</a> (NDJSON), or JSON Lines (JSONL). This is well suited for
processing by traditional line-oriented tools and shell pipelines, but a
complete log file is not strictly valid JSON and needs a parser that can
handle it.</p>
<p>The JSON logs will be printed on a single line, but are shown
expanded here for clarity.</p>
<div class="sourceCode" id="cb662"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb662-1"><a href="#cb662-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb662-2"><a href="#cb662-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;time&quot;</span><span class="fu">:</span> <span class="st">&quot;2025-05-13T17:30:51.036237518+01:00&quot;</span><span class="fu">,</span></span>
<span id="cb662-3"><a href="#cb662-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;level&quot;</span><span class="fu">:</span> <span class="st">&quot;debug&quot;</span><span class="fu">,</span></span>
<span id="cb662-4"><a href="#cb662-4" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;msg&quot;</span><span class="fu">:</span> <span class="st">&quot;4 go routines active</span><span class="ch">\n</span><span class="st">&quot;</span><span class="fu">,</span></span>
<span id="cb662-5"><a href="#cb662-5" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;source&quot;</span><span class="fu">:</span> <span class="st">&quot;cmd/cmd.go:298&quot;</span></span>
<span id="cb662-6"><a href="#cb662-6" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Completed data transfer logs will have extra <code>size</code>
information. Logs which are about a particular object will have
<code>object</code> and <code>objectType</code> fields also.</p>
<div class="sourceCode" id="cb663"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb663-1"><a href="#cb663-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb663-2"><a href="#cb663-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;time&quot;</span><span class="fu">:</span> <span class="st">&quot;2025-05-13T17:38:05.540846352+01:00&quot;</span><span class="fu">,</span></span>
<span id="cb663-3"><a href="#cb663-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;level&quot;</span><span class="fu">:</span> <span class="st">&quot;info&quot;</span><span class="fu">,</span></span>
<span id="cb663-4"><a href="#cb663-4" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;msg&quot;</span><span class="fu">:</span> <span class="st">&quot;Copied (new) to: file2.txt&quot;</span><span class="fu">,</span></span>
<span id="cb663-5"><a href="#cb663-5" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;size&quot;</span><span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
<span id="cb663-6"><a href="#cb663-6" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;object&quot;</span><span class="fu">:</span> <span class="st">&quot;file.txt&quot;</span><span class="fu">,</span></span>
<span id="cb663-7"><a href="#cb663-7" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;objectType&quot;</span><span class="fu">:</span> <span class="st">&quot;*local.Object&quot;</span><span class="fu">,</span></span>
<span id="cb663-8"><a href="#cb663-8" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;source&quot;</span><span class="fu">:</span> <span class="st">&quot;operations/copy.go:368&quot;</span></span>
<span id="cb663-9"><a href="#cb663-9" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Stats logs will contain a <code>stats</code> field which is the same
as returned from the rc call <a
href="https://rclone.org/rc/#core-stats">core/stats</a>.</p>
<div class="sourceCode" id="cb664"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb664-1"><a href="#cb664-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb664-2"><a href="#cb664-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;time&quot;</span><span class="fu">:</span> <span class="st">&quot;2025-05-13T17:38:05.540912847+01:00&quot;</span><span class="fu">,</span></span>
<span id="cb664-3"><a href="#cb664-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;level&quot;</span><span class="fu">:</span> <span class="st">&quot;info&quot;</span><span class="fu">,</span></span>
<span id="cb664-4"><a href="#cb664-4" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;msg&quot;</span><span class="fu">:</span> <span class="st">&quot;...text version of the stats...&quot;</span><span class="fu">,</span></span>
<span id="cb664-5"><a href="#cb664-5" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;stats&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb664-6"><a href="#cb664-6" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;bytes&quot;</span><span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
<span id="cb664-7"><a href="#cb664-7" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;checks&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
<span id="cb664-8"><a href="#cb664-8" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;deletedDirs&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
<span id="cb664-9"><a href="#cb664-9" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;deletes&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
<span id="cb664-10"><a href="#cb664-10" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;elapsedTime&quot;</span><span class="fu">:</span> <span class="fl">0.000904825</span><span class="fu">,</span></span>
<span id="cb664-11"><a href="#cb664-11" aria-hidden="true" tabindex="-1"></a>    <span class="er">...truncated</span> <span class="er">for</span> <span class="er">clarity...</span></span>
<span id="cb664-12"><a href="#cb664-12" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;totalBytes&quot;</span><span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
<span id="cb664-13"><a href="#cb664-13" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;totalChecks&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
<span id="cb664-14"><a href="#cb664-14" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;totalTransfers&quot;</span><span class="fu">:</span> <span class="dv">1</span><span class="fu">,</span></span>
<span id="cb664-15"><a href="#cb664-15" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;transferTime&quot;</span><span class="fu">:</span> <span class="fl">0.000882794</span><span class="fu">,</span></span>
<span id="cb664-16"><a href="#cb664-16" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;transfers&quot;</span><span class="fu">:</span> <span class="dv">1</span></span>
<span id="cb664-17"><a href="#cb664-17" aria-hidden="true" tabindex="-1"></a>  <span class="fu">},</span></span>
<span id="cb664-18"><a href="#cb664-18" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;source&quot;</span><span class="fu">:</span> <span class="st">&quot;accounting/stats.go:569&quot;</span></span>
<span id="cb664-19"><a href="#cb664-19" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h3 id="low-level-retries-int">--low-level-retries int</h3>
<p>This controls the number of low level retries rclone does.</p>
<p>A low level retry is used to retry a failing operation - typically
one HTTP request. This might be uploading a chunk of a big file for
example. You will see low level retries in the log with the
<code>-v</code> flag.</p>
<p>This shouldn't need to be changed from the default in normal
operations. However, if you get a lot of low level retries you may wish
to reduce the value so rclone moves on to a high level retry (see the
<code>--retries</code> flag) quicker.</p>
<p>Disable low level retries with
<code>--low-level-retries 1</code>.</p>
<h3 id="max-backlog-int">--max-backlog int</h3>
<p>This is the maximum allowable backlog of files in a sync/copy/move
queued for being checked or transferred.</p>
<p>This can be set arbitrarily large. It will only use memory when the
queue is in use. Note that it will use in the order of N KiB of memory
when the backlog is in use.</p>
<p>Setting this large allows rclone to calculate how many files are
pending more accurately, give a more accurate estimated finish time and
make <code>--order-by</code> work more accurately.</p>
<p>Setting this small will make rclone more synchronous to the listings
of the remote which may be desirable.</p>
<p>Setting this to a negative number will make the backlog as large as
possible.</p>
<h3 id="max-buffer-memory">--max-buffer-memory SizeSuffix</h3>
<p>If set, don't allocate more than given amount of memory as buffers.
If not set or set to <code>0</code> or <code>off</code> this will not
limit the amount of memory in use.</p>
<p>This includes memory used by buffers created by the
<code>--buffer</code> flag and buffers used by multi-thread
transfers.</p>
<p>Most multi-thread transfers do not take additional memory, but some
do depending on the backend (eg the s3 backend for uploads). This means
there is a tension between total setting <code>--transfers</code> as
high as possible and memory use.</p>
<p>Setting <code>--max-buffer-memory</code> allows the buffer memory to
be controlled so that it doesn't overwhelm the machine and allows
<code>--transfers</code> to be set large.</p>
<h3 id="max-connections-int">--max-connections int</h3>
<p>This sets the maximum number of concurrent calls to the backend API.
It may not map 1:1 to TCP or HTTP connections depending on the backend
in use and the use of HTTP1 vs HTTP2.</p>
<p>When downloading files, backends only limit the initial opening of
the stream. The bulk data download is not counted as a connection. This
means that the <code>--max--connections</code> flag won't limit the
total number of downloads.</p>
<p>Note that it is possible to cause deadlocks with this setting so it
should be used with care.</p>
<p>If you are doing a sync or copy then make sure
<code>--max-connections</code> is one more than the sum of
<code>--transfers</code> and <code>--checkers</code>.</p>
<p>If you use <code>--check-first</code> then
<code>--max-connections</code> just needs to be one more than the
maximum of <code>--checkers</code> and <code>--transfers</code>.</p>
<p>So for <code>--max-connections 3</code> you'd use
<code>--checkers 2 --transfers 2 --check-first</code> or
<code>--checkers 1 --transfers 1</code>.</p>
<p>Setting this flag can be useful for backends which do multipart
uploads to limit the number of simultaneous parts being transferred.</p>
<h3 id="max-delete-int">--max-delete int</h3>
<p>This tells rclone not to delete more than N files. If that limit is
exceeded then a fatal error will be generated and rclone will stop the
operation in progress.</p>
<h3 id="max-delete-size-sizesuffix">--max-delete-size SizeSuffix</h3>
<p>Rclone will stop deleting files when the total size of deletions has
reached the size specified. It defaults to off.</p>
<p>If that limit is exceeded then a fatal error will be generated and
rclone will stop the operation in progress.</p>
<h3 id="max-depth-int">--max-depth int</h3>
<p>This modifies the recursion depth for all the commands except
purge.</p>
<p>So if you do <code>rclone --max-depth 1 ls remote:path</code> you
will see only the files in the top level directory. Using
<code>--max-depth 2</code> means you will see all the files in first two
directory levels and so on.</p>
<p>For historical reasons the <code>lsd</code> command defaults to using
a <code>--max-depth</code> of 1 - you can override this with the command
line flag.</p>
<p>You can use this command to disable recursion (with
<code>--max-depth 1</code>).</p>
<p>Note that if you use this with <code>sync</code> and
<code>--delete-excluded</code> the files not recursed through are
considered excluded and will be deleted on the destination. Test first
with <code>--dry-run</code> if you are not sure what will happen.</p>
<h3 id="max-duration-duration">--max-duration Duration</h3>
<p>Rclone will stop transferring when it has run for the duration
specified. Defaults to off.</p>
<p>When the limit is reached all transfers will stop immediately. Use
<code>--cutoff-mode</code> to modify this behaviour.</p>
<p>Rclone will exit with exit code 10 if the duration limit is
reached.</p>
<h3 id="max-transfer-sizesuffix">--max-transfer SizeSuffix</h3>
<p>Rclone will stop transferring when it has reached the size specified.
Defaults to off.</p>
<p>When the limit is reached all transfers will stop immediately. Use
<code>--cutoff-mode</code> to modify this behaviour.</p>
<p>Rclone will exit with exit code 8 if the transfer limit is
reached.</p>
<h3 id="cutoff-mode-hardsoftcautious">--cutoff-mode
HARD|SOFT|CAUTIOUS</h3>
<p>Configure the behavior of <code>--max-transfer</code> and
<code>--max-duration</code>.</p>
<p><code>HARD</code> will stop transferring immediately when rclone
reaches the limit. This is the default.</p>
<p><code>SOFT</code> will stop starting new transfers when rclone
reaches the limit.</p>
<p><code>CAUTIOUS</code> will try to prevent rclone from reaching the
limit. Only applicable for <code>--max-transfer</code>.</p>
<h2 id="m---metadata">-M, --metadata</h2>
<p>Setting this flag enables rclone to copy the metadata from the source
to the destination. For local backends this is ownership, permissions,
xattr etc. See the <a href="#metadata">metadata section</a> for more
info.</p>
<h3 id="metadata-mapper">--metadata-mapper SpaceSepList</h3>
<p>If you supply the parameter
<code>--metadata-mapper /path/to/program</code> then rclone will use
that program to map metadata from source object to destination
object.</p>
<p>The argument to this flag should be a command with an optional space
separated list of arguments. If one of the arguments has a space in then
enclose it in <code>"</code>, if you want a literal <code>"</code> in an
argument then enclose the argument in <code>"</code> and double the
<code>"</code>. See <a href="https://godoc.org/encoding/csv">CSV
encoding</a> for more info.</p>
<div class="sourceCode" id="cb665"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb665-1"><a href="#cb665-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--metadata-mapper</span> <span class="st">&quot;python bin/test_metadata_mapper.py&quot;</span></span>
<span id="cb665-2"><a href="#cb665-2" aria-hidden="true" tabindex="-1"></a><span class="ex">--metadata-mapper</span> <span class="st">&#39;python bin/test_metadata_mapper.py &quot;argument with a space&quot;&#39;</span></span>
<span id="cb665-3"><a href="#cb665-3" aria-hidden="true" tabindex="-1"></a><span class="ex">--metadata-mapper</span> <span class="st">&#39;python bin/test_metadata_mapper.py &quot;argument with &quot;&quot;two&quot;&quot; quotes&quot;&#39;</span></span></code></pre></div>
<p>This uses a simple JSON based protocol with input on STDIN and output
on STDOUT. This will be called for every file and directory copied and
may be called concurrently.</p>
<p>The program's job is to take a metadata blob on the input and turn it
into a metadata blob on the output suitable for the destination
backend.</p>
<p>Input to the program (via STDIN) might look like this. This provides
some context for the <code>Metadata</code> which may be important.</p>
<ul>
<li><code>SrcFs</code> is the config string for the remote that the
object is currently on.</li>
<li><code>SrcFsType</code> is the name of the source backend.</li>
<li><code>DstFs</code> is the config string for the remote that the
object is being copied to</li>
<li><code>DstFsType</code> is the name of the destination backend.</li>
<li><code>Remote</code> is the path of the object relative to the
root.</li>
<li><code>Size</code>, <code>MimeType</code>, <code>ModTime</code> are
attributes of the object.</li>
<li><code>IsDir</code> is <code>true</code> if this is a directory (not
yet implemented).</li>
<li><code>ID</code> is the source <code>ID</code> of the object if
known.</li>
<li><code>Metadata</code> is the backend specific metadata as described
in the backend docs.</li>
</ul>
<div class="sourceCode" id="cb666"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb666-1"><a href="#cb666-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb666-2"><a href="#cb666-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;SrcFs&quot;</span><span class="fu">:</span> <span class="st">&quot;gdrive:&quot;</span><span class="fu">,</span></span>
<span id="cb666-3"><a href="#cb666-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;SrcFsType&quot;</span><span class="fu">:</span> <span class="st">&quot;drive&quot;</span><span class="fu">,</span></span>
<span id="cb666-4"><a href="#cb666-4" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;DstFs&quot;</span><span class="fu">:</span> <span class="st">&quot;newdrive:user&quot;</span><span class="fu">,</span></span>
<span id="cb666-5"><a href="#cb666-5" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;DstFsType&quot;</span><span class="fu">:</span> <span class="st">&quot;onedrive&quot;</span><span class="fu">,</span></span>
<span id="cb666-6"><a href="#cb666-6" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Remote&quot;</span><span class="fu">:</span> <span class="st">&quot;test.txt&quot;</span><span class="fu">,</span></span>
<span id="cb666-7"><a href="#cb666-7" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Size&quot;</span><span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
<span id="cb666-8"><a href="#cb666-8" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;MimeType&quot;</span><span class="fu">:</span> <span class="st">&quot;text/plain; charset=utf-8&quot;</span><span class="fu">,</span></span>
<span id="cb666-9"><a href="#cb666-9" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;ModTime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T17:53:10.286745272+01:00&quot;</span><span class="fu">,</span></span>
<span id="cb666-10"><a href="#cb666-10" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;IsDir&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
<span id="cb666-11"><a href="#cb666-11" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;ID&quot;</span><span class="fu">:</span> <span class="st">&quot;xyz&quot;</span><span class="fu">,</span></span>
<span id="cb666-12"><a href="#cb666-12" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Metadata&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb666-13"><a href="#cb666-13" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;btime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T16:53:11Z&quot;</span><span class="fu">,</span></span>
<span id="cb666-14"><a href="#cb666-14" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;content-type&quot;</span><span class="fu">:</span> <span class="st">&quot;text/plain; charset=utf-8&quot;</span><span class="fu">,</span></span>
<span id="cb666-15"><a href="#cb666-15" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;mtime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T17:53:10.286745272+01:00&quot;</span><span class="fu">,</span></span>
<span id="cb666-16"><a href="#cb666-16" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;owner&quot;</span><span class="fu">:</span> <span class="st">&quot;user1@domain1.com&quot;</span><span class="fu">,</span></span>
<span id="cb666-17"><a href="#cb666-17" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;permissions&quot;</span><span class="fu">:</span> <span class="st">&quot;...&quot;</span><span class="fu">,</span></span>
<span id="cb666-18"><a href="#cb666-18" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;description&quot;</span><span class="fu">:</span> <span class="st">&quot;my nice file&quot;</span><span class="fu">,</span></span>
<span id="cb666-19"><a href="#cb666-19" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;starred&quot;</span><span class="fu">:</span> <span class="st">&quot;false&quot;</span></span>
<span id="cb666-20"><a href="#cb666-20" aria-hidden="true" tabindex="-1"></a>  <span class="fu">}</span></span>
<span id="cb666-21"><a href="#cb666-21" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>The program should then modify the input as desired and send it to
STDOUT. The returned <code>Metadata</code> field will be used in its
entirety for the destination object. Any other fields will be ignored.
Note in this example we translate user names and permissions and add
something to the description:</p>
<div class="sourceCode" id="cb667"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb667-1"><a href="#cb667-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb667-2"><a href="#cb667-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Metadata&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb667-3"><a href="#cb667-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;btime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T16:53:11Z&quot;</span><span class="fu">,</span></span>
<span id="cb667-4"><a href="#cb667-4" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;content-type&quot;</span><span class="fu">:</span> <span class="st">&quot;text/plain; charset=utf-8&quot;</span><span class="fu">,</span></span>
<span id="cb667-5"><a href="#cb667-5" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;mtime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T17:53:10.286745272+01:00&quot;</span><span class="fu">,</span></span>
<span id="cb667-6"><a href="#cb667-6" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;owner&quot;</span><span class="fu">:</span> <span class="st">&quot;user1@domain2.com&quot;</span><span class="fu">,</span></span>
<span id="cb667-7"><a href="#cb667-7" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;permissions&quot;</span><span class="fu">:</span> <span class="st">&quot;...&quot;</span><span class="fu">,</span></span>
<span id="cb667-8"><a href="#cb667-8" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;description&quot;</span><span class="fu">:</span> <span class="st">&quot;my nice file [migrated from domain1]&quot;</span><span class="fu">,</span></span>
<span id="cb667-9"><a href="#cb667-9" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;starred&quot;</span><span class="fu">:</span> <span class="st">&quot;false&quot;</span></span>
<span id="cb667-10"><a href="#cb667-10" aria-hidden="true" tabindex="-1"></a>  <span class="fu">}</span></span>
<span id="cb667-11"><a href="#cb667-11" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Metadata can be removed here too.</p>
<p>An example python program might look something like this to implement
the above transformations.</p>
<div class="sourceCode" id="cb668"><pre
class="sourceCode python"><code class="sourceCode python"><span id="cb668-1"><a href="#cb668-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> sys, json</span>
<span id="cb668-2"><a href="#cb668-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb668-3"><a href="#cb668-3" aria-hidden="true" tabindex="-1"></a>i <span class="op">=</span> json.load(sys.stdin)</span>
<span id="cb668-4"><a href="#cb668-4" aria-hidden="true" tabindex="-1"></a>metadata <span class="op">=</span> i[<span class="st">&quot;Metadata&quot;</span>]</span>
<span id="cb668-5"><a href="#cb668-5" aria-hidden="true" tabindex="-1"></a><span class="co"># Add tag to description</span></span>
<span id="cb668-6"><a href="#cb668-6" aria-hidden="true" tabindex="-1"></a><span class="cf">if</span> <span class="st">&quot;description&quot;</span> <span class="kw">in</span> metadata:</span>
<span id="cb668-7"><a href="#cb668-7" aria-hidden="true" tabindex="-1"></a>    metadata[<span class="st">&quot;description&quot;</span>] <span class="op">+=</span> <span class="st">&quot; [migrated from domain1]&quot;</span></span>
<span id="cb668-8"><a href="#cb668-8" aria-hidden="true" tabindex="-1"></a><span class="cf">else</span>:</span>
<span id="cb668-9"><a href="#cb668-9" aria-hidden="true" tabindex="-1"></a>    metadata[<span class="st">&quot;description&quot;</span>] <span class="op">=</span> <span class="st">&quot;[migrated from domain1]&quot;</span></span>
<span id="cb668-10"><a href="#cb668-10" aria-hidden="true" tabindex="-1"></a><span class="co"># Modify owner</span></span>
<span id="cb668-11"><a href="#cb668-11" aria-hidden="true" tabindex="-1"></a><span class="cf">if</span> <span class="st">&quot;owner&quot;</span> <span class="kw">in</span> metadata:</span>
<span id="cb668-12"><a href="#cb668-12" aria-hidden="true" tabindex="-1"></a>    metadata[<span class="st">&quot;owner&quot;</span>] <span class="op">=</span> metadata[<span class="st">&quot;owner&quot;</span>].replace(<span class="st">&quot;domain1.com&quot;</span>, <span class="st">&quot;domain2.com&quot;</span>)</span>
<span id="cb668-13"><a href="#cb668-13" aria-hidden="true" tabindex="-1"></a>o <span class="op">=</span> { <span class="st">&quot;Metadata&quot;</span>: metadata }</span>
<span id="cb668-14"><a href="#cb668-14" aria-hidden="true" tabindex="-1"></a>json.dump(o, sys.stdout, indent<span class="op">=</span><span class="st">&quot;</span><span class="ch">\t</span><span class="st">&quot;</span>)</span></code></pre></div>
<p>You can find this example (slightly expanded) in the rclone source
code at <a
href="https://github.com/rclone/rclone/blob/master/bin/test_metadata_mapper.py">bin/test_metadata_mapper.py</a>.</p>
<p>If you want to see the input to the metadata mapper and the output
returned from it in the log you can use
<code>-vv --dump mapper</code>.</p>
<p>See the <a href="#metadata">metadata section</a> for more info.</p>
<h3 id="metadata-set-stringarray">--metadata-set stringArray</h3>
<p>Specify value as string in format <code>key=value</code> to add
metadata <code>key</code> with value <code>value</code> when uploading.
This can be repeated as many times as required. See the <a
href="#metadata">metadata section</a> for more info.</p>
<h3 id="modify-window-duration">--modify-window Duration</h3>
<p>When checking whether a file has been modified, this is the maximum
allowed time difference that a file can have and still be considered
equivalent.</p>
<p>The default is <code>1ns</code> unless this is overridden by a
remote. For example OS X only stores modification times to the nearest
second so if you are reading and writing to an OS X filing system this
will be <code>1s</code> by default.</p>
<p>This command line flag allows you to override that computed
default.</p>
<h3
id="multi-thread-write-buffer-size-sizesuffix">--multi-thread-write-buffer-size
SizeSuffix</h3>
<p>When transferring with multiple threads, rclone will buffer the
specified number of bytes in memory before writing to disk for each
thread.</p>
<p>This can improve performance if the underlying filesystem does not
deal well with a lot of small writes in different positions of the file,
so if you see transfers being limited by disk write speed, you might
want to experiment with different values. Specially for magnetic drives
and remote file systems a higher value can be useful.</p>
<p>Nevertheless, the default of <code>128k</code> should be fine for
almost all use cases, so before changing it ensure that network is not
really your bottleneck.</p>
<p>As a final hint, size is not the only factor: block size (or similar
concept) can have an impact. In one case, we observed that exact
multiples of 16k performed much better than other values.</p>
<h3 id="multi-thread-chunk-size-sizesuffix">--multi-thread-chunk-size
SizeSuffix</h3>
<p>Normally the chunk size for multi thread transfers is set by the
backend. However some backends such as <code>local</code> and
<code>smb</code> (which implement <code>OpenWriterAt</code> but not
<code>OpenChunkWriter</code>) don't have a natural chunk size.</p>
<p>In this case the value of this option is used (default 64Mi).</p>
<h3 id="multi-thread-cutoff">--multi-thread-cutoff SizeSuffix</h3>
<p>When transferring files above specified size to capable backends,
rclone will use multiple threads to transfer the file (default
256M).</p>
<p>Capable backends are marked in the <a
href="https://rclone.org/overview/#optional-features">overview</a> as
<code>MultithreadUpload</code>. (They need to implement either the
<code>OpenWriterAt</code> or <code>OpenChunkWriter</code> internal
interfaces). These include include, <code>local</code>, <code>s3</code>,
<code>azureblob</code>, <code>b2</code>,
<code>oracleobjectstorage</code> and <code>smb</code> at the time of
writing.</p>
<p>On the local disk, rclone preallocates the file (using
<code>fallocate(FALLOC_FL_KEEP_SIZE)</code> on unix or
<code>NTSetInformationFile</code> on Windows both of which takes no
time) then each thread writes directly into the file at the correct
place. This means that rclone won't create fragmented or sparse files
and there won't be any assembly time at the end of the transfer.</p>
<p>The number of threads used to transfer is controlled by
<code>--multi-thread-streams</code>.</p>
<p>Use <code>-vv</code> if you wish to see info about the threads.</p>
<p>This will work with the <a
href="https://rclone.org/commands/rclone_sync/">sync</a>, <a
href="https://rclone.org/commands/rclone_copy/">copy</a> and <a
href="https://rclone.org/commands/rclone_move/">move</a> commands, and
friends <a href="https://rclone.org/commands/rclone_copyto/">copyto</a>,
<a href="https://rclone.org/commands/rclone_moveto/">moveto</a>. Multi
thread transfers will be used with <code>rclone mount</code> and
<code>rclone serve</code> if <code>--vfs-cache-mode</code> is set to
<code>writes</code> or above.</p>
<p>Most multi-thread transfers do not take additional memory, but some
do (for example uploading to s3). In the worst case memory usage can be
at maximum <code>--transfers</code> *
<code>--multi-thread-chunk-size</code> *
<code>--multi-thread-streams</code> or specifically for the s3 backend
<code>--transfers</code> * <code>--s3-chunk-size</code> *
<code>--s3-concurrency</code>. However you can use the the <a
href="https://rclone.org/docs/#max-buffer-memory">--max-buffer-memory</a>
flag to control the maximum memory used here.</p>
<p><strong>NB</strong> that this <strong>only</strong> works with
supported backends as the destination but will work with any backend as
the source.</p>
<p><strong>NB</strong> that multi-thread copies are disabled for local
to local copies as they are faster without unless
<code>--multi-thread-streams</code> is set explicitly.</p>
<p><strong>NB</strong> on Windows using multi-thread transfers to the
local disk will cause the resulting files to be <a
href="https://en.wikipedia.org/wiki/Sparse_file">sparse</a>. Use
<code>--local-no-sparse</code> to disable sparse files (which may cause
long delays at the start of transfers) or disable multi-thread transfers
with <code>--multi-thread-streams 0</code></p>
<h3 id="multi-thread-streams-int">--multi-thread-streams int</h3>
<p>When using multi thread transfers (see above
<code>--multi-thread-cutoff</code>) this sets the number of streams to
use. Set to <code>0</code> to disable multi thread transfers (Default
4).</p>
<p>If the backend has a <code>--backend-upload-concurrency</code>
setting (eg <code>--s3-upload-concurrency</code>) then this setting will
be used as the number of transfers instead if it is larger than the
value of <code>--multi-thread-streams</code> or
<code>--multi-thread-streams</code> isn't set.</p>
<h3 id="name-transform-stringarray">--name-transform stringArray</h3>
<p><code>--name-transform</code> introduces path name transformations
for <code>rclone copy</code>, <code>rclone sync</code>, and
<code>rclone move</code>. These transformations enable modifications to
source and destination file names by applying prefixes, suffixes, and
other alterations during transfer operations. For detailed docs and
examples, see <a
href="https://rclone.org/commands/rclone_convmv/"><code>convmv</code></a>.</p>
<h3 id="no-check-dest">--no-check-dest</h3>
<p>The <code>--no-check-dest</code> can be used with <code>move</code>
or <code>copy</code> and it causes rclone not to check the destination
at all when copying files.</p>
<p>This means that:</p>
<ul>
<li>the destination is not listed minimising the API calls</li>
<li>files are always transferred</li>
<li>this can cause duplicates on remotes which allow it (e.g. Google
Drive)</li>
<li><code>--retries 1</code> is recommended otherwise you'll transfer
everything again on a retry</li>
</ul>
<p>This flag is useful to minimise the transactions if you know that
none of the files are on the destination.</p>
<p>This is a specialized flag which should be ignored by most users!</p>
<h3 id="no-gzip-encoding">--no-gzip-encoding</h3>
<p>Don't set <code>Accept-Encoding: gzip</code>. This means that rclone
won't ask the server for compressed files automatically. Useful if
you've set the server to return files with
<code>Content-Encoding: gzip</code> but you uploaded compressed
files.</p>
<p>There is no need to set this in normal operation, and doing so will
decrease the network transfer efficiency of rclone.</p>
<h3 id="no-traverse">--no-traverse</h3>
<p>The <code>--no-traverse</code> flag controls whether the destination
file system is traversed when using the <code>copy</code> or
<code>move</code> commands. <code>--no-traverse</code> is not compatible
with <code>sync</code> and will be ignored if you supply it with
<code>sync</code>.</p>
<p>If you are only copying a small number of files (or are filtering
most of the files) and/or have a large number of files on the
destination then <code>--no-traverse</code> will stop rclone listing the
destination and save time.</p>
<p>However, if you are copying a large number of files, especially if
you are doing a copy where lots of the files under consideration haven't
changed and won't need copying then you shouldn't use
<code>--no-traverse</code>.</p>
<p>See <a href="https://rclone.org/commands/rclone_copy/">rclone
copy</a> for an example of how to use it.</p>
<h3 id="no-unicode-normalization">--no-unicode-normalization</h3>
<p>Don't normalize unicode characters in filenames during the sync
routine.</p>
<p>Sometimes, an operating system will store filenames containing
unicode parts in their decomposed form (particularly macOS). Some cloud
storage systems will then recompose the unicode, resulting in duplicate
files if the data is ever copied back to a local filesystem.</p>
<p>Using this flag will disable that functionality, treating each
unicode character as unique. For example, by default é and é will be
normalized into the same character. With
<code>--no-unicode-normalization</code> they will be treated as unique
characters.</p>
<h3 id="no-update-modtime">--no-update-modtime</h3>
<p>When using this flag, rclone won't update modification times of
remote files if they are incorrect as it would normally.</p>
<p>This can be used if the remote is being synced with another tool also
(e.g. the Google Drive client).</p>
<h3 id="no-update-dir-modtime">--no-update-dir-modtime</h3>
<p>When using this flag, rclone won't update modification times of
remote directories if they are incorrect as it would normally.</p>
<h3 id="order-by-string">--order-by string</h3>
<p>The <code>--order-by</code> flag controls the order in which files in
the backlog are processed in <code>rclone sync</code>,
<code>rclone copy</code> and <code>rclone move</code>.</p>
<p>The order by string is constructed like this. The first part
describes what aspect is being measured:</p>
<ul>
<li><code>size</code> - order by the size of the files</li>
<li><code>name</code> - order by the full path of the files</li>
<li><code>modtime</code> - order by the modification date of the
files</li>
</ul>
<p>This can have a modifier appended with a comma:</p>
<ul>
<li><code>ascending</code> or <code>asc</code> - order so that the
smallest (or oldest) is processed first</li>
<li><code>descending</code> or <code>desc</code> - order so that the
largest (or newest) is processed first</li>
<li><code>mixed</code> - order so that the smallest is processed first
for some threads and the largest for others</li>
</ul>
<p>If the modifier is <code>mixed</code> then it can have an optional
percentage (which defaults to <code>50</code>), e.g.
<code>size,mixed,25</code> which means that 25% of the threads should be
taking the smallest items and 75% the largest. The threads which take
the smallest first will always take the smallest first and likewise the
largest first threads. The <code>mixed</code> mode can be useful to
minimise the transfer time when you are transferring a mixture of large
and small files - the large files are guaranteed upload threads and
bandwidth and the small files will be processed continuously.</p>
<p>If no modifier is supplied then the order is
<code>ascending</code>.</p>
<p>For example</p>
<ul>
<li><code>--order-by size,desc</code> - send the largest files
first</li>
<li><code>--order-by modtime,ascending</code> - send the oldest files
first</li>
<li><code>--order-by name</code> - send the files with alphabetically by
path first</li>
</ul>
<p>If the <code>--order-by</code> flag is not supplied or it is supplied
with an empty string then the default ordering will be used which is as
scanned. With <code>--checkers 1</code> this is mostly alphabetical,
however with the default <code>--checkers 8</code> it is somewhat
random.</p>
<h4 id="limitations-3">Limitations</h4>
<p>The <code>--order-by</code> flag does not do a separate pass over the
data. This means that it may transfer some files out of the order
specified if</p>
<ul>
<li>there are no files in the backlog or the source has not been fully
scanned yet</li>
<li>there are more than <a href="#max-backlog-int">--max-backlog</a>
files in the backlog</li>
</ul>
<p>Rclone will do its best to transfer the best file it has so in
practice this should not cause a problem. Think of
<code>--order-by</code> as being more of a best efforts flag rather than
a perfect ordering.</p>
<p>If you want perfect ordering then you will need to specify <a
href="#check-first">--check-first</a> which will find all the files
which need transferring first before transferring any.</p>
<h3 id="partial-suffix">--partial-suffix string</h3>
<p>When <a href="#inplace">--inplace</a> is not used, it causes rclone
to use the <code>--partial-suffix</code> as suffix for temporary
files.</p>
<p>Suffix length limit is 16 characters.</p>
<p>The default is <code>.partial</code>.</p>
<h3 id="password-command">--password-command SpaceSepList</h3>
<p>This flag supplies a program which should supply the config password
when run. This is an alternative to rclone prompting for the password or
setting the <code>RCLONE_CONFIG_PASS</code> variable. It is also used
when setting the config password for the first time.</p>
<p>The argument to this should be a command with a space separated list
of arguments. If one of the arguments has a space in then enclose it in
<code>"</code>, if you want a literal <code>"</code> in an argument then
enclose the argument in <code>"</code> and double the <code>"</code>.
See <a href="https://godoc.org/encoding/csv">CSV encoding</a> for more
info.</p>
<p>Eg</p>
<div class="sourceCode" id="cb669"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb669-1"><a href="#cb669-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--password-command</span> <span class="st">&quot;echo hello&quot;</span></span>
<span id="cb669-2"><a href="#cb669-2" aria-hidden="true" tabindex="-1"></a><span class="ex">--password-command</span> <span class="st">&#39;echo &quot;hello with space&quot;&#39;</span></span>
<span id="cb669-3"><a href="#cb669-3" aria-hidden="true" tabindex="-1"></a><span class="ex">--password-command</span> <span class="st">&#39;echo &quot;hello with &quot;&quot;quotes&quot;&quot; and space&quot;&#39;</span></span></code></pre></div>
<p>Note that when changing the configuration password the environment
variable <code>RCLONE_PASSWORD_CHANGE=1</code> will be set. This can be
used to distinguish initial decryption of the config file from the new
password.</p>
<p>See the <a href="#configuration-encryption">Configuration
Encryption</a> for more info.</p>
<p>See a <a
href="https://github.com/rclone/rclone/wiki/Windows-Powershell-use-rclone-password-command-for-Config-file-password">Windows
PowerShell example on the Wiki</a>.</p>
<h3 id="p---progress">-P, --progress</h3>
<p>This flag makes rclone update the stats in a static block in the
terminal providing a realtime overview of the transfer.</p>
<p>Any log messages will scroll above the static block. Log messages
will push the static block down to the bottom of the terminal where it
will stay.</p>
<p>Normally this is updated every 500mS but this period can be
overridden with the <code>--stats</code> flag.</p>
<p>This can be used with the <code>--stats-one-line</code> flag for a
simpler display.</p>
<p>To change the display length of filenames (for different terminal
widths), see the <code>--stats-file-name-length</code> option. The
default output is formatted for 80 character wide terminals.</p>
<p>Note: On Windows until <a
href="https://github.com/Azure/go-ansiterm/issues/26">this bug</a> is
fixed all non-ASCII characters will be replaced with <code>.</code> when
<code>--progress</code> is in use.</p>
<h3 id="progress-terminal-title">--progress-terminal-title</h3>
<p>This flag, when used with <code>-P/--progress</code>, will print the
string <code>ETA: %s</code> to the terminal title.</p>
<h3 id="q---quiet">-q, --quiet</h3>
<p>This flag will limit rclone's output to error messages only.</p>
<h3 id="refresh-times">--refresh-times</h3>
<p>The <code>--refresh-times</code> flag can be used to update
modification times of existing files when they are out of sync on
backends which don't support hashes.</p>
<p>This is useful if you uploaded files with the incorrect timestamps
and you now wish to correct them.</p>
<p>This flag is <strong>only</strong> useful for destinations which
don't support hashes (e.g. <code>crypt</code>).</p>
<p>This can be used any of the sync commands <a
href="https://rclone.org/commands/rclone_sync/">sync</a>, <a
href="https://rclone.org/commands/rclone_copy/">copy</a> or <a
href="https://rclone.org/commands/rclone_move/">move</a>.</p>
<p>To use this flag you will need to be doing a modification time sync
(so not using <code>--size-only</code> or <code>--checksum</code>). The
flag will have no effect when using <code>--size-only</code> or
<code>--checksum</code>.</p>
<p>If this flag is used when rclone comes to upload a file it will check
to see if there is an existing file on the destination. If this file
matches the source with size (and checksum if available) but has a
differing timestamp then instead of re-uploading it, rclone will update
the timestamp on the destination file. If the checksum does not match
rclone will upload the new file. If the checksum is absent (e.g. on a
<code>crypt</code> backend) then rclone will update the timestamp.</p>
<p>Note that some remotes can't set the modification time without
re-uploading the file so this flag is less useful on them.</p>
<p>Normally if you are doing a modification time sync rclone will update
modification times without <code>--refresh-times</code> provided that
the remote supports checksums <strong>and</strong> the checksums match
on the file. However if the checksums are absent then rclone will upload
the file rather than setting the timestamp as this is the safe
behaviour.</p>
<h3 id="retries-int">--retries int</h3>
<p>Retry the entire sync if it fails this many times it fails (default
3).</p>
<p>Some remotes can be unreliable and a few retries help pick up the
files which didn't get transferred because of errors.</p>
<p>Disable retries with <code>--retries 1</code>.</p>
<h3 id="retries-sleep-duration">--retries-sleep Duration</h3>
<p>This sets the interval between each retry specified by
<code>--retries</code></p>
<p>The default is <code>0</code>. Use <code>0</code> to disable.</p>
<h3 id="server-side-across-configs">--server-side-across-configs</h3>
<p>Allow server-side operations (e.g. copy or move) to work across
different configurations.</p>
<p>This can be useful if you wish to do a server-side copy or move
between two remotes which use the same backend but are configured
differently.</p>
<p>Note that this isn't enabled by default because it isn't easy for
rclone to tell if it will work between any two configurations.</p>
<h3 id="size-only">--size-only</h3>
<p>Normally rclone will look at modification time and size of files to
see if they are equal. If you set this flag then rclone will check only
the size.</p>
<p>This can be useful transferring files from Dropbox which have been
modified by the desktop sync client which doesn't set checksums of
modification times in the same way as rclone.</p>
<h3 id="stats-duration">--stats Duration</h3>
<p>Commands which transfer data (<a
href="https://rclone.org/commands/rclone_sync/">sync</a>, <a
href="https://rclone.org/commands/rclone_copy/">copy</a>, <a
href="https://rclone.org/commands/rclone_copyto/">copyto</a>, <a
href="https://rclone.org/commands/rclone_move/">move</a>, <a
href="https://rclone.org/commands/rclone_moveto/">moveto</a>) will print
data transfer stats at regular intervals to show their progress.</p>
<p>This sets the interval.</p>
<p>The default is <code>1m</code>. Use <code>0</code> to disable.</p>
<p>If you set the stats interval then all commands can show stats. This
can be useful when running other commands, <code>check</code> or
<code>mount</code> for example.</p>
<p>Stats are logged at <code>INFO</code> level by default which means
they won't show at default log level <code>NOTICE</code>. Use
<code>--stats-log-level NOTICE</code> or <code>-v</code> to make them
show. See the <a href="#logging">logging</a> section for more info on
log levels.</p>
<p>Note that on macOS you can send a SIGINFO (which is normally ctrl-T
in the terminal) to make the stats print immediately.</p>
<h3 id="stats-file-name-length-int">--stats-file-name-length int</h3>
<p>By default, the <code>--stats</code> output will truncate file names
and paths longer than 40 characters. This is equivalent to providing
<code>--stats-file-name-length 40</code>. Use
<code>--stats-file-name-length 0</code> to disable any truncation of
file names printed by stats.</p>
<h3 id="stats-log-level-loglevel">--stats-log-level LogLevel</h3>
<p>Log level to show <code>--stats</code> output at. This can be
<code>DEBUG</code>, <code>INFO</code>, <code>NOTICE</code>, or
<code>ERROR</code>. The default is <code>INFO</code>. This means at the
default level of logging, which is <code>NOTICE</code>, the stats won't
show - if you want them to then use
<code>--stats-log-level NOTICE</code>. See the <a
href="#logging">logging</a> section for more details on log levels.</p>
<h3 id="stats-one-line">--stats-one-line</h3>
<p>When this is specified, rclone condenses the stats into a single line
showing the most important stats only.</p>
<h3 id="stats-one-line-date">--stats-one-line-date</h3>
<p>When this is specified, rclone enables the single-line stats and
prepends <!-- markdownlint-disable-next-line no-space-in-code --> the
display with a date string. The default is
<code>2006/01/02 15:04:05 -</code></p>
<h3 id="stats-one-line-date-format-string">--stats-one-line-date-format
string</h3>
<p>When this is specified, rclone enables the single-line stats and
prepends the display with a user-supplied date string. The date string
MUST be enclosed in quotes. Follow <a
href="https://golang.org/pkg/time/#Time.Format">golang specs</a> for
date formatting syntax.</p>
<h3 id="stats-unit-string">--stats-unit string</h3>
<p>By default, data transfer rates will be printed in bytes per second,
corresponding to <code>--stats-unit bytes</code>.</p>
<p>This option allows the data rate to be printed in bits per second, by
specifying <code>--stats-unit bits</code>. Data transfer volume will
still be reported in bytes.</p>
<p>The rate is reported as a binary unit, not SI unit. So 1 Mbit/s
equals 1,048,576 bit/s and not 1,000,000 bit/s.</p>
<h3 id="suffix-string">--suffix string</h3>
<p>When using <a
href="https://rclone.org/commands/rclone_sync/">sync</a>, <a
href="https://rclone.org/commands/rclone_copy/">copy</a> or <a
href="https://rclone.org/commands/rclone_move/">move</a> any files which
would have been overwritten or deleted will have the suffix added to
them. If there is a file with the same path (after the suffix has been
added), then it will be overwritten.</p>
<p>The remote in use must support server-side move or copy and you must
use the same remote as the destination of the sync.</p>
<p>This is for use with files to add the suffix in the current directory
or with <code>--backup-dir</code>. See <code>--backup-dir</code> for
more info.</p>
<p>For example</p>
<div class="sourceCode" id="cb670"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb670-1"><a href="#cb670-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="at">--interactive</span> /path/to/local/file remote:current <span class="at">--suffix</span> .bak</span></code></pre></div>
<p>will copy <code>/path/to/local</code> to <code>remote:current</code>,
but for any files which would have been updated or deleted have .bak
added.</p>
<p>If using <code>rclone sync</code> with <code>--suffix</code> and
without <code>--backup-dir</code> then it is recommended to put a filter
rule in excluding the suffix otherwise the <code>sync</code> will delete
the backup files.</p>
<div class="sourceCode" id="cb671"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb671-1"><a href="#cb671-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--interactive</span> /path/to/local/file remote:current <span class="at">--suffix</span> .bak <span class="at">--exclude</span> <span class="st">&quot;*.bak&quot;</span></span></code></pre></div>
<h3 id="suffix-keep-extension">--suffix-keep-extension</h3>
<p>When using <code>--suffix</code>, setting this causes rclone put the
SUFFIX before the extension of the files that it backs up rather than
after.</p>
<p>So let's say we had <code>--suffix -2019-01-01</code>, without the
flag <code>file.txt</code> would be backed up to
<code>file.txt-2019-01-01</code> and with the flag it would be backed up
to <code>file-2019-01-01.txt</code>. This can be helpful to make sure
the suffixed files can still be opened.</p>
<p>If a file has two (or more) extensions and the second (or subsequent)
extension is recognised as a valid mime type, then the suffix will go
before that extension. So <code>file.tar.gz</code> would be backed up to
<code>file-2019-01-01.tar.gz</code> whereas
<code>file.badextension.gz</code> would be backed up to
<code>file.badextension-2019-01-01.gz</code>.</p>
<h3 id="syslog">--syslog</h3>
<p>On capable OSes (not Windows or Plan9) send all log output to
syslog.</p>
<p>This can be useful for running rclone in a script or
<code>rclone mount</code>.</p>
<h3 id="syslog-facility-string">--syslog-facility string</h3>
<p>If using <code>--syslog</code> this sets the syslog facility (e.g.
<code>KERN</code>, <code>USER</code>). See <code>man syslog</code> for a
list of possible facilities. The default facility is
<code>DAEMON</code>.</p>
<h3 id="temp-dir-string">--temp-dir string</h3>
<p>Specify the directory rclone will use for temporary files, to
override the default. Make sure the directory exists and have accessible
permissions.</p>
<p>By default the operating system's temp directory will be used:</p>
<ul>
<li>On Unix systems, <code>$TMPDIR</code> if non-empty, else
<code>/tmp</code>.</li>
<li>On Windows, the first non-empty value from <code>%TMP%</code>,
<code>%TEMP%</code>, <code>%USERPROFILE%</code>, or the Windows
directory.</li>
</ul>
<p>When overriding the default with this option, the specified path will
be set as value of environment variable <code>TMPDIR</code> on Unix
systems and <code>TMP</code> and <code>TEMP</code> on Windows.</p>
<p>You can use the <a
href="https://rclone.org/commands/rclone_config_paths/">config paths</a>
command to see the current value.</p>
<h3 id="tpslimit-float">--tpslimit float</h3>
<p>Limit transactions per second to this number. Default is 0 which is
used to mean unlimited transactions per second.</p>
<p>A transaction is roughly defined as an API call; its exact meaning
will depend on the backend. For HTTP based backends it is an HTTP
PUT/GET/POST/etc and its response. For FTP/SFTP it is a round trip
transaction over TCP.</p>
<p>For example, to limit rclone to 10 transactions per second use
<code>--tpslimit 10</code>, or to 1 transaction every 2 seconds use
<code>--tpslimit 0.5</code>.</p>
<p>Use this when the number of transactions per second from rclone is
causing a problem with the cloud storage provider (e.g. getting you
banned or rate limited).</p>
<p>This can be very useful for <code>rclone mount</code> to control the
behaviour of applications using it.</p>
<p>This limit applies to all HTTP based backends and to the FTP and SFTP
backends. It does not apply to the local backend or the Storj
backend.</p>
<p>See also <code>--tpslimit-burst</code>.</p>
<h3 id="tpslimit-burst-int">--tpslimit-burst int</h3>
<p>Max burst of transactions for <code>--tpslimit</code> (default
<code>1</code>).</p>
<p>Normally <code>--tpslimit</code> will do exactly the number of
transaction per second specified. However if you supply
<code>--tps-burst</code> then rclone can save up some transactions from
when it was idle giving a burst of up to the parameter supplied.</p>
<p>For example if you provide <code>--tpslimit-burst 10</code> then if
rclone has been idle for more than 10*<code>--tpslimit</code> then it
can do 10 transactions very quickly before they are limited again.</p>
<p>This may be used to increase performance of <code>--tpslimit</code>
without changing the long term average number of transactions per
second.</p>
<h3 id="track-renames">--track-renames</h3>
<p>By default, rclone doesn't keep track of renamed files, so if you
rename a file locally then sync it to a remote, rclone will delete the
old file on the remote and upload a new copy.</p>
<p>An rclone sync with <code>--track-renames</code> runs like a normal
sync, but keeps track of objects which exist in the destination but not
in the source (which would normally be deleted), and which objects exist
in the source but not the destination (which would normally be
transferred). These objects are then candidates for renaming.</p>
<p>After the sync, rclone matches up the source only and destination
only objects using the <code>--track-renames-strategy</code> specified
and either renames the destination object or transfers the source and
deletes the destination object. <code>--track-renames</code> is
stateless like all of rclone's syncs.</p>
<p>To use this flag the destination must support server-side copy or
server-side move, and to use a hash based
<code>--track-renames-strategy</code> (the default) the source and the
destination must have a compatible hash.</p>
<p>If the destination does not support server-side copy or move, rclone
will fall back to the default behaviour and log an error level message
to the console.</p>
<p>Encrypted destinations are not currently supported by
<code>--track-renames</code> if <code>--track-renames-strategy</code>
includes <code>hash</code>.</p>
<p>Note that <code>--track-renames</code> is incompatible with
<code>--no-traverse</code> and that it uses extra memory to keep track
of all the rename candidates.</p>
<p>Note also that <code>--track-renames</code> is incompatible with
<code>--delete-before</code> and will select <code>--delete-after</code>
instead of <code>--delete-during</code>.</p>
<h3 id="track-renames-strategy-string">--track-renames-strategy
string</h3>
<p>This option changes the file matching criteria for
<code>--track-renames</code>.</p>
<p>The matching is controlled by a comma separated selection of these
tokens:</p>
<ul>
<li><code>modtime</code> - the modification time of the file - not
supported on all backends</li>
<li><code>hash</code> - the hash of the file contents - not supported on
all backends</li>
<li><code>leaf</code> - the name of the file not including its directory
name</li>
<li><code>size</code> - the size of the file (this is always
enabled)</li>
</ul>
<p>The default option is <code>hash</code>.</p>
<p>Using <code>--track-renames-strategy modtime,leaf</code> would match
files based on modification time, the leaf of the file name and the size
only.</p>
<p>Using <code>--track-renames-strategy modtime</code> or
<code>leaf</code> can enable <code>--track-renames</code> support for
encrypted destinations.</p>
<p>Note that the <code>hash</code> strategy is not supported with
encrypted destinations.</p>
<h3 id="delete-beforeduringafter">--delete-(before,during,after)</h3>
<p>This option allows you to specify when files on your destination are
deleted when you sync folders.</p>
<p>Specifying the value <code>--delete-before</code> will delete all
files present on the destination, but not on the source <em>before</em>
starting the transfer of any new or updated files. This uses two passes
through the file systems, one for the deletions and one for the
copies.</p>
<p>Specifying <code>--delete-during</code> will delete files while
checking and uploading files. This is the fastest option and uses the
least memory.</p>
<p>Specifying <code>--delete-after</code> (the default value) will delay
deletion of files until all new/updated files have been successfully
transferred. The files to be deleted are collected in the copy pass then
deleted after the copy pass has completed successfully. The files to be
deleted are held in memory so this mode may use more memory. This is the
safest mode as it will only delete files if there have been no errors
subsequent to that. If there have been errors before the deletions start
then you will get the message
<code>not deleting files as there were IO errors</code>.</p>
<h3 id="fast-list">--fast-list</h3>
<p>When doing anything which involves a directory listing (e.g.
<code>sync</code>, <code>copy</code>, <code>ls</code> - in fact nearly
every command), rclone has different strategies to choose from.</p>
<p>The basic strategy is to list one directory and processes it before
using more directory lists to process any subdirectories. This is a
mandatory backend feature, called <code>List</code>, which means it is
supported by all backends. This strategy uses small amount of memory,
and because it can be parallelised it is fast for operations involving
processing of the list results.</p>
<p>Some backends provide the support for an alternative strategy, where
all files beneath a directory can be listed in one (or a small number)
of transactions. Rclone supports this alternative strategy through an
optional backend feature called <a
href="https://rclone.org/overview/#listr"><code>ListR</code></a>. You
can see in the storage system overview documentation's <a
href="https://rclone.org/overview/#optional-features">optional
features</a> section which backends it is enabled for (these tend to be
the bucket-based ones, e.g. S3, B2, GCS, Swift). This strategy requires
fewer transactions for highly recursive operations, which is important
on backends where this is charged or heavily rate limited. It may be
faster (due to fewer transactions) or slower (because it can't be
parallelized) depending on different parameters, and may require more
memory if rclone has to keep the whole listing in memory.</p>
<p>Which listing strategy rclone picks for a given operation is
complicated, but in general it tries to choose the best possible. It
will prefer <code>ListR</code> in situations where it doesn't need to
store the listed files in memory, e.g. for unlimited recursive
<code>ls</code> command variants. In other situations it will prefer
<code>List</code>, e.g. for <code>sync</code> and <code>copy</code>,
where it needs to keep the listed files in memory, and is performing
operations on them where parallelization may be a huge advantage.</p>
<p>Rclone is not able to take all relevant parameters into account for
deciding the best strategy, and therefore allows you to influence the
choice in two ways: You can stop rclone from using <code>ListR</code> by
disabling the feature, using the <a href="#disable-string">--disable</a>
option (<code>--disable ListR</code>), or you can allow rclone to use
<code>ListR</code> where it would normally choose not to do so due to
higher memory usage, using the <code>--fast-list</code> option. Rclone
should always produce identical results either way. Using
<code>--disable ListR</code> or <code>--fast-list</code> on a remote
which doesn't support <code>ListR</code> does nothing, rclone will just
ignore it.</p>
<p>A rule of thumb is that if you pay for transactions and can fit your
entire sync listing into memory, then <code>--fast-list</code> is
recommended. If you have a very big sync to do, then don't use
<code>--fast-list</code>, otherwise you will run out of memory. Run some
tests and compare before you decide, and if in doubt then just leave the
default, let rclone decide, i.e. not use <code>--fast-list</code>.</p>
<h3 id="timeout-duration">--timeout Duration</h3>
<p>This sets the IO idle timeout. If a transfer has started but then
becomes idle for this long it is considered broken and disconnected.</p>
<p>The default is <code>5m</code>. Set to <code>0</code> to disable.</p>
<h3 id="transfers-int">--transfers int</h3>
<p>The number of file transfers to run in parallel. It can sometimes be
useful to set this to a smaller number if the remote is giving a lot of
timeouts or bigger if you have lots of bandwidth and a fast remote.</p>
<p>The default is to run 4 file transfers in parallel.</p>
<p>Look at --multi-thread-streams if you would like to control single
file transfers.</p>
<h3 id="u---update">-u, --update</h3>
<p>This forces rclone to skip any files which exist on the destination
and have a modified time that is newer than the source file.</p>
<p>This can be useful in avoiding needless transfers when transferring
to a remote which doesn't support modification times directly (or when
using <code>--use-server-modtime</code> to avoid extra API calls) as it
is more accurate than a <code>--size-only</code> check and faster than
using <code>--checksum</code>. On such remotes (or when using
<code>--use-server-modtime</code>) the time checked will be the uploaded
time.</p>
<p>If an existing destination file has a modification time older than
the source file's, it will be updated if the sizes are different. If the
sizes are the same, it will be updated if the checksum is different or
not available.</p>
<p>If an existing destination file has a modification time equal (within
the computed modify window) to the source file's, it will be updated if
the sizes are different. The checksum will not be checked in this case
unless the <code>--checksum</code> flag is provided.</p>
<p>In all other cases the file will not be updated.</p>
<p>Consider using the <code>--modify-window</code> flag to compensate
for time skews between the source and the backend, for backends that do
not support mod times, and instead use uploaded times. However, if the
backend does not support checksums, note that syncing or copying within
the time skew window may still result in additional transfers for
safety.</p>
<h3 id="use-mmap">--use-mmap</h3>
<p>If this flag is set then rclone will use anonymous memory allocated
by mmap on Unix based platforms and VirtualAlloc on Windows for its
transfer buffers (size controlled by <code>--buffer-size</code>). Memory
allocated like this does not go on the Go heap and can be returned to
the OS immediately when it is finished with.</p>
<p>If this flag is not set then rclone will allocate and free the
buffers using the Go memory allocator which may use more memory as
memory pages are returned less aggressively to the OS.</p>
<p>It is possible this does not work well on all platforms so it is
disabled by default; in the future it may be enabled by default.</p>
<h3 id="use-server-modtime">--use-server-modtime</h3>
<p>Some object-store backends (e.g, Swift, S3) do not preserve file
modification times (modtime). On these backends, rclone stores the
original modtime as additional metadata on the object. By default it
will make an API call to retrieve the metadata when the modtime is
needed by an operation.</p>
<p>Use this flag to disable the extra API call and rely instead on the
server's modified time. In cases such as a local to remote sync using
<code>--update</code>, knowing the local file is newer than the time it
was last uploaded to the remote is sufficient. In those cases, this flag
can speed up the process and reduce the number of API calls
necessary.</p>
<p>Using this flag on a sync operation without also using
<code>--update</code> would cause all files modified at any time other
than the last upload time to be uploaded again, which is probably not
what you want.</p>
<h3 id="v--vv---verbose">-v, -vv, --verbose</h3>
<p>With <code>-v</code> rclone will tell you about each file that is
transferred and a small number of significant events.</p>
<p>With <code>-vv</code> rclone will become very verbose telling you
about every file it considers and transfers. Please send bug reports
with a log with this setting.</p>
<p>When setting verbosity as an environment variable, use
<code>RCLONE_VERBOSE=1</code> or <code>RCLONE_VERBOSE=2</code> for
<code>-v</code> and <code>-vv</code> respectively.</p>
<h3 id="v---version">-V, --version</h3>
<p>Prints the version number</p>
<h2 id="ssltls-options">SSL/TLS options</h2>
<p>The outgoing SSL/TLS connections rclone makes can be controlled with
these options. For example this can be very useful with the HTTP or
WebDAV backends. Rclone HTTP servers have their own set of configuration
for SSL/TLS which you can find in their documentation.</p>
<h3 id="ca-cert-stringarray">--ca-cert stringArray</h3>
<p>This loads the PEM encoded certificate authority certificates and
uses it to verify the certificates of the servers rclone connects
to.</p>
<p>If you have generated certificates signed with a local CA then you
will need this flag to connect to servers using those certificates.</p>
<h3 id="client-cert-string">--client-cert string</h3>
<p>This loads the PEM encoded client side certificate.</p>
<p>This is used for <a
href="https://en.wikipedia.org/wiki/Mutual_authentication">mutual TLS
authentication</a>.</p>
<p>The <code>--client-key</code> flag is required too when using
this.</p>
<h3 id="client-key-string">--client-key string</h3>
<p>This loads the PEM encoded client side private key used for mutual
TLS authentication. Used in conjunction with
<code>--client-cert</code>.</p>
<p>Supported types are:</p>
<ul>
<li>Unencrypted PKCS#1 ("BEGIN RSA PRIVATE KEY")</li>
<li>Unencrypted PKCS#8 ("BEGIN PRIVATE KEY")</li>
<li>Encrypted PKCS#8 ("BEGIN ENCRYPTED PRIVATE KEY")</li>
<li>Legacy PEM encryption (e.g., DEK-Info headers), which are
automatically detected.</li>
</ul>
<h3 id="client-pass-string">--client-pass string</h3>
<p>This can be used to supply an optional password to decrypt the client
key file.</p>
<p><strong>NB</strong> the password should be obscured so it should be
the output of <code>rclone obscure YOURPASSWORD</code>.</p>
<h3 id="no-check-certificate">--no-check-certificate</h3>
<p><code>--no-check-certificate</code> controls whether a client
verifies the server's certificate chain and host name. If
<code>--no-check-certificate</code> is true, TLS accepts any certificate
presented by the server and any host name in that certificate. In this
mode, TLS is susceptible to man-in-the-middle attacks.</p>
<p>This option defaults to <code>false</code>.</p>
<p><strong>This should be used only for testing.</strong></p>
<h2 id="configuration-encryption">Configuration encryption</h2>
<p>Your configuration file contains information for logging in to your
cloud services. This means that you should keep your
<code>rclone.conf</code> file in a secure location.</p>
<p>If you are in an environment where that isn't possible, you can add a
password to your configuration. This means that you will have to supply
the password every time you start rclone.</p>
<p>To add a password to your rclone configuration, execute
<code>rclone config</code>.</p>
<div class="sourceCode" id="cb672"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb672-1"><a href="#cb672-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone config</span>
<span id="cb672-2"><a href="#cb672-2" aria-hidden="true" tabindex="-1"></a><span class="ex">Current</span> remotes:</span>
<span id="cb672-3"><a href="#cb672-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb672-4"><a href="#cb672-4" aria-hidden="true" tabindex="-1"></a><span class="ex">e</span><span class="er">)</span> <span class="ex">Edit</span> existing remote</span>
<span id="cb672-5"><a href="#cb672-5" aria-hidden="true" tabindex="-1"></a><span class="ex">n</span><span class="er">)</span> <span class="ex">New</span> remote</span>
<span id="cb672-6"><a href="#cb672-6" aria-hidden="true" tabindex="-1"></a><span class="ex">d</span><span class="er">)</span> <span class="ex">Delete</span> remote</span>
<span id="cb672-7"><a href="#cb672-7" aria-hidden="true" tabindex="-1"></a><span class="ex">s</span><span class="er">)</span> <span class="ex">Set</span> configuration password</span>
<span id="cb672-8"><a href="#cb672-8" aria-hidden="true" tabindex="-1"></a><span class="ex">q</span><span class="er">)</span> <span class="ex">Quit</span> config</span>
<span id="cb672-9"><a href="#cb672-9" aria-hidden="true" tabindex="-1"></a><span class="ex">e/n/d/s/q</span><span class="op">&gt;</span></span></code></pre></div>
<p>Go into <code>s</code>, Set configuration password:</p>
<div class="sourceCode" id="cb673"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb673-1"><a href="#cb673-1" aria-hidden="true" tabindex="-1"></a><span class="ex">e/n/d/s/q</span><span class="op">&gt;</span> s</span>
<span id="cb673-2"><a href="#cb673-2" aria-hidden="true" tabindex="-1"></a><span class="ex">Your</span> configuration is not encrypted.</span>
<span id="cb673-3"><a href="#cb673-3" aria-hidden="true" tabindex="-1"></a><span class="ex">If</span> you add a password, you will protect your login information to cloud services.</span>
<span id="cb673-4"><a href="#cb673-4" aria-hidden="true" tabindex="-1"></a><span class="ex">a</span><span class="er">)</span> <span class="ex">Add</span> Password</span>
<span id="cb673-5"><a href="#cb673-5" aria-hidden="true" tabindex="-1"></a><span class="ex">q</span><span class="er">)</span> <span class="ex">Quit</span> to main menu</span>
<span id="cb673-6"><a href="#cb673-6" aria-hidden="true" tabindex="-1"></a><span class="ex">a/q</span><span class="op">&gt;</span> a</span>
<span id="cb673-7"><a href="#cb673-7" aria-hidden="true" tabindex="-1"></a><span class="ex">Enter</span> NEW configuration password:</span>
<span id="cb673-8"><a href="#cb673-8" aria-hidden="true" tabindex="-1"></a><span class="ex">password:</span></span>
<span id="cb673-9"><a href="#cb673-9" aria-hidden="true" tabindex="-1"></a><span class="ex">Confirm</span> NEW password:</span>
<span id="cb673-10"><a href="#cb673-10" aria-hidden="true" tabindex="-1"></a><span class="ex">password:</span></span>
<span id="cb673-11"><a href="#cb673-11" aria-hidden="true" tabindex="-1"></a><span class="ex">Password</span> set</span>
<span id="cb673-12"><a href="#cb673-12" aria-hidden="true" tabindex="-1"></a><span class="ex">Your</span> configuration is encrypted.</span>
<span id="cb673-13"><a href="#cb673-13" aria-hidden="true" tabindex="-1"></a><span class="ex">c</span><span class="er">)</span> <span class="ex">Change</span> Password</span>
<span id="cb673-14"><a href="#cb673-14" aria-hidden="true" tabindex="-1"></a><span class="ex">u</span><span class="er">)</span> <span class="ex">Unencrypt</span> configuration</span>
<span id="cb673-15"><a href="#cb673-15" aria-hidden="true" tabindex="-1"></a><span class="ex">q</span><span class="er">)</span> <span class="ex">Quit</span> to main menu</span>
<span id="cb673-16"><a href="#cb673-16" aria-hidden="true" tabindex="-1"></a><span class="ex">c/u/q</span><span class="op">&gt;</span></span></code></pre></div>
<p>Your configuration is now encrypted, and every time you start rclone
you will have to supply the password. See below for details. In the same
menu, you can change the password or completely remove encryption from
your configuration.</p>
<p>There is no way to recover the configuration if you lose your
password.</p>
<p>You can also use</p>
<ul>
<li><a
href="https://rclone.org/commands/rclone_config_encryption_set/">rclone
config encryption set</a> to set the config encryption directly</li>
<li><a
href="https://rclone.org/commands/rclone_config_encryption_remove/">rclone
config encryption remove</a> to remove it</li>
<li><a
href="https://rclone.org/commands/rclone_config_encryption_check/">rclone
config encryption check</a> to check that it is encrypted properly.</li>
</ul>
<p>rclone uses <a
href="https://godoc.org/golang.org/x/crypto/nacl/secretbox">nacl
secretbox</a> which in turn uses XSalsa20 and Poly1305 to encrypt and
authenticate your configuration with secret-key cryptography. The
password is SHA-256 hashed, which produces the key for secretbox. The
hashed password is not stored.</p>
<p>While this provides very good security, we do not recommend storing
your encrypted rclone configuration in public if it contains sensitive
information, maybe except if you use a very strong password.</p>
<p>If it is safe in your environment, you can set the
<code>RCLONE_CONFIG_PASS</code> environment variable to contain your
password, in which case it will be used for decrypting the
configuration.</p>
<p>You can set this for a session from a script. For unix like systems
save this to a file called <code>set-rclone-password</code>:</p>
<div class="sourceCode" id="cb674"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb674-1"><a href="#cb674-1" aria-hidden="true" tabindex="-1"></a><span class="co">#!/bin/echo Source this file don&#39;t run it</span></span>
<span id="cb674-2"><a href="#cb674-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb674-3"><a href="#cb674-3" aria-hidden="true" tabindex="-1"></a><span class="bu">read</span> <span class="at">-s</span> <span class="va">RCLONE_CONFIG_PASS</span></span>
<span id="cb674-4"><a href="#cb674-4" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">RCLONE_CONFIG_PASS</span></span></code></pre></div>
<p>Then source the file when you want to use it. From the shell you
would do <code>source set-rclone-password</code>. It will then ask you
for the password and set it in the environment variable.</p>
<p>An alternate means of supplying the password is to provide a script
which will retrieve the password and print on standard output. This
script should have a fully specified path name and not rely on any
environment variables. The script is supplied either via <a
href="#password-command"><code>--password-command="..."</code></a>
command line argument or via the <code>RCLONE_PASSWORD_COMMAND</code>
environment variable.</p>
<p>One useful example of this is using the <code>passwordstore</code>
application to retrieve the password:</p>
<div class="sourceCode" id="cb675"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb675-1"><a href="#cb675-1" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">RCLONE_PASSWORD_COMMAND</span><span class="op">=</span><span class="st">&quot;pass rclone/config&quot;</span></span></code></pre></div>
<p>If the <code>passwordstore</code> password manager holds the password
for the rclone configuration, using the script method means the password
is primarily protected by the <code>passwordstore</code> system, and is
never embedded in the clear in scripts, nor available for examination
using the standard commands available. It is quite possible with long
running rclone sessions for copies of passwords to be innocently
captured in log files or terminal scroll buffers, etc. Using the script
method of supplying the password enhances the security of the config
password considerably.</p>
<p>If you are running rclone inside a script, unless you are using the
<code>--password-command</code> method, you might want to disable
password prompts. To do that, pass the parameter
<code>--ask-password=false</code> to rclone. This will make rclone fail
instead of asking for a password if <code>RCLONE_CONFIG_PASS</code>
doesn't contain a valid password, and <code>--password-command</code>
has not been supplied.</p>
<p>Whenever running commands that may be affected by options in a
configuration file, rclone will look for an existing file according to
the rules described <a href="#config-string">above</a>, and load any it
finds. If an encrypted file is found, this includes decrypting it, with
the possible consequence of a password prompt. When executing a command
line that you know are not actually using anything from such a
configuration file, you can avoid it being loaded by overriding the
location, e.g. with one of the documented special values for memory-only
configuration. Since only backend options can be stored in configuration
files, this is normally unnecessary for commands that do not operate on
backends, e.g. <code>completion</code>. However, it will be relevant for
commands that do operate on backends in general, but are used without
referencing a stored remote, e.g. listing local filesystem paths, or <a
href="#connection-strings">connection strings</a>:
<code>rclone --config="" ls .</code></p>
<h3 id="configuration-encryption-cheatsheet">Configuration encryption
cheatsheet</h3>
<p>You can quickly apply a configuration encryption without plain-text
at rest or transfer. Detailed instructions for popular OSes:</p>
<h4 id="mac">Mac</h4>
<ul>
<li><p>Generate and store a password</p>
<div class="sourceCode" id="cb676"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb676-1"><a href="#cb676-1" aria-hidden="true" tabindex="-1"></a><span class="ex">security</span> add-generic-password <span class="at">-a</span> rclone <span class="at">-s</span> config <span class="at">-w</span> <span class="va">$(</span><span class="ex">openssl</span> rand <span class="at">-base64</span> 40<span class="va">)</span></span></code></pre></div></li>
<li><p>Add the retrieval instruction to your <code>.zprofile</code> /
<code>.profile</code></p>
<div class="sourceCode" id="cb677"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb677-1"><a href="#cb677-1" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">RCLONE_PASSWORD_COMMAND</span><span class="op">=</span><span class="st">&quot;/usr/bin/security find-generic-password -a rclone -s config -w&quot;</span></span></code></pre></div></li>
</ul>
<h4 id="linux-1">Linux</h4>
<ul>
<li><p>Prerequisite: Linux doesn't come with a default password manager.
Let's install the "pass" utility using a package manager, e.g.
<code>apt install pass</code>, <code>yum install pass</code>, <a
href="https://www.passwordstore.org/#download">etc.</a>; then initialize
a password store: <code>pass init rclone</code>.</p></li>
<li><p>Generate and store a password</p>
<div class="sourceCode" id="cb678"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb678-1"><a href="#cb678-1" aria-hidden="true" tabindex="-1"></a><span class="bu">echo</span> <span class="va">$(</span><span class="ex">openssl</span> rand <span class="at">-base64</span> 40<span class="va">)</span> <span class="kw">|</span> <span class="ex">pass</span> insert <span class="at">-m</span> rclone/config</span></code></pre></div></li>
<li><p>Add the retrieval instruction</p>
<div class="sourceCode" id="cb679"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb679-1"><a href="#cb679-1" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">RCLONE_PASSWORD_COMMAND</span><span class="op">=</span><span class="st">&quot;/usr/bin/pass rclone/config&quot;</span></span></code></pre></div></li>
</ul>
<h4 id="windows-2">Windows</h4>
<ul>
<li><p>Generate and store a password</p>
<pre class="pwsh"><code>New-Object -TypeName PSCredential -ArgumentList &quot;rclone&quot;, (ConvertTo-SecureString -String ([System.Web.Security.Membership]::GeneratePassword(40, 10)) -AsPlainText -Force) | Export-Clixml -Path &quot;rclone-credential.xml&quot;</code></pre></li>
<li><p>Add the password retrieval instruction</p>
<pre class="pwsh"><code>[Environment]::SetEnvironmentVariable(&quot;RCLONE_PASSWORD_COMMAND&quot;, &quot;[System.Runtime.InteropServices.Marshal]::PtrToStringAuto([System.Runtime.InteropServices.Marshal]::SecureStringToBSTR((Import-Clixml -Path &quot;rclone-credential.xml&quot;).Password))&quot;)</code></pre></li>
</ul>
<h4 id="encrypt-the-config-file-all-systems">Encrypt the config file
(all systems)</h4>
<ul>
<li><p>Execute <code>rclone config</code>, and select option
<code>s) Set configuration password</code></p></li>
<li><p>Add/update the password from previous steps</p></li>
</ul>
<h2 id="developer-options">Developer options</h2>
<p>These options are useful when developing or debugging rclone. There
are also some more remote specific options which aren't documented here
which are used for testing. These start with remote name e.g.
<code>--drive-test-option</code> - see the docs for the remote in
question.</p>
<h3 id="cpuprofile-string">--cpuprofile string</h3>
<p>Write CPU profile to a file. This can be analysed with
<code>go tool pprof</code>.</p>
<h3 id="memprofile-string">--memprofile string</h3>
<p>Write memory profile to a file. This can be analysed with
<code>go tool pprof</code>.</p>
<h3 id="dump-dumpflags">--dump DumpFlags</h3>
<p>The <code>--dump</code> flag takes a comma separated list of flags to
dump info about.</p>
<p>Note that some headers, such as <code>Accept-Encoding</code>, may not
be correct as shown in the request, and the response may not show
<code>Content-Encoding</code> if the go standard libraries auto gzip
encoding was in effect. In this case the body of the request will be
gunzipped before showing it.</p>
<p>The available flags are:</p>
<ul>
<li><code>headers</code> dumps HTTP headers. Any
<code>Authorization:</code> headers will be excluded, but output may
still contain sensitive information. Can be very verbose. Useful for
debugging only. Use <code>auth</code> if you do want the
<code>Authorization:</code> headers.</li>
<li><code>auth</code> dumps HTTP headers like <code>headers</code>, but
also includes any <code>Authorization:</code> headers. This means the
output will probably contain sensitive information. Use
<code>headers</code> to dump without <code>Authorization:</code>
headers. Can be very verbose. Useful for debugging only.</li>
<li><code>bodies</code> dumps HTTP headers and bodies. May contain
sensitive info. Can be very verbose. Useful for debugging only. Note
that the bodies are buffered in memory so don't use this for enormous
files.</li>
<li><code>requests</code> is similar to <code>bodies</code>, but dumps
the request bodies and the response headers. Useful for debugging
download problems.</li>
<li><code>responses</code> is similar to <code>bodies</code>, but dumps
the response bodies and the request headers. Useful for debugging upload
problems.</li>
<li><code>filters</code> dumps the filters. Useful to see exactly what
include and exclude options are filtering on.</li>
<li><code>goroutines</code> dumps a list of the running go-routines at
the end of the command.</li>
<li><code>openfiles</code> dumps a list of the open files at the end of
the command. It uses the <code>lsof</code> Unix command to do that, so
you'll need that installed to use it.</li>
<li><code>mapper</code> dumps the JSON blobs being sent to the program
supplied with <code>--metadata-mapper</code> and received from it. It
can be useful for debugging the metadata mapper interface.</li>
</ul>
<h2 id="filtering">Filtering</h2>
<p>For the filtering options</p>
<ul>
<li><code>--delete-excluded</code></li>
<li><code>--filter</code></li>
<li><code>--filter-from</code></li>
<li><code>--exclude</code></li>
<li><code>--exclude-from</code></li>
<li><code>--exclude-if-present</code></li>
<li><code>--include</code></li>
<li><code>--include-from</code></li>
<li><code>--files-from</code></li>
<li><code>--files-from-raw</code></li>
<li><code>--min-size</code></li>
<li><code>--max-size</code></li>
<li><code>--min-age</code></li>
<li><code>--max-age</code></li>
<li><code>--hash-filter</code></li>
<li><code>--dump filters</code></li>
<li><code>--metadata-include</code></li>
<li><code>--metadata-include-from</code></li>
<li><code>--metadata-exclude</code></li>
<li><code>--metadata-exclude-from</code></li>
<li><code>--metadata-filter</code></li>
<li><code>--metadata-filter-from</code></li>
</ul>
<p>See the <a href="https://rclone.org/filtering/">filtering
section</a>.</p>
<h2 id="remote-control">Remote control</h2>
<p>For the remote control options and for instructions on how to remote
control rclone:</p>
<ul>
<li><code>--rc</code></li>
<li>Anything starting with <code>--rc-</code></li>
</ul>
<p>See <a href="https://rclone.org/rc/">the remote control
section</a>.</p>
<h2 id="logging">Logging</h2>
<p>rclone has 4 levels of logging, <code>ERROR</code>,
<code>NOTICE</code>, <code>INFO</code> and <code>DEBUG</code>.</p>
<p>By default, rclone logs to standard error. This means you can
redirect standard error and still see the normal output of rclone
commands (e.g. <code>rclone ls</code>).</p>
<p>By default, rclone will produce <code>Error</code> and
<code>Notice</code> level messages.</p>
<p>If you use the <code>-q</code> flag, rclone will only produce
<code>Error</code> messages.</p>
<p>If you use the <code>-v</code> flag, rclone will produce
<code>Error</code>, <code>Notice</code> and <code>Info</code>
messages.</p>
<p>If you use the <code>-vv</code> flag, rclone will produce
<code>Error</code>, <code>Notice</code>, <code>Info</code> and
<code>Debug</code> messages.</p>
<p>You can also control the log levels with the <code>--log-level</code>
flag.</p>
<p>If you use the <code>--log-file</code> option, rclone will redirect
<code>Error</code>, <code>Info</code> and <code>Debug</code> messages
along with standard error to a file.</p>
<p>If you use the <code>--syslog</code> flag then rclone will log to
syslog and the <code>--syslog-facility</code> control which facility it
uses.</p>
<p>Rclone prefixes all log messages with their level in capitals, e.g.
INFO which makes it easy to grep the log file for different kinds of
information.</p>
<h2 id="metrics">Metrics</h2>
<p>Rclone can publish metrics in the OpenMetrics/Prometheus format.</p>
<p>To enable the metrics endpoint, use the <code>--metrics-addr</code>
flag. Metrics can also be published on the <code>--rc-addr</code> port
if the <code>--rc</code> flag and <code>--rc-enable-metrics</code> flags
are supplied or if using rclone rcd <code>--rc-enable-metrics</code></p>
<p>Rclone provides extensive configuration options for the metrics HTTP
endpoint. These settings are grouped under the Metrics section and have
a prefix <code>--metrics-*</code>.</p>
<p>When metrics are enabled with <code>--rc-enable-metrics</code>, they
will be published on the same port as the rc API. In this case, the
<code>--metrics-*</code> flags will be ignored, and the HTTP endpoint
configuration will be managed by the <code>--rc-*</code> parameters.</p>
<h2 id="exit-code">Exit code</h2>
<p>If any errors occur during the command execution, rclone will exit
with a non-zero exit code. This allows scripts to detect when rclone
operations have failed.</p>
<p>During the startup phase, rclone will exit immediately if an error is
detected in the configuration. There will always be a log message
immediately before exiting.</p>
<p>When rclone is running it will accumulate errors as it goes along,
and only exit with a non-zero exit code if (after retries) there were
still failed transfers. For every error counted there will be a high
priority log message (visible with <code>-q</code>) showing the message
and which file caused the problem. A high priority message is also shown
when starting a retry so the user can see that any previous error
messages may not be valid after the retry. If rclone has done a retry it
will log a high priority message if the retry was successful.</p>
<h3 id="list-of-exit-codes">List of exit codes</h3>
<ul>
<li><code>0</code> - Success</li>
<li><code>1</code> - Error not otherwise categorised</li>
<li><code>2</code> - Syntax or usage error</li>
<li><code>3</code> - Directory not found</li>
<li><code>4</code> - File not found</li>
<li><code>5</code> - Temporary error (one that more retries might fix)
(Retry errors)</li>
<li><code>6</code> - Less serious errors (like 461 errors from dropbox)
(NoRetry errors)</li>
<li><code>7</code> - Fatal error (one that more retries won't fix, like
account suspended) (Fatal errors)</li>
<li><code>8</code> - Transfer exceeded - limit set by --max-transfer
reached</li>
<li><code>9</code> - Operation successful, but no files transferred
(Requires <a
href="#error-on-no-transfer"><code>--error-on-no-transfer</code></a>)</li>
<li><code>10</code> - Duration exceeded - limit set by --max-duration
reached</li>
</ul>
<h2 id="environment-variables">Environment variables</h2>
<p>Rclone can be configured entirely using environment variables. These
can be used to set defaults for options or config file entries.</p>
<h3 id="options-92">Options</h3>
<p>Every option in rclone can have its default set by environment
variable.</p>
<p>To find the name of the environment variable, first, take the long
option name, strip the leading <code>--</code>, change <code>-</code> to
<code>_</code>, make upper case and prepend <code>RCLONE_</code>.</p>
<p>For example, to always set <code>--stats 5s</code>, set the
environment variable <code>RCLONE_STATS=5s</code>. If you set stats on
the command line this will override the environment variable
setting.</p>
<p>Or to always use the trash in drive <code>--drive-use-trash</code>,
set <code>RCLONE_DRIVE_USE_TRASH=true</code>.</p>
<p>Verbosity is slightly different, the environment variable equivalent
of <code>--verbose</code> or <code>-v</code> is
<code>RCLONE_VERBOSE=1</code>, or for <code>-vv</code>,
<code>RCLONE_VERBOSE=2</code>.</p>
<p>The same parser is used for the options and the environment variables
so they take exactly the same form.</p>
<p>The options set by environment variables can be seen with the
<code>-vv</code> flag, e.g. <code>rclone version -vv</code>.</p>
<p>Options that can appear multiple times (type
<code>stringArray</code>) are treated slightly differently as
environment variables can only be defined once. In order to allow a
simple mechanism for adding one or many items, the input is treated as a
<a href="https://godoc.org/encoding/csv">CSV encoded</a> string. For
example</p>
<table>
<colgroup>
<col style="width: 52%" />
<col style="width: 47%" />
</colgroup>
<thead>
<tr class="header">
<th>Environment variable</th>
<th>Equivalent options</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><code>RCLONE_EXCLUDE="*.jpg"</code></td>
<td><code>--exclude "*.jpg"</code></td>
</tr>
<tr class="even">
<td><code>RCLONE_EXCLUDE="*.jpg,*.png"</code></td>
<td><code>--exclude "*.jpg"</code> <code>--exclude "*.png"</code></td>
</tr>
<tr class="odd">
<td><code>RCLONE_EXCLUDE='"*.jpg","*.png"'</code></td>
<td><code>--exclude "*.jpg"</code> <code>--exclude "*.png"</code></td>
</tr>
<tr class="even">
<td><code>RCLONE_EXCLUDE='"/directory with comma , in it /**"'</code></td>
<td>`--exclude "/directory with comma , in it /**"</td>
</tr>
</tbody>
</table>
<p>If <code>stringArray</code> options are defined as environment
variables <strong>and</strong> options on the command line then all the
values will be used.</p>
<h3 id="config-file">Config file</h3>
<p>You can set defaults for values in the config file on an individual
remote basis. The names of the config items are documented in the page
for each backend.</p>
<p>To find the name of the environment variable, you need to set, take
<code>RCLONE_CONFIG_</code> + name of remote + <code>_</code> + name of
config file option and make it all uppercase. Note one implication here
is the remote's name must be convertible into a valid environment
variable name, so it can only contain letters, digits, or the
<code>_</code> (underscore) character.</p>
<p>For example, to configure an S3 remote named <code>mys3:</code>
without a config file (using unix ways of setting environment
variables):</p>
<div class="sourceCode" id="cb682"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb682-1"><a href="#cb682-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> export RCLONE_CONFIG_MYS3_TYPE=s3</span>
<span id="cb682-2"><a href="#cb682-2" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> export RCLONE_CONFIG_MYS3_ACCESS_KEY_ID=XXX</span>
<span id="cb682-3"><a href="#cb682-3" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> export RCLONE_CONFIG_MYS3_SECRET_ACCESS_KEY=XXX</span>
<span id="cb682-4"><a href="#cb682-4" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsd mys3:</span>
<span id="cb682-5"><a href="#cb682-5" aria-hidden="true" tabindex="-1"></a>          <span class="ex">-1</span> 2016-09-21 12:54:21        <span class="at">-1</span> my-bucket</span>
<span id="cb682-6"><a href="#cb682-6" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone listremotes <span class="kw">|</span> <span class="fu">grep</span> mys3</span>
<span id="cb682-7"><a href="#cb682-7" aria-hidden="true" tabindex="-1"></a><span class="ex">mys3:</span></span></code></pre></div>
<p>Note that if you want to create a remote using environment variables
you must create the <code>..._TYPE</code> variable as above.</p>
<p>Note that the name of a remote created using environment variable is
case insensitive, in contrast to regular remotes stored in config file
as documented <a href="#valid-remote-names">above</a>. You must write
the name in uppercase in the environment variable, but as seen from
example above it will be listed and can be accessed in lowercase, while
you can also refer to the same remote in uppercase:</p>
<div class="sourceCode" id="cb683"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb683-1"><a href="#cb683-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsd mys3:</span>
<span id="cb683-2"><a href="#cb683-2" aria-hidden="true" tabindex="-1"></a>          <span class="ex">-1</span> 2016-09-21 12:54:21        <span class="at">-1</span> my-bucket</span>
<span id="cb683-3"><a href="#cb683-3" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsd MYS3:</span>
<span id="cb683-4"><a href="#cb683-4" aria-hidden="true" tabindex="-1"></a>          <span class="ex">-1</span> 2016-09-21 12:54:21        <span class="at">-1</span> my-bucket</span></code></pre></div>
<p>Note that you can only set the options of the immediate backend, so
RCLONE_CONFIG_MYS3CRYPT_ACCESS_KEY_ID has no effect, if myS3Crypt is a
crypt remote based on an S3 remote. However RCLONE_S3_ACCESS_KEY_ID will
set the access key of all remotes using S3, including myS3Crypt.</p>
<p>Note also that now rclone has <a
href="#connection-strings">connection strings</a>, it is probably easier
to use those instead which makes the above example</p>
<div class="sourceCode" id="cb684"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb684-1"><a href="#cb684-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsd :s3,access_key_id=XXX,secret_access_key=XXX:</span></code></pre></div>
<h3 id="precedence">Precedence</h3>
<p>The various different methods of backend configuration are read in
this order and the first one with a value is used.</p>
<ul>
<li>Parameters in connection strings, e.g.
<code>myRemote,skip_links:</code></li>
<li>Flag values as supplied on the command line, e.g.
<code>--skip-links</code></li>
<li>Remote specific environment vars, e.g.
<code>RCLONE_CONFIG_MYREMOTE_SKIP_LINKS</code> (see above).</li>
<li>Backend-specific environment vars, e.g.
<code>RCLONE_LOCAL_SKIP_LINKS</code>.</li>
<li>Backend generic environment vars, e.g.
<code>RCLONE_SKIP_LINKS</code>.</li>
<li>Config file, e.g. <code>skip_links = true</code>.</li>
<li>Default values, e.g. <code>false</code> - these can't be
changed.</li>
</ul>
<p>So if both <code>--skip-links</code> is supplied on the command line
and an environment variable <code>RCLONE_LOCAL_SKIP_LINKS</code> is set,
the command line flag will take preference.</p>
<p>The backend configurations set by environment variables can be seen
with the <code>-vv</code> flag, e.g.
<code>rclone about myRemote: -vv</code>.</p>
<p>For non backend configuration the order is as follows:</p>
<ul>
<li>Flag values as supplied on the command line, e.g.
<code>--stats 5s</code>.</li>
<li>Environment vars, e.g. <code>RCLONE_STATS=5s</code>.</li>
<li>Default values, e.g. <code>1m</code> - these can't be changed.</li>
</ul>
<h3 id="other-environment-variables">Other environment variables</h3>
<ul>
<li><code>RCLONE_CONFIG_PASS</code> set to contain your config file
password (see <a href="#configuration-encryption">Configuration
Encryption</a> section)</li>
<li><code>HTTP_PROXY</code>, <code>HTTPS_PROXY</code> and
<code>NO_PROXY</code> (or the lowercase versions thereof).
<ul>
<li><code>HTTPS_PROXY</code> takes precedence over
<code>HTTP_PROXY</code> for https requests.</li>
<li>The environment values may be either a complete URL or a
"host[:port]" for, in which case the "http" scheme is assumed.</li>
</ul></li>
<li><code>USER</code> and <code>LOGNAME</code> values are used as
fallbacks for current username. The primary method for looking up
username is OS-specific: Windows API on Windows, real user ID in
/etc/passwd on Unix systems. In the documentation the current username
is simply referred to as <code>$USER</code>.</li>
<li><code>RCLONE_CONFIG_DIR</code> - rclone <strong>sets</strong> this
variable for use in config files and sub processes to point to the
directory holding the config file.</li>
</ul>
<p>The options set by environment variables can be seen with the
<code>-vv</code> and <code>--log-level=DEBUG</code> flags, e.g.
<code>rclone version -vv</code>.</p>
<h1 id="configuring-rclone-on-a-remote-headless-machine">Configuring
rclone on a remote / headless machine</h1>
<p>Some of the configurations (those involving oauth2) require an
internet-connected web browser.</p>
<p>If you are trying to set rclone up on a remote or headless machine
with no browser available on it (e.g. a NAS or a server in a
datacenter), then you will need to use an alternative means of
configuration. There are three ways of doing it, described below.</p>
<h2 id="configuring-using-rclone-authorize">Configuring using rclone
authorize</h2>
<p>On the headless machine run <a href="/commands/rclone_config">rclone
config</a>, but answer <code>N</code> to the question
<code>Use web browser to automatically authenticate rclone with remote?</code>.</p>
<pre class="text"><code>Use web browser to automatically authenticate rclone with remote?
 * Say Y if the machine running rclone has a web browser you can use
 * Say N if running rclone on a (remote) machine without web browser access
If not sure try Y. If Y failed, try N.

y) Yes (default)
n) No
y/n&gt; n

Option config_token.
For this to work, you will need rclone available on a machine that has
a web browser available.
For more help and alternate methods see: https://rclone.org/remote_setup/
Execute the following on the machine with the web browser (same rclone
version recommended):
        rclone authorize &quot;onedrive&quot;
Then paste the result.
Enter a value.
config_token&gt;</code></pre>
<p>Then on your main desktop machine, run <a
href="https://rclone.org/commands/rclone_authorize/">rclone
authorize</a>.</p>
<pre class="text"><code>rclone authorize &quot;onedrive&quot;
NOTICE: Make sure your Redirect URL is set to &quot;http://localhost:53682/&quot; in your custom config.
NOTICE: If your browser doesn&#39;t open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx
NOTICE: Log in and authorize rclone for access
NOTICE: Waiting for code...

Got code
Paste the following into your remote machine ---&gt;
SECRET_TOKEN
&lt;---End paste</code></pre>
<p>Then back to the headless machine, paste in the code.</p>
<pre class="text"><code>config_token&gt; SECRET_TOKEN
--------------------
[acd12]
client_id =
client_secret =
token = SECRET_TOKEN
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt;</code></pre>
<h2 id="configuring-by-copying-the-config-file">Configuring by copying
the config file</h2>
<p>Rclone stores all of its configuration in a single file. This can
easily be copied to configure a remote rclone (although some backends
does not support reusing the same configuration, consult your backend
documentation to be sure).</p>
<p>Start by running <a href="/commands/rclone_config">rclone config</a>
to create the configuration file on your desktop machine.</p>
<div class="sourceCode" id="cb688"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb688-1"><a href="#cb688-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>Then locate the file by running <a
href="/commands/rclone_config_file">rclone config file</a>.</p>
<div class="sourceCode" id="cb689"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb689-1"><a href="#cb689-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone config file</span>
<span id="cb689-2"><a href="#cb689-2" aria-hidden="true" tabindex="-1"></a><span class="ex">Configuration</span> file is stored at:</span>
<span id="cb689-3"><a href="#cb689-3" aria-hidden="true" tabindex="-1"></a><span class="ex">/home/user/.rclone.conf</span></span></code></pre></div>
<p>Finally, transfer the file to the remote machine (scp, cut paste,
ftp, sftp, etc.) and place it in the correct location (use <a
href="/commands/rclone_config_file">rclone config file</a> on the remote
machine to find out where).</p>
<h2 id="configuring-using-ssh-tunnel">Configuring using SSH Tunnel</h2>
<p>If you have an SSH client installed on your local machine, you can
set up an SSH tunnel to redirect the port 53682 into the headless
machine by using the following command:</p>
<div class="sourceCode" id="cb690"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb690-1"><a href="#cb690-1" aria-hidden="true" tabindex="-1"></a><span class="fu">ssh</span> <span class="at">-L</span> localhost:53682:localhost:53682 username@remote_server</span></code></pre></div>
<p>Then on the headless machine run <a
href="/commands/rclone_config">rclone config</a> and answer
<code>Y</code> to the question
<code>Use web browser to automatically authenticate rclone with remote?</code>.</p>
<pre class="text"><code>Use web browser to automatically authenticate rclone with remote?
 * Say Y if the machine running rclone has a web browser you can use
 * Say N if running rclone on a (remote) machine without web browser access
If not sure try Y. If Y failed, try N.

y) Yes (default)
n) No
y/n&gt; y
NOTICE: Make sure your Redirect URL is set to &quot;http://localhost:53682/&quot; in your custom config.
NOTICE: If your browser doesn&#39;t open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx
NOTICE: Log in and authorize rclone for access
NOTICE: Waiting for code...</code></pre>
<p>Finally, copy and paste the presented URL
<code>http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx</code> to
the browser on your local machine, complete the auth and you are
done.</p>
<h1 id="filtering-includes-and-excludes">Filtering, includes and
excludes</h1>
<p>Filter flags determine which files rclone <code>sync</code>,
<code>move</code>, <code>ls</code>, <code>lsl</code>,
<code>md5sum</code>, <code>sha1sum</code>, <code>size</code>,
<code>delete</code>, <code>check</code> and similar commands apply
to.</p>
<p>They are specified in terms of path/file name patterns; path/file
lists; file age and size, or presence of a file in a directory. Bucket
based remotes without the concept of directory apply filters to object
key, age and size in an analogous way.</p>
<p>Rclone <code>purge</code> does not obey filters.</p>
<p>To test filters without risk of damage to data, apply them to
<code>rclone ls</code>, or with the <code>--dry-run</code> and
<code>-vv</code> flags.</p>
<p>Rclone filter patterns can only be used in filter command line
options, not in the specification of a remote.</p>
<p>E.g. <code>rclone copy "remote:dir*.jpg" /path/to/dir</code> does not
have a filter effect.
<code>rclone copy remote:dir /path/to/dir --include "*.jpg"</code>
does.</p>
<p><strong>Important</strong> Avoid mixing any two of
<code>--include...</code>, <code>--exclude...</code> or
<code>--filter...</code> flags in an rclone command. The results might
not be what you expect. Instead use a <code>--filter...</code> flag.</p>
<h2 id="patterns-for-matching-pathfile-names">Patterns for matching
path/file names</h2>
<h3 id="patterns">Pattern syntax</h3>
<p>Here is a formal definition of the pattern syntax, <a
href="#examples">examples</a> are below.</p>
<p>Rclone matching rules follow a glob style:</p>
<pre class="text"><code>*         matches any sequence of non-separator (/) characters
**        matches any sequence of characters including / separators
?         matches any single non-separator (/) character
[ [ ! ] { character-range } ]
          character class (must be non-empty)
{ pattern-list }
          pattern alternatives
{{ regexp }}
          regular expression to match
c         matches character c (c != *, **, ?, \, [, {, })
\c        matches reserved character c (c = *, **, ?, \, [, {, }) or character class</code></pre>
<p>character-range:</p>
<pre class="text"><code>c         matches character c (c != \, -, ])
\c        matches reserved character c (c = \, -, ])
lo - hi   matches character c for lo &lt;= c &lt;= hi</code></pre>
<p>pattern-list:</p>
<pre class="text"><code>pattern { , pattern }
          comma-separated (without spaces) patterns</code></pre>
<p>character classes (see <a
href="https://golang.org/pkg/regexp/syntax/">Go regular expression
reference</a>) include:</p>
<pre class="text"><code>Named character classes (e.g. [\d], [^\d], [\D], [^\D])
Perl character classes (e.g. \s, \S, \w, \W)
ASCII character classes (e.g. [[:alnum:]], [[:alpha:]], [[:punct:]], [[:xdigit:]])</code></pre>
<p>regexp for advanced users to insert a regular expression - see <a
href="#regexp">below</a> for more info:</p>
<pre class="text"><code>Any re2 regular expression not containing `}}`</code></pre>
<p>If the filter pattern starts with a <code>/</code> then it only
matches at the top level of the directory tree, <strong>relative to the
root of the remote</strong> (not necessarily the root of the drive). If
it does not start with <code>/</code> then it is matched starting at the
<strong>end of the path/file name</strong> but it only matches a
complete path element - it must match from a <code>/</code> separator or
the beginning of the path/file.</p>
<pre class="text"><code>file.jpg   - matches &quot;file.jpg&quot;
           - matches &quot;directory/file.jpg&quot;
           - doesn&#39;t match &quot;afile.jpg&quot;
           - doesn&#39;t match &quot;directory/afile.jpg&quot;
/file.jpg  - matches &quot;file.jpg&quot; in the root directory of the remote
           - doesn&#39;t match &quot;afile.jpg&quot;
           - doesn&#39;t match &quot;directory/file.jpg&quot;</code></pre>
<p>The top level of the remote might not be the top level of the
drive.</p>
<p>E.g. for a Microsoft Windows local directory structure</p>
<pre class="text"><code>F:
├── bkp
├── data
│   ├── excl
│   │   ├── 123.jpg
│   │   └── 456.jpg
│   ├── incl
│   │   └── document.pdf</code></pre>
<p>To copy the contents of folder <code>data</code> into folder
<code>bkp</code> excluding the contents of subfolder
<code>excl</code>the following command treats <code>F:\data</code> and
<code>F:\bkp</code> as top level for filtering.</p>
<p><code>rclone copy F:\data\ F:\bkp\ --exclude=/excl/**</code></p>
<p><strong>Important</strong> Use <code>/</code> in path/file name
patterns and not <code>\</code> even if running on Microsoft
Windows.</p>
<p>Simple patterns are case sensitive unless the
<code>--ignore-case</code> flag is used.</p>
<p>Without <code>--ignore-case</code> (default)</p>
<pre class="text"><code>potato - matches &quot;potato&quot;
       - doesn&#39;t match &quot;POTATO&quot;</code></pre>
<p>With <code>--ignore-case</code></p>
<pre class="text"><code>potato - matches &quot;potato&quot;
       - matches &quot;POTATO&quot;</code></pre>
<h2 id="regexp">Using regular expressions in filter patterns</h2>
<p>The syntax of filter patterns is glob style matching (like
<code>bash</code> uses) to make things easy for users. However this does
not provide absolute control over the matching, so for advanced users
rclone also provides a regular expression syntax.</p>
<p>Rclone generally accepts Perl-style regular expressions, the exact
syntax is defined in the <a
href="https://golang.org/pkg/regexp/syntax/">Go regular expression
reference</a>. Regular expressions should be enclosed in <code>{{</code>
<code>}}</code>. They will match only the last path segment if the glob
doesn't start with <code>/</code> or the whole path name if it does.
Note that rclone does not attempt to parse the supplied regular
expression, meaning that using any regular expression filter will
prevent rclone from using <a href="#directory_filter">directory filter
rules</a>, as it will instead check every path against the supplied
regular expression(s).</p>
<p>Here is how the <code>{{regexp}}</code> is transformed into an full
regular expression to match the entire path:</p>
<pre class="text"><code>{{regexp}}  becomes (^|/)(regexp)$
/{{regexp}} becomes ^(regexp)$</code></pre>
<p>Regexp syntax can be mixed with glob syntax, for example</p>
<pre class="text"><code>*.{{jpe?g}} to match file.jpg, file.jpeg but not file.png</code></pre>
<p>You can also use regexp flags - to set case insensitive, for
example</p>
<pre class="text"><code>*.{{(?i)jpg}} to match file.jpg, file.JPG but not file.png</code></pre>
<p>Be careful with wildcards in regular expressions - you don't want
them to match path separators normally. To match any file name starting
with <code>start</code> and ending with <code>end</code> write</p>
<pre class="text"><code>{{start[^/]*end\.jpg}}</code></pre>
<p>Not</p>
<pre class="text"><code>{{start.*end\.jpg}}</code></pre>
<p>Which will match a directory called <code>start</code> with a file
called <code>end.jpg</code> in it as the <code>.*</code> will match
<code>/</code> characters.</p>
<p>Note that you can use <code>-vv --dump filters</code> to show the
filter patterns in regexp format - rclone implements the glob patterns
by transforming them into regular expressions.</p>
<h2 id="examples">Filter pattern examples</h2>
<table>
<colgroup>
<col style="width: 27%" />
<col style="width: 20%" />
<col style="width: 17%" />
<col style="width: 35%" />
</colgroup>
<thead>
<tr class="header">
<th>Description</th>
<th>Pattern</th>
<th>Matches</th>
<th>Does not match</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Wildcard</td>
<td><code>*.jpg</code></td>
<td><code>/file.jpg</code></td>
<td><code>/file.png</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.jpg</code></td>
<td><code>/dir/file.png</code></td>
</tr>
<tr class="odd">
<td>Rooted</td>
<td><code>/*.jpg</code></td>
<td><code>/file.jpg</code></td>
<td><code>/file.png</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/file2.jpg</code></td>
<td><code>/dir/file.jpg</code></td>
</tr>
<tr class="odd">
<td>Alternates</td>
<td><code>*.{jpg,png}</code></td>
<td><code>/file.jpg</code></td>
<td><code>/file.gif</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.png</code></td>
<td><code>/dir/file.gif</code></td>
</tr>
<tr class="odd">
<td>Path Wildcard</td>
<td><code>dir/**</code></td>
<td><code>/dir/anyfile</code></td>
<td><code>file.png</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/subdir/dir/subsubdir/anyfile</code></td>
<td><code>/subdir/file.png</code></td>
</tr>
<tr class="odd">
<td>Any Char</td>
<td><code>*.t?t</code></td>
<td><code>/file.txt</code></td>
<td><code>/file.qxt</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.tzt</code></td>
<td><code>/dir/file.png</code></td>
</tr>
<tr class="odd">
<td>Range</td>
<td><code>*.[a-z]</code></td>
<td><code>/file.a</code></td>
<td><code>/file.0</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.b</code></td>
<td><code>/dir/file.1</code></td>
</tr>
<tr class="odd">
<td>Escape</td>
<td><code>*.\?\?\?</code></td>
<td><code>/file.???</code></td>
<td><code>/file.abc</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.???</code></td>
<td><code>/dir/file.def</code></td>
</tr>
<tr class="odd">
<td>Class</td>
<td><code>*.\d\d\d</code></td>
<td><code>/file.012</code></td>
<td><code>/file.abc</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.345</code></td>
<td><code>/dir/file.def</code></td>
</tr>
<tr class="odd">
<td>Regexp</td>
<td><code>*.{{jpe?g}}</code></td>
<td><code>/file.jpeg</code></td>
<td><code>/file.png</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.jpg</code></td>
<td><code>/dir/file.jpeeg</code></td>
</tr>
<tr class="odd">
<td>Rooted Regexp</td>
<td><code>/{{.*\.jpe?g}}</code></td>
<td><code>/file.jpeg</code></td>
<td><code>/file.png</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/file.jpg</code></td>
<td><code>/dir/file.jpg</code></td>
</tr>
</tbody>
</table>
<h2 id="how-filter-rules-work">How filter rules are applied to
files</h2>
<p>Rclone path/file name filters are made up of one or more of the
following flags:</p>
<ul>
<li><code>--include</code></li>
<li><code>--include-from</code></li>
<li><code>--exclude</code></li>
<li><code>--exclude-from</code></li>
<li><code>--filter</code></li>
<li><code>--filter-from</code></li>
</ul>
<p>There can be more than one instance of individual flags.</p>
<p>Rclone internally uses a combined list of all the include and exclude
rules. The order in which rules are processed can influence the result
of the filter.</p>
<p>All flags of the same type are processed together in the order above,
regardless of what order the different types of flags are included on
the command line.</p>
<p>Multiple instances of the same flag are processed from left to right
according to their position in the command line.</p>
<p>To mix up the order of processing includes and excludes use
<code>--filter...</code> flags.</p>
<p>Within <code>--include-from</code>, <code>--exclude-from</code> and
<code>--filter-from</code> flags rules are processed from top to bottom
of the referenced file.</p>
<p>If there is an <code>--include</code> or <code>--include-from</code>
flag specified, rclone implies a <code>- **</code> rule which it adds to
the bottom of the internal rule list. Specifying a <code>+</code> rule
with a <code>--filter...</code> flag does not imply that rule.</p>
<p>Each path/file name passed through rclone is matched against the
combined filter list. At first match to a rule the path/file name is
included or excluded and no further filter rules are processed for that
path/file.</p>
<p>If rclone does not find a match, after testing against all rules
(including the implied rule if appropriate), the path/file name is
included.</p>
<p>Any path/file included at that stage is processed by the rclone
command.</p>
<p><code>--files-from</code> and <code>--files-from-raw</code> flags
over-ride and cannot be combined with other filter options.</p>
<p>To see the internal combined rule list, in regular expression form,
for a command add the <code>--dump filters</code> flag. Running an
rclone command with <code>--dump filters</code> and <code>-vv</code>
flags lists the internal filter elements and shows how they are applied
to each source path/file. There is not currently a means provided to
pass regular expression filter options into rclone directly though
character class filter rules contain character classes. <a
href="https://golang.org/pkg/regexp/syntax/">Go regular expression
reference</a></p>
<h3 id="directory_filter">How filter rules are applied to
directories</h3>
<p>Rclone commands are applied to path/file names not directories. The
entire contents of a directory can be matched to a filter by the pattern
<code>directory/*</code> or recursively by
<code>directory/**</code>.</p>
<p>Directory filter rules are defined with a closing <code>/</code>
separator.</p>
<p>E.g. <code>/directory/subdirectory/</code> is an rclone directory
filter rule.</p>
<p>Rclone commands can use directory filter rules to determine whether
they recurse into subdirectories. This potentially optimises access to a
remote by avoiding listing unnecessary directories. Whether optimisation
is desirable depends on the specific filter rules and source remote
content.</p>
<p>If any <a href="#regexp">regular expression filters</a> are in use,
then no directory recursion optimisation is possible, as rclone must
check every path against the supplied regular expression(s).</p>
<p>Directory recursion optimisation occurs if either:</p>
<ul>
<li><p>A source remote does not support the rclone <code>ListR</code>
primitive. local, sftp, Microsoft OneDrive and WebDAV do not support
<code>ListR</code>. Google Drive and most bucket type storage do. <a
href="https://rclone.org/overview/#optional-features">Full
list</a></p></li>
<li><p>On other remotes (those that support <code>ListR</code>), if the
rclone command is not naturally recursive, and provided it is not run
with the <code>--fast-list</code> flag. <code>ls</code>,
<code>lsf -R</code> and <code>size</code> are naturally recursive but
<code>sync</code>, <code>copy</code> and <code>move</code> are
not.</p></li>
<li><p>Whenever the <code>--disable ListR</code> flag is applied to an
rclone command.</p></li>
</ul>
<p>Rclone commands imply directory filter rules from path/file filter
rules. To view the directory filter rules rclone has implied for a
command specify the <code>--dump filters</code> flag.</p>
<p>E.g. for an include rule</p>
<pre class="text"><code>/a/*.jpg</code></pre>
<p>Rclone implies the directory include rule</p>
<pre class="text"><code>/a/</code></pre>
<p>Directory filter rules specified in an rclone command can limit the
scope of an rclone command but path/file filters still have to be
specified.</p>
<p>E.g. <code>rclone ls remote: --include /directory/</code> will not
match any files. Because it is an <code>--include</code> option the
<code>--exclude **</code> rule is implied, and the
<code>/directory/</code> pattern serves only to optimise access to the
remote by ignoring everything outside of that directory.</p>
<p>E.g. <code>rclone ls remote: --filter-from filter-list.txt</code>
with a file <code>filter-list.txt</code>:</p>
<pre class="text"><code>- /dir1/
- /dir2/
+ *.pdf
- **</code></pre>
<p>All files in directories <code>dir1</code> or <code>dir2</code> or
their subdirectories are completely excluded from the listing. Only
files of suffix <code>pdf</code> in the root of <code>remote:</code> or
its subdirectories are listed. The <code>- **</code> rule prevents
listing of any path/files not previously matched by the rules above.</p>
<p>Option <code>exclude-if-present</code> creates a directory exclude
rule based on the presence of a file in a directory and takes precedence
over other rclone directory filter rules.</p>
<p>When using pattern list syntax, if a pattern item contains either
<code>/</code> or <code>**</code>, then rclone will not able to imply a
directory filter rule from this pattern list.</p>
<p>E.g. for an include rule</p>
<pre class="text"><code>{dir1/**,dir2/**}</code></pre>
<p>Rclone will match files below directories <code>dir1</code> or
<code>dir2</code> only, but will not be able to use this filter to
exclude a directory <code>dir3</code> from being traversed.</p>
<p>Directory recursion optimisation may affect performance, but normally
not the result. One exception to this is sync operations with option
<code>--create-empty-src-dirs</code>, where any traversed empty
directories will be created. With the pattern list example
<code>{dir1/**,dir2/**}</code> above, this would create an empty
directory <code>dir3</code> on destination (when it exists on source).
Changing the filter to <code>{dir1,dir2}/**</code>, or splitting it into
two include rules <code>--include dir1/** --include dir2/**</code>, will
match the same files while also filtering directories, with the result
that an empty directory <code>dir3</code> will no longer be created.</p>
<h3 id="exclude---exclude-files-matching-pattern"><code>--exclude</code>
- Exclude files matching pattern</h3>
<p>Excludes path/file names from an rclone command based on a single
exclude rule.</p>
<p>This flag can be repeated. See above for the order filter flags are
processed in.</p>
<p><code>--exclude</code> should not be used with
<code>--include</code>, <code>--include-from</code>,
<code>--filter</code> or <code>--filter-from</code> flags.</p>
<p><code>--exclude</code> has no effect when combined with
<code>--files-from</code> or <code>--files-from-raw</code> flags.</p>
<p>E.g. <code>rclone ls remote: --exclude *.bak</code> excludes all .bak
files from listing.</p>
<p>E.g. <code>rclone size remote: --exclude "/dir/**"</code> returns the
total size of all files on <code>remote:</code> excluding those in root
directory <code>dir</code> and sub directories.</p>
<p>E.g. on Microsoft Windows
<code>rclone ls remote: --exclude "*\[{JP,KR,HK}\]*"</code> lists the
files in <code>remote:</code> without <code>[JP]</code> or
<code>[KR]</code> or <code>[HK]</code> in their name. Quotes prevent the
shell from interpreting the <code>\</code> characters.<code>\</code>
characters escape the <code>[</code> and <code>]</code> so an rclone
filter treats them literally rather than as a character-range. The
<code>{</code> and <code>}</code> define an rclone pattern list. For
other operating systems single quotes are required ie
<code>rclone ls remote: --exclude '*\[{JP,KR,HK}\]*'</code></p>
<h3
id="exclude-from---read-exclude-patterns-from-file"><code>--exclude-from</code>
- Read exclude patterns from file</h3>
<p>Excludes path/file names from an rclone command based on rules in a
named file. The file contains a list of remarks and pattern rules.</p>
<p>For an example <code>exclude-file.txt</code>:</p>
<pre class="text"><code># a sample exclude rule file
*.bak
file2.jpg</code></pre>
<p><code>rclone ls remote: --exclude-from exclude-file.txt</code> lists
the files on <code>remote:</code> except those named
<code>file2.jpg</code> or with a suffix <code>.bak</code>. That is
equivalent to
<code>rclone ls remote: --exclude file2.jpg --exclude "*.bak"</code>.</p>
<p>This flag can be repeated. See above for the order filter flags are
processed in.</p>
<p>The <code>--exclude-from</code> flag is useful where multiple exclude
filter rules are applied to an rclone command.</p>
<p><code>--exclude-from</code> should not be used with
<code>--include</code>, <code>--include-from</code>,
<code>--filter</code> or <code>--filter-from</code> flags.</p>
<p><code>--exclude-from</code> has no effect when combined with
<code>--files-from</code> or <code>--files-from-raw</code> flags.</p>
<p><code>--exclude-from</code> followed by <code>-</code> reads filter
rules from standard input.</p>
<h3 id="include---include-files-matching-pattern"><code>--include</code>
- Include files matching pattern</h3>
<p>Adds a single include rule based on path/file names to an rclone
command.</p>
<p>This flag can be repeated. See above for the order filter flags are
processed in.</p>
<p><code>--include</code> has no effect when combined with
<code>--files-from</code> or <code>--files-from-raw</code> flags.</p>
<p><code>--include</code> implies <code>--exclude **</code> at the end
of an rclone internal filter list. Therefore if you mix
<code>--include</code> and <code>--include-from</code> flags with
<code>--exclude</code>, <code>--exclude-from</code>,
<code>--filter</code> or <code>--filter-from</code>, you must use
include rules for all the files you want in the include statement. For
more flexibility use the <code>--filter-from</code> flag.</p>
<p>E.g. <code>rclone ls remote: --include "*.{png,jpg}"</code> lists the
files on <code>remote:</code> with suffix <code>.png</code> and
<code>.jpg</code>. All other files are excluded.</p>
<p>E.g. multiple rclone copy commands can be combined with
<code>--include</code> and a pattern-list.</p>
<div class="sourceCode" id="cb711"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb711-1"><a href="#cb711-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy /vol1/A remote:A</span>
<span id="cb711-2"><a href="#cb711-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy /vol1/B remote:B</span></code></pre></div>
<p>is equivalent to:</p>
<div class="sourceCode" id="cb712"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb712-1"><a href="#cb712-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy /vol1 remote: <span class="at">--include</span> <span class="st">&quot;{A,B}/**&quot;</span></span></code></pre></div>
<p>E.g. <code>rclone ls remote:/wheat --include "??[^[:punct:]]*"</code>
lists the files <code>remote:</code> directory <code>wheat</code> (and
subdirectories) whose third character is not punctuation. This example
uses an <a href="https://golang.org/pkg/regexp/syntax/">ASCII character
class</a>.</p>
<h3
id="include-from---read-include-patterns-from-file"><code>--include-from</code>
- Read include patterns from file</h3>
<p>Adds path/file names to an rclone command based on rules in a named
file. The file contains a list of remarks and pattern rules.</p>
<p>For an example <code>include-file.txt</code>:</p>
<pre class="text"><code># a sample include rule file
*.jpg
file2.avi</code></pre>
<p><code>rclone ls remote: --include-from include-file.txt</code> lists
the files on <code>remote:</code> with name <code>file2.avi</code> or
suffix <code>.jpg</code>. That is equivalent to
<code>rclone ls remote: --include file2.avi --include "*.jpg"</code>.</p>
<p>This flag can be repeated. See above for the order filter flags are
processed in.</p>
<p>The <code>--include-from</code> flag is useful where multiple include
filter rules are applied to an rclone command.</p>
<p><code>--include-from</code> implies <code>--exclude **</code> at the
end of an rclone internal filter list. Therefore if you mix
<code>--include</code> and <code>--include-from</code> flags with
<code>--exclude</code>, <code>--exclude-from</code>,
<code>--filter</code> or <code>--filter-from</code>, you must use
include rules for all the files you want in the include statement. For
more flexibility use the <code>--filter-from</code> flag.</p>
<p><code>--include-from</code> has no effect when combined with
<code>--files-from</code> or <code>--files-from-raw</code> flags.</p>
<p><code>--include-from</code> followed by <code>-</code> reads filter
rules from standard input.</p>
<h3 id="filter---add-a-file-filtering-rule"><code>--filter</code> - Add
a file-filtering rule</h3>
<p>Specifies path/file names to an rclone command, based on a single
include or exclude rule, in <code>+</code> or <code>-</code> format.</p>
<p>This flag can be repeated. See above for the order filter flags are
processed in.</p>
<p><code>--filter +</code> differs from <code>--include</code>. In the
case of <code>--include</code> rclone implies an
<code>--exclude *</code> rule which it adds to the bottom of the
internal rule list. <code>--filter...+</code> does not imply that
rule.</p>
<p><code>--filter</code> has no effect when combined with
<code>--files-from</code> or <code>--files-from-raw</code> flags.</p>
<p><code>--filter</code> should not be used with <code>--include</code>,
<code>--include-from</code>, <code>--exclude</code> or
<code>--exclude-from</code> flags.</p>
<p>E.g. <code>rclone ls remote: --filter "- *.bak"</code> excludes all
<code>.bak</code> files from a list of <code>remote:</code>.</p>
<h3
id="filter-from---read-filtering-patterns-from-a-file"><code>--filter-from</code>
- Read filtering patterns from a file</h3>
<p>Adds path/file names to an rclone command based on rules in a named
file. The file contains a list of remarks and pattern rules. Include
<!-- markdownlint-disable-next-line no-space-in-code --> rules start
with <code>+</code> and exclude rules with <code>-</code>.
<code>!</code> clears existing rules. Rules are processed in the order
they are defined.</p>
<p>This flag can be repeated. See above for the order filter flags are
processed in.</p>
<p>Arrange the order of filter rules with the most restrictive first and
work down.</p>
<p>Lines starting with # or ; are ignored, and can be used to write
comments. Inline comments are not supported. <em>Use
<code>-vv --dump filters</code> to see how they appear in the final
regexp.</em></p>
<p>E.g. for <code>filter-file.txt</code>:</p>
<pre class="text"><code># a sample filter rule file
- secret*.jpg
+ *.jpg
+ *.png
+ file2.avi
- /dir/tmp/** # WARNING! This text will be treated as part of the path.
- /dir/Trash/**
+ /dir/**
# exclude everything else
- *</code></pre>
<p><code>rclone ls remote: --filter-from filter-file.txt</code> lists
the path/files on <code>remote:</code> including all <code>jpg</code>
and <code>png</code> files, excluding any matching
<code>secret*.jpg</code> and including <code>file2.avi</code>. It also
includes everything in the directory <code>dir</code> at the root of
<code>remote</code>, except <code>remote:dir/Trash</code> which it
excludes. Everything else is excluded.</p>
<p>E.g. for an alternative <code>filter-file.txt</code>:</p>
<pre class="text"><code>- secret*.jpg
+ *.jpg
+ *.png
+ file2.avi
- *</code></pre>
<p>Files <code>file1.jpg</code>, <code>file3.png</code> and
<code>file2.avi</code> are listed whilst <code>secret17.jpg</code> and
files without the suffix <code>.jpg</code> or <code>.png</code> are
excluded.</p>
<p>E.g. for an alternative <code>filter-file.txt</code>:</p>
<pre class="text"><code>+ *.jpg
+ *.gif
!
+ 42.doc
- *</code></pre>
<p>Only file 42.doc is listed. Prior rules are cleared by the
<code>!</code>.</p>
<h3
id="files-from---read-list-of-source-file-names"><code>--files-from</code>
- Read list of source-file names</h3>
<p>Adds path/files to an rclone command from a list in a named file.
Rclone processes the path/file names in the order of the list, and no
others.</p>
<p>Other filter flags (<code>--include</code>,
<code>--include-from</code>, <code>--exclude</code>,
<code>--exclude-from</code>, <code>--filter</code> and
<code>--filter-from</code>) are ignored when <code>--files-from</code>
is used.</p>
<p><code>--files-from</code> expects a list of files as its input.
Leading or trailing whitespace is stripped from the input lines. Lines
starting with <code>#</code> or <code>;</code> are ignored.</p>
<p><code>--files-from</code> followed by <code>-</code> reads the list
of files from standard input.</p>
<p>Rclone commands with a <code>--files-from</code> flag traverse the
remote, treating the names in <code>--files-from</code> as a set of
filters.</p>
<p>If the <code>--no-traverse</code> and <code>--files-from</code> flags
are used together an rclone command does not traverse the remote.
Instead it addresses each path/file named in the file individually. For
each path/file name, that requires typically 1 API call. This can be
efficient for a short <code>--files-from</code> list and a remote
containing many files.</p>
<p>Rclone commands do not error if any names in the
<code>--files-from</code> file are missing from the source remote.</p>
<p>The <code>--files-from</code> flag can be repeated in a single rclone
command to read path/file names from more than one file. The files are
read from left to right along the command line.</p>
<p>Paths within the <code>--files-from</code> file are interpreted as
starting with the root specified in the rclone command. Leading
<code>/</code> separators are ignored. See <a
href="#files-from-raw-read-list-of-source-file-names-without-any-processing">--files-from-raw</a>
if you need the input to be processed in a raw manner.</p>
<p>E.g. for a file <code>files-from.txt</code>:</p>
<pre class="text"><code># comment
file1.jpg
subdir/file2.jpg</code></pre>
<p><code>rclone copy --files-from files-from.txt /home/me/pics remote:pics</code>
copies the following, if they exist, and only those files.</p>
<pre class="text"><code>/home/me/pics/file1.jpg        → remote:pics/file1.jpg
/home/me/pics/subdir/file2.jpg → remote:pics/subdir/file2.jpg</code></pre>
<p>E.g. to copy the following files referenced by their absolute
paths:</p>
<pre class="text"><code>/home/user1/42
/home/user1/dir/ford
/home/user2/prefect</code></pre>
<p>First find a common subdirectory - in this case <code>/home</code>
and put the remaining files in <code>files-from.txt</code> with or
without leading <code>/</code>, e.g.</p>
<pre class="text"><code>user1/42
user1/dir/ford
user2/prefect</code></pre>
<p>Then copy these to a remote:</p>
<div class="sourceCode" id="cb721"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb721-1"><a href="#cb721-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="at">--files-from</span> files-from.txt /home remote:backup</span></code></pre></div>
<p>The three files are transferred as follows:</p>
<pre class="text"><code>/home/user1/42       → remote:backup/user1/important
/home/user1/dir/ford → remote:backup/user1/dir/file
/home/user2/prefect  → remote:backup/user2/stuff</code></pre>
<p>Alternatively if <code>/</code> is chosen as root
<code>files-from.txt</code> will be:</p>
<pre class="text"><code>/home/user1/42
/home/user1/dir/ford
/home/user2/prefect</code></pre>
<p>The copy command will be:</p>
<div class="sourceCode" id="cb724"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb724-1"><a href="#cb724-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="at">--files-from</span> files-from.txt / remote:backup</span></code></pre></div>
<p>Then there will be an extra <code>home</code> directory on the
remote:</p>
<pre class="text"><code>/home/user1/42       → remote:backup/home/user1/42
/home/user1/dir/ford → remote:backup/home/user1/dir/ford
/home/user2/prefect  → remote:backup/home/user2/prefect</code></pre>
<h3
id="files-from-raw---read-list-of-source-file-names-without-any-processing"><code>--files-from-raw</code>
- Read list of source-file names without any processing</h3>
<p>This flag is the same as <code>--files-from</code> except that input
is read in a raw manner. Lines with leading / trailing whitespace, and
lines starting with <code>;</code> or <code>#</code> are read without
any processing. <a href="https://rclone.org/commands/rclone_lsf/">rclone
lsf</a> has a compatible format that can be used to export file lists
from remotes for input to <code>--files-from-raw</code>.</p>
<h3
id="ignore-case---make-searches-case-insensitive"><code>--ignore-case</code>
- make searches case insensitive</h3>
<p>By default, rclone filter patterns are case sensitive. The
<code>--ignore-case</code> flag makes all of the filters patterns on the
command line case insensitive.</p>
<p>E.g. <code>--include "zaphod.txt"</code> does not match a file
<code>Zaphod.txt</code>. With <code>--ignore-case</code> a match is
made.</p>
<h2 id="quoting-shell-metacharacters">Quoting shell metacharacters</h2>
<p>Rclone commands with filter patterns containing shell metacharacters
may not as work as expected in your shell and may require quoting.</p>
<p>E.g. linux, OSX (<code>*</code> metacharacter)</p>
<ul>
<li><code>--include \*.jpg</code></li>
<li><code>--include '*.jpg'</code></li>
<li><code>--include='*.jpg'</code></li>
</ul>
<p>Microsoft Windows expansion is done by the command, not shell, so
<code>--include *.jpg</code> does not require quoting.</p>
<p>If the rclone error
<code>Command .... needs .... arguments maximum: you provided .... non flag arguments:</code>
is encountered, the cause is commonly spaces within the name of a remote
or flag value. The fix then is to quote values containing spaces.</p>
<h2 id="other-filters">Other filters</h2>
<h3
id="min-size---dont-transfer-any-file-smaller-than-this"><code>--min-size</code>
- Don't transfer any file smaller than this</h3>
<p>Controls the minimum size file within the scope of an rclone command.
Default units are <code>KiB</code> but abbreviations <code>B</code>,
<code>K</code>, <code>M</code>, <code>G</code>, <code>T</code> or
<code>P</code> are valid.</p>
<p>E.g. <code>rclone ls remote: --min-size 50k</code> lists files on
<code>remote:</code> of 50 KiB size or larger.</p>
<p>See <a href="https://rclone.org/docs/#size-options">the size option
docs</a> for more info.</p>
<h3
id="max-size---dont-transfer-any-file-larger-than-this"><code>--max-size</code>
- Don't transfer any file larger than this</h3>
<p>Controls the maximum size file within the scope of an rclone command.
Default units are <code>KiB</code> but abbreviations <code>B</code>,
<code>K</code>, <code>M</code>, <code>G</code>, <code>T</code> or
<code>P</code> are valid.</p>
<p>E.g. <code>rclone ls remote: --max-size 1G</code> lists files on
<code>remote:</code> of 1 GiB size or smaller.</p>
<p>See <a href="https://rclone.org/docs/#size-options">the size option
docs</a> for more info.</p>
<h3
id="max-age---dont-transfer-any-file-older-than-this"><code>--max-age</code>
- Don't transfer any file older than this</h3>
<p>Controls the maximum age of files within the scope of an rclone
command.</p>
<p><code>--max-age</code> applies only to files and not to
directories.</p>
<p>E.g. <code>rclone ls remote: --max-age 2d</code> lists files on
<code>remote:</code> of 2 days old or less.</p>
<p>See <a href="https://rclone.org/docs/#time-options">the time option
docs</a> for valid formats.</p>
<h3
id="min-age---dont-transfer-any-file-younger-than-this"><code>--min-age</code>
- Don't transfer any file younger than this</h3>
<p>Controls the minimum age of files within the scope of an rclone
command. (see <code>--max-age</code> for valid formats)</p>
<p><code>--min-age</code> applies only to files and not to
directories.</p>
<p>E.g. <code>rclone ls remote: --min-age 2d</code> lists files on
<code>remote:</code> of 2 days old or more.</p>
<p>See <a href="https://rclone.org/docs/#time-options">the time option
docs</a> for valid formats.</p>
<h3 id="hash-filter"><code>--hash-filter</code> - Deterministically
select a subset of files</h3>
<p>The <code>--hash-filter</code> flag enables selecting a deterministic
subset of files, useful for:</p>
<ol type="1">
<li>Running large sync operations across multiple machines.</li>
<li>Checking a subset of files for bitrot.</li>
<li>Any other operations where a sample of files is required.</li>
</ol>
<h4 id="syntax">Syntax</h4>
<p>The flag takes two parameters expressed as a fraction:</p>
<div class="sourceCode" id="cb726"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb726-1"><a href="#cb726-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--hash-filter</span> K/N</span></code></pre></div>
<ul>
<li><code>N</code>: The total number of partitions (must be a positive
integer).</li>
<li><code>K</code>: The specific partition to select (an integer from
<code>0</code> to <code>N</code>).</li>
</ul>
<p>For example:</p>
<ul>
<li><code>--hash-filter 1/3</code>: Selects the first third of the
files.</li>
<li><code>--hash-filter 2/3</code> and <code>--hash-filter 3/3</code>:
Select the second and third partitions, respectively.</li>
</ul>
<p>Each partition is non-overlapping, ensuring all files are covered
without duplication.</p>
<h4 id="random-partition-selection">Random Partition Selection</h4>
<p>Use <code>@</code> as <code>K</code> to randomly select a
partition:</p>
<div class="sourceCode" id="cb727"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb727-1"><a href="#cb727-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--hash-filter</span> @/M</span></code></pre></div>
<p>For example, <code>--hash-filter @/3</code> will randomly select a
number between 0 and 2. This will stay constant across retries.</p>
<h4 id="how-it-works">How It Works</h4>
<ul>
<li>Rclone takes each file's full path, normalizes it to lowercase, and
applies Unicode normalization.</li>
<li>It then hashes the normalized path into a 64 bit number.</li>
<li>The hash result is reduced modulo <code>N</code> to assign the file
to a partition.</li>
<li>If the calculated partition does not match <code>K</code> the file
is excluded.</li>
<li>Other filters may apply if the file is not excluded.</li>
</ul>
<p><strong>Important:</strong> Rclone will traverse all directories to
apply the filter.</p>
<h4 id="usage-notes">Usage Notes</h4>
<ul>
<li>Safe to use with <code>rclone sync</code>; source and destination
selections will match.</li>
<li><strong>Do not</strong> use with <code>--delete-excluded</code>, as
this could delete unselected files.</li>
<li>Ignored if <code>--files-from</code> is used.</li>
</ul>
<h4 id="examples-1">Examples</h4>
<h5 id="dividing-files-into-4-partitions">Dividing files into 4
partitions</h5>
<p>Assuming the current directory contains <code>file1.jpg</code>
through <code>file9.jpg</code>:</p>
<div class="sourceCode" id="cb728"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb728-1"><a href="#cb728-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsf <span class="at">--hash-filter</span> 0/4 .</span>
<span id="cb728-2"><a href="#cb728-2" aria-hidden="true" tabindex="-1"></a><span class="ex">file1.jpg</span></span>
<span id="cb728-3"><a href="#cb728-3" aria-hidden="true" tabindex="-1"></a><span class="ex">file5.jpg</span></span>
<span id="cb728-4"><a href="#cb728-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb728-5"><a href="#cb728-5" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsf <span class="at">--hash-filter</span> 1/4 .</span>
<span id="cb728-6"><a href="#cb728-6" aria-hidden="true" tabindex="-1"></a><span class="ex">file3.jpg</span></span>
<span id="cb728-7"><a href="#cb728-7" aria-hidden="true" tabindex="-1"></a><span class="ex">file6.jpg</span></span>
<span id="cb728-8"><a href="#cb728-8" aria-hidden="true" tabindex="-1"></a><span class="ex">file9.jpg</span></span>
<span id="cb728-9"><a href="#cb728-9" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb728-10"><a href="#cb728-10" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsf <span class="at">--hash-filter</span> 2/4 .</span>
<span id="cb728-11"><a href="#cb728-11" aria-hidden="true" tabindex="-1"></a><span class="ex">file2.jpg</span></span>
<span id="cb728-12"><a href="#cb728-12" aria-hidden="true" tabindex="-1"></a><span class="ex">file4.jpg</span></span>
<span id="cb728-13"><a href="#cb728-13" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb728-14"><a href="#cb728-14" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsf <span class="at">--hash-filter</span> 3/4 .</span>
<span id="cb728-15"><a href="#cb728-15" aria-hidden="true" tabindex="-1"></a><span class="ex">file7.jpg</span></span>
<span id="cb728-16"><a href="#cb728-16" aria-hidden="true" tabindex="-1"></a><span class="ex">file8.jpg</span></span>
<span id="cb728-17"><a href="#cb728-17" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb728-18"><a href="#cb728-18" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsf <span class="at">--hash-filter</span> 4/4 . <span class="co"># the same as --hash-filter 0/4</span></span>
<span id="cb728-19"><a href="#cb728-19" aria-hidden="true" tabindex="-1"></a><span class="ex">file1.jpg</span></span>
<span id="cb728-20"><a href="#cb728-20" aria-hidden="true" tabindex="-1"></a><span class="ex">file5.jpg</span></span></code></pre></div>
<h5 id="syncing-the-first-quarter-of-files">Syncing the first quarter of
files</h5>
<div class="sourceCode" id="cb729"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb729-1"><a href="#cb729-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--hash-filter</span> 1/4 source:path destination:path</span></code></pre></div>
<h5 id="checking-a-random-1-of-files-for-integrity">Checking a random 1%
of files for integrity</h5>
<div class="sourceCode" id="cb730"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb730-1"><a href="#cb730-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> check <span class="at">--download</span> <span class="at">--hash-filter</span> @/100 source:path destination:path</span></code></pre></div>
<h2 id="other-flags">Other flags</h2>
<h3
id="delete-excluded---delete-files-on-dest-excluded-from-sync"><code>--delete-excluded</code>
- Delete files on dest excluded from sync</h3>
<p><strong>Important</strong> this flag is dangerous to your data - use
with <code>--dry-run</code> and <code>-v</code> first.</p>
<p>In conjunction with <code>rclone sync</code>,
<code>--delete-excluded</code> deletes any files on the destination
which are excluded from the command.</p>
<p>E.g. the scope of <code>rclone sync --interactive A: B:</code> can be
restricted:</p>
<div class="sourceCode" id="cb731"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb731-1"><a href="#cb731-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">--min-size</span> 50k <span class="at">--delete-excluded</span> sync A: B:</span></code></pre></div>
<p>All files on <code>B:</code> which are less than 50 KiB are deleted
because they are excluded from the rclone sync command.</p>
<h3
id="dump-filters---dump-the-filters-to-the-output"><code>--dump filters</code>
- dump the filters to the output</h3>
<p>Dumps the defined filters to standard output in regular expression
format.</p>
<p>Useful for debugging.</p>
<h2 id="exclude-directory-based-on-a-file">Exclude directory based on a
file</h2>
<p>The <code>--exclude-if-present</code> flag controls whether a
directory is within the scope of an rclone command based on the presence
of a named file within it. The flag can be repeated to check for
multiple file names, presence of any of them will exclude the
directory.</p>
<p>This flag has a priority over other filter flags.</p>
<p>E.g. for the following directory structure:</p>
<pre class="text"><code>dir1/file1
dir1/dir2/file2
dir1/dir2/dir3/file3
dir1/dir2/dir3/.ignore</code></pre>
<p>The command <code>rclone ls --exclude-if-present .ignore dir1</code>
does not list <code>dir3</code>, <code>file3</code> or
<code>.ignore</code>.</p>
<h2 id="metadata">Metadata filters</h2>
<p>The metadata filters work in a very similar way to the normal file
name filters, except they match <a
href="https://rclone.org/docs/#metadata">metadata</a> on the object.</p>
<p>The metadata should be specified as <code>key=value</code> patterns.
This may be wildcarded using the normal <a href="#patterns">filter
patterns</a> or <a href="#regexp">regular expressions</a>.</p>
<p>For example if you wished to list only local files with a mode of
<code>100664</code> you could do that with:</p>
<div class="sourceCode" id="cb733"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb733-1"><a href="#cb733-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf <span class="at">-M</span> <span class="at">--files-only</span> <span class="at">--metadata-include</span> <span class="st">&quot;mode=100664&quot;</span> .</span></code></pre></div>
<p>Or if you wished to show files with an <code>atime</code>,
<code>mtime</code> or <code>btime</code> at a given date:</p>
<div class="sourceCode" id="cb734"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb734-1"><a href="#cb734-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsf <span class="at">-M</span> <span class="at">--files-only</span> <span class="at">--metadata-include</span> <span class="st">&quot;[abm]time=2022-12-16*&quot;</span> .</span></code></pre></div>
<p>Like file filtering, metadata filtering only applies to files not to
directories.</p>
<p>The filters can be applied using these flags.</p>
<ul>
<li><code>--metadata-include</code> - Include metadatas matching
pattern</li>
<li><code>--metadata-include-from</code> - Read metadata include
patterns from file (use - to read from stdin)</li>
<li><code>--metadata-exclude</code> - Exclude metadatas matching
pattern</li>
<li><code>--metadata-exclude-from</code> - Read metadata exclude
patterns from file (use - to read from stdin)</li>
<li><code>--metadata-filter</code> - Add a metadata filtering rule</li>
<li><code>--metadata-filter-from</code> - Read metadata filtering
patterns from a file (use - to read from stdin)</li>
</ul>
<p>Each flag can be repeated. See the section on <a
href="#how-filter-rules-work">how filter rules are applied</a> for more
details - these flags work in an identical way to the file name
filtering flags, but instead of file name patterns have metadata
patterns.</p>
<h2 id="common-pitfalls">Common pitfalls</h2>
<p>The most frequent filter support issues on the <a
href="https://forum.rclone.org/">rclone forum</a> are:</p>
<ul>
<li>Not using paths relative to the root of the remote</li>
<li>Not using <code>/</code> to match from the root of a remote</li>
<li>Not using <code>**</code> to match the contents of a directory</li>
</ul>
<h1 id="gui-experimental">GUI (Experimental)</h1>
<p>Rclone can serve a web based GUI (graphical user interface). This is
somewhat experimental at the moment so things may be subject to
change.</p>
<p>Run this command in a terminal and rclone will download and then
display the GUI in a web browser.</p>
<div class="sourceCode" id="cb735"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb735-1"><a href="#cb735-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rcd <span class="at">--rc-web-gui</span></span></code></pre></div>
<p>This will produce logs like this and rclone needs to continue to run
to serve the GUI:</p>
<pre class="text"><code>2019/08/25 11:40:14 NOTICE: A new release for gui is present at https://github.com/rclone/rclone-webui-react/releases/download/v0.0.6/currentbuild.zip
2019/08/25 11:40:14 NOTICE: Downloading webgui binary. Please wait. [Size: 3813937, Path :  /home/USER/.cache/rclone/webgui/v0.0.6.zip]
2019/08/25 11:40:16 NOTICE: Unzipping
2019/08/25 11:40:16 NOTICE: Serving remote control on http://127.0.0.1:5572/</code></pre>
<p>This assumes you are running rclone locally on your machine. It is
possible to separate the rclone and the GUI - see below for details.</p>
<p>If you wish to check for updates then you can add
<code>--rc-web-gui-update</code> to the command line.</p>
<p>If you find your GUI broken, you may force it to update by add
<code>--rc-web-gui-force-update</code>.</p>
<p>By default, rclone will open your browser. Add
<code>--rc-web-gui-no-open-browser</code> to disable this feature.</p>
<h2 id="using-the-gui">Using the GUI</h2>
<p>Once the GUI opens, you will be looking at the dashboard which has an
overall overview.</p>
<p>On the left hand side you will see a series of view buttons you can
click on:</p>
<ul>
<li>Dashboard - main overview</li>
<li>Configs - examine and create new configurations</li>
<li>Explorer - view, download and upload files to the cloud storage
systems</li>
<li>Backend - view or alter the backend config</li>
<li>Log out</li>
</ul>
<p>(More docs and walkthrough video to come!)</p>
<h2 id="how-it-works-1">How it works</h2>
<p>When you run the <code>rclone rcd --rc-web-gui</code> this is what
happens</p>
<ul>
<li>Rclone starts but only runs the remote control API ("rc").</li>
<li>The API is bound to localhost with an auto-generated username and
password.</li>
<li>If the API bundle is missing then rclone will download it.</li>
<li>rclone will start serving the files from the API bundle over the
same port as the API</li>
<li>rclone will open the browser with a <code>login_token</code> so it
can log straight in.</li>
</ul>
<h2 id="advanced-use">Advanced use</h2>
<p>The <code>rclone rcd</code> may use any of the <a
href="https://rclone.org/rc/#supported-parameters">flags documented on
the rc page</a>.</p>
<p>The flag <code>--rc-web-gui</code> is shorthand for</p>
<ul>
<li>Download the web GUI if necessary</li>
<li>Check we are using some authentication</li>
<li><code>--rc-user gui</code></li>
<li><code>--rc-pass &lt;random password&gt;</code></li>
<li><code>--rc-serve</code></li>
</ul>
<p>These flags can be overridden as desired.</p>
<p>See also the <a href="https://rclone.org/commands/rclone_rcd/">rclone
rcd documentation</a>.</p>
<h3 id="example-running-a-public-gui">Example: Running a public GUI</h3>
<p>For example the GUI could be served on a public port over SSL using
an htpasswd file using the following flags:</p>
<ul>
<li><code>--rc-web-gui</code></li>
<li><code>--rc-addr :443</code></li>
<li><code>--rc-htpasswd /path/to/htpasswd</code></li>
<li><code>--rc-cert /path/to/ssl.crt</code></li>
<li><code>--rc-key /path/to/ssl.key</code></li>
</ul>
<h3 id="example-running-a-gui-behind-a-proxy">Example: Running a GUI
behind a proxy</h3>
<p>If you want to run the GUI behind a proxy at <code>/rclone</code> you
could use these flags:</p>
<ul>
<li><code>--rc-web-gui</code></li>
<li><code>--rc-baseurl rclone</code></li>
<li><code>--rc-htpasswd /path/to/htpasswd</code></li>
</ul>
<p>Or instead of htpasswd if you just want a single user and
password:</p>
<ul>
<li><code>--rc-user me</code></li>
<li><code>--rc-pass mypassword</code></li>
</ul>
<h2 id="project">Project</h2>
<p>The GUI is being developed in the: <a
href="https://github.com/rclone/rclone-webui-react">rclone/rclone-webui-react
repository</a>.</p>
<p>Bug reports and contributions are very welcome :-)</p>
<p>If you have questions then please ask them on the <a
href="https://forum.rclone.org/">rclone forum</a>.</p>
<h1 id="remote-controlling-rclone-with-its-api">Remote controlling
rclone with its API</h1>
<p>If rclone is run with the <code>--rc</code> flag then it starts an
HTTP server which can be used to remote control rclone using its
API.</p>
<p>You can either use the <a href="#api-rc">rc</a> command to access the
API or <a href="#api-http">use HTTP directly</a>.</p>
<p>If you just want to run a remote control then see the <a
href="https://rclone.org/commands/rclone_rcd/">rcd</a> command.</p>
<h2 id="supported-parameters">Supported parameters</h2>
<h3 id="rc">--rc</h3>
<p>Flag to start the http server listen on remote requests.</p>
<h3 id="rc-addrip">--rc-addr=IP</h3>
<p>IPaddress:Port or :Port to bind server to. (default
"localhost:5572").</p>
<h3 id="rc-certkey">--rc-cert=KEY</h3>
<p>SSL PEM key (concatenation of certificate and CA certificate).</p>
<h3 id="rc-client-capath">--rc-client-ca=PATH</h3>
<p>Client certificate authority to verify clients with.</p>
<h3 id="rc-htpasswdpath">--rc-htpasswd=PATH</h3>
<p>htpasswd file - if not provided no authentication is done.</p>
<h3 id="rc-keypath">--rc-key=PATH</h3>
<p>TLS PEM private key file.</p>
<h3 id="rc-max-header-bytesvalue">--rc-max-header-bytes=VALUE</h3>
<p>Maximum size of request header (default 4096).</p>
<h3 id="rc-min-tls-versionvalue">--rc-min-tls-version=VALUE</h3>
<p>The minimum TLS version that is acceptable. Valid values are
"tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0").</p>
<h3 id="rc-uservalue">--rc-user=VALUE</h3>
<p>User name for authentication.</p>
<h3 id="rc-passvalue">--rc-pass=VALUE</h3>
<p>Password for authentication.</p>
<h3 id="rc-realmvalue">--rc-realm=VALUE</h3>
<p>Realm for authentication (default "rclone").</p>
<h3
id="rc-server-read-timeoutduration">--rc-server-read-timeout=DURATION</h3>
<p>Timeout for server reading data (default 1h0m0s).</p>
<h3
id="rc-server-write-timeoutduration">--rc-server-write-timeout=DURATION</h3>
<p>Timeout for server writing data (default 1h0m0s).</p>
<h3 id="rc-serve">--rc-serve</h3>
<p>Enable the serving of remote objects via the HTTP interface. This
means objects will be accessible at <code>http://127.0.0.1:5572/</code>
by default, so you can browse to <code>http://127.0.0.1:5572/</code> or
<code>http://127.0.0.1:5572/*</code> to see a listing of the remotes.
Objects may be requested from remotes using this syntax
<code>http://127.0.0.1:5572/[remote:path]/path/to/object</code></p>
<p>Default Off.</p>
<h3 id="rc-serve-no-modtime">--rc-serve-no-modtime</h3>
<p>Set this flag to skip reading the modification time (can speed things
up).</p>
<p>Default Off.</p>
<h3 id="rc-files-pathtodirectory">--rc-files /path/to/directory</h3>
<p>Path to local files to serve on the HTTP server.</p>
<p>If this is set then rclone will serve the files in that directory. It
will also open the root in the web browser if specified. This is for
implementing browser based GUIs for rclone functions.</p>
<p>If <code>--rc-user</code> or <code>--rc-pass</code> is set then the
URL that is opened will have the authorization in the URL in the
<code>http://user:pass@localhost/</code> style.</p>
<p>Default Off.</p>
<h3 id="rc-enable-metrics">--rc-enable-metrics</h3>
<p>Enable OpenMetrics/Prometheus compatible endpoint at
<code>/metrics</code>. If more control over the metrics is desired (for
example running it on a different port or with different auth) then
endpoint can be enabled with the <code>--metrics-*</code> flags
instead.</p>
<p>Default Off.</p>
<h3 id="rc-web-gui">--rc-web-gui</h3>
<p>Set this flag to serve the default web gui on the same port as
rclone.</p>
<p>Default Off.</p>
<h3 id="rc-allow-origin">--rc-allow-origin</h3>
<p>Set the allowed Access-Control-Allow-Origin for rc requests.</p>
<p>Can be used with --rc-web-gui if the rclone is running on different
IP than the web-gui.</p>
<p>Default is IP address on which rc is running.</p>
<h3 id="rc-web-fetch-url">--rc-web-fetch-url</h3>
<p>Set the URL to fetch the rclone-web-gui files from.</p>
<p>Default <a
href="https://api.github.com/repos/rclone/rclone-webui-react/releases/latest"
class="uri">https://api.github.com/repos/rclone/rclone-webui-react/releases/latest</a>.</p>
<h3 id="rc-web-gui-update">--rc-web-gui-update</h3>
<p>Set this flag to check and update rclone-webui-react from the
rc-web-fetch-url.</p>
<p>Default Off.</p>
<h3 id="rc-web-gui-force-update">--rc-web-gui-force-update</h3>
<p>Set this flag to force update rclone-webui-react from the
rc-web-fetch-url.</p>
<p>Default Off.</p>
<h3 id="rc-web-gui-no-open-browser">--rc-web-gui-no-open-browser</h3>
<p>Set this flag to disable opening browser automatically when using
web-gui.</p>
<p>Default Off.</p>
<h3
id="rc-job-expire-durationduration">--rc-job-expire-duration=DURATION</h3>
<p>Expire finished async jobs older than DURATION (default 60s).</p>
<h3
id="rc-job-expire-intervalduration">--rc-job-expire-interval=DURATION</h3>
<p>Interval duration to check for expired async jobs (default 10s).</p>
<h3 id="rc-no-auth">--rc-no-auth</h3>
<p>By default rclone will require authorisation to have been set up on
the rc interface in order to use any methods which access any rclone
remotes. Eg <code>operations/list</code> is denied as it involved
creating a remote as is <code>sync/copy</code>.</p>
<p>If this is set then no authorisation will be required on the server
to use these methods. The alternative is to use <code>--rc-user</code>
and <code>--rc-pass</code> and use these credentials in the request.</p>
<p>Default Off.</p>
<h3 id="rc-baseurl">--rc-baseurl</h3>
<p>Prefix for URLs.</p>
<p>Default is root</p>
<h3 id="rc-template">--rc-template</h3>
<p>User-specified template.</p>
<h2 id="api-rc">Accessing the remote control via the rclone rc
command</h2>
<p>Rclone itself implements the remote control protocol in its
<code>rclone rc</code> command.</p>
<p>You can use it like this:</p>
<div class="sourceCode" id="cb737"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb737-1"><a href="#cb737-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone rc rc/noop param1=one param2=two</span>
<span id="cb737-2"><a href="#cb737-2" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb737-3"><a href="#cb737-3" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;param1&quot;</span><span class="ex">:</span> <span class="st">&quot;one&quot;</span>,</span>
<span id="cb737-4"><a href="#cb737-4" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;param2&quot;</span><span class="ex">:</span> <span class="st">&quot;two&quot;</span></span>
<span id="cb737-5"><a href="#cb737-5" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span></code></pre></div>
<p>If the remote is running on a different URL than the default
<code>http://localhost:5572/</code>, use the <code>--url</code> option
to specify it:</p>
<div class="sourceCode" id="cb738"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb738-1"><a href="#cb738-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc <span class="at">--url</span> http://some.remote:1234/ rc/noop</span></code></pre></div>
<p>Or, if the remote is listening on a Unix socket, use the
<code>--unix-socket</code> option instead:</p>
<div class="sourceCode" id="cb739"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb739-1"><a href="#cb739-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc <span class="at">--unix-socket</span> /tmp/rclone.sock rc/noop</span></code></pre></div>
<p>Run <code>rclone rc</code> on its own, without any commands, to see
the help for the installed remote control commands. Note that this also
needs to connect to the remote server.</p>
<h2 id="json-input">JSON input</h2>
<p><code>rclone rc</code> also supports a <code>--json</code> flag which
can be used to send more complicated input parameters.</p>
<div class="sourceCode" id="cb740"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb740-1"><a href="#cb740-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone rc <span class="at">--json</span> <span class="st">&#39;{ &quot;p1&quot;: [1,&quot;2&quot;,null,4], &quot;p2&quot;: { &quot;a&quot;:1, &quot;b&quot;:2 } }&#39;</span> rc/noop</span>
<span id="cb740-2"><a href="#cb740-2" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb740-3"><a href="#cb740-3" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;p1&quot;</span><span class="ex">:</span> [</span>
<span id="cb740-4"><a href="#cb740-4" aria-hidden="true" tabindex="-1"></a>        <span class="ex">1,</span></span>
<span id="cb740-5"><a href="#cb740-5" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;2&quot;</span><span class="ex">,</span></span>
<span id="cb740-6"><a href="#cb740-6" aria-hidden="true" tabindex="-1"></a>        <span class="ex">null,</span></span>
<span id="cb740-7"><a href="#cb740-7" aria-hidden="true" tabindex="-1"></a>        <span class="ex">4</span></span>
<span id="cb740-8"><a href="#cb740-8" aria-hidden="true" tabindex="-1"></a>    <span class="ex">],</span></span>
<span id="cb740-9"><a href="#cb740-9" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;p2&quot;</span><span class="ex">:</span> {</span>
<span id="cb740-10"><a href="#cb740-10" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;a&quot;</span><span class="ex">:</span> 1,</span>
<span id="cb740-11"><a href="#cb740-11" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;b&quot;</span><span class="ex">:</span> 2</span>
<span id="cb740-12"><a href="#cb740-12" aria-hidden="true" tabindex="-1"></a>    <span class="kw">}</span></span>
<span id="cb740-13"><a href="#cb740-13" aria-hidden="true" tabindex="-1"></a><span class="er">}</span></span></code></pre></div>
<p>If the parameter being passed is an object then it can be passed as a
JSON string rather than using the <code>--json</code> flag which
simplifies the command line.</p>
<div class="sourceCode" id="cb741"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb741-1"><a href="#cb741-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc operations/list fs=/tmp remote=test opt=<span class="st">&#39;{&quot;showHash&quot;: true}&#39;</span></span></code></pre></div>
<p>Rather than</p>
<div class="sourceCode" id="cb742"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb742-1"><a href="#cb742-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc operations/list <span class="at">--json</span> <span class="st">&#39;{&quot;fs&quot;: &quot;/tmp&quot;, &quot;remote&quot;: &quot;test&quot;, &quot;opt&quot;: {&quot;showHash&quot;: true}}&#39;</span></span></code></pre></div>
<h2 id="special-parameters">Special parameters</h2>
<p>The rc interface supports some special parameters which apply to
<strong>all</strong> commands. These start with <code>_</code> to show
they are different.</p>
<h3 id="running-asynchronous-jobs-with-_async-true">Running asynchronous
jobs with _async = true</h3>
<p>Each rc call is classified as a job and it is assigned its own id. By
default jobs are executed immediately as they are created or
synchronously.</p>
<p>If <code>_async</code> has a true value when supplied to an rc call
then it will return immediately with a job id and the task will be run
in the background. The <code>job/status</code> call can be used to get
information of the background job. The job can be queried for up to 1
minute after it has finished.</p>
<p>It is recommended that potentially long running jobs, e.g.
<code>sync/sync</code>, <code>sync/copy</code>, <code>sync/move</code>,
<code>operations/purge</code> are run with the <code>_async</code> flag
to avoid any potential problems with the HTTP request and response
timing out.</p>
<p>Starting a job with the <code>_async</code> flag:</p>
<div class="sourceCode" id="cb743"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb743-1"><a href="#cb743-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone rc <span class="at">--json</span> <span class="st">&#39;{ &quot;p1&quot;: [1,&quot;2&quot;,null,4], &quot;p2&quot;: { &quot;a&quot;:1, &quot;b&quot;:2 }, &quot;_async&quot;: true }&#39;</span> rc/noop</span>
<span id="cb743-2"><a href="#cb743-2" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb743-3"><a href="#cb743-3" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;jobid&quot;</span><span class="ex">:</span> 2</span>
<span id="cb743-4"><a href="#cb743-4" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span></code></pre></div>
<p>Query the status to see if the job has finished. For more information
on the meaning of these return parameters see the
<code>job/status</code> call.</p>
<div class="sourceCode" id="cb744"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb744-1"><a href="#cb744-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone rc <span class="at">--json</span> <span class="st">&#39;{ &quot;jobid&quot;:2 }&#39;</span> job/status</span>
<span id="cb744-2"><a href="#cb744-2" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb744-3"><a href="#cb744-3" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;duration&quot;</span><span class="ex">:</span> 0.000124163,</span>
<span id="cb744-4"><a href="#cb744-4" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;endTime&quot;</span><span class="ex">:</span> <span class="st">&quot;2018-10-27T11:38:07.911245881+01:00&quot;</span>,</span>
<span id="cb744-5"><a href="#cb744-5" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;error&quot;</span><span class="ex">:</span> <span class="st">&quot;&quot;</span>,</span>
<span id="cb744-6"><a href="#cb744-6" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;finished&quot;</span><span class="ex">:</span> true,</span>
<span id="cb744-7"><a href="#cb744-7" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;id&quot;</span><span class="ex">:</span> 2,</span>
<span id="cb744-8"><a href="#cb744-8" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;output&quot;</span><span class="ex">:</span> {</span>
<span id="cb744-9"><a href="#cb744-9" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;_async&quot;</span><span class="ex">:</span> true,</span>
<span id="cb744-10"><a href="#cb744-10" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;p1&quot;</span><span class="ex">:</span> [</span>
<span id="cb744-11"><a href="#cb744-11" aria-hidden="true" tabindex="-1"></a>            <span class="ex">1,</span></span>
<span id="cb744-12"><a href="#cb744-12" aria-hidden="true" tabindex="-1"></a>            <span class="st">&quot;2&quot;</span><span class="ex">,</span></span>
<span id="cb744-13"><a href="#cb744-13" aria-hidden="true" tabindex="-1"></a>            <span class="ex">null,</span></span>
<span id="cb744-14"><a href="#cb744-14" aria-hidden="true" tabindex="-1"></a>            <span class="ex">4</span></span>
<span id="cb744-15"><a href="#cb744-15" aria-hidden="true" tabindex="-1"></a>        <span class="ex">],</span></span>
<span id="cb744-16"><a href="#cb744-16" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;p2&quot;</span><span class="ex">:</span> {</span>
<span id="cb744-17"><a href="#cb744-17" aria-hidden="true" tabindex="-1"></a>            <span class="st">&quot;a&quot;</span><span class="ex">:</span> 1,</span>
<span id="cb744-18"><a href="#cb744-18" aria-hidden="true" tabindex="-1"></a>            <span class="st">&quot;b&quot;</span><span class="ex">:</span> 2</span>
<span id="cb744-19"><a href="#cb744-19" aria-hidden="true" tabindex="-1"></a>        <span class="kw">}</span></span>
<span id="cb744-20"><a href="#cb744-20" aria-hidden="true" tabindex="-1"></a>    <span class="er">}</span><span class="ex">,</span></span>
<span id="cb744-21"><a href="#cb744-21" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;startTime&quot;</span><span class="ex">:</span> <span class="st">&quot;2018-10-27T11:38:07.911121728+01:00&quot;</span>,</span>
<span id="cb744-22"><a href="#cb744-22" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;success&quot;</span><span class="ex">:</span> true</span>
<span id="cb744-23"><a href="#cb744-23" aria-hidden="true" tabindex="-1"></a><span class="er">}</span></span></code></pre></div>
<p><code>job/list</code> can be used to show the running or recently
completed jobs</p>
<div class="sourceCode" id="cb745"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb745-1"><a href="#cb745-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone rc job/list</span>
<span id="cb745-2"><a href="#cb745-2" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb745-3"><a href="#cb745-3" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;jobids&quot;</span><span class="ex">:</span> [</span>
<span id="cb745-4"><a href="#cb745-4" aria-hidden="true" tabindex="-1"></a>        <span class="ex">2</span></span>
<span id="cb745-5"><a href="#cb745-5" aria-hidden="true" tabindex="-1"></a>    <span class="ex">]</span></span>
<span id="cb745-6"><a href="#cb745-6" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span></code></pre></div>
<h3 id="setting-config-flags-with-_config">Setting config flags with
_config</h3>
<p>If you wish to set config (the equivalent of the global flags) for
the duration of an rc call only then pass in the <code>_config</code>
parameter.</p>
<p>This should be in the same format as the <code>main</code> key
returned by <a href="#options-get">options/get</a>.</p>
<div class="sourceCode" id="cb746"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb746-1"><a href="#cb746-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc <span class="at">--loopback</span> options/get blocks=main</span></code></pre></div>
<p>You can see more help on these options with this command (see <a
href="#option-blocks">the options blocks section</a> for more info).</p>
<div class="sourceCode" id="cb747"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb747-1"><a href="#cb747-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc <span class="at">--loopback</span> options/info blocks=main</span></code></pre></div>
<p>For example, if you wished to run a sync with the
<code>--checksum</code> parameter, you would pass this parameter in your
JSON blob.</p>
<div class="sourceCode" id="cb748"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb748-1"><a href="#cb748-1" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_config&quot;:</span><span class="fu">{</span><span class="dt">&quot;CheckSum&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">}</span></span></code></pre></div>
<p>If using <code>rclone rc</code> this could be passed as</p>
<div class="sourceCode" id="cb749"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb749-1"><a href="#cb749-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc sync/sync ... _config=<span class="st">&#39;{&quot;CheckSum&quot;: true}&#39;</span></span></code></pre></div>
<p>Any config parameters you don't set will inherit the global defaults
which were set with command line flags or environment variables.</p>
<p>Note that it is possible to set some values as strings or integers -
see <a href="#data-types">data types</a> for more info. Here is an
example setting the equivalent of <code>--buffer-size</code> in string
or integer format.</p>
<div class="sourceCode" id="cb750"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb750-1"><a href="#cb750-1" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_config&quot;:</span><span class="fu">{</span><span class="dt">&quot;BufferSize&quot;</span><span class="fu">:</span> <span class="st">&quot;42M&quot;</span><span class="fu">}</span></span>
<span id="cb750-2"><a href="#cb750-2" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_config&quot;:</span><span class="fu">{</span><span class="dt">&quot;BufferSize&quot;</span><span class="fu">:</span> <span class="dv">44040192</span><span class="fu">}</span></span></code></pre></div>
<p>If you wish to check the <code>_config</code> assignment has worked
properly then calling <code>options/local</code> will show what the
value got set to.</p>
<h3 id="setting-filter-flags-with-_filter">Setting filter flags with
_filter</h3>
<p>If you wish to set filters for the duration of an rc call only then
pass in the <code>_filter</code> parameter.</p>
<p>This should be in the same format as the <code>filter</code> key
returned by <a href="#options-get">options/get</a>.</p>
<div class="sourceCode" id="cb751"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb751-1"><a href="#cb751-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc <span class="at">--loopback</span> options/get blocks=filter</span></code></pre></div>
<p>You can see more help on these options with this command (see <a
href="#option-blocks">the options blocks section</a> for more info).</p>
<div class="sourceCode" id="cb752"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb752-1"><a href="#cb752-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc <span class="at">--loopback</span> options/info blocks=filter</span></code></pre></div>
<p>For example, if you wished to run a sync with these flags</p>
<div class="sourceCode" id="cb753"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb753-1"><a href="#cb753-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--max-size</span> 1M <span class="at">--max-age</span> 42s <span class="at">--include</span> <span class="st">&quot;a&quot;</span> <span class="at">--include</span> <span class="st">&quot;b&quot;</span></span></code></pre></div>
<p>you would pass this parameter in your JSON blob.</p>
<div class="sourceCode" id="cb754"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb754-1"><a href="#cb754-1" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_filter&quot;:</span><span class="fu">{</span><span class="dt">&quot;MaxSize&quot;</span><span class="fu">:</span><span class="st">&quot;1M&quot;</span><span class="fu">,</span> <span class="dt">&quot;IncludeRule&quot;</span><span class="fu">:</span><span class="ot">[</span><span class="st">&quot;a&quot;</span><span class="ot">,</span><span class="st">&quot;b&quot;</span><span class="ot">]</span><span class="fu">,</span> <span class="dt">&quot;MaxAge&quot;</span><span class="fu">:</span><span class="st">&quot;42s&quot;</span><span class="fu">}</span></span></code></pre></div>
<p>If using <code>rclone rc</code> this could be passed as</p>
<div class="sourceCode" id="cb755"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb755-1"><a href="#cb755-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc ... _filter=<span class="st">&#39;{&quot;MaxSize&quot;:&quot;1M&quot;, &quot;IncludeRule&quot;:[&quot;a&quot;,&quot;b&quot;], &quot;MaxAge&quot;:&quot;42s&quot;}&#39;</span></span></code></pre></div>
<p>Any filter parameters you don't set will inherit the global defaults
which were set with command line flags or environment variables.</p>
<p>Note that it is possible to set some values as strings or integers -
see <a href="#data-types">data types</a> for more info. Here is an
example setting the equivalent of <code>--buffer-size</code> in string
or integer format.</p>
<div class="sourceCode" id="cb756"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb756-1"><a href="#cb756-1" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_filter&quot;:</span><span class="fu">{</span><span class="dt">&quot;MinSize&quot;</span><span class="fu">:</span> <span class="st">&quot;42M&quot;</span><span class="fu">}</span></span>
<span id="cb756-2"><a href="#cb756-2" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_filter&quot;:</span><span class="fu">{</span><span class="dt">&quot;MinSize&quot;</span><span class="fu">:</span> <span class="dv">44040192</span><span class="fu">}</span></span></code></pre></div>
<p>If you wish to check the <code>_filter</code> assignment has worked
properly then calling <code>options/local</code> will show what the
value got set to.</p>
<h3 id="assigning-operations-to-groups-with-_group-value">Assigning
operations to groups with _group = value</h3>
<p>Each rc call has its own stats group for tracking its metrics. By
default grouping is done by the composite group name from prefix
<code>job/</code> and id of the job like so <code>job/1</code>.</p>
<p>If <code>_group</code> has a value then stats for that request will
be grouped under that value. This allows caller to group stats under
their own name.</p>
<p>Stats for specific group can be accessed by passing
<code>group</code> to <code>core/stats</code>:</p>
<div class="sourceCode" id="cb757"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb757-1"><a href="#cb757-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone rc <span class="at">--json</span> <span class="st">&#39;{ &quot;group&quot;: &quot;job/1&quot; }&#39;</span> core/stats</span>
<span id="cb757-2"><a href="#cb757-2" aria-hidden="true" tabindex="-1"></a><span class="kw">{</span></span>
<span id="cb757-3"><a href="#cb757-3" aria-hidden="true" tabindex="-1"></a>    <span class="st">&quot;speed&quot;</span><span class="ex">:</span> 12345</span>
<span id="cb757-4"><a href="#cb757-4" aria-hidden="true" tabindex="-1"></a>    <span class="ex">...</span></span>
<span id="cb757-5"><a href="#cb757-5" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span></code></pre></div>
<h2 id="data-types">Data types</h2>
<p>When the API returns types, these will mostly be straight forward
integer, string or boolean types.</p>
<p>However some of the types returned by the <a
href="#options-get">options/get</a> call and taken by the <a
href="#options-set">options/set</a> calls as well as the
<code>vfsOpt</code>, <code>mountOpt</code> and the <code>_config</code>
parameters.</p>
<ul>
<li><code>Duration</code> - these are returned as an integer duration in
nanoseconds. They may be set as an integer, or they may be set with time
string, eg "5s". See the <a
href="https://rclone.org/docs/#options">options section</a> for more
info.</li>
<li><code>Size</code> - these are returned as an integer number of
bytes. They may be set as an integer or they may be set with a size
suffix string, eg "10M". See the <a
href="https://rclone.org/docs/#options">options section</a> for more
info.</li>
<li>Enumerated type (such as <code>CutoffMode</code>,
<code>DumpFlags</code>, <code>LogLevel</code>, <code>VfsCacheMode</code>
- these will be returned as an integer and may be set as an integer but
more conveniently they can be set as a string, eg "HARD" for
<code>CutoffMode</code> or <code>DEBUG</code> for
<code>LogLevel</code>.</li>
<li><code>BandwidthSpec</code> - this will be set and returned as a
string, eg "1M".</li>
</ul>
<h3 id="option-blocks">Option blocks</h3>
<p>The calls <a href="#options-info">options/info</a> (for the main
config) and <a href="#config-providers">config/providers</a> (for the
backend config) may be used to get information on the rclone
configuration options. This can be used to build user interfaces for
displaying and setting any rclone option.</p>
<p>These consist of arrays of <code>Option</code> blocks. These have the
following format. Each block describes a single option.</p>
<table>
<colgroup>
<col style="width: 19%" />
<col style="width: 16%" />
<col style="width: 27%" />
<col style="width: 36%" />
</colgroup>
<thead>
<tr class="header">
<th>Field</th>
<th>Type</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Name</td>
<td>string</td>
<td>N</td>
<td>name of the option in snake_case</td>
</tr>
<tr class="even">
<td>FieldName</td>
<td>string</td>
<td>N</td>
<td>name of the field used in the rc - if blank use Name. May contain
"." for nested fields.</td>
</tr>
<tr class="odd">
<td>Help</td>
<td>string</td>
<td>N</td>
<td>help, started with a single sentence on a single line</td>
</tr>
<tr class="even">
<td>Groups</td>
<td>string</td>
<td>Y</td>
<td>groups this option belongs to - comma separated string for options
classification</td>
</tr>
<tr class="odd">
<td>Provider</td>
<td>string</td>
<td>Y</td>
<td>set to filter on provider</td>
</tr>
<tr class="even">
<td>Default</td>
<td>any</td>
<td>N</td>
<td>default value, if set (and not to nil or "") then Required does
nothing</td>
</tr>
<tr class="odd">
<td>Value</td>
<td>any</td>
<td>N</td>
<td>value to be set by flags</td>
</tr>
<tr class="even">
<td>Examples</td>
<td>Examples</td>
<td>Y</td>
<td>predefined values that can be selected from list (multiple-choice
option)</td>
</tr>
<tr class="odd">
<td>ShortOpt</td>
<td>string</td>
<td>Y</td>
<td>the short command line option for this</td>
</tr>
<tr class="even">
<td>Hide</td>
<td>Visibility</td>
<td>N</td>
<td>if non zero, this option is hidden from the configurator or the
command line</td>
</tr>
<tr class="odd">
<td>Required</td>
<td>bool</td>
<td>N</td>
<td>this option is required, meaning value cannot be empty unless there
is a default</td>
</tr>
<tr class="even">
<td>IsPassword</td>
<td>bool</td>
<td>N</td>
<td>set if the option is a password</td>
</tr>
<tr class="odd">
<td>NoPrefix</td>
<td>bool</td>
<td>N</td>
<td>set if the option for this should not use the backend prefix</td>
</tr>
<tr class="even">
<td>Advanced</td>
<td>bool</td>
<td>N</td>
<td>set if this is an advanced config option</td>
</tr>
<tr class="odd">
<td>Exclusive</td>
<td>bool</td>
<td>N</td>
<td>set if the answer can only be one of the examples (empty string
allowed unless Required or Default is set)</td>
</tr>
<tr class="even">
<td>Sensitive</td>
<td>bool</td>
<td>N</td>
<td>set if this option should be redacted when using
<code>rclone config redacted</code></td>
</tr>
</tbody>
</table>
<p>An example of this might be the <code>--log-level</code> flag. Note
that the <code>Name</code> of the option becomes the command line flag
with <code>_</code> replaced with <code>-</code>.</p>
<div class="sourceCode" id="cb758"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb758-1"><a href="#cb758-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb758-2"><a href="#cb758-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Advanced&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
<span id="cb758-3"><a href="#cb758-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Default&quot;</span><span class="fu">:</span> <span class="dv">5</span><span class="fu">,</span></span>
<span id="cb758-4"><a href="#cb758-4" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;DefaultStr&quot;</span><span class="fu">:</span> <span class="st">&quot;NOTICE&quot;</span><span class="fu">,</span></span>
<span id="cb758-5"><a href="#cb758-5" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Examples&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
<span id="cb758-6"><a href="#cb758-6" aria-hidden="true" tabindex="-1"></a>        <span class="fu">{</span></span>
<span id="cb758-7"><a href="#cb758-7" aria-hidden="true" tabindex="-1"></a>            <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
<span id="cb758-8"><a href="#cb758-8" aria-hidden="true" tabindex="-1"></a>            <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;EMERGENCY&quot;</span></span>
<span id="cb758-9"><a href="#cb758-9" aria-hidden="true" tabindex="-1"></a>        <span class="fu">}</span><span class="ot">,</span></span>
<span id="cb758-10"><a href="#cb758-10" aria-hidden="true" tabindex="-1"></a>        <span class="fu">{</span></span>
<span id="cb758-11"><a href="#cb758-11" aria-hidden="true" tabindex="-1"></a>            <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
<span id="cb758-12"><a href="#cb758-12" aria-hidden="true" tabindex="-1"></a>            <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;ALERT&quot;</span></span>
<span id="cb758-13"><a href="#cb758-13" aria-hidden="true" tabindex="-1"></a>        <span class="fu">}</span><span class="ot">,</span></span>
<span id="cb758-14"><a href="#cb758-14" aria-hidden="true" tabindex="-1"></a>        <span class="er">...</span></span>
<span id="cb758-15"><a href="#cb758-15" aria-hidden="true" tabindex="-1"></a>    <span class="ot">]</span><span class="fu">,</span></span>
<span id="cb758-16"><a href="#cb758-16" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Exclusive&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
<span id="cb758-17"><a href="#cb758-17" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;FieldName&quot;</span><span class="fu">:</span> <span class="st">&quot;LogLevel&quot;</span><span class="fu">,</span></span>
<span id="cb758-18"><a href="#cb758-18" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Groups&quot;</span><span class="fu">:</span> <span class="st">&quot;Logging&quot;</span><span class="fu">,</span></span>
<span id="cb758-19"><a href="#cb758-19" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Log level DEBUG|INFO|NOTICE|ERROR&quot;</span><span class="fu">,</span></span>
<span id="cb758-20"><a href="#cb758-20" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Hide&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
<span id="cb758-21"><a href="#cb758-21" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;IsPassword&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
<span id="cb758-22"><a href="#cb758-22" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Name&quot;</span><span class="fu">:</span> <span class="st">&quot;log_level&quot;</span><span class="fu">,</span></span>
<span id="cb758-23"><a href="#cb758-23" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;NoPrefix&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
<span id="cb758-24"><a href="#cb758-24" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Required&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
<span id="cb758-25"><a href="#cb758-25" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Sensitive&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
<span id="cb758-26"><a href="#cb758-26" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Type&quot;</span><span class="fu">:</span> <span class="st">&quot;LogLevel&quot;</span><span class="fu">,</span></span>
<span id="cb758-27"><a href="#cb758-27" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
<span id="cb758-28"><a href="#cb758-28" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;ValueStr&quot;</span><span class="fu">:</span> <span class="st">&quot;NOTICE&quot;</span></span>
<span id="cb758-29"><a href="#cb758-29" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span><span class="er">,</span></span></code></pre></div>
<p>Note that the <code>Help</code> may be multiple lines separated by
<code>\n</code>. The first line will always be a short sentence and this
is the sentence shown when running <code>rclone help flags</code>.</p>
<h2 id="specifying-remotes-to-work-on">Specifying remotes to work
on</h2>
<p>Remotes are specified with the <code>fs=</code>, <code>srcFs=</code>,
<code>dstFs=</code> parameters depending on the command being used.</p>
<p>The parameters can be a string as per the rest of rclone, eg
<code>s3:bucket/path</code> or <code>:sftp:/my/dir</code>. They can also
be specified as JSON blobs.</p>
<p>If specifying a JSON blob it should be a object mapping strings to
strings. These values will be used to configure the remote. There are 3
special values which may be set:</p>
<ul>
<li><code>type</code> - set to <code>type</code> to specify a remote
called <code>:type:</code></li>
<li><code>_name</code> - set to <code>name</code> to specify a remote
called <code>name:</code></li>
<li><code>_root</code> - sets the root of the remote - may be empty</li>
</ul>
<p>One of <code>_name</code> or <code>type</code> should normally be
set. If the <code>local</code> backend is desired then <code>type</code>
should be set to <code>local</code>. If <code>_root</code> isn't
specified then it defaults to the root of the remote.</p>
<p>For example this JSON is equivalent to <code>remote:/tmp</code></p>
<div class="sourceCode" id="cb759"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb759-1"><a href="#cb759-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb759-2"><a href="#cb759-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;_name&quot;</span><span class="fu">:</span> <span class="st">&quot;remote&quot;</span><span class="fu">,</span></span>
<span id="cb759-3"><a href="#cb759-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;/tmp&quot;</span></span>
<span id="cb759-4"><a href="#cb759-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>And this is equivalent to
<code>:sftp,host='example.com':/tmp</code></p>
<div class="sourceCode" id="cb760"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb760-1"><a href="#cb760-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb760-2"><a href="#cb760-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
<span id="cb760-3"><a href="#cb760-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;example.com&quot;</span><span class="fu">,</span></span>
<span id="cb760-4"><a href="#cb760-4" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;/tmp&quot;</span></span>
<span id="cb760-5"><a href="#cb760-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>And this is equivalent to <code>/tmp/dir</code></p>
<div class="sourceCode" id="cb761"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb761-1"><a href="#cb761-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb761-2"><a href="#cb761-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;local&quot;</span><span class="fu">,</span></span>
<span id="cb761-3"><a href="#cb761-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;/tmp/dir&quot;</span></span>
<span id="cb761-4"><a href="#cb761-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h2 id="supported-commands">Supported commands</h2>
<h3 id="backend-command">backend/command: Runs a backend command.</h3>
<p>This takes the following parameters:</p>
<ul>
<li>command - a string with the command name</li>
<li>fs - a remote name string e.g. "drive:"</li>
<li>arg - a list of arguments for the backend command</li>
<li>opt - a map of string to string of options</li>
</ul>
<p>Returns:</p>
<ul>
<li>result - result from the backend command</li>
</ul>
<p>Example:</p>
<pre><code>rclone rc backend/command command=noop fs=. -o echo=yes -o blue -a path1 -a path2</code></pre>
<p>Returns</p>
<pre><code>{
    &quot;result&quot;: {
        &quot;arg&quot;: [
            &quot;path1&quot;,
            &quot;path2&quot;
        ],
        &quot;name&quot;: &quot;noop&quot;,
        &quot;opt&quot;: {
            &quot;blue&quot;: &quot;&quot;,
            &quot;echo&quot;: &quot;yes&quot;
        }
    }
}</code></pre>
<p>Note that this is the direct equivalent of using this "backend"
command:</p>
<pre><code>rclone backend noop . -o echo=yes -o blue path1 path2</code></pre>
<p>Note that arguments must be preceded by the "-a" flag</p>
<p>See the <a
href="https://rclone.org/commands/rclone_backend/">backend</a> command
for more information.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="cache-expire">cache/expire: Purge a remote from cache</h3>
<p>Purge a remote from the cache backend. Supports either a directory or
a file. Params: - remote = path to remote (required) - withData =
true/false to delete cached data (chunks) as well (optional)</p>
<p>Eg</p>
<pre><code>rclone rc cache/expire remote=path/to/sub/folder/
rclone rc cache/expire remote=/ withData=true</code></pre>
<h3 id="cache-fetch">cache/fetch: Fetch file chunks</h3>
<p>Ensure the specified file chunks are cached on disk.</p>
<p>The chunks= parameter specifies the file chunks to check. It takes a
comma separated list of array slice indices. The slice indices are
similar to Python slices: start[:end]</p>
<p>start is the 0 based chunk number from the beginning of the file to
fetch inclusive. end is 0 based chunk number from the beginning of the
file to fetch exclusive. Both values can be negative, in which case they
count from the back of the file. The value "-5:" represents the last 5
chunks of a file.</p>
<p>Some valid examples are: ":5,-5:" -&gt; the first and last five
chunks "0,-2" -&gt; the first and the second last chunk "0:10" -&gt; the
first ten chunks</p>
<p>Any parameter with a key that starts with "file" can be used to
specify files to fetch, e.g.</p>
<pre><code>rclone rc cache/fetch chunks=0 file=hello file2=home/goodbye</code></pre>
<p>File names will automatically be encrypted when the a crypt remote is
used on top of the cache.</p>
<h3 id="cache-stats">cache/stats: Get cache stats</h3>
<p>Show statistics for the cache remote.</p>
<h3 id="config-create">config/create: create the config for a
remote.</h3>
<p>This takes the following parameters:</p>
<ul>
<li>name - name of remote</li>
<li>parameters - a map of { "key": "value" } pairs</li>
<li>type - type of the new remote</li>
<li>opt - a dictionary of options to control the configuration
<ul>
<li>obscure - declare passwords are plain and need obscuring</li>
<li>noObscure - declare passwords are already obscured and don't need
obscuring</li>
<li>noOutput - don't print anything to stdout</li>
<li>nonInteractive - don't interact with a user, return questions</li>
<li>continue - continue the config process with an answer</li>
<li>all - ask all the config questions not just the post config
ones</li>
<li>state - state to restart with - used with continue</li>
<li>result - result to restart with - used with continue</li>
</ul></li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_config_create/">config
create</a> command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-delete">config/delete: Delete a remote in the config
file.</h3>
<p>Parameters:</p>
<ul>
<li>name - name of remote to delete</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_config_delete/">config
delete</a> command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-dump">config/dump: Dumps the config file.</h3>
<p>Returns a JSON object: - key: value</p>
<p>Where keys are remote names and values are the config parameters.</p>
<p>See the <a
href="https://rclone.org/commands/rclone_config_dump/">config dump</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-get">config/get: Get a remote in the config file.</h3>
<p>Parameters:</p>
<ul>
<li>name - name of remote to get</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_config_dump/">config dump</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-listremotes">config/listremotes: Lists the remotes in the
config file and defined in environment variables.</h3>
<p>Returns - remotes - array of remote names</p>
<p>See the <a
href="https://rclone.org/commands/rclone_listremotes/">listremotes</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-password">config/password: password the config for a
remote.</h3>
<p>This takes the following parameters:</p>
<ul>
<li>name - name of remote</li>
<li>parameters - a map of { "key": "value" } pairs</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_config_password/">config
password</a> command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-paths">config/paths: Reads the config file path and other
important paths.</h3>
<p>Returns a JSON object with the following keys:</p>
<ul>
<li>config: path to config file</li>
<li>cache: path to root of cache directory</li>
<li>temp: path to root of temporary directory</li>
</ul>
<p>Eg</p>
<pre><code>{
    &quot;cache&quot;: &quot;/home/USER/.cache/rclone&quot;,
    &quot;config&quot;: &quot;/home/USER/.rclone.conf&quot;,
    &quot;temp&quot;: &quot;/tmp&quot;
}</code></pre>
<p>See the <a
href="https://rclone.org/commands/rclone_config_paths/">config paths</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-providers">config/providers: Shows how providers are
configured in the config file.</h3>
<p>Returns a JSON object: - providers - array of objects</p>
<p>See the <a
href="https://rclone.org/commands/rclone_config_providers/">config
providers</a> command for more information on the above.</p>
<p>Note that the Options blocks are in the same format as returned by
"options/info". They are described in the <a
href="#option-blocks">option blocks</a> section.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-setpath">config/setpath: Set the path of the config
file</h3>
<p>Parameters:</p>
<ul>
<li>path - path to the config file to use</li>
</ul>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-unlock">config/unlock: Unlock the config file.</h3>
<p>Unlocks the config file if it is locked.</p>
<p>Parameters:</p>
<ul>
<li>'config_password' - password to unlock the config file</li>
</ul>
<p>A good idea is to disable AskPassword before making this call</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-update">config/update: update the config for a
remote.</h3>
<p>This takes the following parameters:</p>
<ul>
<li>name - name of remote</li>
<li>parameters - a map of { "key": "value" } pairs</li>
<li>opt - a dictionary of options to control the configuration
<ul>
<li>obscure - declare passwords are plain and need obscuring</li>
<li>noObscure - declare passwords are already obscured and don't need
obscuring</li>
<li>noOutput - don't print anything to stdout</li>
<li>nonInteractive - don't interact with a user, return questions</li>
<li>continue - continue the config process with an answer</li>
<li>all - ask all the config questions not just the post config
ones</li>
<li>state - state to restart with - used with continue</li>
<li>result - result to restart with - used with continue</li>
</ul></li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_config_update/">config
update</a> command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="core-bwlimit">core/bwlimit: Set the bandwidth limit.</h3>
<p>This sets the bandwidth limit to the string passed in. This should be
a single bandwidth limit entry or a pair of upload:download
bandwidth.</p>
<p>Eg</p>
<pre><code>rclone rc core/bwlimit rate=off
{
    &quot;bytesPerSecond&quot;: -1,
    &quot;bytesPerSecondTx&quot;: -1,
    &quot;bytesPerSecondRx&quot;: -1,
    &quot;rate&quot;: &quot;off&quot;
}
rclone rc core/bwlimit rate=1M
{
    &quot;bytesPerSecond&quot;: 1048576,
    &quot;bytesPerSecondTx&quot;: 1048576,
    &quot;bytesPerSecondRx&quot;: 1048576,
    &quot;rate&quot;: &quot;1M&quot;
}
rclone rc core/bwlimit rate=1M:100k
{
    &quot;bytesPerSecond&quot;: 1048576,
    &quot;bytesPerSecondTx&quot;: 1048576,
    &quot;bytesPerSecondRx&quot;: 131072,
    &quot;rate&quot;: &quot;1M&quot;
}</code></pre>
<p>If the rate parameter is not supplied then the bandwidth is
queried</p>
<pre><code>rclone rc core/bwlimit
{
    &quot;bytesPerSecond&quot;: 1048576,
    &quot;bytesPerSecondTx&quot;: 1048576,
    &quot;bytesPerSecondRx&quot;: 1048576,
    &quot;rate&quot;: &quot;1M&quot;
}</code></pre>
<p>The format of the parameter is exactly the same as passed to
--bwlimit except only one bandwidth may be specified.</p>
<p>In either case "rate" is returned as a human-readable string, and
"bytesPerSecond" is returned as a number.</p>
<h3 id="core-command">core/command: Run a rclone terminal command over
rc.</h3>
<p>This takes the following parameters:</p>
<ul>
<li>command - a string with the command name.</li>
<li>arg - a list of arguments for the backend command.</li>
<li>opt - a map of string to string of options.</li>
<li>returnType - one of ("COMBINED_OUTPUT", "STREAM",
"STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR").
<ul>
<li>Defaults to "COMBINED_OUTPUT" if not set.</li>
<li>The STREAM returnTypes will write the output to the body of the HTTP
message.</li>
<li>The COMBINED_OUTPUT will write the output to the "result"
parameter.</li>
</ul></li>
</ul>
<p>Returns:</p>
<ul>
<li>result - result from the backend command.
<ul>
<li>Only set when using returnType "COMBINED_OUTPUT".</li>
</ul></li>
<li>error - set if rclone exits with an error code.</li>
<li>returnType - one of ("COMBINED_OUTPUT", "STREAM",
"STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR").</li>
</ul>
<p>Example:</p>
<pre><code>rclone rc core/command command=ls -a mydrive:/ -o max-depth=1
rclone rc core/command -a ls -a mydrive:/ -o max-depth=1</code></pre>
<p>Returns:</p>
<pre><code>{
    &quot;error&quot;: false,
    &quot;result&quot;: &quot;&lt;Raw command line output&gt;&quot;
}

OR
{
    &quot;error&quot;: true,
    &quot;result&quot;: &quot;&lt;Raw command line output&gt;&quot;
}
</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="core-du">core/du: Returns disk usage of a locally attached
disk.</h3>
<p>This returns the disk usage for the local directory passed in as
dir.</p>
<p>If the directory is not passed in, it defaults to the directory
pointed to by --cache-dir.</p>
<ul>
<li>dir - string (optional)</li>
</ul>
<p>Returns:</p>
<pre><code>{
    &quot;dir&quot;: &quot;/&quot;,
    &quot;info&quot;: {
        &quot;Available&quot;: 361769115648,
        &quot;Free&quot;: 361785892864,
        &quot;Total&quot;: 982141468672
    }
}</code></pre>
<h3 id="core-gc">core/gc: Runs a garbage collection.</h3>
<p>This tells the go runtime to do a garbage collection run. It isn't
necessary to call this normally, but it can be useful for debugging
memory problems.</p>
<h3 id="core-group-list">core/group-list: Returns list of stats.</h3>
<p>This returns list of stats groups currently in memory.</p>
<p>Returns the following values:</p>
<pre><code>{
    &quot;groups&quot;:  an array of group names:
        [
            &quot;group1&quot;,
            &quot;group2&quot;,
            ...
        ]
}</code></pre>
<h3 id="core-memstats">core/memstats: Returns the memory statistics</h3>
<p>This returns the memory statistics of the running program. What the
values mean are explained in the go docs:
https://golang.org/pkg/runtime/#MemStats</p>
<p>The most interesting values for most people are:</p>
<ul>
<li>HeapAlloc - this is the amount of memory rclone is actually
using</li>
<li>HeapSys - this is the amount of memory rclone has obtained from the
OS</li>
<li>Sys - this is the total amount of memory requested from the OS
<ul>
<li>It is virtual memory so may include unused memory</li>
</ul></li>
</ul>
<h3 id="core-obscure">core/obscure: Obscures a string passed in.</h3>
<p>Pass a clear string and rclone will obscure it for the config file: -
clear - string</p>
<p>Returns: - obscured - string</p>
<h3 id="core-pid">core/pid: Return PID of current process</h3>
<p>This returns PID of current process. Useful for stopping rclone
process.</p>
<h3 id="core-quit">core/quit: Terminates the app.</h3>
<p>(Optional) Pass an exit code to be used for terminating the app: -
exitCode - int</p>
<h3 id="core-stats">core/stats: Returns stats about current
transfers.</h3>
<p>This returns all available stats:</p>
<pre><code>rclone rc core/stats</code></pre>
<p>If group is not provided then summed up stats for all groups will be
returned.</p>
<p>Parameters</p>
<ul>
<li>group - name of the stats group (string, optional)</li>
<li>short - if true will not return the transferring and checking arrays
(boolean, optional)</li>
</ul>
<p>Returns the following values:</p>
<pre><code>{
    &quot;bytes&quot;: total transferred bytes since the start of the group,
    &quot;checks&quot;: number of files checked,
    &quot;deletes&quot; : number of files deleted,
    &quot;elapsedTime&quot;: time in floating point seconds since rclone was started,
    &quot;errors&quot;: number of errors,
    &quot;eta&quot;: estimated time in seconds until the group completes,
    &quot;fatalError&quot;: boolean whether there has been at least one fatal error,
    &quot;lastError&quot;: last error string,
    &quot;renames&quot; : number of files renamed,
    &quot;listed&quot; : number of directory entries listed,
    &quot;retryError&quot;: boolean showing whether there has been at least one non-NoRetryError,
        &quot;serverSideCopies&quot;: number of server side copies done,
        &quot;serverSideCopyBytes&quot;: number bytes server side copied,
        &quot;serverSideMoves&quot;: number of server side moves done,
        &quot;serverSideMoveBytes&quot;: number bytes server side moved,
    &quot;speed&quot;: average speed in bytes per second since start of the group,
    &quot;totalBytes&quot;: total number of bytes in the group,
    &quot;totalChecks&quot;: total number of checks in the group,
    &quot;totalTransfers&quot;: total number of transfers in the group,
    &quot;transferTime&quot; : total time spent on running jobs,
    &quot;transfers&quot;: number of transferred files,
    &quot;transferring&quot;: an array of currently active file transfers:
        [
            {
                &quot;bytes&quot;: total transferred bytes for this file,
                &quot;eta&quot;: estimated time in seconds until file transfer completion
                &quot;name&quot;: name of the file,
                &quot;percentage&quot;: progress of the file transfer in percent,
                &quot;speed&quot;: average speed over the whole transfer in bytes per second,
                &quot;speedAvg&quot;: current speed in bytes per second as an exponentially weighted moving average,
                &quot;size&quot;: size of the file in bytes
            }
        ],
    &quot;checking&quot;: an array of names of currently active file checks
        []
}</code></pre>
<p>Values for "transferring", "checking" and "lastError" are only
assigned if data is available. The value for "eta" is null if an eta
cannot be determined.</p>
<h3 id="core-stats-delete">core/stats-delete: Delete stats group.</h3>
<p>This deletes entire stats group.</p>
<p>Parameters</p>
<ul>
<li>group - name of the stats group (string)</li>
</ul>
<h3 id="core-stats-reset">core/stats-reset: Reset stats.</h3>
<p>This clears counters, errors and finished transfers for all stats or
specific stats group if group is provided.</p>
<p>Parameters</p>
<ul>
<li>group - name of the stats group (string)</li>
</ul>
<h3 id="core-transferred">core/transferred: Returns stats about
completed transfers.</h3>
<p>This returns stats about completed transfers:</p>
<pre><code>rclone rc core/transferred</code></pre>
<p>If group is not provided then completed transfers for all groups will
be returned.</p>
<p>Note only the last 100 completed transfers are returned.</p>
<p>Parameters</p>
<ul>
<li>group - name of the stats group (string)</li>
</ul>
<p>Returns the following values:</p>
<pre><code>{
    &quot;transferred&quot;:  an array of completed transfers (including failed ones):
        [
            {
                &quot;name&quot;: name of the file,
                &quot;size&quot;: size of the file in bytes,
                &quot;bytes&quot;: total transferred bytes for this file,
                &quot;checked&quot;: if the transfer is only checked (skipped, deleted),
                &quot;what&quot;: the purpose of the transfer (transferring, deleting, checking, importing, hashing, merging, listing, moving, renaming),
                &quot;timestamp&quot;: integer representing millisecond unix epoch,
                &quot;error&quot;: string description of the error (empty if successful),
                &quot;jobid&quot;: id of the job that this transfer belongs to
            }
        ]
}</code></pre>
<h3 id="core-version">core/version: Shows the current version of rclone
and the go runtime.</h3>
<p>This shows the current version of go and the go runtime:</p>
<ul>
<li>version - rclone version, e.g. "v1.53.0"</li>
<li>decomposed - version number as [major, minor, patch]</li>
<li>isGit - boolean - true if this was compiled from the git
version</li>
<li>isBeta - boolean - true if this is a beta version</li>
<li>os - OS in use as according to Go</li>
<li>arch - cpu architecture in use according to Go</li>
<li>goVersion - version of Go runtime in use</li>
<li>linking - type of rclone executable (static or dynamic)</li>
<li>goTags - space separated build tags or "none"</li>
</ul>
<h3 id="debug-set-block-profile-rate">debug/set-block-profile-rate: Set
runtime.SetBlockProfileRate for blocking profiling.</h3>
<p>SetBlockProfileRate controls the fraction of goroutine blocking
events that are reported in the blocking profile. The profiler aims to
sample an average of one blocking event per rate nanoseconds spent
blocked.</p>
<p>To include every blocking event in the profile, pass rate = 1. To
turn off profiling entirely, pass rate &lt;= 0.</p>
<p>After calling this you can use this to see the blocking profile:</p>
<pre><code>go tool pprof http://localhost:5572/debug/pprof/block</code></pre>
<p>Parameters:</p>
<ul>
<li>rate - int</li>
</ul>
<h3 id="debug-set-gc-percent">debug/set-gc-percent: Call
runtime/debug.SetGCPercent for setting the garbage collection target
percentage.</h3>
<p>SetGCPercent sets the garbage collection target percentage: a
collection is triggered when the ratio of freshly allocated data to live
data remaining after the previous collection reaches this percentage.
SetGCPercent returns the previous setting. The initial setting is the
value of the GOGC environment variable at startup, or 100 if the
variable is not set.</p>
<p>This setting may be effectively reduced in order to maintain a memory
limit. A negative percentage effectively disables garbage collection,
unless the memory limit is reached.</p>
<p>See https://pkg.go.dev/runtime/debug#SetMemoryLimit for more
details.</p>
<p>Parameters:</p>
<ul>
<li>gc-percent - int</li>
</ul>
<h3
id="debug-set-mutex-profile-fraction">debug/set-mutex-profile-fraction:
Set runtime.SetMutexProfileFraction for mutex profiling.</h3>
<p>SetMutexProfileFraction controls the fraction of mutex contention
events that are reported in the mutex profile. On average 1/rate events
are reported. The previous rate is returned.</p>
<p>To turn off profiling entirely, pass rate 0. To just read the current
rate, pass rate &lt; 0. (For n&gt;1 the details of sampling may
change.)</p>
<p>Once this is set you can look use this to profile the mutex
contention:</p>
<pre><code>go tool pprof http://localhost:5572/debug/pprof/mutex</code></pre>
<p>Parameters:</p>
<ul>
<li>rate - int</li>
</ul>
<p>Results:</p>
<ul>
<li>previousRate - int</li>
</ul>
<h3 id="debug-set-soft-memory-limit">debug/set-soft-memory-limit: Call
runtime/debug.SetMemoryLimit for setting a soft memory limit for the
runtime.</h3>
<p>SetMemoryLimit provides the runtime with a soft memory limit.</p>
<p>The runtime undertakes several processes to try to respect this
memory limit, including adjustments to the frequency of garbage
collections and returning memory to the underlying system more
aggressively. This limit will be respected even if GOGC=off (or, if
SetGCPercent(-1) is executed).</p>
<p>The input limit is provided as bytes, and includes all memory mapped,
managed, and not released by the Go runtime. Notably, it does not
account for space used by the Go binary and memory external to Go, such
as memory managed by the underlying system on behalf of the process, or
memory managed by non-Go code inside the same process. Examples of
excluded memory sources include: OS kernel memory held on behalf of the
process, memory allocated by C code, and memory mapped by syscall.Mmap
(because it is not managed by the Go runtime).</p>
<p>A zero limit or a limit that's lower than the amount of memory used
by the Go runtime may cause the garbage collector to run nearly
continuously. However, the application may still make progress.</p>
<p>The memory limit is always respected by the Go runtime, so to
effectively disable this behavior, set the limit very high.
math.MaxInt64 is the canonical value for disabling the limit, but values
much greater than the available memory on the underlying system work
just as well.</p>
<p>See https://go.dev/doc/gc-guide for a detailed guide explaining the
soft memory limit in more detail, as well as a variety of common
use-cases and scenarios.</p>
<p>SetMemoryLimit returns the previously set memory limit. A negative
input does not adjust the limit, and allows for retrieval of the
currently set memory limit.</p>
<p>Parameters:</p>
<ul>
<li>mem-limit - int</li>
</ul>
<h3 id="fscache-clear">fscache/clear: Clear the Fs cache.</h3>
<p>This clears the fs cache. This is where remotes created from backends
are cached for a short while to make repeated rc calls more
efficient.</p>
<p>If you change the parameters of a backend then you may want to call
this to clear an existing remote out of the cache before re-creating
it.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="fscache-entries">fscache/entries: Returns the number of entries
in the fs cache.</h3>
<p>This returns the number of entries in the fs cache.</p>
<p>Returns - entries - number of items in the cache</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="job-list">job/list: Lists the IDs of the running jobs</h3>
<p>Parameters: None.</p>
<p>Results:</p>
<ul>
<li>executeId - string id of rclone executing (change after
restart)</li>
<li>jobids - array of integer job ids (starting at 1 on each
restart)</li>
</ul>
<h3 id="job-status">job/status: Reads the status of the job ID</h3>
<p>Parameters:</p>
<ul>
<li>jobid - id of the job (integer).</li>
</ul>
<p>Results:</p>
<ul>
<li>finished - boolean</li>
<li>duration - time in seconds that the job ran for</li>
<li>endTime - time the job finished (e.g.
"2018-10-26T18:50:20.528746884+01:00")</li>
<li>error - error from the job or empty string for no error</li>
<li>finished - boolean whether the job has finished or not</li>
<li>id - as passed in above</li>
<li>startTime - time the job started (e.g.
"2018-10-26T18:50:20.528336039+01:00")</li>
<li>success - boolean - true for success false otherwise</li>
<li>output - output of the job as would have been returned if called
synchronously</li>
<li>progress - output of the progress related to the underlying job</li>
</ul>
<h3 id="job-stop">job/stop: Stop the running job</h3>
<p>Parameters:</p>
<ul>
<li>jobid - id of the job (integer).</li>
</ul>
<h3 id="job-stopgroup">job/stopgroup: Stop all running jobs in a
group</h3>
<p>Parameters:</p>
<ul>
<li>group - name of the group (string).</li>
</ul>
<h3 id="mount-listmounts">mount/listmounts: Show current mount
points</h3>
<p>This shows currently mounted points, which can be used for performing
an unmount.</p>
<p>This takes no parameters and returns</p>
<ul>
<li>mountPoints: list of current mount points</li>
</ul>
<p>Eg</p>
<pre><code>rclone rc mount/listmounts</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="mount-mount">mount/mount: Create a new mount point</h3>
<p>rclone allows Linux, FreeBSD, macOS and Windows to mount any of
Rclone's cloud storage systems as a file system with FUSE.</p>
<p>If no mountType is provided, the priority is given as follows: 1.
mount 2.cmount 3.mount2</p>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote path to be mounted (required)</li>
<li>mountPoint: valid path on the local machine (required)</li>
<li>mountType: one of the values (mount, cmount, mount2) specifies the
mount implementation to use</li>
<li>mountOpt: a JSON object with Mount options in.</li>
<li>vfsOpt: a JSON object with VFS options in.</li>
</ul>
<p>Example:</p>
<div class="sourceCode" id="cb781"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb781-1"><a href="#cb781-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc mount/mount fs=mydrive: mountPoint=/home/<span class="op">&lt;</span>user<span class="op">&gt;</span>/mountPoint</span>
<span id="cb781-2"><a href="#cb781-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc mount/mount fs=mydrive: mountPoint=/home/<span class="op">&lt;</span>user<span class="op">&gt;</span>/mountPoint mountType=mount</span>
<span id="cb781-3"><a href="#cb781-3" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt=<span class="st">&#39;{&quot;CacheMode&quot;: 2}&#39;</span> mountOpt=<span class="st">&#39;{&quot;AllowOther&quot;: true}&#39;</span></span></code></pre></div>
<p>The vfsOpt are as described in options/get and can be seen in the the
"vfs" section when running and the mountOpt can be seen in the "mount"
section:</p>
<div class="sourceCode" id="cb782"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb782-1"><a href="#cb782-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc options/get</span></code></pre></div>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="mount-types">mount/types: Show all possible mount types</h3>
<p>This shows all possible mount types and returns them as a list.</p>
<p>This takes no parameters and returns</p>
<ul>
<li>mountTypes: list of mount types</li>
</ul>
<p>The mount types are strings like "mount", "mount2", "cmount" and can
be passed to mount/mount as the mountType parameter.</p>
<p>Eg</p>
<pre><code>rclone rc mount/types</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="mount-unmount">mount/unmount: Unmount selected active mount</h3>
<p>rclone allows Linux, FreeBSD, macOS and Windows to mount any of
Rclone's cloud storage systems as a file system with FUSE.</p>
<p>This takes the following parameters:</p>
<ul>
<li>mountPoint: valid path on the local machine where the mount was
created (required)</li>
</ul>
<p>Example:</p>
<pre><code>rclone rc mount/unmount mountPoint=/home/&lt;user&gt;/mountPoint</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="mount-unmountall">mount/unmountall: Unmount all active
mounts</h3>
<p>rclone allows Linux, FreeBSD, macOS and Windows to mount any of
Rclone's cloud storage systems as a file system with FUSE.</p>
<p>This takes no parameters and returns error if unmount does not
succeed.</p>
<p>Eg</p>
<pre><code>rclone rc mount/unmountall</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-about">operations/about: Return the space used on the
remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
</ul>
<p>The result is as returned from rclone about --json</p>
<p>See the <a href="https://rclone.org/commands/rclone_about/">about</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-check">operations/check: check the source and
destination are the same</h3>
<p>Checks the files in the source and destination match. It compares
sizes and hashes and logs a report of files that don't match. It doesn't
alter the source or destination.</p>
<p>This takes the following parameters:</p>
<ul>
<li>srcFs - a remote name string e.g. "drive:" for the source, "/" for
local filesystem</li>
<li>dstFs - a remote name string e.g. "drive2:" for the destination, "/"
for local filesystem</li>
<li>download - check by downloading rather than with hash</li>
<li>checkFileHash - treat checkFileFs:checkFileRemote as a SUM file with
hashes of given type</li>
<li>checkFileFs - treat checkFileFs:checkFileRemote as a SUM file with
hashes of given type</li>
<li>checkFileRemote - treat checkFileFs:checkFileRemote as a SUM file
with hashes of given type</li>
<li>oneWay - check one way only, source files must exist on remote</li>
<li>combined - make a combined report of changes (default false)</li>
<li>missingOnSrc - report all files missing from the source (default
true)</li>
<li>missingOnDst - report all files missing from the destination
(default true)</li>
<li>match - report all matching files (default false)</li>
<li>differ - report all non-matching files (default true)</li>
<li>error - report all files with errors (hashing or reading) (default
true)</li>
</ul>
<p>If you supply the download flag, it will download the data from both
remotes and check them against each other on the fly. This can be useful
for remotes that don't support hashes or if you really want to check all
the data.</p>
<p>If you supply the size-only global flag, it will only compare the
sizes not the hashes as well. Use this for a quick check.</p>
<p>If you supply the checkFileHash option with a valid hash name, the
checkFileFs:checkFileRemote must point to a text file in the SUM format.
This treats the checksum file as the source and dstFs as the
destination. Note that srcFs is not used and should not be supplied in
this case.</p>
<p>Returns:</p>
<ul>
<li>success - true if no error, false otherwise</li>
<li>status - textual summary of check, OK or text string</li>
<li>hashType - hash used in check, may be missing</li>
<li>combined - array of strings of combined report of changes</li>
<li>missingOnSrc - array of strings of all files missing from the
source</li>
<li>missingOnDst - array of strings of all files missing from the
destination</li>
<li>match - array of strings of all matching files</li>
<li>differ - array of strings of all non-matching files</li>
<li>error - array of strings of all files with errors (hashing or
reading)</li>
</ul>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-cleanup">operations/cleanup: Remove trashed files in
the remote or path</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_cleanup/">cleanup</a> command
for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-copyfile">operations/copyfile: Copy a file from
source remote to destination remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>srcFs - a remote name string e.g. "drive:" for the source, "/" for
local filesystem</li>
<li>srcRemote - a path within that remote e.g. "file.txt" for the
source</li>
<li>dstFs - a remote name string e.g. "drive2:" for the destination, "/"
for local filesystem</li>
<li>dstRemote - a path within that remote e.g. "file2.txt" for the
destination</li>
</ul>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-copyurl">operations/copyurl: Copy the URL to the
object</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
<li>remote - a path within that remote e.g. "dir"</li>
<li>url - string, URL to read from</li>
<li>autoFilename - boolean, set to true to retrieve destination file
name from url</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_copyurl/">copyurl</a> command
for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-delete">operations/delete: Remove files in the
path</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_delete/">delete</a> command for
more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-deletefile">operations/deletefile: Remove the single
file pointed to</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
<li>remote - a path within that remote e.g. "dir"</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_deletefile/">deletefile</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-fsinfo">operations/fsinfo: Return information about
the remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
</ul>
<p>This returns info about the remote passed in;</p>
<pre><code>{
        // optional features and whether they are available or not
        &quot;Features&quot;: {
                &quot;About&quot;: true,
                &quot;BucketBased&quot;: false,
                &quot;BucketBasedRootOK&quot;: false,
                &quot;CanHaveEmptyDirectories&quot;: true,
                &quot;CaseInsensitive&quot;: false,
                &quot;ChangeNotify&quot;: false,
                &quot;CleanUp&quot;: false,
                &quot;Command&quot;: true,
                &quot;Copy&quot;: false,
                &quot;DirCacheFlush&quot;: false,
                &quot;DirMove&quot;: true,
                &quot;Disconnect&quot;: false,
                &quot;DuplicateFiles&quot;: false,
                &quot;GetTier&quot;: false,
                &quot;IsLocal&quot;: true,
                &quot;ListR&quot;: false,
                &quot;MergeDirs&quot;: false,
                &quot;MetadataInfo&quot;: true,
                &quot;Move&quot;: true,
                &quot;OpenWriterAt&quot;: true,
                &quot;PublicLink&quot;: false,
                &quot;Purge&quot;: true,
                &quot;PutStream&quot;: true,
                &quot;PutUnchecked&quot;: false,
                &quot;ReadMetadata&quot;: true,
                &quot;ReadMimeType&quot;: false,
                &quot;ServerSideAcrossConfigs&quot;: false,
                &quot;SetTier&quot;: false,
                &quot;SetWrapper&quot;: false,
                &quot;Shutdown&quot;: false,
                &quot;SlowHash&quot;: true,
                &quot;SlowModTime&quot;: false,
                &quot;UnWrap&quot;: false,
                &quot;UserInfo&quot;: false,
                &quot;UserMetadata&quot;: true,
                &quot;WrapFs&quot;: false,
                &quot;WriteMetadata&quot;: true,
                &quot;WriteMimeType&quot;: false
        },
        // Names of hashes available
        &quot;Hashes&quot;: [
                &quot;md5&quot;,
                &quot;sha1&quot;,
                &quot;whirlpool&quot;,
                &quot;crc32&quot;,
                &quot;sha256&quot;,
                &quot;dropbox&quot;,
                &quot;mailru&quot;,
                &quot;quickxor&quot;
        ],
        &quot;Name&quot;: &quot;local&quot;,        // Name as created
        &quot;Precision&quot;: 1,         // Precision of timestamps in ns
        &quot;Root&quot;: &quot;/&quot;,            // Path as created
        &quot;String&quot;: &quot;Local file system at /&quot;, // how the remote will appear in logs
        // Information about the system metadata for this backend
        &quot;MetadataInfo&quot;: {
                &quot;System&quot;: {
                        &quot;atime&quot;: {
                                &quot;Help&quot;: &quot;Time of last access&quot;,
                                &quot;Type&quot;: &quot;RFC 3339&quot;,
                                &quot;Example&quot;: &quot;2006-01-02T15:04:05.999999999Z07:00&quot;
                        },
                        &quot;btime&quot;: {
                                &quot;Help&quot;: &quot;Time of file birth (creation)&quot;,
                                &quot;Type&quot;: &quot;RFC 3339&quot;,
                                &quot;Example&quot;: &quot;2006-01-02T15:04:05.999999999Z07:00&quot;
                        },
                        &quot;gid&quot;: {
                                &quot;Help&quot;: &quot;Group ID of owner&quot;,
                                &quot;Type&quot;: &quot;decimal number&quot;,
                                &quot;Example&quot;: &quot;500&quot;
                        },
                        &quot;mode&quot;: {
                                &quot;Help&quot;: &quot;File type and mode&quot;,
                                &quot;Type&quot;: &quot;octal, unix style&quot;,
                                &quot;Example&quot;: &quot;0100664&quot;
                        },
                        &quot;mtime&quot;: {
                                &quot;Help&quot;: &quot;Time of last modification&quot;,
                                &quot;Type&quot;: &quot;RFC 3339&quot;,
                                &quot;Example&quot;: &quot;2006-01-02T15:04:05.999999999Z07:00&quot;
                        },
                        &quot;rdev&quot;: {
                                &quot;Help&quot;: &quot;Device ID (if special file)&quot;,
                                &quot;Type&quot;: &quot;hexadecimal&quot;,
                                &quot;Example&quot;: &quot;1abc&quot;
                        },
                        &quot;uid&quot;: {
                                &quot;Help&quot;: &quot;User ID of owner&quot;,
                                &quot;Type&quot;: &quot;decimal number&quot;,
                                &quot;Example&quot;: &quot;500&quot;
                        }
                },
                &quot;Help&quot;: &quot;Textual help string\n&quot;
        }
}</code></pre>
<p>This command does not have a command line equivalent so use this
instead:</p>
<pre><code>rclone rc --loopback operations/fsinfo fs=remote:</code></pre>
<h3 id="operations-hashsum">operations/hashsum: Produces a hashsum file
for all the objects in the path.</h3>
<p>Produces a hash file for all the objects in the path using the hash
named. The output is in the same format as the standard md5sum/sha1sum
tool.</p>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:" for the source, "/" for
local filesystem
<ul>
<li>this can point to a file and just that file will be returned in the
listing.</li>
</ul></li>
<li>hashType - type of hash to be used</li>
<li>download - check by downloading rather than with hash (boolean)</li>
<li>base64 - output the hashes in base64 rather than hex (boolean)</li>
</ul>
<p>If you supply the download flag, it will download the data from the
remote and create the hash on the fly. This can be useful for remotes
that don't support the given hash or if you really want to check all the
data.</p>
<p>Note that if you wish to supply a checkfile to check hashes against
the current files then you should use operations/check instead of
operations/hashsum.</p>
<p>Returns:</p>
<ul>
<li>hashsum - array of strings of the hashes</li>
<li>hashType - type of hash used</li>
</ul>
<p>Example:</p>
<pre><code>$ rclone rc --loopback operations/hashsum fs=bin hashType=MD5 download=true base64=true
{
    &quot;hashType&quot;: &quot;md5&quot;,
    &quot;hashsum&quot;: [
        &quot;WTSVLpuiXyJO_kGzJerRLg==  backend-versions.sh&quot;,
        &quot;v1b_OlWCJO9LtNq3EIKkNQ==  bisect-go-rclone.sh&quot;,
        &quot;VHbmHzHh4taXzgag8BAIKQ==  bisect-rclone.sh&quot;,
    ]
}</code></pre>
<p>See the <a
href="https://rclone.org/commands/rclone_hashsum/">hashsum</a> command
for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-list">operations/list: List the given remote and path
in JSON format</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
<li>remote - a path within that remote e.g. "dir"</li>
<li>opt - a dictionary of options to control the listing (optional)
<ul>
<li>recurse - If set recurse directories</li>
<li>noModTime - If set return modification time</li>
<li>showEncrypted - If set show decrypted names</li>
<li>showOrigIDs - If set show the IDs for each item if known</li>
<li>showHash - If set return a dictionary of hashes</li>
<li>noMimeType - If set don't show mime types</li>
<li>dirsOnly - If set only show directories</li>
<li>filesOnly - If set only show files</li>
<li>metadata - If set return metadata of objects also</li>
<li>hashTypes - array of strings of hash types to show if showHash
set</li>
</ul></li>
</ul>
<p>Returns:</p>
<ul>
<li>list
<ul>
<li>This is an array of objects as described in the lsjson command</li>
</ul></li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_lsjson/">lsjson</a> command for
more information on the above and examples.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-mkdir">operations/mkdir: Make a destination directory
or container</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
<li>remote - a path within that remote e.g. "dir"</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_mkdir/">mkdir</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-movefile">operations/movefile: Move a file from
source remote to destination remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>srcFs - a remote name string e.g. "drive:" for the source, "/" for
local filesystem</li>
<li>srcRemote - a path within that remote e.g. "file.txt" for the
source</li>
<li>dstFs - a remote name string e.g. "drive2:" for the destination, "/"
for local filesystem</li>
<li>dstRemote - a path within that remote e.g. "file2.txt" for the
destination</li>
</ul>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-publiclink">operations/publiclink: Create or retrieve
a public link to the given file or folder.</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
<li>remote - a path within that remote e.g. "dir"</li>
<li>unlink - boolean - if set removes the link rather than adding it
(optional)</li>
<li>expire - string - the expiry time of the link e.g. "1d"
(optional)</li>
</ul>
<p>Returns:</p>
<ul>
<li>url - URL of the resource</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_link/">link</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-purge">operations/purge: Remove a directory or
container and all of its contents</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
<li>remote - a path within that remote e.g. "dir"</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_purge/">purge</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-rmdir">operations/rmdir: Remove an empty directory or
container</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
<li>remote - a path within that remote e.g. "dir"</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_rmdir/">rmdir</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-rmdirs">operations/rmdirs: Remove all the empty
directories in the path</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
<li>remote - a path within that remote e.g. "dir"</li>
<li>leaveRoot - boolean, set to true not to delete the root</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_rmdirs/">rmdirs</a> command for
more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-settier">operations/settier: Changes storage tier or
class on all files in the path</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_settier/">settier</a> command
for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-settierfile">operations/settierfile: Changes storage
tier or class on the single file pointed to</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
<li>remote - a path within that remote e.g. "dir"</li>
</ul>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-size">operations/size: Count the number of bytes and
files in remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:path/to/dir"</li>
</ul>
<p>Returns:</p>
<ul>
<li>count - number of files</li>
<li>bytes - number of bytes in those files</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_size/">size</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-stat">operations/stat: Give information about the
supplied file or directory</h3>
<p>This takes the following parameters</p>
<ul>
<li>fs - a remote name string eg "drive:"</li>
<li>remote - a path within that remote eg "dir"</li>
<li>opt - a dictionary of options to control the listing (optional)
<ul>
<li>see operations/list for the options</li>
</ul></li>
</ul>
<p>The result is</p>
<ul>
<li>item - an object as described in the lsjson command. Will be null if
not found.</li>
</ul>
<p>Note that if you are only interested in files then it is much more
efficient to set the filesOnly flag in the options.</p>
<p>See the <a
href="https://rclone.org/commands/rclone_lsjson/">lsjson</a> command for
more information on the above and examples.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-uploadfile">operations/uploadfile: Upload file using
multiform/form-data</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. "drive:"</li>
<li>remote - a path within that remote e.g. "dir"</li>
<li>each part in body represents a file to be uploaded</li>
</ul>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="options-blocks">options/blocks: List all the option blocks</h3>
<p>Returns: - options - a list of the options block names</p>
<h3 id="options-get">options/get: Get all the global options</h3>
<p>Returns an object where keys are option block names and values are an
object with the current option values in.</p>
<p>Parameters:</p>
<ul>
<li>blocks: optional string of comma separated blocks to include
<ul>
<li>all are included if this is missing or ""</li>
</ul></li>
</ul>
<p>Note that these are the global options which are unaffected by use of
the _config and _filter parameters. If you wish to read the parameters
set in _config or _filter use options/local.</p>
<p>This shows the internal names of the option within rclone which
should map to the external options very easily with a few
exceptions.</p>
<h3 id="options-info">options/info: Get info about all the global
options</h3>
<p>Returns an object where keys are option block names and values are an
array of objects with info about each options.</p>
<p>Parameters:</p>
<ul>
<li>blocks: optional string of comma separated blocks to include
<ul>
<li>all are included if this is missing or ""</li>
</ul></li>
</ul>
<p>These objects are in the same format as returned by
"config/providers". They are described in the <a
href="#option-blocks">option blocks</a> section.</p>
<h3 id="options-local">options/local: Get the currently active config
for this call</h3>
<p>Returns an object with the keys "config" and "filter". The "config"
key contains the local config and the "filter" key contains the local
filters.</p>
<p>Note that these are the local options specific to this rc call. If
_config was not supplied then they will be the global options. Likewise
with "_filter".</p>
<p>This call is mostly useful for seeing if _config and _filter passing
is working.</p>
<p>This shows the internal names of the option within rclone which
should map to the external options very easily with a few
exceptions.</p>
<h3 id="options-set">options/set: Set an option</h3>
<p>Parameters:</p>
<ul>
<li>option block name containing an object with
<ul>
<li>key: value</li>
</ul></li>
</ul>
<p>Repeated as often as required.</p>
<p>Only supply the options you wish to change. If an option is unknown
it will be silently ignored. Not all options will have an effect when
changed like this.</p>
<p>For example:</p>
<p>This sets DEBUG level logs (-vv) (these can be set by number or
string)</p>
<pre><code>rclone rc options/set --json &#39;{&quot;main&quot;: {&quot;LogLevel&quot;: &quot;DEBUG&quot;}}&#39;
rclone rc options/set --json &#39;{&quot;main&quot;: {&quot;LogLevel&quot;: 8}}&#39;</code></pre>
<p>And this sets INFO level logs (-v)</p>
<pre><code>rclone rc options/set --json &#39;{&quot;main&quot;: {&quot;LogLevel&quot;: &quot;INFO&quot;}}&#39;</code></pre>
<p>And this sets NOTICE level logs (normal without -v)</p>
<pre><code>rclone rc options/set --json &#39;{&quot;main&quot;: {&quot;LogLevel&quot;: &quot;NOTICE&quot;}}&#39;</code></pre>
<h3 id="pluginsctl-addPlugin">pluginsctl/addPlugin: Add a plugin using
url</h3>
<p>Used for adding a plugin to the webgui.</p>
<p>This takes the following parameters:</p>
<ul>
<li>url - http url of the github repo where the plugin is hosted
(http://github.com/rclone/rclone-webui-react).</li>
</ul>
<p>Example:</p>
<p>rclone rc pluginsctl/addPlugin</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="pluginsctl-getPluginsForType">pluginsctl/getPluginsForType: Get
plugins with type criteria</h3>
<p>This shows all possible plugins by a mime type.</p>
<p>This takes the following parameters:</p>
<ul>
<li>type - supported mime type by a loaded plugin e.g. (video/mp4,
audio/mp3).</li>
<li>pluginType - filter plugins based on their type e.g. (DASHBOARD,
FILE_HANDLER, TERMINAL).</li>
</ul>
<p>Returns:</p>
<ul>
<li>loadedPlugins - list of current production plugins.</li>
<li>testPlugins - list of temporarily loaded development plugins,
usually running on a different server.</li>
</ul>
<p>Example:</p>
<p>rclone rc pluginsctl/getPluginsForType type=video/mp4</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="pluginsctl-listPlugins">pluginsctl/listPlugins: Get the list of
currently loaded plugins</h3>
<p>This allows you to get the currently enabled plugins and their
details.</p>
<p>This takes no parameters and returns:</p>
<ul>
<li>loadedPlugins - list of current production plugins.</li>
<li>testPlugins - list of temporarily loaded development plugins,
usually running on a different server.</li>
</ul>
<p>E.g.</p>
<p>rclone rc pluginsctl/listPlugins</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="pluginsctl-listTestPlugins">pluginsctl/listTestPlugins: Show
currently loaded test plugins</h3>
<p>Allows listing of test plugins with the rclone.test set to true in
package.json of the plugin.</p>
<p>This takes no parameters and returns:</p>
<ul>
<li>loadedTestPlugins - list of currently available test plugins.</li>
</ul>
<p>E.g.</p>
<pre><code>rclone rc pluginsctl/listTestPlugins</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="pluginsctl-removePlugin">pluginsctl/removePlugin: Remove a
loaded plugin</h3>
<p>This allows you to remove a plugin using it's name.</p>
<p>This takes parameters:</p>
<ul>
<li>name - name of the plugin in the format
<code>author</code>/<code>plugin_name</code>.</li>
</ul>
<p>E.g.</p>
<p>rclone rc pluginsctl/removePlugin name=rclone/video-plugin</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="pluginsctl-removeTestPlugin">pluginsctl/removeTestPlugin: Remove
a test plugin</h3>
<p>This allows you to remove a plugin using it's name.</p>
<p>This takes the following parameters:</p>
<ul>
<li>name - name of the plugin in the format
<code>author</code>/<code>plugin_name</code>.</li>
</ul>
<p>Example:</p>
<pre><code>rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="rc-error">rc/error: This returns an error</h3>
<p>This returns an error with the input as part of its error string.
Useful for testing error handling.</p>
<h3 id="rc-list">rc/list: List all the registered remote control
commands</h3>
<p>This lists all the registered remote control commands as a JSON map
in the commands response.</p>
<h3 id="rc-noop">rc/noop: Echo the input to the output parameters</h3>
<p>This echoes the input parameters to the output parameters for testing
purposes. It can be used to check that rclone is still alive and to
check that parameter passing is working properly.</p>
<h3 id="rc-noopauth">rc/noopauth: Echo the input to the output
parameters requiring auth</h3>
<p>This echoes the input parameters to the output parameters for testing
purposes. It can be used to check that rclone is still alive and to
check that parameter passing is working properly.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="serve-list">serve/list: Show running servers</h3>
<p>Show running servers with IDs.</p>
<p>This takes no parameters and returns</p>
<ul>
<li>list: list of running serve commands</li>
</ul>
<p>Each list element will have</p>
<ul>
<li>id: ID of the server</li>
<li>addr: address the server is running on</li>
<li>params: parameters used to start the server</li>
</ul>
<p>Eg</p>
<pre><code>rclone rc serve/list</code></pre>
<p>Returns</p>
<div class="sourceCode" id="cb795"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb795-1"><a href="#cb795-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb795-2"><a href="#cb795-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;list&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
<span id="cb795-3"><a href="#cb795-3" aria-hidden="true" tabindex="-1"></a>        <span class="fu">{</span></span>
<span id="cb795-4"><a href="#cb795-4" aria-hidden="true" tabindex="-1"></a>            <span class="dt">&quot;addr&quot;</span><span class="fu">:</span> <span class="st">&quot;[::]:4321&quot;</span><span class="fu">,</span></span>
<span id="cb795-5"><a href="#cb795-5" aria-hidden="true" tabindex="-1"></a>            <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;nfs-ffc2a4e5&quot;</span><span class="fu">,</span></span>
<span id="cb795-6"><a href="#cb795-6" aria-hidden="true" tabindex="-1"></a>            <span class="dt">&quot;params&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb795-7"><a href="#cb795-7" aria-hidden="true" tabindex="-1"></a>                <span class="dt">&quot;fs&quot;</span><span class="fu">:</span> <span class="st">&quot;remote:&quot;</span><span class="fu">,</span></span>
<span id="cb795-8"><a href="#cb795-8" aria-hidden="true" tabindex="-1"></a>                <span class="dt">&quot;opt&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb795-9"><a href="#cb795-9" aria-hidden="true" tabindex="-1"></a>                    <span class="dt">&quot;ListenAddr&quot;</span><span class="fu">:</span> <span class="st">&quot;:4321&quot;</span></span>
<span id="cb795-10"><a href="#cb795-10" aria-hidden="true" tabindex="-1"></a>                <span class="fu">},</span></span>
<span id="cb795-11"><a href="#cb795-11" aria-hidden="true" tabindex="-1"></a>                <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;nfs&quot;</span><span class="fu">,</span></span>
<span id="cb795-12"><a href="#cb795-12" aria-hidden="true" tabindex="-1"></a>                <span class="dt">&quot;vfsOpt&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb795-13"><a href="#cb795-13" aria-hidden="true" tabindex="-1"></a>                    <span class="dt">&quot;CacheMode&quot;</span><span class="fu">:</span> <span class="st">&quot;full&quot;</span></span>
<span id="cb795-14"><a href="#cb795-14" aria-hidden="true" tabindex="-1"></a>                <span class="fu">}</span></span>
<span id="cb795-15"><a href="#cb795-15" aria-hidden="true" tabindex="-1"></a>            <span class="fu">}</span></span>
<span id="cb795-16"><a href="#cb795-16" aria-hidden="true" tabindex="-1"></a>        <span class="fu">}</span></span>
<span id="cb795-17"><a href="#cb795-17" aria-hidden="true" tabindex="-1"></a>    <span class="ot">]</span></span>
<span id="cb795-18"><a href="#cb795-18" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="serve-start">serve/start: Create a new server</h3>
<p>Create a new server with the specified parameters.</p>
<p>This takes the following parameters:</p>
<ul>
<li><code>type</code> - type of server: <code>http</code>,
<code>webdav</code>, <code>ftp</code>, <code>sftp</code>,
<code>nfs</code>, etc.</li>
<li><code>fs</code> - remote storage path to serve</li>
<li><code>addr</code> - the ip:port to run the server on, eg ":1234" or
"localhost:1234"</li>
</ul>
<p>Other parameters are as described in the documentation for the
relevant <a href="https://rclone.org/commands/rclone_serve/">rclone
serve</a> command line options. To translate a command line option to an
rc parameter, remove the leading <code>--</code> and replace
<code>-</code> with <code>_</code>, so <code>--vfs-cache-mode</code>
becomes <code>vfs_cache_mode</code>. Note that global parameters must be
set with <code>_config</code> and <code>_filter</code> as described
above.</p>
<p>Examples:</p>
<pre><code>rclone rc serve/start type=nfs fs=remote: addr=:4321 vfs_cache_mode=full
rclone rc serve/start --json &#39;{&quot;type&quot;:&quot;nfs&quot;,&quot;fs&quot;:&quot;remote:&quot;,&quot;addr&quot;:&quot;:1234&quot;,&quot;vfs_cache_mode&quot;:&quot;full&quot;}&#39;</code></pre>
<p>This will give the reply</p>
<div class="sourceCode" id="cb797"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb797-1"><a href="#cb797-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb797-2"><a href="#cb797-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;addr&quot;</span><span class="fu">:</span> <span class="st">&quot;[::]:4321&quot;</span><span class="fu">,</span> <span class="er">//</span> <span class="er">Address</span> <span class="er">the</span> <span class="er">server</span> <span class="er">was</span> <span class="er">started</span> <span class="er">on</span></span>
<span id="cb797-3"><a href="#cb797-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;nfs-ecfc6852&quot;</span> <span class="er">//</span> <span class="er">Unique</span> <span class="er">identifier</span> <span class="er">for</span> <span class="er">the</span> <span class="er">server</span> <span class="er">instance</span></span>
<span id="cb797-4"><a href="#cb797-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Or an error if it failed to start.</p>
<p>Stop the server with <code>serve/stop</code> and list the running
servers with <code>serve/list</code>.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="serve-stop">serve/stop: Unserve selected active serve</h3>
<p>Stops a running <code>serve</code> instance by ID.</p>
<p>This takes the following parameters:</p>
<ul>
<li>id: as returned by serve/start</li>
</ul>
<p>This will give an empty response if successful or an error if
not.</p>
<p>Example:</p>
<pre><code>rclone rc serve/stop id=12345</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="serve-stopall">serve/stopall: Stop all active servers</h3>
<p>Stop all active servers.</p>
<p>This will stop all active servers.</p>
<pre><code>rclone rc serve/stopall</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="serve-types">serve/types: Show all possible serve types</h3>
<p>This shows all possible serve types and returns them as a list.</p>
<p>This takes no parameters and returns</p>
<ul>
<li>types: list of serve types, eg "nfs", "sftp", etc</li>
</ul>
<p>The serve types are strings like "serve", "serve2", "cserve" and can
be passed to serve/start as the serveType parameter.</p>
<p>Eg</p>
<pre><code>rclone rc serve/types</code></pre>
<p>Returns</p>
<div class="sourceCode" id="cb801"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb801-1"><a href="#cb801-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb801-2"><a href="#cb801-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;types&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
<span id="cb801-3"><a href="#cb801-3" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;http&quot;</span><span class="ot">,</span></span>
<span id="cb801-4"><a href="#cb801-4" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;sftp&quot;</span><span class="ot">,</span></span>
<span id="cb801-5"><a href="#cb801-5" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;nfs&quot;</span></span>
<span id="cb801-6"><a href="#cb801-6" aria-hidden="true" tabindex="-1"></a>    <span class="ot">]</span></span>
<span id="cb801-7"><a href="#cb801-7" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="sync-bisync">sync/bisync: Perform bidirectional synchronization
between two paths.</h3>
<p>This takes the following parameters</p>
<ul>
<li>path1 - a remote directory string e.g. <code>drive:path1</code></li>
<li>path2 - a remote directory string e.g. <code>drive:path2</code></li>
<li>dryRun - dry-run mode</li>
<li>resync - performs the resync run</li>
<li>checkAccess - abort if RCLONE_TEST files are not found on both
filesystems</li>
<li>checkFilename - file name for checkAccess (default:
RCLONE_TEST)</li>
<li>maxDelete - abort sync if percentage of deleted files is above this
threshold (default: 50)</li>
<li>force - Bypass maxDelete safety check and run the sync</li>
<li>checkSync - <code>true</code> by default, <code>false</code>
disables comparison of final listings, <code>only</code> will skip sync,
only compare listings from the last run</li>
<li>createEmptySrcDirs - Sync creation and deletion of empty
directories. (Not compatible with --remove-empty-dirs)</li>
<li>removeEmptyDirs - remove empty directories at the final cleanup
step</li>
<li>filtersFile - read filtering patterns from a file</li>
<li>ignoreListingChecksum - Do not use checksums for listings</li>
<li>resilient - Allow future runs to retry after certain less-serious
errors, instead of requiring resync.</li>
<li>workdir - server directory for history files (default:
<code>~/.cache/rclone/bisync</code>)</li>
<li>backupdir1 - --backup-dir for Path1. Must be a non-overlapping path
on the same remote.</li>
<li>backupdir2 - --backup-dir for Path2. Must be a non-overlapping path
on the same remote.</li>
<li>noCleanup - retain working files</li>
</ul>
<p>See <a href="https://rclone.org/commands/rclone_bisync/">bisync
command help</a> and <a href="https://rclone.org/bisync/">full bisync
description</a> for more information.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="sync-copy">sync/copy: copy a directory from source remote to
destination remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>srcFs - a remote name string e.g. "drive:src" for the source</li>
<li>dstFs - a remote name string e.g. "drive:dst" for the
destination</li>
<li>createEmptySrcDirs - create empty src directories on destination if
set</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_copy/">copy</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="sync-move">sync/move: move a directory from source remote to
destination remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>srcFs - a remote name string e.g. "drive:src" for the source</li>
<li>dstFs - a remote name string e.g. "drive:dst" for the
destination</li>
<li>createEmptySrcDirs - create empty src directories on destination if
set</li>
<li>deleteEmptySrcDirs - delete empty src directories if set</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_move/">move</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="sync-sync">sync/sync: sync a directory from source remote to
destination remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>srcFs - a remote name string e.g. "drive:src" for the source</li>
<li>dstFs - a remote name string e.g. "drive:dst" for the
destination</li>
<li>createEmptySrcDirs - create empty src directories on destination if
set</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_sync/">sync</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="vfs-forget">vfs/forget: Forget files or directories in the
directory cache.</h3>
<p>This forgets the paths in the directory cache causing them to be
re-read from the remote when needed.</p>
<p>If no paths are passed in then it will forget all the paths in the
directory cache.</p>
<pre><code>rclone rc vfs/forget</code></pre>
<p>Otherwise pass files or dirs in as file=path or dir=path. Any
parameter key starting with file will forget that file and any starting
with dir will forget that dir, e.g.</p>
<pre><code>rclone rc vfs/forget file=hello file2=goodbye dir=home/junk</code></pre>
<p>This command takes an "fs" parameter. If this parameter is not
supplied and if there is only one VFS in use then that VFS will be used.
If there is more than one VFS in use then the "fs" parameter must be
supplied.</p>
<h3 id="vfs-list">vfs/list: List active VFSes.</h3>
<p>This lists the active VFSes.</p>
<p>It returns a list under the key "vfses" where the values are the VFS
names that could be passed to the other VFS commands in the "fs"
parameter.</p>
<h3 id="vfs-poll-interval">vfs/poll-interval: Get the status or update
the value of the poll-interval option.</h3>
<p>Without any parameter given this returns the current status of the
poll-interval setting.</p>
<p>When the interval=duration parameter is set, the poll-interval value
is updated and the polling function is notified. Setting interval=0
disables poll-interval.</p>
<pre><code>rclone rc vfs/poll-interval interval=5m</code></pre>
<p>The timeout=duration parameter can be used to specify a time to wait
for the current poll function to apply the new value. If timeout is less
or equal 0, which is the default, wait indefinitely.</p>
<p>The new poll-interval value will only be active when the timeout is
not reached.</p>
<p>If poll-interval is updated or disabled temporarily, some changes
might not get picked up by the polling function, depending on the used
remote.</p>
<p>This command takes an "fs" parameter. If this parameter is not
supplied and if there is only one VFS in use then that VFS will be used.
If there is more than one VFS in use then the "fs" parameter must be
supplied.</p>
<h3 id="vfs-queue">vfs/queue: Queue info for a VFS.</h3>
<p>This returns info about the upload queue for the selected VFS.</p>
<p>This is only useful if <code>--vfs-cache-mode</code> &gt; off. If you
call it when the <code>--vfs-cache-mode</code> is off, it will return an
empty result.</p>
<pre><code>{
    &quot;queued&quot;: // an array of files queued for upload
    [
        {
            &quot;name&quot;:      &quot;file&quot;,   // string: name (full path) of the file,
            &quot;id&quot;:        123,      // integer: id of this item in the queue,
            &quot;size&quot;:      79,       // integer: size of the file in bytes
            &quot;expiry&quot;:    1.5       // float: time until file is eligible for transfer, lowest goes first
            &quot;tries&quot;:     1,        // integer: number of times we have tried to upload
            &quot;delay&quot;:     5.0,      // float: seconds between upload attempts
            &quot;uploading&quot;: false,    // boolean: true if item is being uploaded
        },
   ],
}</code></pre>
<p>The <code>expiry</code> time is the time until the file is eligible
for being uploaded in floating point seconds. This may go negative. As
rclone only transfers <code>--transfers</code> files at once, only the
lowest <code>--transfers</code> expiry times will have
<code>uploading</code> as <code>true</code>. So there may be files with
negative expiry times for which <code>uploading</code> is
<code>false</code>.</p>
<p>This command takes an "fs" parameter. If this parameter is not
supplied and if there is only one VFS in use then that VFS will be used.
If there is more than one VFS in use then the "fs" parameter must be
supplied.</p>
<h3 id="vfs-queue-set-expiry">vfs/queue-set-expiry: Set the expiry time
for an item queued for upload.</h3>
<p>Use this to adjust the <code>expiry</code> time for an item in the
upload queue. You will need to read the <code>id</code> of the item
using <code>vfs/queue</code> before using this call.</p>
<p>You can then set <code>expiry</code> to a floating point number of
seconds from now when the item is eligible for upload. If you want the
item to be uploaded as soon as possible then set it to a large negative
number (eg -1000000000). If you want the upload of the item to be
delayed for a long time then set it to a large positive number.</p>
<p>Setting the <code>expiry</code> of an item which has already has
started uploading will have no effect - the item will carry on being
uploaded.</p>
<p>This will return an error if called with
<code>--vfs-cache-mode</code> off or if the <code>id</code> passed is
not found.</p>
<p>This takes the following parameters</p>
<ul>
<li><code>fs</code> - select the VFS in use (optional)</li>
<li><code>id</code> - a numeric ID as returned from
<code>vfs/queue</code></li>
<li><code>expiry</code> - a new expiry time as floating point
seconds</li>
<li><code>relative</code> - if set, expiry is to be treated as relative
to the current expiry (optional, boolean)</li>
</ul>
<p>This returns an empty result on success, or an error.</p>
<p>This command takes an "fs" parameter. If this parameter is not
supplied and if there is only one VFS in use then that VFS will be used.
If there is more than one VFS in use then the "fs" parameter must be
supplied.</p>
<h3 id="vfs-refresh">vfs/refresh: Refresh the directory cache.</h3>
<p>This reads the directories for the specified paths and freshens the
directory cache.</p>
<p>If no paths are passed in then it will refresh the root
directory.</p>
<pre><code>rclone rc vfs/refresh</code></pre>
<p>Otherwise pass directories in as dir=path. Any parameter key starting
with dir will refresh that directory, e.g.</p>
<pre><code>rclone rc vfs/refresh dir=home/junk dir2=data/misc</code></pre>
<p>If the parameter recursive=true is given the whole directory tree
will get refreshed. This refresh will use --fast-list if enabled.</p>
<p>This command takes an "fs" parameter. If this parameter is not
supplied and if there is only one VFS in use then that VFS will be used.
If there is more than one VFS in use then the "fs" parameter must be
supplied.</p>
<h3 id="vfs-stats">vfs/stats: Stats for a VFS.</h3>
<p>This returns stats for the selected VFS.</p>
<pre><code>{
    // Status of the disk cache - only present if --vfs-cache-mode &gt; off
    &quot;diskCache&quot;: {
        &quot;bytesUsed&quot;: 0,
        &quot;erroredFiles&quot;: 0,
        &quot;files&quot;: 0,
        &quot;hashType&quot;: 1,
        &quot;outOfSpace&quot;: false,
        &quot;path&quot;: &quot;/home/user/.cache/rclone/vfs/local/mnt/a&quot;,
        &quot;pathMeta&quot;: &quot;/home/user/.cache/rclone/vfsMeta/local/mnt/a&quot;,
        &quot;uploadsInProgress&quot;: 0,
        &quot;uploadsQueued&quot;: 0
    },
    &quot;fs&quot;: &quot;/mnt/a&quot;,
    &quot;inUse&quot;: 1,
    // Status of the in memory metadata cache
    &quot;metadataCache&quot;: {
        &quot;dirs&quot;: 1,
        &quot;files&quot;: 0
    },
    // Options as returned by options/get
    &quot;opt&quot;: {
        &quot;CacheMaxAge&quot;: 3600000000000,
        // ...
        &quot;WriteWait&quot;: 1000000000
    }
}</code></pre>
<p>This command takes an "fs" parameter. If this parameter is not
supplied and if there is only one VFS in use then that VFS will be used.
If there is more than one VFS in use then the "fs" parameter must be
supplied.</p>
<h2 id="api-http">Accessing the remote control via HTTP</h2>
<p>Rclone implements a simple HTTP based protocol.</p>
<p>Each endpoint takes an JSON object and returns a JSON object or an
error. The JSON objects are essentially a map of string names to
values.</p>
<p>All calls must made using POST.</p>
<p>The input objects can be supplied using URL parameters, POST
parameters or by supplying "Content-Type: application/json" and a JSON
blob in the body. There are examples of these below using
<code>curl</code>.</p>
<p>The response will be a JSON blob in the body of the response. This is
formatted to be reasonably human-readable.</p>
<h3 id="error-returns">Error returns</h3>
<p>If an error occurs then there will be an HTTP error status (e.g. 500)
and the body of the response will contain a JSON encoded error object,
e.g.</p>
<div class="sourceCode" id="cb809"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb809-1"><a href="#cb809-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb809-2"><a href="#cb809-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;error&quot;</span><span class="fu">:</span> <span class="st">&quot;Expecting string value for key </span><span class="ch">\&quot;</span><span class="st">remote</span><span class="ch">\&quot;</span><span class="st"> (was float64)&quot;</span><span class="fu">,</span></span>
<span id="cb809-3"><a href="#cb809-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;input&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb809-4"><a href="#cb809-4" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;fs&quot;</span><span class="fu">:</span> <span class="st">&quot;/tmp&quot;</span><span class="fu">,</span></span>
<span id="cb809-5"><a href="#cb809-5" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;remote&quot;</span><span class="fu">:</span> <span class="dv">3</span></span>
<span id="cb809-6"><a href="#cb809-6" aria-hidden="true" tabindex="-1"></a>    <span class="fu">},</span></span>
<span id="cb809-7"><a href="#cb809-7" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;status&quot;</span><span class="fu">:</span> <span class="dv">400</span><span class="fu">,</span></span>
<span id="cb809-8"><a href="#cb809-8" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;path&quot;</span><span class="fu">:</span> <span class="st">&quot;operations/rmdir&quot;</span></span>
<span id="cb809-9"><a href="#cb809-9" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>The keys in the error response are:</p>
<ul>
<li>error - error string</li>
<li>input - the input parameters to the call</li>
<li>status - the HTTP status code</li>
<li>path - the path of the call</li>
</ul>
<h3 id="cors">CORS</h3>
<p>The sever implements basic CORS support and allows all origins for
that. The response to a preflight OPTIONS request will echo the
requested "Access-Control-Request-Headers" back.</p>
<h3 id="using-post-with-url-parameters-only">Using POST with URL
parameters only</h3>
<div class="sourceCode" id="cb810"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb810-1"><a href="#cb810-1" aria-hidden="true" tabindex="-1"></a><span class="ex">curl</span> <span class="at">-X</span> POST <span class="st">&#39;http://localhost:5572/rc/noop?potato=1&amp;sausage=2&#39;</span></span></code></pre></div>
<p>Response</p>
<div class="sourceCode" id="cb811"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb811-1"><a href="#cb811-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb811-2"><a href="#cb811-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="st">&quot;1&quot;</span><span class="fu">,</span></span>
<span id="cb811-3"><a href="#cb811-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="st">&quot;2&quot;</span></span>
<span id="cb811-4"><a href="#cb811-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Here is what an error response looks like:</p>
<div class="sourceCode" id="cb812"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb812-1"><a href="#cb812-1" aria-hidden="true" tabindex="-1"></a><span class="ex">curl</span> <span class="at">-X</span> POST <span class="st">&#39;http://localhost:5572/rc/error?potato=1&amp;sausage=2&#39;</span></span></code></pre></div>
<div class="sourceCode" id="cb813"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb813-1"><a href="#cb813-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb813-2"><a href="#cb813-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;error&quot;</span><span class="fu">:</span> <span class="st">&quot;arbitrary error on input map[potato:1 sausage:2]&quot;</span><span class="fu">,</span></span>
<span id="cb813-3"><a href="#cb813-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;input&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb813-4"><a href="#cb813-4" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="st">&quot;1&quot;</span><span class="fu">,</span></span>
<span id="cb813-5"><a href="#cb813-5" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="st">&quot;2&quot;</span></span>
<span id="cb813-6"><a href="#cb813-6" aria-hidden="true" tabindex="-1"></a>    <span class="fu">}</span></span>
<span id="cb813-7"><a href="#cb813-7" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Note that curl doesn't return errors to the shell unless you use the
<code>-f</code> option</p>
<div class="sourceCode" id="cb814"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb814-1"><a href="#cb814-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> curl <span class="at">-f</span> <span class="at">-X</span> POST <span class="st">&#39;http://localhost:5572/rc/error?potato=1&amp;sausage=2&#39;</span></span>
<span id="cb814-2"><a href="#cb814-2" aria-hidden="true" tabindex="-1"></a><span class="ex">curl:</span> <span class="er">(</span><span class="ex">22</span><span class="kw">)</span> <span class="ex">The</span> requested URL returned error: 400 Bad Request</span>
<span id="cb814-3"><a href="#cb814-3" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> echo <span class="va">$?</span></span>
<span id="cb814-4"><a href="#cb814-4" aria-hidden="true" tabindex="-1"></a><span class="ex">22</span></span></code></pre></div>
<h3 id="using-post-with-a-form">Using POST with a form</h3>
<div class="sourceCode" id="cb815"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb815-1"><a href="#cb815-1" aria-hidden="true" tabindex="-1"></a><span class="ex">curl</span> <span class="at">--data</span> <span class="st">&quot;potato=1&quot;</span> <span class="at">--data</span> <span class="st">&quot;sausage=2&quot;</span> http://localhost:5572/rc/noop</span></code></pre></div>
<p>Response</p>
<div class="sourceCode" id="cb816"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb816-1"><a href="#cb816-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb816-2"><a href="#cb816-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="st">&quot;1&quot;</span><span class="fu">,</span></span>
<span id="cb816-3"><a href="#cb816-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="st">&quot;2&quot;</span></span>
<span id="cb816-4"><a href="#cb816-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Note that you can combine these with URL parameters too with the POST
parameters taking precedence.</p>
<div class="sourceCode" id="cb817"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb817-1"><a href="#cb817-1" aria-hidden="true" tabindex="-1"></a><span class="ex">curl</span> <span class="at">--data</span> <span class="st">&quot;potato=1&quot;</span> <span class="at">--data</span> <span class="st">&quot;sausage=2&quot;</span> <span class="st">&quot;http://localhost:5572/rc/noop?rutabaga=3&amp;sausage=4&quot;</span></span></code></pre></div>
<p>Response</p>
<div class="sourceCode" id="cb818"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb818-1"><a href="#cb818-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb818-2"><a href="#cb818-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="st">&quot;1&quot;</span><span class="fu">,</span></span>
<span id="cb818-3"><a href="#cb818-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;rutabaga&quot;</span><span class="fu">:</span> <span class="st">&quot;3&quot;</span><span class="fu">,</span></span>
<span id="cb818-4"><a href="#cb818-4" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="st">&quot;4&quot;</span></span>
<span id="cb818-5"><a href="#cb818-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h3 id="using-post-with-a-json-blob">Using POST with a JSON blob</h3>
<div class="sourceCode" id="cb819"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb819-1"><a href="#cb819-1" aria-hidden="true" tabindex="-1"></a><span class="ex">curl</span> <span class="at">-H</span> <span class="st">&quot;Content-Type: application/json&quot;</span> <span class="at">-X</span> POST <span class="at">-d</span> <span class="st">&#39;{&quot;potato&quot;:2,&quot;sausage&quot;:1}&#39;</span> http://localhost:5572/rc/noop</span></code></pre></div>
<p>response</p>
<div class="sourceCode" id="cb820"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb820-1"><a href="#cb820-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb820-2"><a href="#cb820-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;password&quot;</span><span class="fu">:</span> <span class="st">&quot;xyz&quot;</span><span class="fu">,</span></span>
<span id="cb820-3"><a href="#cb820-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;username&quot;</span><span class="fu">:</span> <span class="st">&quot;xyz&quot;</span></span>
<span id="cb820-4"><a href="#cb820-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>This can be combined with URL parameters too if required. The JSON
blob takes precedence.</p>
<div class="sourceCode" id="cb821"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb821-1"><a href="#cb821-1" aria-hidden="true" tabindex="-1"></a><span class="ex">curl</span> <span class="at">-H</span> <span class="st">&quot;Content-Type: application/json&quot;</span> <span class="at">-X</span> POST <span class="at">-d</span> <span class="st">&#39;{&quot;potato&quot;:2,&quot;sausage&quot;:1}&#39;</span> <span class="st">&#39;http://localhost:5572/rc/noop?rutabaga=3&amp;potato=4&#39;</span></span></code></pre></div>
<div class="sourceCode" id="cb822"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb822-1"><a href="#cb822-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb822-2"><a href="#cb822-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="dv">2</span><span class="fu">,</span></span>
<span id="cb822-3"><a href="#cb822-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;rutabaga&quot;</span><span class="fu">:</span> <span class="st">&quot;3&quot;</span><span class="fu">,</span></span>
<span id="cb822-4"><a href="#cb822-4" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="dv">1</span></span>
<span id="cb822-5"><a href="#cb822-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h2 id="debugging-rclone-with-pprof">Debugging rclone with pprof</h2>
<p>If you use the <code>--rc</code> flag this will also enable the use
of the go profiling tools on the same port.</p>
<p>To use these, first <a href="https://golang.org/doc/install">install
go</a>.</p>
<h3 id="debugging-memory-use">Debugging memory use</h3>
<p>To profile rclone's memory use you can run:</p>
<div class="sourceCode" id="cb823"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb823-1"><a href="#cb823-1" aria-hidden="true" tabindex="-1"></a><span class="ex">go</span> tool pprof <span class="at">-web</span> http://localhost:5572/debug/pprof/heap</span></code></pre></div>
<p>This should open a page in your browser showing what is using what
memory.</p>
<p>You can also use the <code>-text</code> flag to produce a textual
summary</p>
<div class="sourceCode" id="cb824"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb824-1"><a href="#cb824-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> go tool pprof <span class="at">-text</span> http://localhost:5572/debug/pprof/heap</span>
<span id="cb824-2"><a href="#cb824-2" aria-hidden="true" tabindex="-1"></a><span class="ex">Showing</span> nodes accounting for 1537.03kB, 100% of 1537.03kB total</span>
<span id="cb824-3"><a href="#cb824-3" aria-hidden="true" tabindex="-1"></a>      <span class="ex">flat</span>  flat%   sum%        cum   cum%</span>
<span id="cb824-4"><a href="#cb824-4" aria-hidden="true" tabindex="-1"></a> <span class="ex">1024.03kB</span> 66.62% 66.62%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode</span>
<span id="cb824-5"><a href="#cb824-5" aria-hidden="true" tabindex="-1"></a>     <span class="ex">513kB</span> 33.38%   100%      513kB 33.38%  net/http.newBufioWriterSize</span>
<span id="cb824-6"><a href="#cb824-6" aria-hidden="true" tabindex="-1"></a>         <span class="ex">0</span>     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/cmd/all.init</span>
<span id="cb824-7"><a href="#cb824-7" aria-hidden="true" tabindex="-1"></a>         <span class="ex">0</span>     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/cmd/serve.init</span>
<span id="cb824-8"><a href="#cb824-8" aria-hidden="true" tabindex="-1"></a>         <span class="ex">0</span>     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/cmd/serve/restic.init</span>
<span id="cb824-9"><a href="#cb824-9" aria-hidden="true" tabindex="-1"></a>         <span class="ex">0</span>     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2.init</span>
<span id="cb824-10"><a href="#cb824-10" aria-hidden="true" tabindex="-1"></a>         <span class="ex">0</span>     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init</span>
<span id="cb824-11"><a href="#cb824-11" aria-hidden="true" tabindex="-1"></a>         <span class="ex">0</span>     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0</span>
<span id="cb824-12"><a href="#cb824-12" aria-hidden="true" tabindex="-1"></a>         <span class="ex">0</span>     0%   100%  1024.03kB 66.62%  main.init</span>
<span id="cb824-13"><a href="#cb824-13" aria-hidden="true" tabindex="-1"></a>         <span class="ex">0</span>     0%   100%      513kB 33.38%  net/http.<span class="er">(</span><span class="ex">*conn</span><span class="kw">)</span><span class="ex">.readRequest</span></span>
<span id="cb824-14"><a href="#cb824-14" aria-hidden="true" tabindex="-1"></a>         <span class="ex">0</span>     0%   100%      513kB 33.38%  net/http.<span class="er">(</span><span class="ex">*conn</span><span class="kw">)</span><span class="ex">.serve</span></span>
<span id="cb824-15"><a href="#cb824-15" aria-hidden="true" tabindex="-1"></a>         <span class="ex">0</span>     0%   100%  1024.03kB 66.62%  runtime.main</span></code></pre></div>
<h3 id="debugging-go-routine-leaks">Debugging go routine leaks</h3>
<p>Memory leaks are most often caused by go routine leaks keeping memory
alive which should have been garbage collected.</p>
<p>See all active go routines using</p>
<div class="sourceCode" id="cb825"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb825-1"><a href="#cb825-1" aria-hidden="true" tabindex="-1"></a><span class="ex">curl</span> http://localhost:5572/debug/pprof/goroutine<span class="pp">?</span>debug=1</span></code></pre></div>
<p>Or go to <a
href="http://localhost:5572/debug/pprof/goroutine?debug=1"
class="uri">http://localhost:5572/debug/pprof/goroutine?debug=1</a> in
your browser.</p>
<h3 id="other-profiles-to-look-at">Other profiles to look at</h3>
<p>You can see a summary of profiles available at <a
href="http://localhost:5572/debug/pprof/"
class="uri">http://localhost:5572/debug/pprof/</a></p>
<p>Here is how to use some of them:</p>
<ul>
<li>Memory:
<code>go tool pprof http://localhost:5572/debug/pprof/heap</code></li>
<li>Go routines:
<code>curl http://localhost:5572/debug/pprof/goroutine?debug=1</code></li>
<li>30-second CPU profile:
<code>go tool pprof http://localhost:5572/debug/pprof/profile</code></li>
<li>5-second execution trace:
<code>wget http://localhost:5572/debug/pprof/trace?seconds=5</code></li>
<li>Goroutine blocking profile
<ul>
<li>Enable first with:
<code>rclone rc debug/set-block-profile-rate rate=1</code> (<a
href="#debug-set-block-profile-rate">docs</a>)</li>
<li><code>go tool pprof http://localhost:5572/debug/pprof/block</code></li>
</ul></li>
<li>Contended mutexes:
<ul>
<li>Enable first with:
<code>rclone rc debug/set-mutex-profile-fraction rate=1</code> (<a
href="#debug-set-mutex-profile-fraction">docs</a>)</li>
<li><code>go tool pprof http://localhost:5572/debug/pprof/mutex</code></li>
</ul></li>
</ul>
<p>See the <a
href="https://golang.org/pkg/net/http/pprof/">net/http/pprof docs</a>
for more info on how to use the profiling and for a general overview see
<a href="https://blog.golang.org/profiling-go-programs">the Go team's
blog post on profiling go programs</a>.</p>
<p>The profiling hook is <a
href="https://stackoverflow.com/q/26545159/164234">zero overhead unless
it is used</a>.</p>
<h1 id="overview-of-cloud-storage-systems">Overview of cloud storage
systems</h1>
<p>Each cloud storage system is slightly different. Rclone attempts to
provide a unified interface to them, but some underlying differences
show through.</p>
<h2 id="features-1">Features</h2>
<p>Here is an overview of the major features of each cloud storage
system.</p>
<table>
<colgroup>
<col style="width: 25%" />
<col style="width: 16%" />
<col style="width: 8%" />
<col style="width: 16%" />
<col style="width: 15%" />
<col style="width: 9%" />
<col style="width: 8%" />
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
<th style="text-align: center;">Hash</th>
<th style="text-align: center;">ModTime</th>
<th style="text-align: center;">Case Insensitive</th>
<th style="text-align: center;">Duplicate Files</th>
<th style="text-align: center;">MIME Type</th>
<th style="text-align: center;">Metadata</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>1Fichier</td>
<td style="text-align: center;">Whirlpool</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Akamai Netstorage</td>
<td style="text-align: center;">MD5, SHA256</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Amazon S3 (or S3 compatible)</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">RWU</td>
</tr>
<tr class="even">
<td>Backblaze B2</td>
<td style="text-align: center;">SHA1</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Box</td>
<td style="text-align: center;">SHA1</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Citrix ShareFile</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Cloudinary</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Dropbox</td>
<td style="text-align: center;">DBHASH ¹</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Enterprise File Fabric</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>FileLu Cloud Storage</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Files.com</td>
<td style="text-align: center;">MD5, CRC32</td>
<td style="text-align: center;">DR/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>FTP</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R/W ¹⁰</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Gofile</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">DR/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Google Cloud Storage</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Google Drive</td>
<td style="text-align: center;">MD5, SHA1, SHA256</td>
<td style="text-align: center;">DR/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">DRWU</td>
</tr>
<tr class="even">
<td>Google Photos</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>HDFS</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>HiDrive</td>
<td style="text-align: center;">HiDrive ¹²</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>HTTP</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>iCloud Drive</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Internet Archive</td>
<td style="text-align: center;">MD5, SHA1, CRC32</td>
<td style="text-align: center;">R/W ¹¹</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">RWU</td>
</tr>
<tr class="even">
<td>Jottacloud</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">RW</td>
</tr>
<tr class="odd">
<td>Koofr</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Linkbox</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Mail.ru Cloud</td>
<td style="text-align: center;">Mailru ⁶</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Mega</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Memory</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Microsoft Azure Blob Storage</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Microsoft Azure Files Storage</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Microsoft OneDrive</td>
<td style="text-align: center;">QuickXorHash ⁵</td>
<td style="text-align: center;">DR/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">DRW</td>
</tr>
<tr class="odd">
<td>OpenDrive</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Partial ⁸</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>OpenStack Swift</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Oracle Object Storage</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">RU</td>
</tr>
<tr class="even">
<td>pCloud</td>
<td style="text-align: center;">MD5, SHA1 ⁷</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>PikPak</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Pixeldrain</td>
<td style="text-align: center;">SHA256</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">RW</td>
</tr>
<tr class="odd">
<td>premiumize.me</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>put.io</td>
<td style="text-align: center;">CRC-32</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Proton Drive</td>
<td style="text-align: center;">SHA1</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>QingStor</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">- ⁹</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Quatrix by Maytech</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Seafile</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>SFTP</td>
<td style="text-align: center;">MD5, SHA1 ²</td>
<td style="text-align: center;">DR/W</td>
<td style="text-align: center;">Depends</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Sia</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>SMB</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>SugarSync</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Storj</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Uloz.to</td>
<td style="text-align: center;">MD5, SHA256 ¹³</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Uptobox</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>WebDAV</td>
<td style="text-align: center;">MD5, SHA1 ³</td>
<td style="text-align: center;">R ⁴</td>
<td style="text-align: center;">Depends</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Yandex Disk</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Zoho WorkDrive</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>The local filesystem</td>
<td style="text-align: center;">All</td>
<td style="text-align: center;">DR/W</td>
<td style="text-align: center;">Depends</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">DRWU</td>
</tr>
</tbody>
</table>
<p>¹ Dropbox supports <a
href="https://www.dropbox.com/developers/reference/content-hash">its own
custom hash</a>. This is an SHA256 sum of all the 4 MiB block
SHA256s.</p>
<p>² SFTP supports checksums if the same login has shell access and
<code>md5sum</code> or <code>sha1sum</code> as well as <code>echo</code>
are in the remote's PATH.</p>
<p>³ WebDAV supports hashes when used with Fastmail Files, Owncloud and
Nextcloud only.</p>
<p>⁴ WebDAV supports modtimes when used with Fastmail Files, Owncloud
and Nextcloud only.</p>
<p>⁵ <a
href="https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash">QuickXorHash</a>
is Microsoft's own hash.</p>
<p>⁶ Mail.ru uses its own modified SHA1 hash</p>
<p>⁷ pCloud only supports SHA1 (not MD5) in its EU region</p>
<p>⁸ Opendrive does not support creation of duplicate files using their
web client interface or other stock clients, but the underlying storage
platform has been determined to allow duplicate files, and it is
possible to create them with <code>rclone</code>. It may be that this is
a mistake or an unsupported feature.</p>
<p>⁹ QingStor does not support SetModTime for objects bigger than 5
GiB.</p>
<p>¹⁰ FTP supports modtimes for the major FTP servers, and also others
if they advertised required protocol extensions. See <a
href="https://rclone.org/ftp/#modification-times">this</a> for more
details.</p>
<p>¹¹ Internet Archive requires option <code>wait_archive</code> to be
set to a non-zero value for full modtime support.</p>
<p>¹² HiDrive supports <a href="https://static.hidrive.com/dev/0001">its
own custom hash</a>. It combines SHA1 sums for each 4 KiB block
hierarchically to a single top-level sum.</p>
<p>¹³ Uloz.to provides server-calculated MD5 hash upon file upload. MD5
and SHA256 hashes are client-calculated and stored as metadata
fields.</p>
<h3 id="hash">Hash</h3>
<p>The cloud storage system supports various hash types of the objects.
The hashes are used when transferring data as an integrity check and can
be specifically used with the <code>--checksum</code> flag in syncs and
in the <code>check</code> command.</p>
<p>To use the verify checksums when transferring between cloud storage
systems they must support a common hash type.</p>
<h3 id="modtime">ModTime</h3>
<p>Almost all cloud storage systems store some sort of timestamp on
objects, but several of them not something that is appropriate to use
for syncing. E.g. some backends will only write a timestamp that
represents the time of the upload. To be relevant for syncing it should
be able to store the modification time of the source object. If this is
not the case, rclone will only check the file size by default, though
can be configured to check the file hash (with the
<code>--checksum</code> flag). Ideally it should also be possible to
change the timestamp of an existing file without having to re-upload
it.</p>
<table>
<colgroup>
<col style="width: 27%" />
<col style="width: 72%" />
</colgroup>
<thead>
<tr class="header">
<th>Key</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><code>-</code></td>
<td>ModTimes not supported - times likely the upload time</td>
</tr>
<tr class="even">
<td><code>R</code></td>
<td>ModTimes supported on files but can't be changed without
re-upload</td>
</tr>
<tr class="odd">
<td><code>R/W</code></td>
<td>Read and Write ModTimes fully supported on files</td>
</tr>
<tr class="even">
<td><code>DR</code></td>
<td>ModTimes supported on files and directories but can't be changed
without re-upload</td>
</tr>
<tr class="odd">
<td><code>DR/W</code></td>
<td>Read and Write ModTimes fully supported on files and
directories</td>
</tr>
</tbody>
</table>
<p>Storage systems with a <code>-</code> in the ModTime column, means
the modification read on objects is not the modification time of the
file when uploaded. It is most likely the time the file was uploaded, or
possibly something else (like the time the picture was taken in Google
Photos).</p>
<p>Storage systems with a <code>R</code> (for read-only) in the ModTime
column, means the it keeps modification times on objects, and updates
them when uploading objects, but it does not support changing only the
modification time (<code>SetModTime</code> operation) without
re-uploading, possibly not even without deleting existing first. Some
operations in rclone, such as <code>copy</code> and <code>sync</code>
commands, will automatically check for <code>SetModTime</code> support
and re-upload if necessary to keep the modification times in sync. Other
commands will not work without <code>SetModTime</code> support, e.g.
<code>touch</code> command on an existing file will fail, and changes to
modification time only on a files in a <code>mount</code> will be
silently ignored.</p>
<p>Storage systems with <code>R/W</code> (for read/write) in the ModTime
column, means they do also support modtime-only operations.</p>
<p>Storage systems with <code>D</code> in the ModTime column means that
the following symbols apply to directories as well as files.</p>
<h3 id="case-insensitive">Case Insensitive</h3>
<p>If a cloud storage systems is case sensitive then it is possible to
have two files which differ only in case, e.g. <code>file.txt</code> and
<code>FILE.txt</code>. If a cloud storage system is case insensitive
then that isn't possible.</p>
<p>This can cause problems when syncing between a case insensitive
system and a case sensitive system. The symptom of this is that no
matter how many times you run the sync it never completes fully.</p>
<p>The local filesystem and SFTP may or may not be case sensitive
depending on OS.</p>
<ul>
<li>Windows - usually case insensitive, though case is preserved</li>
<li>OSX - usually case insensitive, though it is possible to format case
sensitive</li>
<li>Linux - usually case sensitive, but there are case insensitive file
systems (e.g. FAT formatted USB keys)</li>
</ul>
<p>Most of the time this doesn't cause any problems as people tend to
avoid files whose name differs only by case even on case sensitive
systems.</p>
<h3 id="duplicate-files">Duplicate files</h3>
<p>If a cloud storage system allows duplicate files then it can have two
objects with the same name.</p>
<p>This confuses rclone greatly when syncing - use the
<code>rclone dedupe</code> command to rename or remove duplicates.</p>
<h3 id="restricted-filenames">Restricted filenames</h3>
<p>Some cloud storage systems might have restrictions on the characters
that are usable in file or directory names. When <code>rclone</code>
detects such a name during a file upload, it will transparently replace
the restricted characters with similar looking Unicode characters. To
handle the different sets of restricted characters for different
backends, rclone uses something it calls <a
href="#encoding">encoding</a>.</p>
<p>This process is designed to avoid ambiguous file names as much as
possible and allow to move files between many cloud storage systems
transparently.</p>
<p>The name shown by <code>rclone</code> to the user or during log
output will only contain a minimal set of <a
href="#restricted-characters">replaced characters</a> to ensure correct
formatting and not necessarily the actual name used on the cloud
storage.</p>
<p>This transformation is reversed when downloading a file or parsing
<code>rclone</code> arguments. For example, when uploading a file named
<code>my file?.txt</code> to Onedrive, it will be displayed as
<code>my file?.txt</code> on the console, but stored as
<code>my file？.txt</code> to Onedrive (the <code>?</code> gets replaced
by the similar looking <code>？</code> character, the so-called
"fullwidth question mark"). The reverse transformation allows to read a
file <code>unusual/name.txt</code> from Google Drive, by passing the
name <code>unusual／name.txt</code> on the command line (the
<code>/</code> needs to be replaced by the similar looking
<code>／</code> character).</p>
<h4 id="restricted-filenames-caveats">Caveats</h4>
<p>The filename encoding system works well in most cases, at least where
file names are written in English or similar languages. You might not
even notice it: It just works. In some cases it may lead to issues,
though. E.g. when file names are written in Chinese, or Japanese, where
it is always the Unicode fullwidth variants of the punctuation marks
that are used.</p>
<p>On Windows, the characters <code>:</code>, <code>*</code> and
<code>?</code> are examples of restricted characters. If these are used
in filenames on a remote that supports it, Rclone will transparently
convert them to their fullwidth Unicode variants <code>＊</code>,
<code>？</code> and <code>：</code> when downloading to Windows, and
back again when uploading. This way files with names that are not
allowed on Windows can still be stored.</p>
<p>However, if you have files on your Windows system originally with
these same Unicode characters in their names, they will be included in
the same conversion process. E.g. if you create a file in your Windows
filesystem with name <code>Test：1.jpg</code>, where <code>：</code> is
the Unicode fullwidth colon symbol, and use rclone to upload it to
Google Drive, which supports regular <code>:</code> (halfwidth question
mark), rclone will replace the fullwidth <code>:</code> with the
halfwidth <code>:</code> and store the file as <code>Test:1.jpg</code>
in Google Drive. Since both Windows and Google Drive allows the name
<code>Test：1.jpg</code>, it would probably be better if rclone just
kept the name as is in this case.</p>
<p>With the opposite situation; if you have a file named
<code>Test:1.jpg</code>, in your Google Drive, e.g. uploaded from a
Linux system where <code>:</code> is valid in file names. Then later use
rclone to copy this file to your Windows computer you will notice that
on your local disk it gets renamed to <code>Test：1.jpg</code>. The
original filename is not legal on Windows, due to the <code>:</code>,
and rclone therefore renames it to make the copy possible. That is all
good. However, this can also lead to an issue: If you already had a
<em>different</em> file named <code>Test：1.jpg</code> on Windows, and
then use rclone to copy either way. Rclone will then treat the file
originally named <code>Test:1.jpg</code> on Google Drive and the file
originally named <code>Test：1.jpg</code> on Windows as the same file,
and replace the contents from one with the other.</p>
<p>Its virtually impossible to handle all cases like these correctly in
all situations, but by customizing the <a href="#encoding">encoding
option</a>, changing the set of characters that rclone should convert,
you should be able to create a configuration that works well for your
specific situation. See also the <a
href="https://rclone.org/overview/#encoding-example-windows">example</a>
below.</p>
<p>(Windows was used as an example of a file system with many restricted
characters, and Google drive a storage system with few.)</p>
<h4 id="restricted-characters">Default restricted characters</h4>
<p>The table below shows the characters that are replaced by
default.</p>
<p>When a replacement character is found in a filename, this character
will be escaped with the <code>‛</code> character to avoid ambiguous
file names. (e.g. a file named <code>␀.txt</code> would shown as
<code>‛␀.txt</code>)</p>
<p>Each cloud storage backend can use a different set of characters,
which will be specified in the documentation for each backend.</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>NUL</td>
<td style="text-align: center;">0x00</td>
<td style="text-align: center;">␀</td>
</tr>
<tr class="even">
<td>SOH</td>
<td style="text-align: center;">0x01</td>
<td style="text-align: center;">␁</td>
</tr>
<tr class="odd">
<td>STX</td>
<td style="text-align: center;">0x02</td>
<td style="text-align: center;">␂</td>
</tr>
<tr class="even">
<td>ETX</td>
<td style="text-align: center;">0x03</td>
<td style="text-align: center;">␃</td>
</tr>
<tr class="odd">
<td>EOT</td>
<td style="text-align: center;">0x04</td>
<td style="text-align: center;">␄</td>
</tr>
<tr class="even">
<td>ENQ</td>
<td style="text-align: center;">0x05</td>
<td style="text-align: center;">␅</td>
</tr>
<tr class="odd">
<td>ACK</td>
<td style="text-align: center;">0x06</td>
<td style="text-align: center;">␆</td>
</tr>
<tr class="even">
<td>BEL</td>
<td style="text-align: center;">0x07</td>
<td style="text-align: center;">␇</td>
</tr>
<tr class="odd">
<td>BS</td>
<td style="text-align: center;">0x08</td>
<td style="text-align: center;">␈</td>
</tr>
<tr class="even">
<td>HT</td>
<td style="text-align: center;">0x09</td>
<td style="text-align: center;">␉</td>
</tr>
<tr class="odd">
<td>LF</td>
<td style="text-align: center;">0x0A</td>
<td style="text-align: center;">␊</td>
</tr>
<tr class="even">
<td>VT</td>
<td style="text-align: center;">0x0B</td>
<td style="text-align: center;">␋</td>
</tr>
<tr class="odd">
<td>FF</td>
<td style="text-align: center;">0x0C</td>
<td style="text-align: center;">␌</td>
</tr>
<tr class="even">
<td>CR</td>
<td style="text-align: center;">0x0D</td>
<td style="text-align: center;">␍</td>
</tr>
<tr class="odd">
<td>SO</td>
<td style="text-align: center;">0x0E</td>
<td style="text-align: center;">␎</td>
</tr>
<tr class="even">
<td>SI</td>
<td style="text-align: center;">0x0F</td>
<td style="text-align: center;">␏</td>
</tr>
<tr class="odd">
<td>DLE</td>
<td style="text-align: center;">0x10</td>
<td style="text-align: center;">␐</td>
</tr>
<tr class="even">
<td>DC1</td>
<td style="text-align: center;">0x11</td>
<td style="text-align: center;">␑</td>
</tr>
<tr class="odd">
<td>DC2</td>
<td style="text-align: center;">0x12</td>
<td style="text-align: center;">␒</td>
</tr>
<tr class="even">
<td>DC3</td>
<td style="text-align: center;">0x13</td>
<td style="text-align: center;">␓</td>
</tr>
<tr class="odd">
<td>DC4</td>
<td style="text-align: center;">0x14</td>
<td style="text-align: center;">␔</td>
</tr>
<tr class="even">
<td>NAK</td>
<td style="text-align: center;">0x15</td>
<td style="text-align: center;">␕</td>
</tr>
<tr class="odd">
<td>SYN</td>
<td style="text-align: center;">0x16</td>
<td style="text-align: center;">␖</td>
</tr>
<tr class="even">
<td>ETB</td>
<td style="text-align: center;">0x17</td>
<td style="text-align: center;">␗</td>
</tr>
<tr class="odd">
<td>CAN</td>
<td style="text-align: center;">0x18</td>
<td style="text-align: center;">␘</td>
</tr>
<tr class="even">
<td>EM</td>
<td style="text-align: center;">0x19</td>
<td style="text-align: center;">␙</td>
</tr>
<tr class="odd">
<td>SUB</td>
<td style="text-align: center;">0x1A</td>
<td style="text-align: center;">␚</td>
</tr>
<tr class="even">
<td>ESC</td>
<td style="text-align: center;">0x1B</td>
<td style="text-align: center;">␛</td>
</tr>
<tr class="odd">
<td>FS</td>
<td style="text-align: center;">0x1C</td>
<td style="text-align: center;">␜</td>
</tr>
<tr class="even">
<td>GS</td>
<td style="text-align: center;">0x1D</td>
<td style="text-align: center;">␝</td>
</tr>
<tr class="odd">
<td>RS</td>
<td style="text-align: center;">0x1E</td>
<td style="text-align: center;">␞</td>
</tr>
<tr class="even">
<td>US</td>
<td style="text-align: center;">0x1F</td>
<td style="text-align: center;">␟</td>
</tr>
<tr class="odd">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
<tr class="even">
<td>DEL</td>
<td style="text-align: center;">0x7F</td>
<td style="text-align: center;">␡</td>
</tr>
</tbody>
</table>
<p>The default encoding will also encode these file names as they are
problematic with many cloud storage systems.</p>
<table>
<thead>
<tr class="header">
<th>File name</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>.</td>
<td style="text-align: center;">．</td>
</tr>
<tr class="even">
<td>..</td>
<td style="text-align: center;">．．</td>
</tr>
</tbody>
</table>
<h4 id="invalid-utf8">Invalid UTF-8 bytes</h4>
<p>Some backends only support a sequence of well formed UTF-8 bytes as
file or directory names.</p>
<p>In this case all invalid UTF-8 bytes will be replaced with a quoted
representation of the byte value to allow uploading a file to such a
backend. For example, the invalid byte <code>0xFE</code> will be encoded
as <code>‛FE</code>.</p>
<p>A common source of invalid UTF-8 bytes are local filesystems, that
store names in a different encoding than UTF-8 or UTF-16, like latin1.
See the <a href="https://rclone.org/local/#filenames">local
filenames</a> section for details.</p>
<h4 id="encoding">Encoding option</h4>
<p>Most backends have an encoding option, specified as a flag
<code>--backend-encoding</code> where <code>backend</code> is the name
of the backend, or as a config parameter <code>encoding</code> (you'll
need to select the Advanced config in <code>rclone config</code> to see
it).</p>
<p>This will have default value which encodes and decodes characters in
such a way as to preserve the maximum number of characters (see
above).</p>
<p>However this can be incorrect in some scenarios, for example if you
have a Windows file system with Unicode fullwidth characters
<code>＊</code>, <code>？</code> or <code>：</code>, that you want to
remain as those characters on the remote rather than being translated to
regular (halfwidth) <code>*</code>, <code>?</code> and
<code>:</code>.</p>
<p>The <code>--backend-encoding</code> flags allow you to change that.
You can disable the encoding completely with
<code>--backend-encoding Raw</code> or set <code>encoding = Raw</code>
in the config file.</p>
<p>Encoding takes a comma separated list of encodings. You can see the
list of all possible values by passing an invalid value to this flag,
e.g. <code>--local-encoding "help"</code>. The command
<code>rclone help flags encoding</code> will show you the defaults for
the backends.</p>
<table>
<colgroup>
<col style="width: 31%" />
<col style="width: 34%" />
<col style="width: 34%" />
</colgroup>
<thead>
<tr class="header">
<th>Encoding</th>
<th>Characters</th>
<th>Encoded as</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Asterisk</td>
<td><code>*</code></td>
<td><code>＊</code></td>
</tr>
<tr class="even">
<td>BackQuote</td>
<td><code>`</code></td>
<td><code>｀</code></td>
</tr>
<tr class="odd">
<td>BackSlash</td>
<td><code>\</code></td>
<td><code>＼</code></td>
</tr>
<tr class="even">
<td>Colon</td>
<td><code>:</code></td>
<td><code>：</code></td>
</tr>
<tr class="odd">
<td>CrLf</td>
<td>CR 0x0D, LF 0x0A</td>
<td><code>␍</code>, <code>␊</code></td>
</tr>
<tr class="even">
<td>Ctl</td>
<td>All control characters 0x00-0x1F</td>
<td><code>␀␁␂␃␄␅␆␇␈␉␊␋␌␍␎␏␐␑␒␓␔␕␖␗␘␙␚␛␜␝␞␟</code></td>
</tr>
<tr class="odd">
<td>Del</td>
<td>DEL 0x7F</td>
<td><code>␡</code></td>
</tr>
<tr class="even">
<td>Dollar</td>
<td><code>$</code></td>
<td><code>＄</code></td>
</tr>
<tr class="odd">
<td>Dot</td>
<td><code>.</code> or <code>..</code> as entire string</td>
<td><code>．</code>, <code>．．</code></td>
</tr>
<tr class="even">
<td>DoubleQuote</td>
<td><code>"</code></td>
<td><code>＂</code></td>
</tr>
<tr class="odd">
<td>Exclamation</td>
<td><code>!</code></td>
<td><code>！</code></td>
</tr>
<tr class="even">
<td>Hash</td>
<td><code>#</code></td>
<td><code>＃</code></td>
</tr>
<tr class="odd">
<td>InvalidUtf8</td>
<td>An invalid UTF-8 character (e.g. latin1)</td>
<td><code>�</code></td>
</tr>
<tr class="even">
<td>LeftCrLfHtVt</td>
<td>CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the left of a string</td>
<td><code>␍</code>, <code>␊</code>, <code>␉</code>, <code>␋</code></td>
</tr>
<tr class="odd">
<td>LeftPeriod</td>
<td><code>.</code> on the left of a string</td>
<td><code>.</code></td>
</tr>
<tr class="even">
<td>LeftSpace</td>
<td>SPACE on the left of a string</td>
<td><code>␠</code></td>
</tr>
<tr class="odd">
<td>LeftTilde</td>
<td><code>~</code> on the left of a string</td>
<td><code>～</code></td>
</tr>
<tr class="even">
<td>LtGt</td>
<td><code>&lt;</code>, <code>&gt;</code></td>
<td><code>＜</code>, <code>＞</code></td>
</tr>
<tr class="odd">
<td>None ¹</td>
<td>NUL 0x00</td>
<td>␀</td>
</tr>
<tr class="even">
<td>Percent</td>
<td><code>%</code></td>
<td><code>％</code></td>
</tr>
<tr class="odd">
<td>Pipe</td>
<td>|</td>
<td><code>｜</code></td>
</tr>
<tr class="even">
<td>Question</td>
<td><code>?</code></td>
<td><code>？</code></td>
</tr>
<tr class="odd">
<td>RightCrLfHtVt</td>
<td>CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string</td>
<td><code>␍</code>, <code>␊</code>, <code>␉</code>, <code>␋</code></td>
</tr>
<tr class="even">
<td>RightPeriod</td>
<td><code>.</code> on the right of a string</td>
<td><code>.</code></td>
</tr>
<tr class="odd">
<td>RightSpace</td>
<td>SPACE on the right of a string</td>
<td><code>␠</code></td>
</tr>
<tr class="even">
<td>Semicolon</td>
<td><code>;</code></td>
<td><code>；</code></td>
</tr>
<tr class="odd">
<td>SingleQuote</td>
<td><code>'</code></td>
<td><code>＇</code></td>
</tr>
<tr class="even">
<td>Slash</td>
<td><code>/</code></td>
<td><code>／</code></td>
</tr>
<tr class="odd">
<td>SquareBracket</td>
<td><code>[</code>, <code>]</code></td>
<td><code>［</code>, <code>］</code></td>
</tr>
</tbody>
</table>
<p>¹ Encoding from NUL 0x00 to ␀ is always implicit except when using
Raw. It was previously incorrectly documented as disabling encoding, and
to maintain backward compatibility, its behavior has not been
changed.</p>
<h5 id="encoding-example-ftp">Encoding example: FTP</h5>
<p>To take a specific example, the FTP backend's default encoding is</p>
<div class="sourceCode" id="cb826"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb826-1"><a href="#cb826-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--ftp-encoding</span> <span class="st">&quot;Slash,Del,Ctl,RightSpace,Dot&quot;</span></span></code></pre></div>
<p>However, let's say the FTP server is running on Windows and can't
have any of the invalid Windows characters in file names. You are
backing up Linux servers to this FTP server which do have those
characters in file names. So you would add the Windows set which are</p>
<pre class="text"><code>Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot</code></pre>
<p>to the existing ones, giving:</p>
<pre class="text"><code>Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace</code></pre>
<p>This can be specified using the <code>--ftp-encoding</code> flag or
using an <code>encoding</code> parameter in the config file.</p>
<h5 id="encoding-example-windows">Encoding example: Windows</h5>
<p>As a nother example, take a Windows system where there is a file with
name <code>Test：1.jpg</code>, where <code>：</code> is the Unicode
fullwidth colon symbol. When using rclone to copy this to a remote which
supports <code>:</code>, the regular (halfwidth) colon (such as Google
Drive), you will notice that the file gets renamed to
<code>Test:1.jpg</code>.</p>
<p>To avoid this you can change the set of characters rclone should
convert for the local filesystem, using command-line argument
<code>--local-encoding</code>. Rclone's default behavior on Windows
corresponds to</p>
<div class="sourceCode" id="cb829"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb829-1"><a href="#cb829-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--local-encoding</span> <span class="st">&quot;Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot&quot;</span></span></code></pre></div>
<p>If you want to use fullwidth characters <code>：</code>,
<code>＊</code> and <code>？</code> in your filenames without rclone
changing them when uploading to a remote, then set the same as the
default value but without <code>Colon,Question,Asterisk</code>:</p>
<div class="sourceCode" id="cb830"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb830-1"><a href="#cb830-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--local-encoding</span> <span class="st">&quot;Slash,LtGt,DoubleQuote,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot&quot;</span></span></code></pre></div>
<p>Alternatively, you can disable the conversion of any characters with
<code>--local-encoding Raw</code>.</p>
<p>Instead of using command-line argument <code>--local-encoding</code>,
you may also set it as <a
href="https://rclone.org/docs/#environment-variables">environment
variable</a> <code>RCLONE_LOCAL_ENCODING</code>, or <a
href="https://rclone.org/docs/#configure">configure</a> a remote of type
<code>local</code> in your config, and set the <code>encoding</code>
option there.</p>
<p>The risk by doing this is that if you have a filename with the
regular (halfwidth) <code>:</code>, <code>*</code> and <code>?</code> in
your cloud storage, and you try to download it to your Windows
filesystem, this will fail. These characters are not valid in filenames
on Windows, and you have told rclone not to work around this by
converting them to valid fullwidth variants.</p>
<h3 id="mime-type">MIME Type</h3>
<p>MIME types (also known as media types) classify types of documents
using a simple text classification, e.g. <code>text/html</code> or
<code>application/pdf</code>.</p>
<p>Some cloud storage systems support reading (<code>R</code>) the MIME
type of objects and some support writing (<code>W</code>) the MIME type
of objects.</p>
<p>The MIME type can be important if you are serving files directly to
HTTP from the storage system.</p>
<p>If you are copying from a remote which supports reading
(<code>R</code>) to a remote which supports writing (<code>W</code>)
then rclone will preserve the MIME types. Otherwise they will be guessed
from the extension, or the remote itself may assign the MIME type.</p>
<h3 id="metadata-1">Metadata</h3>
<p>Backends may or may support reading or writing metadata. They may
support reading and writing system metadata (metadata intrinsic to that
backend) and/or user metadata (general purpose metadata).</p>
<p>The levels of metadata support are</p>
<table>
<colgroup>
<col style="width: 27%" />
<col style="width: 72%" />
</colgroup>
<thead>
<tr class="header">
<th>Key</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><code>R</code></td>
<td>Read only System Metadata on files only</td>
</tr>
<tr class="even">
<td><code>RW</code></td>
<td>Read and write System Metadata on files only</td>
</tr>
<tr class="odd">
<td><code>RWU</code></td>
<td>Read and write System Metadata and read and write User Metadata on
files only</td>
</tr>
<tr class="even">
<td><code>DR</code></td>
<td>Read only System Metadata on files and directories</td>
</tr>
<tr class="odd">
<td><code>DRW</code></td>
<td>Read and write System Metadata on files and directories</td>
</tr>
<tr class="even">
<td><code>DRWU</code></td>
<td>Read and write System Metadata and read and write User Metadata on
files and directories</td>
</tr>
</tbody>
</table>
<p>See <a href="https://rclone.org/docs/#metadata">the metadata docs</a>
for more info.</p>
<h2 id="optional-features">Optional Features</h2>
<p>All rclone remotes support a base command set. Other features depend
upon backend-specific capabilities.</p>
<table style="width:100%;">
<colgroup>
<col style="width: 20%" />
<col style="width: 5%" />
<col style="width: 4%" />
<col style="width: 4%" />
<col style="width: 6%" />
<col style="width: 6%" />
<col style="width: 5%" />
<col style="width: 10%" />
<col style="width: 13%" />
<col style="width: 10%" />
<col style="width: 5%" />
<col style="width: 7%" />
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
<th style="text-align: center;">Purge</th>
<th style="text-align: center;">Copy</th>
<th style="text-align: center;">Move</th>
<th style="text-align: center;">DirMove</th>
<th style="text-align: center;">CleanUp</th>
<th style="text-align: center;">ListR</th>
<th style="text-align: center;">StreamUpload</th>
<th style="text-align: left;">MultithreadUpload</th>
<th style="text-align: center;">LinkSharing</th>
<th style="text-align: center;">About</th>
<th style="text-align: center;">EmptyDir</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>1Fichier</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Akamai Netstorage</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Amazon S3 (or S3 compatible)</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>Backblaze B2</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="odd">
<td>Box</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Citrix ShareFile</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Dropbox</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Cloudinary</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="odd">
<td>Enterprise File Fabric</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Files.com</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>FTP</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Gofile</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Google Cloud Storage</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>Google Drive</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Google Photos</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>HDFS</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>HiDrive</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>HTTP</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>iCloud Drive</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>ImageKit</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Internet Archive</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>Jottacloud</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Koofr</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Mail.ru Cloud</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Mega</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Memory</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="odd">
<td>Microsoft Azure Blob Storage</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>Microsoft Azure Files Storage</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Microsoft OneDrive</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes ⁵</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>OpenDrive</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>OpenStack Swift</td>
<td style="text-align: center;">Yes ¹</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>Oracle Object Storage</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="odd">
<td>pCloud</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>PikPak</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Pixeldrain</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>premiumize.me</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>put.io</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Proton Drive</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>QingStor</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>Quatrix by Maytech</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Seafile</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>SFTP</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes ⁴</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Sia</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>SMB</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>SugarSync</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Storj</td>
<td style="text-align: center;">Yes ²</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="odd">
<td>Uloz.to</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Uptobox</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="odd">
<td>WebDAV</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes ³</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Yandex Disk</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Zoho WorkDrive</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: left;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>The local filesystem</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
</tbody>
</table>
<p>¹ Note Swift implements this in order to delete directory markers but
it doesn't actually have a quicker way of deleting files other than
deleting them individually.</p>
<p>² Storj implements this efficiently only for entire buckets. If
purging a directory inside a bucket, files are deleted individually.</p>
<p>³ StreamUpload is not supported with Nextcloud</p>
<p>⁴ Use the <code>--sftp-copy-is-hardlink</code> flag to enable.</p>
<p>⁵ Use the <code>--onedrive-delta</code> flag to enable.</p>
<h3 id="purge">Purge</h3>
<p>This deletes a directory quicker than just deleting all the files in
the directory.</p>
<h3 id="copy">Copy</h3>
<p>Used when copying an object to and from the same remote. This known
as a server-side copy so you can copy a file without downloading it and
uploading it again. It is used if you use <code>rclone copy</code> or
<code>rclone move</code> if the remote doesn't support <code>Move</code>
directly.</p>
<p>If the server doesn't support <code>Copy</code> directly then for
copy operations the file is downloaded then re-uploaded.</p>
<h3 id="move">Move</h3>
<p>Used when moving/renaming an object on the same remote. This is known
as a server-side move of a file. This is used in
<code>rclone move</code> if the server doesn't support
<code>DirMove</code>.</p>
<p>If the server isn't capable of <code>Move</code> then rclone
simulates it with <code>Copy</code> then delete. If the server doesn't
support <code>Copy</code> then rclone will download the file and
re-upload it.</p>
<h3 id="dirmove">DirMove</h3>
<p>This is used to implement <code>rclone move</code> to move a
directory if possible. If it isn't then it will use <code>Move</code> on
each file (which falls back to <code>Copy</code> then download and
upload - see <code>Move</code> section).</p>
<h3 id="cleanup">CleanUp</h3>
<p>This is used for emptying the trash for a remote by
<code>rclone cleanup</code>.</p>
<p>If the server can't do <code>CleanUp</code> then
<code>rclone cleanup</code> will return an error.</p>
<p>‡‡ Note that while Box implements this it has to delete every file
individually so it will be slower than emptying the trash via the
WebUI</p>
<h3 id="listr">ListR</h3>
<p>The remote supports a recursive list to list all the contents beneath
a directory quickly. This enables the <code>--fast-list</code> flag to
work. See the <a href="https://rclone.org/docs/#fast-list">rclone
docs</a> for more details.</p>
<h3 id="streamupload">StreamUpload</h3>
<p>Some remotes allow files to be uploaded without knowing the file size
in advance. This allows certain operations to work without spooling the
file to local disk first, e.g. <code>rclone rcat</code>.</p>
<h3 id="multithreadupload">MultithreadUpload</h3>
<p>Some remotes allow transfers to the remote to be sent as chunks in
parallel. If this is supported then rclone will use multi-thread copying
to transfer files much faster.</p>
<h3 id="linksharing">LinkSharing</h3>
<p>Sets the necessary permissions on a file or folder and prints a link
that allows others to access them, even if they don't have an account on
the particular cloud provider.</p>
<h3 id="about-1">About</h3>
<p>Rclone <code>about</code> prints quota information for a remote.
Typical output includes bytes used, free, quota and in trash.</p>
<p>If a remote lacks about capability
<code>rclone about remote:</code>returns an error.</p>
<p>Backends without about capability cannot determine free space for an
rclone mount, or use policy <code>mfs</code> (most free space) as a
member of an rclone union remote.</p>
<p>See <a href="https://rclone.org/commands/rclone_about/">rclone about
command</a></p>
<h3 id="emptydir">EmptyDir</h3>
<p>The remote supports empty directories. See <a
href="https://rclone.org/bugs/#limitations">Limitations</a> for details.
Most Object/Bucket-based remotes do not support this.</p>
<h1 id="global-flags">Global Flags</h1>
<p>This describes the global flags available to every rclone command
split into groups.</p>
<h2 id="copy-1">Copy</h2>
<p>Flags for anything which can copy a file.</p>
<pre><code>      --check-first                                 Do all the checks before starting transfers
  -c, --checksum                                    Check for changes with size &amp; checksum (if available, or fallback to size only)
      --compare-dest stringArray                    Include additional server-side paths during comparison
      --copy-dest stringArray                       Implies --compare-dest but also copies files from paths into destination
      --cutoff-mode HARD|SOFT|CAUTIOUS              Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
      --ignore-case-sync                            Ignore case when synchronizing
      --ignore-checksum                             Skip post copy check of checksums
      --ignore-existing                             Skip all files that exist on destination
      --ignore-size                                 Ignore size when skipping use modtime or checksum
  -I, --ignore-times                                Don&#39;t skip items that match size and time - transfer all unconditionally
      --immutable                                   Do not modify files, fail if existing files have been modified
      --inplace                                     Download directly to destination file instead of atomic download to temp/rename
  -l, --links                                       Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension
      --max-backlog int                             Maximum number of objects in sync or check backlog (default 10000)
      --max-duration Duration                       Maximum duration rclone will transfer data for (default 0s)
      --max-transfer SizeSuffix                     Maximum size of data to transfer (default off)
  -M, --metadata                                    If set, preserve metadata when copying objects
      --modify-window Duration                      Max time diff to be considered the same (default 1ns)
      --multi-thread-chunk-size SizeSuffix          Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi)
      --multi-thread-cutoff SizeSuffix              Use multi-thread downloads for files above this size (default 256Mi)
      --multi-thread-streams int                    Number of streams to use for multi-thread downloads (default 4)
      --multi-thread-write-buffer-size SizeSuffix   In memory buffer size for writing when in multi-thread mode (default 128Ki)
      --name-transform stringArray                  Transform paths during the copy process
      --no-check-dest                               Don&#39;t check the destination, copy regardless
      --no-traverse                                 Don&#39;t traverse destination file system on copy
      --no-update-dir-modtime                       Don&#39;t update directory modification times
      --no-update-modtime                           Don&#39;t update destination modtime if files identical
      --order-by string                             Instructions on how to order the transfers, e.g. &#39;size,descending&#39;
      --partial-suffix string                       Add partial-suffix to temporary file name when --inplace is not used (default &quot;.partial&quot;)
      --refresh-times                               Refresh the modtime of remote files
      --server-side-across-configs                  Allow server-side operations (e.g. copy) to work across different configs
      --size-only                                   Skip based on size only, not modtime or checksum
      --streaming-upload-cutoff SizeSuffix          Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki)
  -u, --update                                      Skip files that are newer on the destination</code></pre>
<h2 id="sync">Sync</h2>
<p>Flags used for sync commands.</p>
<pre><code>      --backup-dir string               Make backups into hierarchy based in DIR
      --delete-after                    When synchronizing, delete files on destination after transferring (default)
      --delete-before                   When synchronizing, delete files on destination before transferring
      --delete-during                   When synchronizing, delete files during transfer
      --fix-case                        Force rename of case insensitive dest to match source
      --ignore-errors                   Delete even if there are I/O errors
      --list-cutoff int                 To save memory, sort directory listings on disk above this threshold (default 1000000)
      --max-delete int                  When synchronizing, limit the number of deletes (default -1)
      --max-delete-size SizeSuffix      When synchronizing, limit the total size of deletes (default off)
      --suffix string                   Suffix to add to changed files
      --suffix-keep-extension           Preserve the extension when using --suffix
      --track-renames                   When synchronizing, track file renames and do a server-side move if possible
      --track-renames-strategy string   Strategies to use when synchronizing using track-renames hash|modtime|leaf (default &quot;hash&quot;)</code></pre>
<h2 id="important">Important</h2>
<p>Important flags useful for most commands.</p>
<pre><code>  -n, --dry-run         Do a trial run with no permanent changes
  -i, --interactive     Enable interactive mode
  -v, --verbose count   Print lots more stuff (repeat for more)</code></pre>
<h2 id="check">Check</h2>
<p>Flags used for check commands.</p>
<pre><code>      --max-backlog int   Maximum number of objects in sync or check backlog (default 10000)</code></pre>
<h2 id="networking">Networking</h2>
<p>Flags for general networking and HTTP stuff.</p>
<pre><code>      --bind string                        Local address to bind to for outgoing connections, IPv4, IPv6 or name
      --bwlimit BwTimetable                Bandwidth limit in KiB/s, or use suffix B|K|M|G|T|P or a full timetable
      --bwlimit-file BwTimetable           Bandwidth limit per file in KiB/s, or use suffix B|K|M|G|T|P or a full timetable
      --ca-cert stringArray                CA certificate used to verify servers
      --client-cert string                 Client SSL certificate (PEM) for mutual TLS auth
      --client-key string                  Client SSL private key (PEM) for mutual TLS auth
      --client-pass string                 Password for client SSL private key (PEM) for mutual TLS auth (obscured) (obscured)
      --contimeout Duration                Connect timeout (default 1m0s)
      --disable-http-keep-alives           Disable HTTP keep-alives and use each connection once
      --disable-http2                      Disable HTTP/2 in the global transport
      --dscp string                        Set DSCP value to connections, value or name, e.g. CS1, LE, DF, AF21
      --expect-continue-timeout Duration   Timeout when using expect / 100-continue in HTTP (default 1s)
      --header stringArray                 Set HTTP header for all transactions
      --header-download stringArray        Set HTTP header for download transactions
      --header-upload stringArray          Set HTTP header for upload transactions
      --http-proxy string                  HTTP proxy URL
      --max-connections int                Maximum number of simultaneous backend API connections, 0 for unlimited
      --no-check-certificate               Do not verify the server SSL certificate (insecure)
      --no-gzip-encoding                   Don&#39;t set Accept-Encoding: gzip
      --timeout Duration                   IO idle timeout (default 5m0s)
      --tpslimit float                     Limit HTTP transactions per second to this
      --tpslimit-burst int                 Max burst of transactions for --tpslimit (default 1)
      --use-cookies                        Enable session cookiejar
      --user-agent string                  Set the user-agent to a specified string (default &quot;rclone/v1.71.2&quot;)</code></pre>
<h2 id="performance">Performance</h2>
<p>Flags helpful for increasing performance.</p>
<pre><code>      --buffer-size SizeSuffix   In memory buffer size when reading files for each --transfer (default 16Mi)
      --checkers int             Number of checkers to run in parallel (default 8)
      --transfers int            Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="config">Config</h2>
<p>Flags for general configuration of rclone.</p>
<pre><code>      --ask-password                        Allow prompt for password for encrypted configuration (default true)
      --auto-confirm                        If enabled, do not request console confirmation
      --cache-dir string                    Directory rclone will use for caching (default &quot;$HOME/.cache/rclone&quot;)
      --color AUTO|NEVER|ALWAYS             When to show colors (and other ANSI codes) AUTO|NEVER|ALWAYS (default AUTO)
      --config string                       Config file (default &quot;$HOME/.config/rclone/rclone.conf&quot;)
      --default-time Time                   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --disable string                      Disable a comma separated list of features (use --disable help to see a list)
  -n, --dry-run                             Do a trial run with no permanent changes
      --error-on-no-transfer                Sets exit code 9 if no files are transferred, useful in scripts
      --fs-cache-expire-duration Duration   Cache remotes for this long (0 to disable caching) (default 5m0s)
      --fs-cache-expire-interval Duration   Interval to check for expired remotes (default 1m0s)
      --human-readable                      Print numbers in a human-readable format, sizes with suffix Ki|Mi|Gi|Ti|Pi
  -i, --interactive                         Enable interactive mode
      --kv-lock-time Duration               Maximum time to keep key-value database locked by process (default 1s)
      --low-level-retries int               Number of low level retries to do (default 10)
      --max-buffer-memory SizeSuffix        If set, don&#39;t allocate more than this amount of memory as buffers (default off)
      --no-console                          Hide console window (supported on Windows only)
      --no-unicode-normalization            Don&#39;t normalize unicode characters in filenames
      --password-command SpaceSepList       Command for supplying password for encrypted configuration
      --retries int                         Retry operations this many times if they fail (default 3)
      --retries-sleep Duration              Interval between retrying operations if they fail, e.g. 500ms, 60s, 5m (0 to disable) (default 0s)
      --temp-dir string                     Directory rclone will use for temporary files (default &quot;/tmp&quot;)
      --use-mmap                            Use mmap allocator (see docs)
      --use-server-modtime                  Use server modified time instead of object metadata</code></pre>
<h2 id="debugging">Debugging</h2>
<p>Flags for developers.</p>
<pre><code>      --cpuprofile string   Write cpu profile to file
      --dump DumpFlags      List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper
      --dump-bodies         Dump HTTP headers and bodies - may contain sensitive info
      --dump-headers        Dump HTTP headers - may contain sensitive info
      --memprofile string   Write memory profile to file</code></pre>
<h2 id="filter">Filter</h2>
<p>Flags for filtering directory listings.</p>
<pre><code>      --delete-excluded                     Delete files on dest excluded from sync
      --exclude stringArray                 Exclude files matching pattern
      --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray      Exclude directories if filename is present
      --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                  Add a file filtering rule
      --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
      --hash-filter string                  Partition filenames by hash k/n or randomly @/n
      --ignore-case                         Ignore case in filters (case insensitive)
      --include stringArray                 Include files matching pattern
      --include-from stringArray            Read file include patterns from file (use - to read from stdin)
      --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-depth int                       If set limits the recursion depth to this (default -1)
      --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
<h2 id="listing">Listing</h2>
<p>Flags for listing directories.</p>
<pre><code>      --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
      --fast-list           Use recursive list if available; uses more memory but fewer transactions</code></pre>
<h2 id="logging-1">Logging</h2>
<p>Flags for logging and statistics.</p>
<pre><code>      --log-file string                     Log everything to this file
      --log-file-compress                   If set, compress rotated log files using gzip
      --log-file-max-age Duration           Maximum duration to retain old log files (eg &quot;7d&quot;) (default 0s)
      --log-file-max-backups int            Maximum number of old log files to retain
      --log-file-max-size SizeSuffix        Maximum size of the log file before it&#39;s rotated (eg &quot;10M&quot;) (default off)
      --log-format Bits                     Comma separated list of log format options (default date,time)
      --log-level LogLevel                  Log level DEBUG|INFO|NOTICE|ERROR (default NOTICE)
      --log-systemd                         Activate systemd integration for the logger
      --max-stats-groups int                Maximum number of stats groups to keep in memory, on max oldest is discarded (default 1000)
  -P, --progress                            Show progress during transfer
      --progress-terminal-title             Show progress on the terminal title (requires -P/--progress)
  -q, --quiet                               Print as little stuff as possible
      --stats Duration                      Interval between printing stats, e.g. 500ms, 60s, 5m (0 to disable) (default 1m0s)
      --stats-file-name-length int          Max file name length in stats (0 for no limit) (default 45)
      --stats-log-level LogLevel            Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default INFO)
      --stats-one-line                      Make the stats fit on one line
      --stats-one-line-date                 Enable --stats-one-line and add current date/time prefix
      --stats-one-line-date-format string   Enable --stats-one-line-date and use custom formatted date: Enclose date string in double quotes (&quot;), see https://golang.org/pkg/time/#Time.Format
      --stats-unit string                   Show data rate in stats as either &#39;bits&#39; or &#39;bytes&#39; per second (default &quot;bytes&quot;)
      --syslog                              Use Syslog for logging
      --syslog-facility string              Facility for syslog, e.g. KERN,USER (default &quot;DAEMON&quot;)
      --use-json-log                        Use json log format
  -v, --verbose count                       Print lots more stuff (repeat for more)</code></pre>
<h2 id="metadata-2">Metadata</h2>
<p>Flags to control metadata.</p>
<pre><code>  -M, --metadata                            If set, preserve metadata when copying objects
      --metadata-exclude stringArray        Exclude metadatas matching pattern
      --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
      --metadata-filter stringArray         Add a metadata filtering rule
      --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
      --metadata-include stringArray        Include metadatas matching pattern
      --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
      --metadata-mapper SpaceSepList        Program to run to transforming metadata before upload
      --metadata-set stringArray            Add metadata key=value when uploading</code></pre>
<h2 id="rc-1">RC</h2>
<p>Flags to control the Remote Control API.</p>
<pre><code>      --rc                                 Enable the remote control server
      --rc-addr stringArray                IPaddress:Port or :Port to bind server to (default localhost:5572)
      --rc-allow-origin string             Origin which cross-domain request (CORS) can be executed from
      --rc-baseurl string                  Prefix for URLs - leave blank for root
      --rc-cert string                     TLS PEM key (concatenation of certificate and CA certificate)
      --rc-client-ca string                Client certificate authority to verify clients with
      --rc-enable-metrics                  Enable the Prometheus metrics path at the remote control server
      --rc-files string                    Path to local files to serve on the HTTP server
      --rc-htpasswd string                 A htpasswd file - if not provided no authentication is done
      --rc-job-expire-duration Duration    Expire finished async jobs older than this value (default 1m0s)
      --rc-job-expire-interval Duration    Interval to check for expired async jobs (default 10s)
      --rc-key string                      TLS PEM Private key
      --rc-max-header-bytes int            Maximum size of request header (default 4096)
      --rc-min-tls-version string          Minimum TLS version that is acceptable (default &quot;tls1.0&quot;)
      --rc-no-auth                         Don&#39;t require auth for certain methods
      --rc-pass string                     Password for authentication
      --rc-realm string                    Realm for authentication
      --rc-salt string                     Password hashing salt (default &quot;dlPL2MqE&quot;)
      --rc-serve                           Enable the serving of remote objects
      --rc-serve-no-modtime                Don&#39;t read the modification time (can speed things up)
      --rc-server-read-timeout Duration    Timeout for server reading data (default 1h0m0s)
      --rc-server-write-timeout Duration   Timeout for server writing data (default 1h0m0s)
      --rc-template string                 User-specified template
      --rc-user string                     User name for authentication
      --rc-user-from-header string         User name from a defined HTTP header
      --rc-web-fetch-url string            URL to fetch the releases for webgui (default &quot;https://api.github.com/repos/rclone/rclone-webui-react/releases/latest&quot;)
      --rc-web-gui                         Launch WebGUI on localhost
      --rc-web-gui-force-update            Force update to latest version of web gui
      --rc-web-gui-no-open-browser         Don&#39;t open the browser automatically
      --rc-web-gui-update                  Check and update to latest version of web gui</code></pre>
<h2 id="metrics-1">Metrics</h2>
<p>Flags to control the Metrics HTTP endpoint..</p>
<pre><code>      --metrics-addr stringArray                IPaddress:Port or :Port to bind metrics server to
      --metrics-allow-origin string             Origin which cross-domain request (CORS) can be executed from
      --metrics-baseurl string                  Prefix for URLs - leave blank for root
      --metrics-cert string                     TLS PEM key (concatenation of certificate and CA certificate)
      --metrics-client-ca string                Client certificate authority to verify clients with
      --metrics-htpasswd string                 A htpasswd file - if not provided no authentication is done
      --metrics-key string                      TLS PEM Private key
      --metrics-max-header-bytes int            Maximum size of request header (default 4096)
      --metrics-min-tls-version string          Minimum TLS version that is acceptable (default &quot;tls1.0&quot;)
      --metrics-pass string                     Password for authentication
      --metrics-realm string                    Realm for authentication
      --metrics-salt string                     Password hashing salt (default &quot;dlPL2MqE&quot;)
      --metrics-server-read-timeout Duration    Timeout for server reading data (default 1h0m0s)
      --metrics-server-write-timeout Duration   Timeout for server writing data (default 1h0m0s)
      --metrics-template string                 User-specified template
      --metrics-user string                     User name for authentication
      --metrics-user-from-header string         User name from a defined HTTP header
      --rc-enable-metrics                       Enable the Prometheus metrics path at the remote control server</code></pre>
<h2 id="backend">Backend</h2>
<p>Backend-only flags (these can be set in the config file also).</p>
<pre><code>      --alias-description string                            Description of the remote
      --alias-remote string                                 Remote or path to alias
      --azureblob-access-tier string                        Access tier of blob: hot, cool, cold or archive
      --azureblob-account string                            Azure Storage Account Name
      --azureblob-archive-tier-delete                       Delete archive tier blobs before overwriting
      --azureblob-chunk-size SizeSuffix                     Upload chunk size (default 4Mi)
      --azureblob-client-certificate-password string        Password for the certificate file (optional) (obscured)
      --azureblob-client-certificate-path string            Path to a PEM or PKCS12 certificate file including the private key
      --azureblob-client-id string                          The ID of the client in use
      --azureblob-client-secret string                      One of the service principal&#39;s client secrets
      --azureblob-client-send-certificate-chain             Send the certificate chain when using certificate auth
      --azureblob-copy-concurrency int                      Concurrency for multipart copy (default 512)
      --azureblob-copy-cutoff SizeSuffix                    Cutoff for switching to multipart copy (default 8Mi)
      --azureblob-delete-snapshots string                   Set to specify how to deal with snapshots on blob deletion
      --azureblob-description string                        Description of the remote
      --azureblob-directory-markers                         Upload an empty object with a trailing slash when a new directory is created
      --azureblob-disable-checksum                          Don&#39;t store MD5 checksum with object metadata
      --azureblob-disable-instance-discovery                Skip requesting Microsoft Entra instance metadata
      --azureblob-encoding Encoding                         The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
      --azureblob-endpoint string                           Endpoint for the service
      --azureblob-env-auth                                  Read credentials from runtime (environment variables, CLI or MSI)
      --azureblob-key string                                Storage Account Shared Key
      --azureblob-list-chunk int                            Size of blob list (default 5000)
      --azureblob-msi-client-id string                      Object ID of the user-assigned MSI to use, if any
      --azureblob-msi-mi-res-id string                      Azure resource ID of the user-assigned MSI to use, if any
      --azureblob-msi-object-id string                      Object ID of the user-assigned MSI to use, if any
      --azureblob-no-check-container                        If set, don&#39;t attempt to check the container exists or create it
      --azureblob-no-head-object                            If set, do not do HEAD before GET when getting objects
      --azureblob-password string                           The user&#39;s password (obscured)
      --azureblob-public-access string                      Public access level of a container: blob or container
      --azureblob-sas-url string                            SAS URL for container level access only
      --azureblob-service-principal-file string             Path to file containing credentials for use with a service principal
      --azureblob-tenant string                             ID of the service principal&#39;s tenant. Also called its directory ID
      --azureblob-upload-concurrency int                    Concurrency for multipart uploads (default 16)
      --azureblob-upload-cutoff string                      Cutoff for switching to chunked upload (&lt;= 256 MiB) (deprecated)
      --azureblob-use-az                                    Use Azure CLI tool az for authentication
      --azureblob-use-copy-blob                             Whether to use the Copy Blob API when copying to the same storage account (default true)
      --azureblob-use-emulator                              Uses local storage emulator if provided as &#39;true&#39;
      --azureblob-use-msi                                   Use a managed service identity to authenticate (only works in Azure)
      --azureblob-username string                           User name (usually an email address)
      --azurefiles-account string                           Azure Storage Account Name
      --azurefiles-chunk-size SizeSuffix                    Upload chunk size (default 4Mi)
      --azurefiles-client-certificate-password string       Password for the certificate file (optional) (obscured)
      --azurefiles-client-certificate-path string           Path to a PEM or PKCS12 certificate file including the private key
      --azurefiles-client-id string                         The ID of the client in use
      --azurefiles-client-secret string                     One of the service principal&#39;s client secrets
      --azurefiles-client-send-certificate-chain            Send the certificate chain when using certificate auth
      --azurefiles-connection-string string                 Azure Files Connection String
      --azurefiles-description string                       Description of the remote
      --azurefiles-disable-instance-discovery               Skip requesting Microsoft Entra instance metadata
      --azurefiles-encoding Encoding                        The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8,Dot)
      --azurefiles-endpoint string                          Endpoint for the service
      --azurefiles-env-auth                                 Read credentials from runtime (environment variables, CLI or MSI)
      --azurefiles-key string                               Storage Account Shared Key
      --azurefiles-max-stream-size SizeSuffix               Max size for streamed files (default 10Gi)
      --azurefiles-msi-client-id string                     Object ID of the user-assigned MSI to use, if any
      --azurefiles-msi-mi-res-id string                     Azure resource ID of the user-assigned MSI to use, if any
      --azurefiles-msi-object-id string                     Object ID of the user-assigned MSI to use, if any
      --azurefiles-password string                          The user&#39;s password (obscured)
      --azurefiles-sas-url string                           SAS URL
      --azurefiles-service-principal-file string            Path to file containing credentials for use with a service principal
      --azurefiles-share-name string                        Azure Files Share Name
      --azurefiles-tenant string                            ID of the service principal&#39;s tenant. Also called its directory ID
      --azurefiles-upload-concurrency int                   Concurrency for multipart uploads (default 16)
      --azurefiles-use-az                                   Use Azure CLI tool az for authentication
      --azurefiles-use-msi                                  Use a managed service identity to authenticate (only works in Azure)
      --azurefiles-username string                          User name (usually an email address)
      --b2-account string                                   Account ID or Application Key ID
      --b2-chunk-size SizeSuffix                            Upload chunk size (default 96Mi)
      --b2-copy-cutoff SizeSuffix                           Cutoff for switching to multipart copy (default 4Gi)
      --b2-description string                               Description of the remote
      --b2-disable-checksum                                 Disable checksums for large (&gt; upload cutoff) files
      --b2-download-auth-duration Duration                  Time before the public link authorization token will expire in s or suffix ms|s|m|h|d (default 1w)
      --b2-download-url string                              Custom endpoint for downloads
      --b2-encoding Encoding                                The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --b2-endpoint string                                  Endpoint for the service
      --b2-hard-delete                                      Permanently delete files on remote removal, otherwise hide files
      --b2-key string                                       Application Key
      --b2-lifecycle int                                    Set the number of days deleted files should be kept when creating a bucket
      --b2-test-mode string                                 A flag string for X-Bz-Test-Mode header for debugging
      --b2-upload-concurrency int                           Concurrency for multipart uploads (default 4)
      --b2-upload-cutoff SizeSuffix                         Cutoff for switching to chunked upload (default 200Mi)
      --b2-version-at Time                                  Show file versions as they were at the specified time (default off)
      --b2-versions                                         Include old versions in directory listings
      --box-access-token string                             Box App Primary Access Token
      --box-auth-url string                                 Auth server URL
      --box-box-config-file string                          Box App config.json location
      --box-box-sub-type string                              (default &quot;user&quot;)
      --box-client-credentials                              Use client credentials OAuth flow
      --box-client-id string                                OAuth Client Id
      --box-client-secret string                            OAuth Client Secret
      --box-commit-retries int                              Max number of times to try committing a multipart file (default 100)
      --box-description string                              Description of the remote
      --box-encoding Encoding                               The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
      --box-impersonate string                              Impersonate this user ID when using a service account
      --box-list-chunk int                                  Size of listing chunk 1-1000 (default 1000)
      --box-owned-by string                                 Only show items owned by the login (email address) passed in
      --box-root-folder-id string                           Fill in for rclone to use a non root folder as its starting point
      --box-token string                                    OAuth Access Token as a JSON blob
      --box-token-url string                                Token server url
      --box-upload-cutoff SizeSuffix                        Cutoff for switching to multipart upload (&gt;= 50 MiB) (default 50Mi)
      --cache-chunk-clean-interval Duration                 How often should the cache perform cleanups of the chunk storage (default 1m0s)
      --cache-chunk-no-memory                               Disable the in-memory cache for storing chunks during streaming
      --cache-chunk-path string                             Directory to cache chunk files (default &quot;$HOME/.cache/rclone/cache-backend&quot;)
      --cache-chunk-size SizeSuffix                         The size of a chunk (partial file data) (default 5Mi)
      --cache-chunk-total-size SizeSuffix                   The total size that the chunks can take up on the local disk (default 10Gi)
      --cache-db-path string                                Directory to store file structure metadata DB (default &quot;$HOME/.cache/rclone/cache-backend&quot;)
      --cache-db-purge                                      Clear all the cached data for this remote on start
      --cache-db-wait-time Duration                         How long to wait for the DB to be available - 0 is unlimited (default 1s)
      --cache-description string                            Description of the remote
      --cache-info-age Duration                             How long to cache file structure information (directory listings, file size, times, etc.) (default 6h0m0s)
      --cache-plex-insecure string                          Skip all certificate verification when connecting to the Plex server
      --cache-plex-password string                          The password of the Plex user (obscured)
      --cache-plex-url string                               The URL of the Plex server
      --cache-plex-username string                          The username of the Plex user
      --cache-read-retries int                              How many times to retry a read from a cache storage (default 10)
      --cache-remote string                                 Remote to cache
      --cache-rps int                                       Limits the number of requests per second to the source FS (-1 to disable) (default -1)
      --cache-tmp-upload-path string                        Directory to keep temporary files until they are uploaded
      --cache-tmp-wait-time Duration                        How long should files be stored in local cache before being uploaded (default 15s)
      --cache-workers int                                   How many workers should run in parallel to download chunks (default 4)
      --cache-writes                                        Cache file data on writes through the FS
      --chunker-chunk-size SizeSuffix                       Files larger than chunk size will be split in chunks (default 2Gi)
      --chunker-description string                          Description of the remote
      --chunker-fail-hard                                   Choose how chunker should handle files with missing or invalid chunks
      --chunker-hash-type string                            Choose how chunker handles hash sums (default &quot;md5&quot;)
      --chunker-remote string                               Remote to chunk/unchunk
      --cloudinary-adjust-media-files-extensions            Cloudinary handles media formats as a file attribute and strips it from the name, which is unlike most other file systems (default true)
      --cloudinary-api-key string                           Cloudinary API Key
      --cloudinary-api-secret string                        Cloudinary API Secret
      --cloudinary-cloud-name string                        Cloudinary Environment Name
      --cloudinary-description string                       Description of the remote
      --cloudinary-encoding Encoding                        The encoding for the backend (default Slash,LtGt,DoubleQuote,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
      --cloudinary-eventually-consistent-delay Duration     Wait N seconds for eventual consistency of the databases that support the backend operation (default 0s)
      --cloudinary-media-extensions stringArray             Cloudinary supported media extensions (default 3ds,3g2,3gp,ai,arw,avi,avif,bmp,bw,cr2,cr3,djvu,dng,eps3,fbx,flif,flv,gif,glb,gltf,hdp,heic,heif,ico,indd,jp2,jpe,jpeg,jpg,jxl,jxr,m2ts,mov,mp4,mpeg,mts,mxf,obj,ogv,pdf,ply,png,psd,svg,tga,tif,tiff,ts,u3ma,usdz,wdp,webm,webp,wmv)
      --cloudinary-upload-prefix string                     Specify the API endpoint for environments out of the US
      --cloudinary-upload-preset string                     Upload Preset to select asset manipulation on upload
      --combine-description string                          Description of the remote
      --combine-upstreams SpaceSepList                      Upstreams for combining
      --compress-description string                         Description of the remote
      --compress-level int                                  GZIP compression level (-2 to 9) (default -1)
      --compress-mode string                                Compression mode (default &quot;gzip&quot;)
      --compress-ram-cache-limit SizeSuffix                 Some remotes don&#39;t allow the upload of files with unknown size (default 20Mi)
      --compress-remote string                              Remote to compress
  -L, --copy-links                                          Follow symlinks and copy the pointed to item
      --crypt-description string                            Description of the remote
      --crypt-directory-name-encryption                     Option to either encrypt directory names or leave them intact (default true)
      --crypt-filename-encoding string                      How to encode the encrypted filename to text string (default &quot;base32&quot;)
      --crypt-filename-encryption string                    How to encrypt the filenames (default &quot;standard&quot;)
      --crypt-no-data-encryption                            Option to either encrypt file data or leave it unencrypted
      --crypt-pass-bad-blocks                               If set this will pass bad blocks through as all 0
      --crypt-password string                               Password or pass phrase for encryption (obscured)
      --crypt-password2 string                              Password or pass phrase for salt (obscured)
      --crypt-remote string                                 Remote to encrypt/decrypt
      --crypt-server-side-across-configs                    Deprecated: use --server-side-across-configs instead
      --crypt-show-mapping                                  For all files listed show how the names encrypt
      --crypt-strict-names                                  If set, this will raise an error when crypt comes across a filename that can&#39;t be decrypted
      --crypt-suffix string                                 If this is set it will override the default suffix of &quot;.bin&quot; (default &quot;.bin&quot;)
      --doi-description string                              Description of the remote
      --doi-doi string                                      The DOI or the doi.org URL
      --doi-doi-resolver-api-url string                     The URL of the DOI resolver API to use
      --doi-provider string                                 DOI provider
      --drive-acknowledge-abuse                             Set to allow files which return cannotDownloadAbusiveFile to be downloaded
      --drive-allow-import-name-change                      Allow the filetype to change when uploading Google docs
      --drive-auth-owner-only                               Only consider files owned by the authenticated user
      --drive-auth-url string                               Auth server URL
      --drive-chunk-size SizeSuffix                         Upload chunk size (default 8Mi)
      --drive-client-credentials                            Use client credentials OAuth flow
      --drive-client-id string                              Google Application Client Id
      --drive-client-secret string                          OAuth Client Secret
      --drive-copy-shortcut-content                         Server side copy contents of shortcuts instead of the shortcut
      --drive-description string                            Description of the remote
      --drive-disable-http2                                 Disable drive using http2 (default true)
      --drive-encoding Encoding                             The encoding for the backend (default InvalidUtf8)
      --drive-env-auth                                      Get IAM credentials from runtime (environment variables or instance meta data if no env vars)
      --drive-export-formats string                         Comma separated list of preferred formats for downloading Google docs (default &quot;docx,xlsx,pptx,svg&quot;)
      --drive-fast-list-bug-fix                             Work around a bug in Google Drive listing (default true)
      --drive-formats string                                Deprecated: See export_formats
      --drive-impersonate string                            Impersonate this user when using a service account
      --drive-import-formats string                         Comma separated list of preferred formats for uploading Google docs
      --drive-keep-revision-forever                         Keep new head revision of each file forever
      --drive-list-chunk int                                Size of listing chunk 100-1000, 0 to disable (default 1000)
      --drive-metadata-labels Bits                          Control whether labels should be read or written in metadata (default off)
      --drive-metadata-owner Bits                           Control whether owner should be read or written in metadata (default read)
      --drive-metadata-permissions Bits                     Control whether permissions should be read or written in metadata (default off)
      --drive-pacer-burst int                               Number of API calls to allow without sleeping (default 100)
      --drive-pacer-min-sleep Duration                      Minimum time to sleep between API calls (default 100ms)
      --drive-resource-key string                           Resource key for accessing a link-shared file
      --drive-root-folder-id string                         ID of the root folder
      --drive-scope string                                  Comma separated list of scopes that rclone should use when requesting access from drive
      --drive-server-side-across-configs                    Deprecated: use --server-side-across-configs instead
      --drive-service-account-credentials string            Service Account Credentials JSON blob
      --drive-service-account-file string                   Service Account Credentials JSON file path
      --drive-shared-with-me                                Only show files that are shared with me
      --drive-show-all-gdocs                                Show all Google Docs including non-exportable ones in listings
      --drive-size-as-quota                                 Show sizes as storage quota usage, not actual size
      --drive-skip-checksum-gphotos                         Skip checksums on Google photos and videos only
      --drive-skip-dangling-shortcuts                       If set skip dangling shortcut files
      --drive-skip-gdocs                                    Skip google documents in all listings
      --drive-skip-shortcuts                                If set skip shortcut files
      --drive-starred-only                                  Only show files that are starred
      --drive-stop-on-download-limit                        Make download limit errors be fatal
      --drive-stop-on-upload-limit                          Make upload limit errors be fatal
      --drive-team-drive string                             ID of the Shared Drive (Team Drive)
      --drive-token string                                  OAuth Access Token as a JSON blob
      --drive-token-url string                              Token server url
      --drive-trashed-only                                  Only show files that are in the trash
      --drive-upload-cutoff SizeSuffix                      Cutoff for switching to chunked upload (default 8Mi)
      --drive-use-created-date                              Use file created date instead of modified date
      --drive-use-shared-date                               Use date file was shared instead of modified date
      --drive-use-trash                                     Send files to the trash instead of deleting permanently (default true)
      --drive-v2-download-min-size SizeSuffix               If Object&#39;s are greater, use drive v2 API to download (default off)
      --dropbox-auth-url string                             Auth server URL
      --dropbox-batch-mode string                           Upload file batching sync|async|off (default &quot;sync&quot;)
      --dropbox-batch-size int                              Max number of files in upload batch
      --dropbox-batch-timeout Duration                      Max time to allow an idle upload batch before uploading (default 0s)
      --dropbox-chunk-size SizeSuffix                       Upload chunk size (&lt; 150Mi) (default 48Mi)
      --dropbox-client-credentials                          Use client credentials OAuth flow
      --dropbox-client-id string                            OAuth Client Id
      --dropbox-client-secret string                        OAuth Client Secret
      --dropbox-description string                          Description of the remote
      --dropbox-encoding Encoding                           The encoding for the backend (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot)
      --dropbox-export-formats CommaSepList                 Comma separated list of preferred formats for exporting files (default html,md)
      --dropbox-impersonate string                          Impersonate this user when using a business account
      --dropbox-pacer-min-sleep Duration                    Minimum time to sleep between API calls (default 10ms)
      --dropbox-root-namespace string                       Specify a different Dropbox namespace ID to use as the root for all paths
      --dropbox-shared-files                                Instructs rclone to work on individual shared files
      --dropbox-shared-folders                              Instructs rclone to work on shared folders
      --dropbox-show-all-exports                            Show all exportable files in listings
      --dropbox-skip-exports                                Skip exportable files in all listings
      --dropbox-token string                                OAuth Access Token as a JSON blob
      --dropbox-token-url string                            Token server url
      --fichier-api-key string                              Your API Key, get it from https://1fichier.com/console/params.pl
      --fichier-cdn                                         Set if you wish to use CDN download links
      --fichier-description string                          Description of the remote
      --fichier-encoding Encoding                           The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot)
      --fichier-file-password string                        If you want to download a shared file that is password protected, add this parameter (obscured)
      --fichier-folder-password string                      If you want to list the files in a shared folder that is password protected, add this parameter (obscured)
      --fichier-shared-folder string                        If you want to download a shared folder, add this parameter
      --filefabric-description string                       Description of the remote
      --filefabric-encoding Encoding                        The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
      --filefabric-permanent-token string                   Permanent Authentication Token
      --filefabric-root-folder-id string                    ID of the root folder
      --filefabric-token string                             Session Token
      --filefabric-token-expiry string                      Token expiry time
      --filefabric-url string                               URL of the Enterprise File Fabric to connect to
      --filefabric-version string                           Version read from the file fabric
      --filelu-description string                           Description of the remote
      --filelu-encoding Encoding                            The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,CrLf,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,LeftCrLfHtVt,RightSpace,RightPeriod,RightCrLfHtVt,InvalidUtf8,Dot,SquareBracket,Semicolon,Exclamation)
      --filelu-key string                                   Your FileLu Rclone key from My Account
      --filescom-api-key string                             The API key used to authenticate with Files.com
      --filescom-description string                         Description of the remote
      --filescom-encoding Encoding                          The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
      --filescom-password string                            The password used to authenticate with Files.com (obscured)
      --filescom-site string                                Your site subdomain (e.g. mysite) or custom domain (e.g. myfiles.customdomain.com)
      --filescom-username string                            The username used to authenticate with Files.com
      --ftp-allow-insecure-tls-ciphers                      Allow insecure TLS ciphers
      --ftp-ask-password                                    Allow asking for FTP password when needed
      --ftp-close-timeout Duration                          Maximum time to wait for a response to close (default 1m0s)
      --ftp-concurrency int                                 Maximum number of FTP simultaneous connections, 0 for unlimited
      --ftp-description string                              Description of the remote
      --ftp-disable-epsv                                    Disable using EPSV even if server advertises support
      --ftp-disable-mlsd                                    Disable using MLSD even if server advertises support
      --ftp-disable-tls13                                   Disable TLS 1.3 (workaround for FTP servers with buggy TLS)
      --ftp-disable-utf8                                    Disable using UTF-8 even if server advertises support
      --ftp-encoding Encoding                               The encoding for the backend (default Slash,Del,Ctl,RightSpace,Dot)
      --ftp-explicit-tls                                    Use Explicit FTPS (FTP over TLS)
      --ftp-force-list-hidden                               Use LIST -a to force listing of hidden files and folders. This will disable the use of MLSD
      --ftp-host string                                     FTP host to connect to
      --ftp-http-proxy string                               URL for HTTP CONNECT proxy
      --ftp-idle-timeout Duration                           Max time before closing idle connections (default 1m0s)
      --ftp-no-check-certificate                            Do not verify the TLS certificate of the server
      --ftp-no-check-upload                                 Don&#39;t check the upload is OK
      --ftp-pass string                                     FTP password (obscured)
      --ftp-port int                                        FTP port number (default 21)
      --ftp-shut-timeout Duration                           Maximum time to wait for data connection closing status (default 1m0s)
      --ftp-socks-proxy string                              Socks 5 proxy host
      --ftp-tls                                             Use Implicit FTPS (FTP over TLS)
      --ftp-tls-cache-size int                              Size of TLS session cache for all control and data connections (default 32)
      --ftp-user string                                     FTP username (default &quot;$USER&quot;)
      --ftp-writing-mdtm                                    Use MDTM to set modification time (VsFtpd quirk)
      --gcs-access-token string                             Short-lived access token
      --gcs-anonymous                                       Access public buckets and objects without credentials
      --gcs-auth-url string                                 Auth server URL
      --gcs-bucket-acl string                               Access Control List for new buckets
      --gcs-bucket-policy-only                              Access checks should use bucket-level IAM policies
      --gcs-client-credentials                              Use client credentials OAuth flow
      --gcs-client-id string                                OAuth Client Id
      --gcs-client-secret string                            OAuth Client Secret
      --gcs-decompress                                      If set this will decompress gzip encoded objects
      --gcs-description string                              Description of the remote
      --gcs-directory-markers                               Upload an empty object with a trailing slash when a new directory is created
      --gcs-encoding Encoding                               The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
      --gcs-endpoint string                                 Endpoint for the service
      --gcs-env-auth                                        Get GCP IAM credentials from runtime (environment variables or instance meta data if no env vars)
      --gcs-location string                                 Location for the newly created buckets
      --gcs-no-check-bucket                                 If set, don&#39;t attempt to check the bucket exists or create it
      --gcs-object-acl string                               Access Control List for new objects
      --gcs-project-number string                           Project number
      --gcs-service-account-file string                     Service Account Credentials JSON file path
      --gcs-storage-class string                            The storage class to use when storing objects in Google Cloud Storage
      --gcs-token string                                    OAuth Access Token as a JSON blob
      --gcs-token-url string                                Token server url
      --gcs-user-project string                             User project
      --gofile-access-token string                          API Access token
      --gofile-account-id string                            Account ID
      --gofile-description string                           Description of the remote
      --gofile-encoding Encoding                            The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftPeriod,RightPeriod,InvalidUtf8,Dot,Exclamation)
      --gofile-list-chunk int                               Number of items to list in each call (default 1000)
      --gofile-root-folder-id string                        ID of the root folder
      --gphotos-auth-url string                             Auth server URL
      --gphotos-batch-mode string                           Upload file batching sync|async|off (default &quot;sync&quot;)
      --gphotos-batch-size int                              Max number of files in upload batch
      --gphotos-batch-timeout Duration                      Max time to allow an idle upload batch before uploading (default 0s)
      --gphotos-client-credentials                          Use client credentials OAuth flow
      --gphotos-client-id string                            OAuth Client Id
      --gphotos-client-secret string                        OAuth Client Secret
      --gphotos-description string                          Description of the remote
      --gphotos-encoding Encoding                           The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
      --gphotos-include-archived                            Also view and download archived media
      --gphotos-proxy string                                Use the gphotosdl proxy for downloading the full resolution images
      --gphotos-read-only                                   Set to make the Google Photos backend read only
      --gphotos-read-size                                   Set to read the size of media items
      --gphotos-start-year int                              Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000)
      --gphotos-token string                                OAuth Access Token as a JSON blob
      --gphotos-token-url string                            Token server url
      --hasher-auto-size SizeSuffix                         Auto-update checksum for files smaller than this size (disabled by default)
      --hasher-description string                           Description of the remote
      --hasher-hashes CommaSepList                          Comma separated list of supported checksum types (default md5,sha1)
      --hasher-max-age Duration                             Maximum time to keep checksums in cache (0 = no cache, off = cache forever) (default off)
      --hasher-remote string                                Remote to cache checksums for (e.g. myRemote:path)
      --hdfs-data-transfer-protection string                Kerberos data transfer protection: authentication|integrity|privacy
      --hdfs-description string                             Description of the remote
      --hdfs-encoding Encoding                              The encoding for the backend (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot)
      --hdfs-namenode CommaSepList                          Hadoop name nodes and ports
      --hdfs-service-principal-name string                  Kerberos service principal name for the namenode
      --hdfs-username string                                Hadoop user name
      --hidrive-auth-url string                             Auth server URL
      --hidrive-chunk-size SizeSuffix                       Chunksize for chunked uploads (default 48Mi)
      --hidrive-client-credentials                          Use client credentials OAuth flow
      --hidrive-client-id string                            OAuth Client Id
      --hidrive-client-secret string                        OAuth Client Secret
      --hidrive-description string                          Description of the remote
      --hidrive-disable-fetching-member-count               Do not fetch number of objects in directories unless it is absolutely necessary
      --hidrive-encoding Encoding                           The encoding for the backend (default Slash,Dot)
      --hidrive-endpoint string                             Endpoint for the service (default &quot;https://api.hidrive.strato.com/2.1&quot;)
      --hidrive-root-prefix string                          The root/parent folder for all paths (default &quot;/&quot;)
      --hidrive-scope-access string                         Access permissions that rclone should use when requesting access from HiDrive (default &quot;rw&quot;)
      --hidrive-scope-role string                           User-level that rclone should use when requesting access from HiDrive (default &quot;user&quot;)
      --hidrive-token string                                OAuth Access Token as a JSON blob
      --hidrive-token-url string                            Token server url
      --hidrive-upload-concurrency int                      Concurrency for chunked uploads (default 4)
      --hidrive-upload-cutoff SizeSuffix                    Cutoff/Threshold for chunked uploads (default 96Mi)
      --http-description string                             Description of the remote
      --http-headers CommaSepList                           Set HTTP headers for all transactions
      --http-no-escape                                      Do not escape URL metacharacters in path names
      --http-no-head                                        Don&#39;t use HEAD requests
      --http-no-slash                                       Set this if the site doesn&#39;t end directories with /
      --http-url string                                     URL of HTTP host to connect to
      --iclouddrive-apple-id string                         Apple ID
      --iclouddrive-client-id string                        Client id (default &quot;d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d&quot;)
      --iclouddrive-description string                      Description of the remote
      --iclouddrive-encoding Encoding                       The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --iclouddrive-password string                         Password (obscured)
      --imagekit-description string                         Description of the remote
      --imagekit-encoding Encoding                          The encoding for the backend (default Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket)
      --imagekit-endpoint string                            You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)
      --imagekit-only-signed Restrict unsigned image URLs   If you have configured Restrict unsigned image URLs in your dashboard settings, set this to true
      --imagekit-private-key string                         You can find your ImageKit.io private key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)
      --imagekit-public-key string                          You can find your ImageKit.io public key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)
      --imagekit-upload-tags string                         Tags to add to the uploaded files, e.g. &quot;tag1,tag2&quot;
      --imagekit-versions                                   Include old versions in directory listings
      --internetarchive-access-key-id string                IAS3 Access Key
      --internetarchive-description string                  Description of the remote
      --internetarchive-disable-checksum                    Don&#39;t ask the server to test against MD5 checksum calculated by rclone (default true)
      --internetarchive-encoding Encoding                   The encoding for the backend (default Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot)
      --internetarchive-endpoint string                     IAS3 Endpoint (default &quot;https://s3.us.archive.org&quot;)
      --internetarchive-front-endpoint string               Host of InternetArchive Frontend (default &quot;https://archive.org&quot;)
      --internetarchive-item-derive                         Whether to trigger derive on the IA item or not. If set to false, the item will not be derived by IA upon upload (default true)
      --internetarchive-item-metadata stringArray           Metadata to be set on the IA item, this is different from file-level metadata that can be set using --metadata-set
      --internetarchive-secret-access-key string            IAS3 Secret Key (password)
      --internetarchive-wait-archive Duration               Timeout for waiting the server&#39;s processing tasks (specifically archive and book_op) to finish (default 0s)
      --jottacloud-auth-url string                          Auth server URL
      --jottacloud-client-credentials                       Use client credentials OAuth flow
      --jottacloud-client-id string                         OAuth Client Id
      --jottacloud-client-secret string                     OAuth Client Secret
      --jottacloud-description string                       Description of the remote
      --jottacloud-encoding Encoding                        The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
      --jottacloud-hard-delete                              Delete files permanently rather than putting them into the trash
      --jottacloud-md5-memory-limit SizeSuffix              Files bigger than this will be cached on disk to calculate the MD5 if required (default 10Mi)
      --jottacloud-no-versions                              Avoid server side versioning by deleting files and recreating files instead of overwriting them
      --jottacloud-token string                             OAuth Access Token as a JSON blob
      --jottacloud-token-url string                         Token server url
      --jottacloud-trashed-only                             Only show files that are in the trash
      --jottacloud-upload-resume-limit SizeSuffix           Files bigger than this can be resumed if the upload fail&#39;s (default 10Mi)
      --koofr-description string                            Description of the remote
      --koofr-encoding Encoding                             The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --koofr-endpoint string                               The Koofr API endpoint to use
      --koofr-mountid string                                Mount ID of the mount to use
      --koofr-password string                               Your password for rclone generate one at https://app.koofr.net/app/admin/preferences/password (obscured)
      --koofr-provider string                               Choose your storage provider
      --koofr-setmtime                                      Does the backend support setting modification time (default true)
      --koofr-user string                                   Your user name
      --linkbox-description string                          Description of the remote
      --linkbox-token string                                Token from https://www.linkbox.to/admin/account
      --local-case-insensitive                              Force the filesystem to report itself as case insensitive
      --local-case-sensitive                                Force the filesystem to report itself as case sensitive
      --local-description string                            Description of the remote
      --local-encoding Encoding                             The encoding for the backend (default Slash,Dot)
      --local-hashes CommaSepList                           Comma separated list of supported checksum types
      --local-links                                         Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the local backend
      --local-no-check-updated                              Don&#39;t check to see if the files change during upload
      --local-no-clone                                      Disable reflink cloning for server-side copies
      --local-no-preallocate                                Disable preallocation of disk space for transferred files
      --local-no-set-modtime                                Disable setting modtime
      --local-no-sparse                                     Disable sparse files for multi-thread downloads
      --local-nounc                                         Disable UNC (long path names) conversion on Windows
      --local-time-type mtime|atime|btime|ctime             Set what kind of time is returned (default mtime)
      --local-unicode-normalization                         Apply unicode NFC normalization to paths and filenames
      --local-zero-size-links                               Assume the Stat size of links is zero (and read them instead) (deprecated)
      --mailru-auth-url string                              Auth server URL
      --mailru-check-hash                                   What should copy do if file checksum is mismatched or invalid (default true)
      --mailru-client-credentials                           Use client credentials OAuth flow
      --mailru-client-id string                             OAuth Client Id
      --mailru-client-secret string                         OAuth Client Secret
      --mailru-description string                           Description of the remote
      --mailru-encoding Encoding                            The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --mailru-pass string                                  Password (obscured)
      --mailru-speedup-enable                               Skip full upload if there is another file with same data hash (default true)
      --mailru-speedup-file-patterns string                 Comma separated list of file name patterns eligible for speedup (put by hash) (default &quot;*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf&quot;)
      --mailru-speedup-max-disk SizeSuffix                  This option allows you to disable speedup (put by hash) for large files (default 3Gi)
      --mailru-speedup-max-memory SizeSuffix                Files larger than the size given below will always be hashed on disk (default 32Mi)
      --mailru-token string                                 OAuth Access Token as a JSON blob
      --mailru-token-url string                             Token server url
      --mailru-user string                                  User name (usually email)
      --mega-debug                                          Output more debug from Mega
      --mega-description string                             Description of the remote
      --mega-encoding Encoding                              The encoding for the backend (default Slash,InvalidUtf8,Dot)
      --mega-hard-delete                                    Delete files permanently rather than putting them into the trash
      --mega-pass string                                    Password (obscured)
      --mega-use-https                                      Use HTTPS for transfers
      --mega-user string                                    User name
      --memory-description string                           Description of the remote
      --netstorage-account string                           Set the NetStorage account name
      --netstorage-description string                       Description of the remote
      --netstorage-host string                              Domain+path of NetStorage host to connect to
      --netstorage-protocol string                          Select between HTTP or HTTPS protocol (default &quot;https&quot;)
      --netstorage-secret string                            Set the NetStorage account secret/G2O key for authentication (obscured)
  -x, --one-file-system                                     Don&#39;t cross filesystem boundaries (unix/macOS only)
      --onedrive-access-scopes SpaceSepList                 Set scopes to be requested by rclone (default Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access)
      --onedrive-auth-url string                            Auth server URL
      --onedrive-av-override                                Allows download of files the server thinks has a virus
      --onedrive-chunk-size SizeSuffix                      Chunk size to upload files with - must be multiple of 320k (327,680 bytes) (default 10Mi)
      --onedrive-client-credentials                         Use client credentials OAuth flow
      --onedrive-client-id string                           OAuth Client Id
      --onedrive-client-secret string                       OAuth Client Secret
      --onedrive-delta                                      If set rclone will use delta listing to implement recursive listings
      --onedrive-description string                         Description of the remote
      --onedrive-drive-id string                            The ID of the drive to use
      --onedrive-drive-type string                          The type of the drive (personal | business | documentLibrary)
      --onedrive-encoding Encoding                          The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
      --onedrive-expose-onenote-files                       Set to make OneNote files show up in directory listings
      --onedrive-hard-delete                                Permanently delete files on removal
      --onedrive-hash-type string                           Specify the hash in use for the backend (default &quot;auto&quot;)
      --onedrive-link-password string                       Set the password for links created by the link command
      --onedrive-link-scope string                          Set the scope of the links created by the link command (default &quot;anonymous&quot;)
      --onedrive-link-type string                           Set the type of the links created by the link command (default &quot;view&quot;)
      --onedrive-list-chunk int                             Size of listing chunk (default 1000)
      --onedrive-metadata-permissions Bits                  Control whether permissions should be read or written in metadata (default off)
      --onedrive-no-versions                                Remove all versions on modifying operations
      --onedrive-region string                              Choose national cloud region for OneDrive (default &quot;global&quot;)
      --onedrive-root-folder-id string                      ID of the root folder
      --onedrive-server-side-across-configs                 Deprecated: use --server-side-across-configs instead
      --onedrive-tenant string                              ID of the service principal&#39;s tenant. Also called its directory ID
      --onedrive-token string                               OAuth Access Token as a JSON blob
      --onedrive-token-url string                           Token server url
      --onedrive-upload-cutoff SizeSuffix                   Cutoff for switching to chunked upload (default off)
      --oos-attempt-resume-upload                           If true attempt to resume previously started multipart upload for the object
      --oos-chunk-size SizeSuffix                           Chunk size to use for uploading (default 5Mi)
      --oos-compartment string                              Specify compartment OCID, if you need to list buckets
      --oos-config-file string                              Path to OCI config file (default &quot;~/.oci/config&quot;)
      --oos-config-profile string                           Profile name inside the oci config file (default &quot;Default&quot;)
      --oos-copy-cutoff SizeSuffix                          Cutoff for switching to multipart copy (default 4.656Gi)
      --oos-copy-timeout Duration                           Timeout for copy (default 1m0s)
      --oos-description string                              Description of the remote
      --oos-disable-checksum                                Don&#39;t store MD5 checksum with object metadata
      --oos-encoding Encoding                               The encoding for the backend (default Slash,InvalidUtf8,Dot)
      --oos-endpoint string                                 Endpoint for Object storage API
      --oos-leave-parts-on-error                            If true avoid calling abort upload on a failure, leaving all successfully uploaded parts for manual recovery
      --oos-max-upload-parts int                            Maximum number of parts in a multipart upload (default 10000)
      --oos-namespace string                                Object storage namespace
      --oos-no-check-bucket                                 If set, don&#39;t attempt to check the bucket exists or create it
      --oos-provider string                                 Choose your Auth Provider (default &quot;env_auth&quot;)
      --oos-region string                                   Object storage Region
      --oos-sse-customer-algorithm string                   If using SSE-C, the optional header that specifies &quot;AES256&quot; as the encryption algorithm
      --oos-sse-customer-key string                         To use SSE-C, the optional header that specifies the base64-encoded 256-bit encryption key to use to
      --oos-sse-customer-key-file string                    To use SSE-C, a file containing the base64-encoded string of the AES-256 encryption key associated
      --oos-sse-customer-key-sha256 string                  If using SSE-C, The optional header that specifies the base64-encoded SHA256 hash of the encryption
      --oos-sse-kms-key-id string                           if using your own master key in vault, this header specifies the
      --oos-storage-tier string                             The storage class to use when storing new objects in storage. https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/understandingstoragetiers.htm (default &quot;Standard&quot;)
      --oos-upload-concurrency int                          Concurrency for multipart uploads (default 10)
      --oos-upload-cutoff SizeSuffix                        Cutoff for switching to chunked upload (default 200Mi)
      --opendrive-access string                             Files and folders will be uploaded with this access permission (default private) (default &quot;private&quot;)
      --opendrive-chunk-size SizeSuffix                     Files will be uploaded in chunks this size (default 10Mi)
      --opendrive-description string                        Description of the remote
      --opendrive-encoding Encoding                         The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
      --opendrive-password string                           Password (obscured)
      --opendrive-username string                           Username
      --pcloud-auth-url string                              Auth server URL
      --pcloud-client-credentials                           Use client credentials OAuth flow
      --pcloud-client-id string                             OAuth Client Id
      --pcloud-client-secret string                         OAuth Client Secret
      --pcloud-description string                           Description of the remote
      --pcloud-encoding Encoding                            The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --pcloud-hostname string                              Hostname to connect to (default &quot;api.pcloud.com&quot;)
      --pcloud-password string                              Your pcloud password (obscured)
      --pcloud-root-folder-id string                        Fill in for rclone to use a non root folder as its starting point (default &quot;d0&quot;)
      --pcloud-token string                                 OAuth Access Token as a JSON blob
      --pcloud-token-url string                             Token server url
      --pcloud-username string                              Your pcloud username
      --pikpak-chunk-size SizeSuffix                        Chunk size for multipart uploads (default 5Mi)
      --pikpak-description string                           Description of the remote
      --pikpak-device-id string                             Device ID used for authorization
      --pikpak-encoding Encoding                            The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot)
      --pikpak-hash-memory-limit SizeSuffix                 Files bigger than this will be cached on disk to calculate hash if required (default 10Mi)
      --pikpak-no-media-link                                Use original file links instead of media links
      --pikpak-pass string                                  Pikpak password (obscured)
      --pikpak-root-folder-id string                        ID of the root folder
      --pikpak-trashed-only                                 Only show files that are in the trash
      --pikpak-upload-concurrency int                       Concurrency for multipart uploads (default 4)
      --pikpak-upload-cutoff SizeSuffix                     Cutoff for switching to chunked upload (default 200Mi)
      --pikpak-use-trash                                    Send files to the trash instead of deleting permanently (default true)
      --pikpak-user string                                  Pikpak username
      --pikpak-user-agent string                            HTTP user agent for pikpak (default &quot;Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0&quot;)
      --pixeldrain-api-key string                           API key for your pixeldrain account
      --pixeldrain-api-url string                           The API endpoint to connect to. In the vast majority of cases it&#39;s fine to leave (default &quot;https://pixeldrain.com/api&quot;)
      --pixeldrain-description string                       Description of the remote
      --pixeldrain-root-folder-id string                    Root of the filesystem to use (default &quot;me&quot;)
      --premiumizeme-auth-url string                        Auth server URL
      --premiumizeme-client-credentials                     Use client credentials OAuth flow
      --premiumizeme-client-id string                       OAuth Client Id
      --premiumizeme-client-secret string                   OAuth Client Secret
      --premiumizeme-description string                     Description of the remote
      --premiumizeme-encoding Encoding                      The encoding for the backend (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --premiumizeme-token string                           OAuth Access Token as a JSON blob
      --premiumizeme-token-url string                       Token server url
      --protondrive-2fa string                              The 2FA code
      --protondrive-app-version string                      The app version string (default &quot;macos-drive@1.0.0-alpha.1+rclone&quot;)
      --protondrive-description string                      Description of the remote
      --protondrive-enable-caching                          Caches the files and folders metadata to reduce API calls (default true)
      --protondrive-encoding Encoding                       The encoding for the backend (default Slash,LeftSpace,RightSpace,InvalidUtf8,Dot)
      --protondrive-mailbox-password string                 The mailbox password of your two-password proton account (obscured)
      --protondrive-original-file-size                      Return the file size before encryption (default true)
      --protondrive-password string                         The password of your proton account (obscured)
      --protondrive-replace-existing-draft                  Create a new revision when filename conflict is detected
      --protondrive-username string                         The username of your proton account
      --putio-auth-url string                               Auth server URL
      --putio-client-credentials                            Use client credentials OAuth flow
      --putio-client-id string                              OAuth Client Id
      --putio-client-secret string                          OAuth Client Secret
      --putio-description string                            Description of the remote
      --putio-encoding Encoding                             The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --putio-token string                                  OAuth Access Token as a JSON blob
      --putio-token-url string                              Token server url
      --qingstor-access-key-id string                       QingStor Access Key ID
      --qingstor-chunk-size SizeSuffix                      Chunk size to use for uploading (default 4Mi)
      --qingstor-connection-retries int                     Number of connection retries (default 3)
      --qingstor-description string                         Description of the remote
      --qingstor-encoding Encoding                          The encoding for the backend (default Slash,Ctl,InvalidUtf8)
      --qingstor-endpoint string                            Enter an endpoint URL to connection QingStor API
      --qingstor-env-auth                                   Get QingStor credentials from runtime
      --qingstor-secret-access-key string                   QingStor Secret Access Key (password)
      --qingstor-upload-concurrency int                     Concurrency for multipart uploads (default 1)
      --qingstor-upload-cutoff SizeSuffix                   Cutoff for switching to chunked upload (default 200Mi)
      --qingstor-zone string                                Zone to connect to
      --quatrix-api-key string                              API key for accessing Quatrix account
      --quatrix-description string                          Description of the remote
      --quatrix-effective-upload-time string                Wanted upload time for one chunk (default &quot;4s&quot;)
      --quatrix-encoding Encoding                           The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --quatrix-hard-delete                                 Delete files permanently rather than putting them into the trash
      --quatrix-host string                                 Host name of Quatrix account
      --quatrix-maximal-summary-chunk-size SizeSuffix       The maximal summary for all chunks. It should not be less than &#39;transfers&#39;*&#39;minimal_chunk_size&#39; (default 95.367Mi)
      --quatrix-minimal-chunk-size SizeSuffix               The minimal size for one chunk (default 9.537Mi)
      --quatrix-skip-project-folders                        Skip project folders in operations
      --s3-access-key-id string                             AWS Access Key ID
      --s3-acl string                                       Canned ACL used when creating buckets and storing or copying objects
      --s3-bucket-acl string                                Canned ACL used when creating buckets
      --s3-chunk-size SizeSuffix                            Chunk size to use for uploading (default 5Mi)
      --s3-copy-cutoff SizeSuffix                           Cutoff for switching to multipart copy (default 4.656Gi)
      --s3-decompress                                       If set this will decompress gzip encoded objects
      --s3-description string                               Description of the remote
      --s3-directory-bucket                                 Set to use AWS Directory Buckets
      --s3-directory-markers                                Upload an empty object with a trailing slash when a new directory is created
      --s3-disable-checksum                                 Don&#39;t store MD5 checksum with object metadata
      --s3-disable-http2                                    Disable usage of http2 for S3 backends
      --s3-download-url string                              Custom endpoint for downloads
      --s3-encoding Encoding                                The encoding for the backend (default Slash,InvalidUtf8,Dot)
      --s3-endpoint string                                  Endpoint for S3 API
      --s3-env-auth                                         Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars)
      --s3-force-path-style                                 If true use path style access if false use virtual hosted style (default true)
      --s3-ibm-api-key string                               IBM API Key to be used to obtain IAM token
      --s3-ibm-resource-instance-id string                  IBM service instance id
      --s3-leave-parts-on-error                             If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery
      --s3-list-chunk int                                   Size of listing chunk (response list for each ListObject S3 request) (default 1000)
      --s3-list-url-encode Tristate                         Whether to url encode listings: true/false/unset (default unset)
      --s3-list-version int                                 Version of ListObjects to use: 1,2 or 0 for auto
      --s3-location-constraint string                       Location constraint - must be set to match the Region
      --s3-max-upload-parts int                             Maximum number of parts in a multipart upload (default 10000)
      --s3-might-gzip Tristate                              Set this if the backend might gzip objects (default unset)
      --s3-no-check-bucket                                  If set, don&#39;t attempt to check the bucket exists or create it
      --s3-no-head                                          If set, don&#39;t HEAD uploaded objects to check integrity
      --s3-no-head-object                                   If set, do not do HEAD before GET when getting objects
      --s3-no-system-metadata                               Suppress setting and reading of system metadata
      --s3-profile string                                   Profile to use in the shared credentials file
      --s3-provider string                                  Choose your S3 provider
      --s3-region string                                    Region to connect to
      --s3-requester-pays                                   Enables requester pays option when interacting with S3 bucket
      --s3-sdk-log-mode Bits                                Set to debug the SDK (default Off)
      --s3-secret-access-key string                         AWS Secret Access Key (password)
      --s3-server-side-encryption string                    The server-side encryption algorithm used when storing this object in S3
      --s3-session-token string                             An AWS session token
      --s3-shared-credentials-file string                   Path to the shared credentials file
      --s3-sign-accept-encoding Tristate                    Set if rclone should include Accept-Encoding as part of the signature (default unset)
      --s3-sse-customer-algorithm string                    If using SSE-C, the server-side encryption algorithm used when storing this object in S3
      --s3-sse-customer-key string                          To use SSE-C you may provide the secret encryption key used to encrypt/decrypt your data
      --s3-sse-customer-key-base64 string                   If using SSE-C you must provide the secret encryption key encoded in base64 format to encrypt/decrypt your data
      --s3-sse-customer-key-md5 string                      If using SSE-C you may provide the secret encryption key MD5 checksum (optional)
      --s3-sse-kms-key-id string                            If using KMS ID you must provide the ARN of Key
      --s3-storage-class string                             The storage class to use when storing new objects in S3
      --s3-upload-concurrency int                           Concurrency for multipart uploads and copies (default 4)
      --s3-upload-cutoff SizeSuffix                         Cutoff for switching to chunked upload (default 200Mi)
      --s3-use-accelerate-endpoint                          If true use the AWS S3 accelerated endpoint
      --s3-use-accept-encoding-gzip Accept-Encoding: gzip   Whether to send Accept-Encoding: gzip header (default unset)
      --s3-use-already-exists Tristate                      Set if rclone should report BucketAlreadyExists errors on bucket creation (default unset)
      --s3-use-arn-region                                   If true, enables arn region support for the service
      --s3-use-dual-stack                                   If true use AWS S3 dual-stack endpoint (IPv6 support)
      --s3-use-multipart-etag Tristate                      Whether to use ETag in multipart uploads for verification (default unset)
      --s3-use-multipart-uploads Tristate                   Set if rclone should use multipart uploads (default unset)
      --s3-use-presigned-request                            Whether to use a presigned request or PutObject for single part uploads
      --s3-use-unsigned-payload Tristate                    Whether to use an unsigned payload in PutObject (default unset)
      --s3-use-x-id Tristate                                Set if rclone should add x-id URL parameters (default unset)
      --s3-v2-auth                                          If true use v2 authentication
      --s3-version-at Time                                  Show file versions as they were at the specified time (default off)
      --s3-version-deleted                                  Show deleted file markers when using versions
      --s3-versions                                         Include old versions in directory listings
      --seafile-2fa                                         Two-factor authentication (&#39;true&#39; if the account has 2FA enabled)
      --seafile-create-library                              Should rclone create a library if it doesn&#39;t exist
      --seafile-description string                          Description of the remote
      --seafile-encoding Encoding                           The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8,Dot)
      --seafile-library string                              Name of the library
      --seafile-library-key string                          Library password (for encrypted libraries only) (obscured)
      --seafile-pass string                                 Password (obscured)
      --seafile-url string                                  URL of seafile host to connect to
      --seafile-user string                                 User name (usually email address)
      --sftp-ask-password                                   Allow asking for SFTP password when needed
      --sftp-blake3sum-command string                       The command used to read BLAKE3 hashes
      --sftp-chunk-size SizeSuffix                          Upload and download chunk size (default 32Ki)
      --sftp-ciphers SpaceSepList                           Space separated list of ciphers to be used for session encryption, ordered by preference
      --sftp-concurrency int                                The maximum number of outstanding requests for one file (default 64)
      --sftp-connections int                                Maximum number of SFTP simultaneous connections, 0 for unlimited
      --sftp-copy-is-hardlink                               Set to enable server side copies using hardlinks
      --sftp-crc32sum-command string                        The command used to read CRC-32 hashes
      --sftp-description string                             Description of the remote
      --sftp-disable-concurrent-reads                       If set don&#39;t use concurrent reads
      --sftp-disable-concurrent-writes                      If set don&#39;t use concurrent writes
      --sftp-disable-hashcheck                              Disable the execution of SSH commands to determine if remote file hashing is available
      --sftp-hashes CommaSepList                            Comma separated list of supported checksum types
      --sftp-host string                                    SSH host to connect to
      --sftp-host-key-algorithms SpaceSepList               Space separated list of host key algorithms, ordered by preference
      --sftp-http-proxy string                              URL for HTTP CONNECT proxy
      --sftp-idle-timeout Duration                          Max time before closing idle connections (default 1m0s)
      --sftp-key-exchange SpaceSepList                      Space separated list of key exchange algorithms, ordered by preference
      --sftp-key-file string                                Path to PEM-encoded private key file
      --sftp-key-file-pass string                           The passphrase to decrypt the PEM-encoded private key file (obscured)
      --sftp-key-pem string                                 Raw PEM-encoded private key
      --sftp-key-use-agent                                  When set forces the usage of the ssh-agent
      --sftp-known-hosts-file string                        Optional path to known_hosts file
      --sftp-macs SpaceSepList                              Space separated list of MACs (message authentication code) algorithms, ordered by preference
      --sftp-md5sum-command string                          The command used to read MD5 hashes
      --sftp-pass string                                    SSH password, leave blank to use ssh-agent (obscured)
      --sftp-path-override string                           Override path used by SSH shell commands
      --sftp-port int                                       SSH port number (default 22)
      --sftp-pubkey string                                  SSH public certificate for public certificate based authentication
      --sftp-pubkey-file string                             Optional path to public key file
      --sftp-server-command string                          Specifies the path or command to run a sftp server on the remote host
      --sftp-set-env SpaceSepList                           Environment variables to pass to sftp and commands
      --sftp-set-modtime                                    Set the modified time on the remote if set (default true)
      --sftp-sha1sum-command string                         The command used to read SHA-1 hashes
      --sftp-sha256sum-command string                       The command used to read SHA-256 hashes
      --sftp-shell-type string                              The type of SSH shell on remote server, if any
      --sftp-skip-links                                     Set to skip any symlinks and any other non regular files
      --sftp-socks-proxy string                             Socks 5 proxy host
      --sftp-ssh SpaceSepList                               Path and arguments to external ssh binary
      --sftp-subsystem string                               Specifies the SSH2 subsystem on the remote host (default &quot;sftp&quot;)
      --sftp-use-fstat                                      If set use fstat instead of stat
      --sftp-use-insecure-cipher                            Enable the use of insecure ciphers and key exchange methods
      --sftp-user string                                    SSH username (default &quot;$USER&quot;)
      --sftp-xxh128sum-command string                       The command used to read XXH128 hashes
      --sftp-xxh3sum-command string                         The command used to read XXH3 hashes
      --sharefile-auth-url string                           Auth server URL
      --sharefile-chunk-size SizeSuffix                     Upload chunk size (default 64Mi)
      --sharefile-client-credentials                        Use client credentials OAuth flow
      --sharefile-client-id string                          OAuth Client Id
      --sharefile-client-secret string                      OAuth Client Secret
      --sharefile-description string                        Description of the remote
      --sharefile-encoding Encoding                         The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot)
      --sharefile-endpoint string                           Endpoint for API calls
      --sharefile-root-folder-id string                     ID of the root folder
      --sharefile-token string                              OAuth Access Token as a JSON blob
      --sharefile-token-url string                          Token server url
      --sharefile-upload-cutoff SizeSuffix                  Cutoff for switching to multipart upload (default 128Mi)
      --sia-api-password string                             Sia Daemon API Password (obscured)
      --sia-api-url string                                  Sia daemon API URL, like http://sia.daemon.host:9980 (default &quot;http://127.0.0.1:9980&quot;)
      --sia-description string                              Description of the remote
      --sia-encoding Encoding                               The encoding for the backend (default Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot)
      --sia-user-agent string                               Siad User Agent (default &quot;Sia-Agent&quot;)
      --skip-links                                          Don&#39;t warn about skipped symlinks
      --smb-case-insensitive                                Whether the server is configured to be case-insensitive (default true)
      --smb-description string                              Description of the remote
      --smb-domain string                                   Domain name for NTLM authentication (default &quot;WORKGROUP&quot;)
      --smb-encoding Encoding                               The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot)
      --smb-hide-special-share                              Hide special shares (e.g. print$) which users aren&#39;t supposed to access (default true)
      --smb-host string                                     SMB server hostname to connect to
      --smb-idle-timeout Duration                           Max time before closing idle connections (default 1m0s)
      --smb-kerberos-ccache string                          Path to the Kerberos credential cache (krb5cc)
      --smb-pass string                                     SMB password (obscured)
      --smb-port int                                        SMB port number (default 445)
      --smb-spn string                                      Service principal name
      --smb-use-kerberos                                    Use Kerberos authentication
      --smb-user string                                     SMB username (default &quot;$USER&quot;)
      --storj-access-grant string                           Access grant
      --storj-api-key string                                API key
      --storj-description string                            Description of the remote
      --storj-passphrase string                             Encryption passphrase
      --storj-provider string                               Choose an authentication method (default &quot;existing&quot;)
      --storj-satellite-address string                      Satellite address (default &quot;us1.storj.io&quot;)
      --sugarsync-access-key-id string                      Sugarsync Access Key ID
      --sugarsync-app-id string                             Sugarsync App ID
      --sugarsync-authorization string                      Sugarsync authorization
      --sugarsync-authorization-expiry string               Sugarsync authorization expiry
      --sugarsync-deleted-id string                         Sugarsync deleted folder id
      --sugarsync-description string                        Description of the remote
      --sugarsync-encoding Encoding                         The encoding for the backend (default Slash,Ctl,InvalidUtf8,Dot)
      --sugarsync-hard-delete                               Permanently delete files if true
      --sugarsync-private-access-key string                 Sugarsync Private Access Key
      --sugarsync-refresh-token string                      Sugarsync refresh token
      --sugarsync-root-id string                            Sugarsync root id
      --sugarsync-user string                               Sugarsync user
      --swift-application-credential-id string              Application Credential ID (OS_APPLICATION_CREDENTIAL_ID)
      --swift-application-credential-name string            Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME)
      --swift-application-credential-secret string          Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET)
      --swift-auth string                                   Authentication URL for server (OS_AUTH_URL)
      --swift-auth-token string                             Auth Token from alternate authentication - optional (OS_AUTH_TOKEN)
      --swift-auth-version int                              AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION)
      --swift-chunk-size SizeSuffix                         Above this size files will be chunked (default 5Gi)
      --swift-description string                            Description of the remote
      --swift-domain string                                 User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)
      --swift-encoding Encoding                             The encoding for the backend (default Slash,InvalidUtf8)
      --swift-endpoint-type string                          Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default &quot;public&quot;)
      --swift-env-auth                                      Get swift credentials from environment variables in standard OpenStack form
      --swift-fetch-until-empty-page                        When paginating, always fetch unless we received an empty page
      --swift-key string                                    API key or password (OS_PASSWORD)
      --swift-leave-parts-on-error                          If true avoid calling abort upload on a failure
      --swift-no-chunk                                      Don&#39;t chunk files during streaming upload
      --swift-no-large-objects                              Disable support for static and dynamic large objects
      --swift-partial-page-fetch-threshold int              When paginating, fetch if the current page is within this percentage of the limit
      --swift-region string                                 Region name - optional (OS_REGION_NAME)
      --swift-storage-policy string                         The storage policy to use when creating a new container
      --swift-storage-url string                            Storage URL - optional (OS_STORAGE_URL)
      --swift-tenant string                                 Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME)
      --swift-tenant-domain string                          Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME)
      --swift-tenant-id string                              Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID)
      --swift-use-segments-container Tristate               Choose destination for large object segments (default unset)
      --swift-user string                                   User name to log in (OS_USERNAME)
      --swift-user-id string                                User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID)
      --ulozto-app-token string                             The application token identifying the app. An app API key can be either found in the API
      --ulozto-description string                           Description of the remote
      --ulozto-encoding Encoding                            The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --ulozto-list-page-size int                           The size of a single page for list commands. 1-500 (default 500)
      --ulozto-password string                              The password for the user (obscured)
      --ulozto-root-folder-slug string                      If set, rclone will use this folder as the root folder for all operations. For example,
      --ulozto-username string                              The username of the principal to operate as
      --union-action-policy string                          Policy to choose upstream on ACTION category (default &quot;epall&quot;)
      --union-cache-time int                                Cache time of usage and free space (in seconds) (default 120)
      --union-create-policy string                          Policy to choose upstream on CREATE category (default &quot;epmfs&quot;)
      --union-description string                            Description of the remote
      --union-min-free-space SizeSuffix                     Minimum viable free space for lfs/eplfs policies (default 1Gi)
      --union-search-policy string                          Policy to choose upstream on SEARCH category (default &quot;ff&quot;)
      --union-upstreams string                              List of space separated upstreams
      --uptobox-access-token string                         Your access token
      --uptobox-description string                          Description of the remote
      --uptobox-encoding Encoding                           The encoding for the backend (default Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot)
      --uptobox-private                                     Set to make uploaded files private
      --webdav-auth-redirect                                Preserve authentication on redirect
      --webdav-bearer-token string                          Bearer token instead of user/pass (e.g. a Macaroon)
      --webdav-bearer-token-command string                  Command to run to get a bearer token
      --webdav-description string                           Description of the remote
      --webdav-encoding string                              The encoding for the backend
      --webdav-headers CommaSepList                         Set HTTP headers for all transactions
      --webdav-nextcloud-chunk-size SizeSuffix              Nextcloud upload chunk size (default 10Mi)
      --webdav-owncloud-exclude-mounts                      Exclude ownCloud mounted storages
      --webdav-owncloud-exclude-shares                      Exclude ownCloud shares
      --webdav-pacer-min-sleep Duration                     Minimum time to sleep between API calls (default 10ms)
      --webdav-pass string                                  Password (obscured)
      --webdav-unix-socket string                           Path to a unix domain socket to dial to, instead of opening a TCP connection directly
      --webdav-url string                                   URL of http host to connect to
      --webdav-user string                                  User name
      --webdav-vendor string                                Name of the WebDAV site/service/software you are using
      --yandex-auth-url string                              Auth server URL
      --yandex-client-credentials                           Use client credentials OAuth flow
      --yandex-client-id string                             OAuth Client Id
      --yandex-client-secret string                         OAuth Client Secret
      --yandex-description string                           Description of the remote
      --yandex-encoding Encoding                            The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
      --yandex-hard-delete                                  Delete files permanently rather than putting them into the trash
      --yandex-spoof-ua                                     Set the user agent to match an official version of the yandex disk client. May help with upload performance (default true)
      --yandex-token string                                 OAuth Access Token as a JSON blob
      --yandex-token-url string                             Token server url
      --zoho-auth-url string                                Auth server URL
      --zoho-client-credentials                             Use client credentials OAuth flow
      --zoho-client-id string                               OAuth Client Id
      --zoho-client-secret string                           OAuth Client Secret
      --zoho-description string                             Description of the remote
      --zoho-encoding Encoding                              The encoding for the backend (default Del,Ctl,InvalidUtf8)
      --zoho-region string                                  Zoho region to connect to
      --zoho-token string                                   OAuth Access Token as a JSON blob
      --zoho-token-url string                               Token server url
      --zoho-upload-cutoff SizeSuffix                       Cutoff for switching to large file upload api (&gt;= 10 MiB) (default 10Mi)</code></pre>
<h1 id="docker-volume-plugin">Docker Volume Plugin</h1>
<h2 id="introduction">Introduction</h2>
<p>Docker 1.9 has added support for creating <a
href="https://docs.docker.com/storage/volumes/">named volumes</a> via <a
href="https://docs.docker.com/engine/reference/commandline/volume_create/">command-line
interface</a> and mounting them in containers as a way to share data
between them. Since Docker 1.10 you can create named volumes with <a
href="https://docs.docker.com/compose/">Docker Compose</a> by
descriptions in <a
href="https://docs.docker.com/compose/compose-file/compose-file-v2/#volume-configuration-reference">docker-compose.yml</a>
files for use by container groups on a single host. As of Docker 1.12
volumes are supported by <a
href="https://docs.docker.com/engine/swarm/key-concepts/">Docker
Swarm</a> included with Docker Engine and created from descriptions in
<a
href="https://docs.docker.com/compose/compose-file/compose-file-v3/#volume-configuration-reference">swarm
compose v3</a> files for use with <em>swarm stacks</em> across multiple
cluster nodes.</p>
<p><a
href="https://docs.docker.com/engine/extend/plugins_volume/">Docker
Volume Plugins</a> augment the default <code>local</code> volume driver
included in Docker with stateful volumes shared across containers and
hosts. Unlike local volumes, your data will <em>not</em> be deleted when
such volume is removed. Plugins can run managed by the docker daemon, as
a native system service (under systemd, <em>sysv</em> or
<em>upstart</em>) or as a standalone executable. Rclone can run as
docker volume plugin in all these modes. It interacts with the local
docker daemon via <a
href="https://docs.docker.com/engine/extend/plugin_api/">plugin API</a>
and handles mounting of remote file systems into docker containers so it
must run on the same host as the docker daemon or on every Swarm
node.</p>
<h2 id="getting-started">Getting started</h2>
<p>In the first example we will use the <a
href="https://rclone.org/sftp/">SFTP</a> rclone volume with Docker
engine on a standalone Ubuntu machine.</p>
<p>Start from <a
href="https://docs.docker.com/engine/install/">installing Docker</a> on
the host.</p>
<p>The <em>FUSE</em> driver is a prerequisite for rclone mounting and
should be installed on host:</p>
<div class="sourceCode" id="cb846"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb846-1"><a href="#cb846-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> apt-get <span class="at">-y</span> install fuse3</span></code></pre></div>
<p>Create two directories required by rclone docker plugin:</p>
<div class="sourceCode" id="cb847"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb847-1"><a href="#cb847-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> mkdir <span class="at">-p</span> /var/lib/docker-plugins/rclone/config</span>
<span id="cb847-2"><a href="#cb847-2" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> mkdir <span class="at">-p</span> /var/lib/docker-plugins/rclone/cache</span></code></pre></div>
<p>Install the managed rclone docker plugin for your architecture (here
<code>amd64</code>):</p>
<div class="sourceCode" id="cb848"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb848-1"><a href="#cb848-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin install rclone/docker-volume-rclone:amd64 args=<span class="st">&quot;-v&quot;</span> <span class="at">--alias</span> rclone <span class="at">--grant-all-permissions</span></span>
<span id="cb848-2"><a href="#cb848-2" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin list</span></code></pre></div>
<p>Create your <a href="https://rclone.org/sftp/#standard-options">SFTP
volume</a>:</p>
<div class="sourceCode" id="cb849"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb849-1"><a href="#cb849-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> volume create firstvolume <span class="at">-d</span> rclone <span class="at">-o</span> type=sftp <span class="at">-o</span> sftp-host=_hostname_ <span class="at">-o</span> sftp-user=_username_ <span class="at">-o</span> sftp-pass=_password_ <span class="at">-o</span> allow-other=true</span></code></pre></div>
<p>Note that since all options are static, you don't even have to run
<code>rclone config</code> or create the <code>rclone.conf</code> file
(but the <code>config</code> directory should still be present). In the
simplest case you can use <code>localhost</code> as <em>hostname</em>
and your SSH credentials as <em>username</em> and <em>password</em>. You
can also change the remote path to your home directory on the host, for
example <code>-o path=/home/username</code>.</p>
<p>Time to create a test container and mount the volume into it:</p>
<div class="sourceCode" id="cb850"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb850-1"><a href="#cb850-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> run <span class="at">--rm</span> <span class="at">-it</span> <span class="at">-v</span> firstvolume:/mnt <span class="at">--workdir</span> /mnt ubuntu:latest bash</span></code></pre></div>
<p>If all goes well, you will enter the new container and change right
to the mounted SFTP remote. You can type <code>ls</code> to list the
mounted directory or otherwise play with it. Type <code>exit</code> when
you are done. The container will stop but the volume will stay, ready to
be reused. When it's not needed anymore, remove it:</p>
<div class="sourceCode" id="cb851"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb851-1"><a href="#cb851-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> volume list</span>
<span id="cb851-2"><a href="#cb851-2" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> volume remove firstvolume</span></code></pre></div>
<p>Now let us try <strong>something more elaborate</strong>: <a
href="https://rclone.org/drive/">Google Drive</a> volume on multi-node
Docker Swarm.</p>
<p>You should start from installing Docker and FUSE, creating plugin
directories and installing rclone plugin on <em>every</em> swarm node.
Then <a href="https://docs.docker.com/engine/swarm/swarm-mode/">setup
the Swarm</a>.</p>
<p>Google Drive volumes need an access token which can be setup via web
browser and will be periodically renewed by rclone. The managed plugin
cannot run a browser so we will use a technique similar to the <a
href="https://rclone.org/remote_setup/">rclone setup on a headless
box</a>.</p>
<p>Run <a
href="https://rclone.org/commands/rclone_config_create/">rclone
config</a> on <em>another</em> machine equipped with <em>web
browser</em> and graphical user interface. Create the <a
href="https://rclone.org/drive/#standard-options">Google Drive
remote</a>. When done, transfer the resulting <code>rclone.conf</code>
to the Swarm cluster and save as
<code>/var/lib/docker-plugins/rclone/config/rclone.conf</code> on
<em>every</em> node. By default this location is accessible only to the
root user so you will need appropriate privileges. The resulting config
will look like this:</p>
<div class="sourceCode" id="cb852"><pre
class="sourceCode ini"><code class="sourceCode ini"><span id="cb852-1"><a href="#cb852-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[gdrive]</span></span>
<span id="cb852-2"><a href="#cb852-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> drive</span></span>
<span id="cb852-3"><a href="#cb852-3" aria-hidden="true" tabindex="-1"></a><span class="dt">scope </span><span class="ot">=</span><span class="st"> drive</span></span>
<span id="cb852-4"><a href="#cb852-4" aria-hidden="true" tabindex="-1"></a><span class="dt">drive_id </span><span class="ot">=</span><span class="st"> 1234567...</span></span>
<span id="cb852-5"><a href="#cb852-5" aria-hidden="true" tabindex="-1"></a><span class="dt">root_folder_id </span><span class="ot">=</span><span class="st"> 0Abcd...</span></span>
<span id="cb852-6"><a href="#cb852-6" aria-hidden="true" tabindex="-1"></a><span class="dt">token </span><span class="ot">=</span><span class="st"> {&quot;access_token&quot;:...}</span></span></code></pre></div>
<p>Now create the file named <code>example.yml</code> with a swarm stack
description like this:</p>
<div class="sourceCode" id="cb853"><pre
class="sourceCode yml"><code class="sourceCode yaml"><span id="cb853-1"><a href="#cb853-1" aria-hidden="true" tabindex="-1"></a><span class="fu">version</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;3&#39;</span></span>
<span id="cb853-2"><a href="#cb853-2" aria-hidden="true" tabindex="-1"></a><span class="fu">services</span><span class="kw">:</span></span>
<span id="cb853-3"><a href="#cb853-3" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">heimdall</span><span class="kw">:</span></span>
<span id="cb853-4"><a href="#cb853-4" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="fu">image</span><span class="kw">:</span><span class="at"> linuxserver/heimdall:latest</span></span>
<span id="cb853-5"><a href="#cb853-5" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="fu">ports</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="dv">8080</span><span class="at">:</span><span class="dv">80</span><span class="kw">]</span></span>
<span id="cb853-6"><a href="#cb853-6" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="fu">volumes</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="at">configdata:/config</span><span class="kw">]</span></span>
<span id="cb853-7"><a href="#cb853-7" aria-hidden="true" tabindex="-1"></a><span class="fu">volumes</span><span class="kw">:</span></span>
<span id="cb853-8"><a href="#cb853-8" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">configdata</span><span class="kw">:</span></span>
<span id="cb853-9"><a href="#cb853-9" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="fu">driver</span><span class="kw">:</span><span class="at"> rclone</span></span>
<span id="cb853-10"><a href="#cb853-10" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="fu">driver_opts</span><span class="kw">:</span></span>
<span id="cb853-11"><a href="#cb853-11" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">remote</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;gdrive:heimdall&#39;</span></span>
<span id="cb853-12"><a href="#cb853-12" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">allow_other</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;true&#39;</span></span>
<span id="cb853-13"><a href="#cb853-13" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">vfs_cache_mode</span><span class="kw">:</span><span class="at"> full</span></span>
<span id="cb853-14"><a href="#cb853-14" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">poll_interval</span><span class="kw">:</span><span class="at"> </span><span class="dv">0</span></span></code></pre></div>
<p>and run the stack:</p>
<div class="sourceCode" id="cb854"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb854-1"><a href="#cb854-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> stack deploy example <span class="at">-c</span> ./example.yml</span></code></pre></div>
<p>After a few seconds docker will spread the parsed stack description
over cluster, create the <code>example_heimdall</code> service on port
<em>8080</em>, run service containers on one or more cluster nodes and
request the <code>example_configdata</code> volume from rclone plugins
on the node hosts. You can use the following commands to confirm
results:</p>
<div class="sourceCode" id="cb855"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb855-1"><a href="#cb855-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> service ls</span>
<span id="cb855-2"><a href="#cb855-2" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> service ps example_heimdall</span>
<span id="cb855-3"><a href="#cb855-3" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> volume ls</span></code></pre></div>
<p>Point your browser to <code>http://cluster.host.address:8080</code>
and play with the service. Stop it with
<code>docker stack remove example</code> when you are done. Note that
the <code>example_configdata</code> volume(s) created on demand at the
cluster nodes will not be automatically removed together with the stack
but stay for future reuse. You can remove them manually by invoking the
<code>docker volume remove example_configdata</code> command on every
node.</p>
<h2 id="creating-volumes-via-cli">Creating Volumes via CLI</h2>
<p>Volumes can be created with <a
href="https://docs.docker.com/engine/reference/commandline/volume_create/">docker
volume create</a>. Here are a few examples:</p>
<div class="sourceCode" id="cb856"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb856-1"><a href="#cb856-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> volume create vol1 <span class="at">-d</span> rclone <span class="at">-o</span> remote=storj: <span class="at">-o</span> vfs-cache-mode=full</span>
<span id="cb856-2"><a href="#cb856-2" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> volume create vol2 <span class="at">-d</span> rclone <span class="at">-o</span> remote=:storj,access_grant=xxx:heimdall</span>
<span id="cb856-3"><a href="#cb856-3" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> volume create vol3 <span class="at">-d</span> rclone <span class="at">-o</span> type=storj <span class="at">-o</span> path=heimdall <span class="at">-o</span> storj-access-grant=xxx <span class="at">-o</span> poll-interval=0</span></code></pre></div>
<p>Note the <code>-d rclone</code> flag that tells docker to request
volume from the rclone driver. This works even if you installed managed
driver by its full name <code>rclone/docker-volume-rclone</code> because
you provided the <code>--alias rclone</code> option.</p>
<p>Volumes can be inspected as follows:</p>
<div class="sourceCode" id="cb857"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb857-1"><a href="#cb857-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> volume list</span>
<span id="cb857-2"><a href="#cb857-2" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> volume inspect vol1</span></code></pre></div>
<h2 id="volume-configuration">Volume Configuration</h2>
<p>Rclone flags and volume options are set via the <code>-o</code> flag
to the <code>docker volume create</code> command. They include
backend-specific parameters as well as mount and <em>VFS</em> options.
Also there are a few special <code>-o</code> options:
<code>remote</code>, <code>fs</code>, <code>type</code>,
<code>path</code>, <code>mount-type</code> and <code>persist</code>.</p>
<p><code>remote</code> determines an existing remote name from the
config file, with trailing colon and optionally with a remote path. See
the full syntax in the <a
href="https://rclone.org/docs/#syntax-of-remote-paths">rclone
documentation</a>. This option can be aliased as <code>fs</code> to
prevent confusion with the <em>remote</em> parameter of such backends as
<em>crypt</em> or <em>alias</em>.</p>
<p>The <code>remote=:backend:dir/subdir</code> syntax can be used to
create <a href="https://rclone.org/docs/#backend-path-to-dir">on-the-fly
(config-less) remotes</a>, while the <code>type</code> and
<code>path</code> options provide a simpler alternative for this. Using
two split options</p>
<div class="sourceCode" id="cb858"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb858-1"><a href="#cb858-1" aria-hidden="true" tabindex="-1"></a><span class="ex">-o</span> type=backend <span class="at">-o</span> path=dir/subdir</span></code></pre></div>
<p>is equivalent to the combined syntax</p>
<div class="sourceCode" id="cb859"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb859-1"><a href="#cb859-1" aria-hidden="true" tabindex="-1"></a><span class="ex">-o</span> remote=:backend:dir/subdir</span></code></pre></div>
<p>but is arguably easier to parameterize in scripts. The
<code>path</code> part is optional.</p>
<p><a
href="https://rclone.org/commands/rclone_serve_docker/#options">Mount
and VFS options</a> as well as <a
href="https://rclone.org/flags/#backend">backend parameters</a> are
named like their twin command-line flags without the <code>--</code> CLI
prefix. Optionally you can use underscores instead of dashes in option
names. For example, <code>--vfs-cache-mode full</code> becomes
<code>-o vfs-cache-mode=full</code> or
<code>-o vfs_cache_mode=full</code>. Boolean CLI flags without value
will gain the <code>true</code> value, e.g. <code>--allow-other</code>
becomes <code>-o allow-other=true</code> or
<code>-o allow_other=true</code>.</p>
<p>Please note that you can provide parameters only for the backend
immediately referenced by the backend type of mounted
<code>remote</code>. If this is a wrapping backend like <em>alias,
chunker or crypt</em>, you cannot provide options for the referred to
remote or backend. This limitation is imposed by the rclone connection
string parser. The only workaround is to feed plugin with
<code>rclone.conf</code> or configure plugin arguments (see below).</p>
<h2 id="special-volume-options">Special Volume Options</h2>
<p><code>mount-type</code> determines the mount method and in general
can be one of: <code>mount</code>, <code>cmount</code>, or
<code>mount2</code>. This can be aliased as <code>mount_type</code>. It
should be noted that the managed rclone docker plugin currently does not
support the <code>cmount</code> method and <code>mount2</code> is rarely
needed. This option defaults to the first found method, which is usually
<code>mount</code> so you generally won't need it.</p>
<p><code>persist</code> is a reserved boolean (true/false) option. In
future it will allow to persist on-the-fly remotes in the plugin
<code>rclone.conf</code> file.</p>
<h2 id="connection-strings-1">Connection Strings</h2>
<p>The <code>remote</code> value can be extended with <a
href="https://rclone.org/docs/#connection-strings">connection
strings</a> as an alternative way to supply backend parameters. This is
equivalent to the <code>-o</code> backend options with one <em>syntactic
difference</em>. Inside connection string the backend prefix must be
dropped from parameter names but in the <code>-o param=value</code>
array it must be present. For instance, compare the following option
array</p>
<div class="sourceCode" id="cb860"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb860-1"><a href="#cb860-1" aria-hidden="true" tabindex="-1"></a><span class="ex">-o</span> remote=:sftp:/home <span class="at">-o</span> sftp-host=localhost</span></code></pre></div>
<p>with equivalent connection string:</p>
<div class="sourceCode" id="cb861"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb861-1"><a href="#cb861-1" aria-hidden="true" tabindex="-1"></a><span class="ex">-o</span> remote=:sftp,host=localhost:/home</span></code></pre></div>
<p>This difference exists because flag options <code>-o key=val</code>
include not only backend parameters but also mount/VFS flags and
possibly other settings. Also it allows to discriminate the
<code>remote</code> option from the <code>crypt-remote</code> (or
similarly named backend parameters) and arguably simplifies scripting
due to clearer value substitution.</p>
<h2 id="using-with-swarm-or-compose">Using with Swarm or Compose</h2>
<p>Both <em>Docker Swarm</em> and <em>Docker Compose</em> use <a
href="http://yaml.org/spec/1.2/spec.html">YAML</a>-formatted text files
to describe groups (stacks) of containers, their properties, networks
and volumes. <em>Compose</em> uses the <a
href="https://docs.docker.com/compose/compose-file/compose-file-v2/#volume-configuration-reference">compose
v2</a> format, <em>Swarm</em> uses the <a
href="https://docs.docker.com/compose/compose-file/compose-file-v3/#volume-configuration-reference">compose
v3</a> format. They are mostly similar, differences are explained in the
<a
href="https://docs.docker.com/compose/compose-file/compose-versioning/#upgrading">docker
documentation</a>.</p>
<p>Volumes are described by the children of the top-level
<code>volumes:</code> node. Each of them should be named after its
volume and have at least two elements, the self-explanatory
<code>driver: rclone</code> value and the <code>driver_opts:</code>
structure playing the same role as <code>-o key=val</code> CLI
flags:</p>
<div class="sourceCode" id="cb862"><pre
class="sourceCode yml"><code class="sourceCode yaml"><span id="cb862-1"><a href="#cb862-1" aria-hidden="true" tabindex="-1"></a><span class="fu">volumes</span><span class="kw">:</span></span>
<span id="cb862-2"><a href="#cb862-2" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">volume_name_1</span><span class="kw">:</span></span>
<span id="cb862-3"><a href="#cb862-3" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="fu">driver</span><span class="kw">:</span><span class="at"> rclone</span></span>
<span id="cb862-4"><a href="#cb862-4" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="fu">driver_opts</span><span class="kw">:</span></span>
<span id="cb862-5"><a href="#cb862-5" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">remote</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;gdrive:&#39;</span></span>
<span id="cb862-6"><a href="#cb862-6" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">allow_other</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;true&#39;</span></span>
<span id="cb862-7"><a href="#cb862-7" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">vfs_cache_mode</span><span class="kw">:</span><span class="at"> full</span></span>
<span id="cb862-8"><a href="#cb862-8" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">token</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;{&quot;type&quot;: &quot;borrower&quot;, &quot;expires&quot;: &quot;2021-12-31&quot;}&#39;</span></span>
<span id="cb862-9"><a href="#cb862-9" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">poll_interval</span><span class="kw">:</span><span class="at"> </span><span class="dv">0</span></span></code></pre></div>
<p>Notice a few important details:</p>
<ul>
<li>YAML prefers <code>_</code> in option names instead of
<code>-</code>.</li>
<li>YAML treats single and double quotes interchangeably. Simple strings
and integers can be left unquoted.</li>
<li>Boolean values must be quoted like <code>'true'</code> or
<code>"false"</code> because these two words are reserved by YAML.</li>
<li>The filesystem string is keyed with <code>remote</code> (or with
<code>fs</code>). Normally you can omit quotes here, but if the string
ends with colon, you <strong>must</strong> quote it like
<code>remote: "storage_box:"</code>.</li>
<li>YAML is picky about surrounding braces in values as this is in fact
another <a href="http://yaml.org/spec/1.2/spec.html#id2790832">syntax
for key/value mappings</a>. For example, JSON access tokens usually
contain double quotes and surrounding braces, so you must put them in
single quotes.</li>
</ul>
<h2 id="installing-as-managed-plugin">Installing as Managed Plugin</h2>
<p>Docker daemon can install plugins from an image registry and run them
managed. We maintain the <a
href="https://hub.docker.com/p/rclone/docker-volume-rclone/">docker-volume-rclone</a>
plugin image on <a href="https://hub.docker.com">Docker Hub</a>.</p>
<p>Rclone volume plugin requires <strong>Docker Engine &gt;=
19.03.15</strong></p>
<p>The plugin requires presence of two directories on the host before it
can be installed. Note that plugin will <strong>not</strong> create them
automatically. By default they must exist on host at the following
locations (though you can tweak the paths):</p>
<ul>
<li><code>/var/lib/docker-plugins/rclone/config</code> is reserved for
the <code>rclone.conf</code> config file and <strong>must</strong> exist
even if it's empty and the config file is not present.</li>
<li><code>/var/lib/docker-plugins/rclone/cache</code> holds the plugin
state file as well as optional VFS caches.</li>
</ul>
<p>You can <a
href="https://docs.docker.com/engine/reference/commandline/plugin_install/">install
managed plugin</a> with default settings as follows:</p>
<div class="sourceCode" id="cb863"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb863-1"><a href="#cb863-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin install rclone/docker-volume-rclone:amd64 <span class="at">--grant-all-permissions</span> <span class="at">--alias</span> rclone</span></code></pre></div>
<p>The <code>:amd64</code> part of the image specification after colon
is called a <em>tag</em>. Usually you will want to install the latest
plugin for your architecture. In this case the tag will just name it,
like <code>amd64</code> above. The following plugin architectures are
currently available:</p>
<ul>
<li><code>amd64</code></li>
<li><code>arm64</code></li>
<li><code>arm-v7</code></li>
</ul>
<p>Sometimes you might want a concrete plugin version, not the latest
one. Then you should use image tag in the form
<code>:ARCHITECTURE-VERSION</code>. For example, to install plugin
version <code>v1.56.2</code> on architecture <code>arm64</code> you will
use tag <code>arm64-1.56.2</code> (note the removed <code>v</code>) so
the full image specification becomes
<code>rclone/docker-volume-rclone:arm64-1.56.2</code>.</p>
<p>We also provide the <code>latest</code> plugin tag, but since docker
does not support multi-architecture plugins as of the time of this
writing, this tag is currently an <strong>alias for
<code>amd64</code></strong>. By convention the <code>latest</code> tag
is the default one and can be omitted, thus both
<code>rclone/docker-volume-rclone:latest</code> and just
<code>rclone/docker-volume-rclone</code> will refer to the latest plugin
release for the <code>amd64</code> platform.</p>
<p>Also the <code>amd64</code> part can be omitted from the versioned
rclone plugin tags. For example, rclone image reference
<code>rclone/docker-volume-rclone:amd64-1.56.2</code> can be abbreviated
as <code>rclone/docker-volume-rclone:1.56.2</code> for convenience.
However, for non-intel architectures you still have to use the full tag
as <code>amd64</code> or <code>latest</code> will fail to start.</p>
<p>Managed plugin is in fact a special container running in a namespace
separate from normal docker containers. Inside it runs the
<code>rclone serve docker</code> command. The config and cache
directories are bind-mounted into the container at start. The docker
daemon connects to a unix socket created by the command inside the
container. The command creates on-demand remote mounts right inside,
then docker machinery propagates them through kernel mount namespaces
and bind-mounts into requesting user containers.</p>
<p>You can tweak a few plugin settings after installation when it's
disabled (not in use), for instance:</p>
<div class="sourceCode" id="cb864"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb864-1"><a href="#cb864-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin disable rclone</span>
<span id="cb864-2"><a href="#cb864-2" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin set rclone RCLONE_VERBOSE=2 config=/etc/rclone args=<span class="st">&quot;--vfs-cache-mode=writes --allow-other&quot;</span></span>
<span id="cb864-3"><a href="#cb864-3" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin enable rclone</span>
<span id="cb864-4"><a href="#cb864-4" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin inspect rclone</span></code></pre></div>
<p>Note that if docker refuses to disable the plugin, you should find
and remove all active volumes connected with it as well as containers
and swarm services that use them. This is rather tedious so please
carefully plan in advance.</p>
<p>You can tweak the following settings: <code>args</code>,
<code>config</code>, <code>cache</code>, <code>HTTP_PROXY</code>,
<code>HTTPS_PROXY</code>, <code>NO_PROXY</code> and
<code>RCLONE_VERBOSE</code>. It's <em>your</em> task to keep plugin
settings in sync across swarm cluster nodes.</p>
<p><code>args</code> sets command-line arguments for the
<code>rclone serve docker</code> command (<em>none</em> by default).
Arguments should be separated by space so you will normally want to put
them in quotes on the <a
href="https://docs.docker.com/engine/reference/commandline/plugin_set/">docker
plugin set</a> command line. Both <a
href="https://rclone.org/commands/rclone_serve_docker/#options">serve
docker flags</a> and <a href="https://rclone.org/flags/">generic rclone
flags</a> are supported, including backend parameters that will be used
as defaults for volume creation. Note that plugin will fail (due to <a
href="https://github.com/moby/moby/blob/v20.10.7/plugin/v2/plugin.go#L195">this
docker bug</a>) if the <code>args</code> value is empty. Use e.g.
<code>args="-v"</code> as a workaround.</p>
<p><code>config=/host/dir</code> sets alternative host location for the
config directory. Plugin will look for <code>rclone.conf</code> here.
It's not an error if the config file is not present but the directory
must exist. Please note that plugin can periodically rewrite the config
file, for example when it renews storage access tokens. Keep this in
mind and try to avoid races between the plugin and other instances of
rclone on the host that might try to change the config simultaneously
resulting in corrupted <code>rclone.conf</code>. You can also put stuff
like private key files for SFTP remotes in this directory. Just note
that it's bind-mounted inside the plugin container at the predefined
path <code>/data/config</code>. For example, if your key file is named
<code>sftp-box1.key</code> on the host, the corresponding volume config
option should read
<code>-o sftp-key-file=/data/config/sftp-box1.key</code>.</p>
<p><code>cache=/host/dir</code> sets alternative host location for the
<em>cache</em> directory. The plugin will keep VFS caches here. Also it
will create and maintain the <code>docker-plugin.state</code> file in
this directory. When the plugin is restarted or reinstalled, it will
look in this file to recreate any volumes that existed previously.
However, they will not be re-mounted into consuming containers after
restart. Usually this is not a problem as the docker daemon normally
will restart affected user containers after failures, daemon restarts or
host reboots.</p>
<p><code>RCLONE_VERBOSE</code> sets plugin verbosity from <code>0</code>
(errors only, by default) to <code>2</code> (debugging). Verbosity can
be also tweaked via <code>args="-v [-v] ..."</code>. Since arguments are
more generic, you will rarely need this setting. The plugin output by
default feeds the docker daemon log on local host. Log entries are
reflected as <em>errors</em> in the docker log but retain their actual
level assigned by rclone in the encapsulated message string.</p>
<p><code>HTTP_PROXY</code>, <code>HTTPS_PROXY</code>,
<code>NO_PROXY</code> customize the plugin proxy settings.</p>
<p>You can set custom plugin options right when you install it, <em>in
one go</em>:</p>
<div class="sourceCode" id="cb865"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb865-1"><a href="#cb865-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin remove rclone</span>
<span id="cb865-2"><a href="#cb865-2" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin install rclone/docker-volume-rclone:amd64 <span class="dt">\</span></span>
<span id="cb865-3"><a href="#cb865-3" aria-hidden="true" tabindex="-1"></a>       <span class="at">--alias</span> rclone <span class="at">--grant-all-permissions</span> <span class="dt">\</span></span>
<span id="cb865-4"><a href="#cb865-4" aria-hidden="true" tabindex="-1"></a>       args=<span class="st">&quot;-v --allow-other&quot;</span> config=/etc/rclone</span>
<span id="cb865-5"><a href="#cb865-5" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin inspect rclone</span></code></pre></div>
<h2 id="healthchecks">Healthchecks</h2>
<p>The docker plugin volume protocol doesn't provide a way for plugins
to inform the docker daemon that a volume is (un-)available. As a
workaround you can setup a healthcheck to verify that the mount is
responding, for example:</p>
<div class="sourceCode" id="cb866"><pre
class="sourceCode yml"><code class="sourceCode yaml"><span id="cb866-1"><a href="#cb866-1" aria-hidden="true" tabindex="-1"></a><span class="fu">services</span><span class="kw">:</span></span>
<span id="cb866-2"><a href="#cb866-2" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">my_service</span><span class="kw">:</span></span>
<span id="cb866-3"><a href="#cb866-3" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="fu">image</span><span class="kw">:</span><span class="at"> my_image</span></span>
<span id="cb866-4"><a href="#cb866-4" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="fu">healthcheck</span><span class="kw">:</span></span>
<span id="cb866-5"><a href="#cb866-5" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">test</span><span class="kw">:</span><span class="at"> ls /path/to/rclone/mount || exit 1</span></span>
<span id="cb866-6"><a href="#cb866-6" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">interval</span><span class="kw">:</span><span class="at"> 1m</span></span>
<span id="cb866-7"><a href="#cb866-7" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">timeout</span><span class="kw">:</span><span class="at"> 15s</span></span>
<span id="cb866-8"><a href="#cb866-8" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">retries</span><span class="kw">:</span><span class="at"> </span><span class="dv">3</span></span>
<span id="cb866-9"><a href="#cb866-9" aria-hidden="true" tabindex="-1"></a><span class="at">      </span><span class="fu">start_period</span><span class="kw">:</span><span class="at"> 15s</span></span></code></pre></div>
<h2 id="running-plugin-under-systemd">Running Plugin under Systemd</h2>
<p>In most cases you should prefer managed mode. Moreover, MacOS and
Windows do not support native Docker plugins. Please use managed mode on
these systems. Proceed further only if you are on Linux.</p>
<p>First, <a href="https://rclone.org/install/">install rclone</a>. You
can just run it (type <code>rclone serve docker</code> and hit enter)
for the test.</p>
<p>Install <em>FUSE</em>:</p>
<div class="sourceCode" id="cb867"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb867-1"><a href="#cb867-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> apt-get <span class="at">-y</span> install fuse</span></code></pre></div>
<p>Download two systemd configuration files: <a
href="https://raw.githubusercontent.com/rclone/rclone/master/contrib/docker-plugin/systemd/docker-volume-rclone.service">docker-volume-rclone.service</a>
and <a
href="https://raw.githubusercontent.com/rclone/rclone/master/contrib/docker-plugin/systemd/docker-volume-rclone.socket">docker-volume-rclone.socket</a>.</p>
<p>Put them to the <code>/etc/systemd/system/</code> directory:</p>
<div class="sourceCode" id="cb868"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb868-1"><a href="#cb868-1" aria-hidden="true" tabindex="-1"></a><span class="fu">cp</span> docker-volume-plugin.service /etc/systemd/system/</span>
<span id="cb868-2"><a href="#cb868-2" aria-hidden="true" tabindex="-1"></a><span class="fu">cp</span> docker-volume-plugin.socket  /etc/systemd/system/</span></code></pre></div>
<p>Please note that all commands in this section must be run as
<em>root</em> but we omit <code>sudo</code> prefix for brevity. Now
create directories required by the service:</p>
<div class="sourceCode" id="cb869"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb869-1"><a href="#cb869-1" aria-hidden="true" tabindex="-1"></a><span class="fu">mkdir</span> <span class="at">-p</span> /var/lib/docker-volumes/rclone</span>
<span id="cb869-2"><a href="#cb869-2" aria-hidden="true" tabindex="-1"></a><span class="fu">mkdir</span> <span class="at">-p</span> /var/lib/docker-plugins/rclone/config</span>
<span id="cb869-3"><a href="#cb869-3" aria-hidden="true" tabindex="-1"></a><span class="fu">mkdir</span> <span class="at">-p</span> /var/lib/docker-plugins/rclone/cache</span></code></pre></div>
<p>Run the docker plugin service in the socket activated mode:</p>
<div class="sourceCode" id="cb870"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb870-1"><a href="#cb870-1" aria-hidden="true" tabindex="-1"></a><span class="ex">systemctl</span> daemon-reload</span>
<span id="cb870-2"><a href="#cb870-2" aria-hidden="true" tabindex="-1"></a><span class="ex">systemctl</span> start docker-volume-rclone.service</span>
<span id="cb870-3"><a href="#cb870-3" aria-hidden="true" tabindex="-1"></a><span class="ex">systemctl</span> enable docker-volume-rclone.socket</span>
<span id="cb870-4"><a href="#cb870-4" aria-hidden="true" tabindex="-1"></a><span class="ex">systemctl</span> start docker-volume-rclone.socket</span>
<span id="cb870-5"><a href="#cb870-5" aria-hidden="true" tabindex="-1"></a><span class="ex">systemctl</span> restart docker</span></code></pre></div>
<p>Or run the service directly:</p>
<ul>
<li>run <code>systemctl daemon-reload</code> to let systemd pick up new
config</li>
<li>run <code>systemctl enable docker-volume-rclone.service</code> to
make the new service start automatically when you power on your
machine.</li>
<li>run <code>systemctl start docker-volume-rclone.service</code> to
start the service now.</li>
<li>run <code>systemctl restart docker</code> to restart docker daemon
and let it detect the new plugin socket. Note that this step is not
needed in managed mode where docker knows about plugin state
changes.</li>
</ul>
<p>The two methods are equivalent from the user perspective, but I
personally prefer socket activation.</p>
<h2 id="troubleshooting-1">Troubleshooting</h2>
<p>You can <a
href="https://docs.docker.com/engine/extend/#debugging-plugins">see
managed plugin settings</a> with</p>
<div class="sourceCode" id="cb871"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb871-1"><a href="#cb871-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin list</span>
<span id="cb871-2"><a href="#cb871-2" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin inspect rclone</span></code></pre></div>
<p>Note that docker (including latest 20.10.7) will not show actual
values of <code>args</code>, just the defaults.</p>
<p>Use <code>journalctl --unit docker</code> to see managed plugin
output as part of the docker daemon log. Note that docker reflects
plugin lines as <em>errors</em> but their actual level can be seen from
encapsulated message string.</p>
<p>You will usually install the latest version of managed plugin for
your platform. Use the following commands to print the actual installed
version:</p>
<div class="sourceCode" id="cb872"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb872-1"><a href="#cb872-1" aria-hidden="true" tabindex="-1"></a><span class="va">PLUGID</span><span class="op">=</span><span class="va">$(</span><span class="ex">docker</span> plugin list <span class="at">--no-trunc</span> <span class="kw">|</span> <span class="fu">awk</span> <span class="st">&#39;/rclone/{print$1}&#39;</span><span class="va">)</span></span>
<span id="cb872-2"><a href="#cb872-2" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> runc <span class="at">--root</span> /run/docker/runtime-runc/plugins.moby exec <span class="va">$PLUGID</span> rclone version</span></code></pre></div>
<p>You can even use <code>runc</code> to run shell inside the plugin
container:</p>
<div class="sourceCode" id="cb873"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb873-1"><a href="#cb873-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> runc <span class="at">--root</span> /run/docker/runtime-runc/plugins.moby exec <span class="at">--tty</span> <span class="va">$PLUGID</span> bash</span></code></pre></div>
<p>Also you can use curl to check the plugin socket connectivity:</p>
<div class="sourceCode" id="cb874"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb874-1"><a href="#cb874-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin list <span class="at">--no-trunc</span></span>
<span id="cb874-2"><a href="#cb874-2" aria-hidden="true" tabindex="-1"></a><span class="va">PLUGID</span><span class="op">=</span>123abc...</span>
<span id="cb874-3"><a href="#cb874-3" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> curl <span class="at">-H</span> Content-Type:application/json <span class="at">-XPOST</span> <span class="at">-d</span> {} <span class="at">--unix-socket</span> /run/docker/plugins/<span class="va">$PLUGID</span>/rclone.sock http://localhost/Plugin.Activate</span></code></pre></div>
<p>though this is rarely needed.</p>
<p>If the plugin fails to work properly, and only as a last resort after
you tried diagnosing with the above methods, you can try clearing the
state of the plugin. <strong>Note that all existing rclone docker
volumes will probably have to be recreated.</strong> This might be
needed because a reinstall don't cleanup existing state files to allow
for easy restoration, as stated above.</p>
<div class="sourceCode" id="cb875"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb875-1"><a href="#cb875-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin disable rclone <span class="co"># disable the plugin to ensure no interference</span></span>
<span id="cb875-2"><a href="#cb875-2" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> rm /var/lib/docker-plugins/rclone/cache/docker-plugin.state <span class="co"># removing the plugin state</span></span>
<span id="cb875-3"><a href="#cb875-3" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> plugin enable rclone <span class="co"># re-enable the plugin afterward</span></span></code></pre></div>
<h2 id="caveats">Caveats</h2>
<p>Finally I'd like to mention a <em>caveat with updating volume
settings</em>. Docker CLI does not have a dedicated command like
<code>docker volume update</code>. It may be tempting to invoke
<code>docker volume create</code> with updated options on existing
volume, but there is a gotcha. The command will do nothing, it won't
even return an error. I hope that docker maintainers will fix this some
day. In the meantime be aware that you must remove your volume before
recreating it with new settings:</p>
<div class="sourceCode" id="cb876"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb876-1"><a href="#cb876-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> volume remove my_vol</span>
<span id="cb876-2"><a href="#cb876-2" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> volume create my_vol <span class="at">-d</span> rclone <span class="at">-o</span> opt1=new_val1 ...</span></code></pre></div>
<p>and verify that settings did update:</p>
<div class="sourceCode" id="cb877"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb877-1"><a href="#cb877-1" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> volume list</span>
<span id="cb877-2"><a href="#cb877-2" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> volume inspect my_vol</span></code></pre></div>
<p>If docker refuses to remove the volume, you should find containers or
swarm services that use it and stop them first.</p>
<h2 id="bisync">Bisync</h2>
<p><code>bisync</code> is considered an <strong>advanced
command</strong>, so use with care. Make sure you have read and
understood the entire <a href="https://rclone.org/bisync">manual</a>
(especially the <a href="#limitations">Limitations</a> section) before
using, or data loss can result. Questions can be asked in the <a
href="https://forum.rclone.org/">Rclone Forum</a>.</p>
<h2 id="getting-started">Getting started</h2>
<ul>
<li><a href="https://rclone.org/install/">Install rclone</a> and setup
your remotes.</li>
<li>Bisync will create its working directory at
<code>~/.cache/rclone/bisync</code> on Linux,
<code>/Users/yourusername/Library/Caches/rclone/bisync</code> on Mac, or
<code>C:\Users\MyLogin\AppData\Local\rclone\bisync</code> on Windows.
Make sure that this location is writable.</li>
<li>Run bisync with the <code>--resync</code> flag, specifying the paths
to the local and remote sync directory roots.</li>
<li>For successive sync runs, leave off the <code>--resync</code> flag.
(<strong>Important!</strong>)</li>
<li>Consider using a <a href="#filtering">filters file</a> for excluding
unnecessary files and directories from the sync.</li>
<li>Consider setting up the <a href="#check-access">--check-access</a>
feature for safety.</li>
<li>On Linux or Mac, consider setting up a <a href="#cron">crontab
entry</a>. bisync can safely run in concurrent cron jobs thanks to lock
files it maintains.</li>
</ul>
<p>For example, your first command might look like this:</p>
<div class="sourceCode" id="cb878"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb878-1"><a href="#cb878-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> bisync remote1:path1 remote2:path2 <span class="at">--create-empty-src-dirs</span> <span class="at">--compare</span> size,modtime,checksum <span class="at">--slow-hash-sync-only</span> <span class="at">--resilient</span> <span class="at">-MvP</span> <span class="at">--drive-skip-gdocs</span> <span class="at">--fix-case</span> <span class="at">--resync</span> <span class="at">--dry-run</span></span></code></pre></div>
<p>If all looks good, run it again without <code>--dry-run</code>. After
that, remove <code>--resync</code> as well.</p>
<p>Here is a typical run log (with timestamps removed for clarity):</p>
<div class="sourceCode" id="cb879"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb879-1"><a href="#cb879-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> bisync /testdir/path1/ /testdir/path2/ <span class="at">--verbose</span></span>
<span id="cb879-2"><a href="#cb879-2" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : Synching Path1 <span class="st">&quot;/testdir/path1/&quot;</span> with Path2 <span class="st">&quot;/testdir/path2/&quot;</span></span>
<span id="cb879-3"><a href="#cb879-3" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : Path1 checking for diffs</span>
<span id="cb879-4"><a href="#cb879-4" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path1    File is new                         <span class="at">-</span> file11.txt</span>
<span id="cb879-5"><a href="#cb879-5" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path1    File is newer                       <span class="at">-</span> file2.txt</span>
<span id="cb879-6"><a href="#cb879-6" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path1    File is newer                       <span class="at">-</span> file5.txt</span>
<span id="cb879-7"><a href="#cb879-7" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path1    File is newer                       <span class="at">-</span> file7.txt</span>
<span id="cb879-8"><a href="#cb879-8" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path1    File was deleted                    <span class="at">-</span> file4.txt</span>
<span id="cb879-9"><a href="#cb879-9" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path1    File was deleted                    <span class="at">-</span> file6.txt</span>
<span id="cb879-10"><a href="#cb879-10" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path1    File was deleted                    <span class="at">-</span> file8.txt</span>
<span id="cb879-11"><a href="#cb879-11" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : Path1:    7 changes:    1 new,    3 newer,    0 older,    3 deleted</span>
<span id="cb879-12"><a href="#cb879-12" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : Path2 checking for diffs</span>
<span id="cb879-13"><a href="#cb879-13" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path2    File is new                         <span class="at">-</span> file10.txt</span>
<span id="cb879-14"><a href="#cb879-14" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path2    File is newer                       <span class="at">-</span> file1.txt</span>
<span id="cb879-15"><a href="#cb879-15" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path2    File is newer                       <span class="at">-</span> file5.txt</span>
<span id="cb879-16"><a href="#cb879-16" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path2    File is newer                       <span class="at">-</span> file6.txt</span>
<span id="cb879-17"><a href="#cb879-17" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path2    File was deleted                    <span class="at">-</span> file3.txt</span>
<span id="cb879-18"><a href="#cb879-18" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path2    File was deleted                    <span class="at">-</span> file7.txt</span>
<span id="cb879-19"><a href="#cb879-19" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path2    File was deleted                    <span class="at">-</span> file8.txt</span>
<span id="cb879-20"><a href="#cb879-20" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : Path2:    7 changes:    1 new,    3 newer,    0 older,    3 deleted</span>
<span id="cb879-21"><a href="#cb879-21" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : Applying changes</span>
<span id="cb879-22"><a href="#cb879-22" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path1    Queue copy to Path2                 <span class="at">-</span> /testdir/path2/file11.txt</span>
<span id="cb879-23"><a href="#cb879-23" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path1    Queue copy to Path2                 <span class="at">-</span> /testdir/path2/file2.txt</span>
<span id="cb879-24"><a href="#cb879-24" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path2    Queue delete                        <span class="at">-</span> /testdir/path2/file4.txt</span>
<span id="cb879-25"><a href="#cb879-25" aria-hidden="true" tabindex="-1"></a><span class="ex">NOTICE:</span> <span class="at">-</span> WARNING  New or changed in both paths        <span class="at">-</span> file5.txt</span>
<span id="cb879-26"><a href="#cb879-26" aria-hidden="true" tabindex="-1"></a><span class="ex">NOTICE:</span> <span class="at">-</span> Path1    Renaming Path1 copy                 <span class="at">-</span> /testdir/path1/file5.txt..path1</span>
<span id="cb879-27"><a href="#cb879-27" aria-hidden="true" tabindex="-1"></a><span class="ex">NOTICE:</span> <span class="at">-</span> Path1    Queue copy to Path2                 <span class="at">-</span> /testdir/path2/file5.txt..path1</span>
<span id="cb879-28"><a href="#cb879-28" aria-hidden="true" tabindex="-1"></a><span class="ex">NOTICE:</span> <span class="at">-</span> Path2    Renaming Path2 copy                 <span class="at">-</span> /testdir/path2/file5.txt..path2</span>
<span id="cb879-29"><a href="#cb879-29" aria-hidden="true" tabindex="-1"></a><span class="ex">NOTICE:</span> <span class="at">-</span> Path2    Queue copy to Path1                 <span class="at">-</span> /testdir/path1/file5.txt..path2</span>
<span id="cb879-30"><a href="#cb879-30" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path2    Queue copy to Path1                 <span class="at">-</span> /testdir/path1/file6.txt</span>
<span id="cb879-31"><a href="#cb879-31" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path1    Queue copy to Path2                 <span class="at">-</span> /testdir/path2/file7.txt</span>
<span id="cb879-32"><a href="#cb879-32" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path2    Queue copy to Path1                 <span class="at">-</span> /testdir/path1/file1.txt</span>
<span id="cb879-33"><a href="#cb879-33" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path2    Queue copy to Path1                 <span class="at">-</span> /testdir/path1/file10.txt</span>
<span id="cb879-34"><a href="#cb879-34" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path1    Queue delete                        <span class="at">-</span> /testdir/path1/file3.txt</span>
<span id="cb879-35"><a href="#cb879-35" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path2    Do queued copies to                 <span class="at">-</span> Path1</span>
<span id="cb879-36"><a href="#cb879-36" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span> Path1    Do queued copies to                 <span class="at">-</span> Path2</span>
<span id="cb879-37"><a href="#cb879-37" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span>          Do queued deletes on                <span class="at">-</span> Path1</span>
<span id="cb879-38"><a href="#cb879-38" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : <span class="at">-</span>          Do queued deletes on                <span class="at">-</span> Path2</span>
<span id="cb879-39"><a href="#cb879-39" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : Updating listings</span>
<span id="cb879-40"><a href="#cb879-40" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : Validating listings for Path1 <span class="st">&quot;/testdir/path1/&quot;</span> vs Path2 <span class="st">&quot;/testdir/path2/&quot;</span></span>
<span id="cb879-41"><a href="#cb879-41" aria-hidden="true" tabindex="-1"></a><span class="ex">INFO</span>  : Bisync successful</span></code></pre></div>
<h2 id="command-line-syntax">Command line syntax</h2>
<div class="sourceCode" id="cb880"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb880-1"><a href="#cb880-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone bisync <span class="at">--help</span></span>
<span id="cb880-2"><a href="#cb880-2" aria-hidden="true" tabindex="-1"></a><span class="ex">Usage:</span></span>
<span id="cb880-3"><a href="#cb880-3" aria-hidden="true" tabindex="-1"></a>  <span class="ex">rclone</span> bisync remote1:path1 remote2:path2 <span class="pp">[</span><span class="ss">flags</span><span class="pp">]</span></span>
<span id="cb880-4"><a href="#cb880-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb880-5"><a href="#cb880-5" aria-hidden="true" tabindex="-1"></a><span class="ex">Positional</span> arguments:</span>
<span id="cb880-6"><a href="#cb880-6" aria-hidden="true" tabindex="-1"></a>  <span class="ex">Path1,</span> Path2  Local path, or remote storage with <span class="st">&#39;:&#39;</span> plus optional path.</span>
<span id="cb880-7"><a href="#cb880-7" aria-hidden="true" tabindex="-1"></a>                <span class="ex">Type</span> <span class="st">&#39;rclone listremotes&#39;</span> for list of configured remotes.</span>
<span id="cb880-8"><a href="#cb880-8" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb880-9"><a href="#cb880-9" aria-hidden="true" tabindex="-1"></a><span class="ex">Optional</span> Flags:</span>
<span id="cb880-10"><a href="#cb880-10" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--backup-dir1</span> string                   <span class="at">--backup-dir</span> for Path1. Must be a non-overlapping path on the same remote.</span>
<span id="cb880-11"><a href="#cb880-11" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--backup-dir2</span> string                   <span class="at">--backup-dir</span> for Path2. Must be a non-overlapping path on the same remote.</span>
<span id="cb880-12"><a href="#cb880-12" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--check-access</span>                         Ensure expected RCLONE_TEST files are found on both Path1 and Path2 filesystems, else abort.</span>
<span id="cb880-13"><a href="#cb880-13" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--check-filename</span> string                Filename for <span class="at">--check-access</span> <span class="er">(</span><span class="ex">default:</span> RCLONE_TEST<span class="kw">)</span></span>
<span id="cb880-14"><a href="#cb880-14" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--check-sync</span> string                    Controls comparison of final listings: true<span class="kw">|</span><span class="fu">false</span><span class="kw">|</span><span class="ex">only</span> <span class="er">(</span><span class="ex">default:</span> true<span class="kw">)</span> <span class="kw">(</span><span class="ex">default</span> <span class="st">&quot;true&quot;</span><span class="kw">)</span></span>
<span id="cb880-15"><a href="#cb880-15" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--compare</span> string                       Comma-separated list of bisync-specific compare options ex. <span class="st">&#39;size,modtime,checksum&#39;</span> <span class="er">(</span><span class="ex">default:</span> <span class="st">&#39;size,modtime&#39;</span><span class="kw">)</span></span>
<span id="cb880-16"><a href="#cb880-16" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--conflict-loser</span> ConflictLoserAction   Action to take on the loser of a sync conflict <span class="er">(</span><span class="ex">when</span> there is a winner<span class="kw">)</span> <span class="ex">or</span> on both files <span class="er">(</span><span class="ex">when</span> there is no winner<span class="kw">)</span><span class="bu">:</span> , num, pathname, delete <span class="er">(</span><span class="ex">default:</span> num<span class="kw">)</span></span>
<span id="cb880-17"><a href="#cb880-17" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--conflict-resolve</span> string              Automatically resolve conflicts by preferring the version that is: none, path1, path2, newer, older, larger, smaller <span class="er">(</span><span class="ex">default:</span> none<span class="kw">)</span> <span class="kw">(</span><span class="ex">default</span> <span class="st">&quot;none&quot;</span><span class="kw">)</span></span>
<span id="cb880-18"><a href="#cb880-18" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--conflict-suffix</span> string               Suffix to use when renaming a <span class="at">--conflict-loser.</span> Can be either one string or two comma-separated strings to assign different suffixes to Path1/Path2. <span class="er">(</span><span class="ex">default:</span> <span class="st">&#39;conflict&#39;</span><span class="kw">)</span></span>
<span id="cb880-19"><a href="#cb880-19" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--create-empty-src-dirs</span>                Sync creation and deletion of empty directories. <span class="er">(</span><span class="ex">Not</span> compatible with <span class="at">--remove-empty-dirs</span><span class="kw">)</span></span>
<span id="cb880-20"><a href="#cb880-20" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--download-hash</span>                        Compute hash by downloading when otherwise unavailable. <span class="er">(</span><span class="ex">warning:</span> may be slow and use lots of data!<span class="kw">)</span></span>
<span id="cb880-21"><a href="#cb880-21" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--filters-file</span> string                  Read filtering patterns from a file</span>
<span id="cb880-22"><a href="#cb880-22" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--force</span>                                Bypass <span class="at">--max-delete</span> safety check and run the sync. Consider using with <span class="at">--verbose</span></span>
<span id="cb880-23"><a href="#cb880-23" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-h,</span> <span class="at">--help</span>                                 help for bisync</span>
<span id="cb880-24"><a href="#cb880-24" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--ignore-listing-checksum</span>              Do not use checksums for listings <span class="er">(</span><span class="ex">add</span> <span class="at">--ignore-checksum</span> to additionally skip post-copy checksum checks<span class="kw">)</span></span>
<span id="cb880-25"><a href="#cb880-25" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--max-lock</span> Duration                    Consider lock files older than this to be expired <span class="er">(</span><span class="ex">default:</span> 0 <span class="er">(</span><span class="ex">never</span> expire<span class="kw">))</span> <span class="kw">(</span><span class="ex">minimum:</span> 2m<span class="kw">)</span> <span class="kw">(</span><span class="ex">default</span> 0s<span class="kw">)</span></span>
<span id="cb880-26"><a href="#cb880-26" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--no-cleanup</span>                           Retain working files <span class="er">(</span><span class="ex">useful</span> for troubleshooting and testing<span class="kw">)</span><span class="bu">.</span></span>
<span id="cb880-27"><a href="#cb880-27" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--no-slow-hash</span>                         Ignore listing checksums only on backends where they are slow</span>
<span id="cb880-28"><a href="#cb880-28" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--recover</span>                              Automatically recover from interruptions without requiring <span class="at">--resync.</span></span>
<span id="cb880-29"><a href="#cb880-29" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--remove-empty-dirs</span>                    Remove ALL empty directories at the final cleanup step.</span>
<span id="cb880-30"><a href="#cb880-30" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--resilient</span>                            Allow future runs to retry after certain less-serious errors, instead of requiring <span class="at">--resync.</span></span>
<span id="cb880-31"><a href="#cb880-31" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-1,</span> <span class="at">--resync</span>                               Performs the resync run. Equivalent to <span class="at">--resync-mode</span> path1. Consider using <span class="at">--verbose</span> or <span class="at">--dry-run</span> first.</span>
<span id="cb880-32"><a href="#cb880-32" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--resync-mode</span> string                   During resync, prefer the version that is: path1, path2, newer, older, larger, smaller <span class="er">(</span><span class="ex">default:</span> path1 if <span class="at">--resync,</span> otherwise none for no resync.<span class="kw">)</span> <span class="kw">(</span><span class="ex">default</span> <span class="st">&quot;none&quot;</span><span class="kw">)</span></span>
<span id="cb880-33"><a href="#cb880-33" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--retries</span> int                          Retry operations this many times if they fail <span class="er">(</span><span class="ex">requires</span> <span class="at">--resilient</span><span class="kw">)</span><span class="bu">.</span> <span class="er">(</span><span class="ex">default</span> 3<span class="kw">)</span></span>
<span id="cb880-34"><a href="#cb880-34" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--retries-sleep</span> Duration               Interval between retrying operations if they fail, e.g. 500ms, 60s, 5m <span class="er">(</span><span class="ex">0</span> to disable<span class="kw">)</span> <span class="kw">(</span><span class="ex">default</span> 0s<span class="kw">)</span></span>
<span id="cb880-35"><a href="#cb880-35" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--slow-hash-sync-only</span>                  Ignore slow checksums for listings and deltas, but still consider them during sync calls.</span>
<span id="cb880-36"><a href="#cb880-36" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--workdir</span> string                       Use custom working dir <span class="at">-</span> useful for testing. <span class="er">(</span><span class="ex">default:</span> {WORKDIR}<span class="kw">)</span></span>
<span id="cb880-37"><a href="#cb880-37" aria-hidden="true" tabindex="-1"></a>      <span class="ex">--max-delete</span> PERCENT                   Safety check on maximum percentage of deleted files allowed. If exceeded, the bisync run will abort. <span class="er">(</span><span class="ex">default:</span> 50%<span class="kw">)</span></span>
<span id="cb880-38"><a href="#cb880-38" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-n,</span> <span class="at">--dry-run</span>                              Go through the motions <span class="at">-</span> No files are copied/deleted.</span>
<span id="cb880-39"><a href="#cb880-39" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-v,</span> <span class="at">--verbose</span>                              Increases logging verbosity. May be specified more than once for more details.</span></code></pre></div>
<p>Arbitrary rclone flags may be specified on the <a
href="https://rclone.org/commands/rclone_bisync/">bisync command
line</a>, for example
<code>rclone bisync ./testdir/path1/ gdrive:testdir/path2/ --drive-skip-gdocs -v -v --timeout 10s</code>
Note that interactions of various rclone flags with bisync process flow
has not been fully tested yet.</p>
<h3 id="paths">Paths</h3>
<p>Path1 and Path2 arguments may be references to any mix of local
directory paths (absolute or relative), UNC paths
(<code>//server/share/path</code>), Windows drive paths (with a drive
letter and <code>:</code>) or configured <a
href="https://rclone.org/docs/#syntax-of-remote-paths">remotes</a> with
optional subdirectory paths. Cloud references are distinguished by
having a <code>:</code> in the argument (see <a href="#windows">Windows
support</a> below).</p>
<p>Path1 and Path2 are treated equally, in that neither has priority for
file changes (except during <a
href="#resync"><code>--resync</code></a>), and access efficiency does
not change whether a remote is on Path1 or Path2.</p>
<p>The listings in bisync working directory (default:
<code>~/.cache/rclone/bisync</code>) are named based on the Path1 and
Path2 arguments so that separate syncs to individual directories within
the tree may be set up, e.g.:
<code>path_to_local_tree..dropbox_subdir.lst</code>.</p>
<p>Any empty directories after the sync on both the Path1 and Path2
filesystems are not deleted by default, unless
<code>--create-empty-src-dirs</code> is specified. If the
<code>--remove-empty-dirs</code> flag is specified, then both paths will
have ALL empty directories purged as the last step in the process.</p>
<h2 id="command-line-flags">Command-line flags</h2>
<h3 id="resync">--resync</h3>
<p>This will effectively make both Path1 and Path2 filesystems contain a
matching superset of all files. By default, Path2 files that do not
exist in Path1 will be copied to Path1, and the process will then copy
the Path1 tree to Path2.</p>
<p>The <code>--resync</code> sequence is roughly equivalent to the
following (but see <a href="#resync-mode"><code>--resync-mode</code></a>
for other options):</p>
<div class="sourceCode" id="cb881"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb881-1"><a href="#cb881-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy Path2 Path1 <span class="at">--ignore-existing</span> <span class="pp">[--</span><span class="ss">create</span><span class="pp">-</span><span class="ss">empty</span><span class="pp">-</span><span class="ss">src</span><span class="pp">-</span><span class="ss">dirs</span><span class="pp">]</span></span>
<span id="cb881-2"><a href="#cb881-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy Path1 Path2 <span class="pp">[--</span><span class="ss">create</span><span class="pp">-</span><span class="ss">empty</span><span class="pp">-</span><span class="ss">src</span><span class="pp">-</span><span class="ss">dirs</span><span class="pp">]</span></span></code></pre></div>
<p>The base directories on both Path1 and Path2 filesystems must exist
or bisync will fail. This is required for safety - that bisync can
verify that both paths are valid.</p>
<p>When using <code>--resync</code>, a newer version of a file on the
Path2 filesystem will (by default) be overwritten by the Path1
filesystem version. (Note that this is <a
href="https://github.com/rclone/rclone/issues/5681#issuecomment-938761815">NOT
entirely symmetrical</a>, and more symmetrical options can be specified
with the <a href="#resync-mode"><code>--resync-mode</code></a> flag.)
Carefully evaluate deltas using <a
href="https://rclone.org/flags/#non-backend-flags">--dry-run</a>.</p>
<p>For a resync run, one of the paths may be empty (no files in the path
tree). The resync run should result in files on both paths, else a
normal non-resync run will fail.</p>
<p>For a non-resync run, either path being empty (no files in the tree)
fails with
<code>Empty current PathN listing. Cannot sync to an empty directory: X.pathN.lst</code>
This is a safety check that an unexpected empty path does not result in
deleting <strong>everything</strong> in the other path.</p>
<p>Note that <code>--resync</code> implies
<code>--resync-mode path1</code> unless a different <a
href="#resync-mode"><code>--resync-mode</code></a> is explicitly
specified. It is not necessary to use both the <code>--resync</code> and
<code>--resync-mode</code> flags -- either one is sufficient without the
other.</p>
<p><strong>Note:</strong> <code>--resync</code> (including
<code>--resync-mode</code>) should only be used under three specific
(rare) circumstances:</p>
<ol type="1">
<li>It is your <em>first</em> bisync run (between these two paths)</li>
<li>You've just made changes to your bisync settings (such as editing
the contents of your <code>--filters-file</code>)</li>
<li>There was an error on the prior run, and as a result, bisync now
requires <code>--resync</code> to recover</li>
</ol>
<p>The rest of the time, you should <em>omit</em> <code>--resync</code>.
The reason is because <code>--resync</code> will only <em>copy</em> (not
<em>sync</em>) each side to the other. Therefore, if you included
<code>--resync</code> for every bisync run, it would never be possible
to delete a file -- the deleted file would always keep reappearing at
the end of every run (because it's being copied from the other side
where it still exists). Similarly, renaming a file would always result
in a duplicate copy (both old and new name) on both sides.</p>
<p>If you find that frequent interruptions from #3 are an issue, rather
than automatically running <code>--resync</code>, the recommended
alternative is to use the <a
href="#resilient"><code>--resilient</code></a>, <a
href="#recover"><code>--recover</code></a>, and <a
href="#conflict-resolve"><code>--conflict-resolve</code></a> flags,
(along with <a href="#graceful-shutdown">Graceful Shutdown</a> mode,
when needed) for a very robust "set-it-and-forget-it" bisync setup that
can automatically bounce back from almost any interruption it might
encounter. Consider adding something like the following:</p>
<div class="sourceCode" id="cb882"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb882-1"><a href="#cb882-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--resilient</span> <span class="at">--recover</span> <span class="at">--max-lock</span> 2m <span class="at">--conflict-resolve</span> newer</span></code></pre></div>
<h3 id="resync-mode">--resync-mode CHOICE</h3>
<p>In the event that a file differs on both sides during a
<code>--resync</code>, <code>--resync-mode</code> controls which version
will overwrite the other. The supported options are similar to <a
href="#conflict-resolve"><code>--conflict-resolve</code></a>. For all of
the following options, the version that is kept is referred to as the
"winner", and the version that is overwritten (deleted) is referred to
as the "loser". The options are named after the "winner":</p>
<ul>
<li><code>path1</code> - (the default) - the version from Path1 is
unconditionally considered the winner (regardless of
<code>modtime</code> and <code>size</code>, if any). This can be useful
if one side is more trusted or up-to-date than the other, at the time of
the <code>--resync</code>.</li>
<li><code>path2</code> - same as <code>path1</code>, except the path2
version is considered the winner.</li>
<li><code>newer</code> - the newer file (by <code>modtime</code>) is
considered the winner, regardless of which side it came from. This may
result in having a mix of some winners from Path1, and some winners from
Path2. (The implementation is analogous to running
<code>rclone copy --update</code> in both directions.)</li>
<li><code>older</code> - same as <code>newer</code>, except the older
file is considered the winner, and the newer file is considered the
loser.</li>
<li><code>larger</code> - the larger file (by <code>size</code>) is
considered the winner (regardless of <code>modtime</code>, if any). This
can be a useful option for remotes without <code>modtime</code> support,
or with the kinds of files (such as logs) that tend to grow but not
shrink, over time.</li>
<li><code>smaller</code> - the smaller file (by <code>size</code>) is
considered the winner (regardless of <code>modtime</code>, if any).</li>
</ul>
<p>For all of the above options, note the following:</p>
<ul>
<li>If either of the underlying remotes lacks support for the chosen
method, it will be ignored and will fall back to the default of
<code>path1</code>. (For example, if <code>--resync-mode newer</code> is
set, but one of the paths uses a remote that doesn't support
<code>modtime</code>.)</li>
<li>If a winner can't be determined because the chosen method's
attribute is missing or equal, it will be ignored, and bisync will
instead try to determine whether the files differ by looking at the
other <code>--compare</code> methods in effect. (For example, if
<code>--resync-mode newer</code> is set, but the Path1 and Path2
modtimes are identical, bisync will compare the sizes.) If bisync
concludes that they differ, preference is given to whichever is the
"source" at that moment. (In practice, this gives a slight advantage to
Path2, as the 2to1 copy comes before the 1to2 copy.) If the files <em>do
not</em> differ, nothing is copied (as both sides are already
correct).</li>
<li>These options apply only to files that exist on both sides (with the
same name and relative path). Files that exist <em>only</em> on one side
and not the other are <em>always</em> copied to the other, during
<code>--resync</code> (this is one of the main differences between
resync and non-resync runs.).</li>
<li><code>--conflict-resolve</code>, <code>--conflict-loser</code>, and
<code>--conflict-suffix</code> do not apply during
<code>--resync</code>, and unlike these flags, nothing is renamed during
<code>--resync</code>. When a file differs on both sides during
<code>--resync</code>, one version always overwrites the other (much
like in <code>rclone copy</code>.) (Consider using <a
href="#backup-dir1-and-backup-dir2"><code>--backup-dir</code></a> to
retain a backup of the losing version.)</li>
<li>Unlike for <code>--conflict-resolve</code>,
<code>--resync-mode none</code> is not a valid option (or rather, it
will be interpreted as "no resync", unless <code>--resync</code> has
also been specified, in which case it will be ignored.)</li>
<li>Winners and losers are decided at the individual file-level only
(there is not currently an option to pick an entire winning directory
atomically, although the <code>path1</code> and <code>path2</code>
options typically produce a similar result.)</li>
<li>To maintain backward-compatibility, the <code>--resync</code> flag
implies <code>--resync-mode path1</code> unless a different
<code>--resync-mode</code> is explicitly specified. Similarly, all
<code>--resync-mode</code> options (except <code>none</code>) imply
<code>--resync</code>, so it is not necessary to use both the
<code>--resync</code> and <code>--resync-mode</code> flags
simultaneously -- either one is sufficient without the other.</li>
</ul>
<h3 id="check-access">--check-access</h3>
<p>Access check files are an additional safety measure against data
loss. bisync will ensure it can find matching <code>RCLONE_TEST</code>
files in the same places in the Path1 and Path2 filesystems.
<code>RCLONE_TEST</code> files are not generated automatically. For
<code>--check-access</code> to succeed, you must first either:
<strong>A)</strong> Place one or more <code>RCLONE_TEST</code> files in
both systems, or <strong>B)</strong> Set <code>--check-filename</code>
to a filename already in use in various locations throughout your sync'd
fileset. Recommended methods for <strong>A)</strong> include:</p>
<ul>
<li><code>rclone touch Path1/RCLONE_TEST</code> (create a new file)</li>
<li><code>rclone copyto Path1/RCLONE_TEST Path2/RCLONE_TEST</code> (copy
an existing file)</li>
<li><code>rclone copy Path1/RCLONE_TEST Path2/RCLONE_TEST  --include "RCLONE_TEST"</code>
(copy multiple files at once, recursively)</li>
<li>create the files manually (outside of rclone)</li>
<li>run <code>bisync</code> once <em>without</em>
<code>--check-access</code> to set matching files on both filesystems
will also work, but is not preferred, due to potential for user error
(you are temporarily disabling the safety feature).</li>
</ul>
<p>Note that <code>--check-access</code> is still enforced on
<code>--resync</code>, so <code>bisync --resync --check-access</code>
will not work as a method of initially setting the files (this is to
ensure that bisync can't <a
href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=3.%20%2D%2Dcheck%2Daccess%20doesn%27t%20always%20fail%20when%20it%20should">inadvertently
circumvent its own safety switch</a>.)</p>
<p>Time stamps and file contents for <code>RCLONE_TEST</code> files are
not important, just the names and locations. If you have symbolic links
in your sync tree it is recommended to place <code>RCLONE_TEST</code>
files in the linked-to directory tree to protect against bisync assuming
a bunch of deleted files if the linked-to tree should not be accessible.
See also the <a href="--check-filename">--check-filename</a> flag.</p>
<h3 id="check-filename">--check-filename</h3>
<p>Name of the file(s) used in access health validation. The default
<code>--check-filename</code> is <code>RCLONE_TEST</code>. One or more
files having this filename must exist, synchronized between your source
and destination filesets, in order for <code>--check-access</code> to
succeed. See <a href="#check-access">--check-access</a> for additional
details.</p>
<h3 id="compare">--compare</h3>
<p>As of <code>v1.66</code>, bisync fully supports comparing based on
any combination of size, modtime, and checksum (lifting the prior
restriction on backends without modtime support.)</p>
<p>By default (without the <code>--compare</code> flag), bisync inherits
the same comparison options as <code>sync</code> (that is:
<code>size</code> and <code>modtime</code> by default, unless modified
with flags such as <a
href="https://rclone.org/docs/#c-checksum"><code>--checksum</code></a>
or <a href="/docs/#size-only"><code>--size-only</code></a>.)</p>
<p>If the <code>--compare</code> flag is set, it will override these
defaults. This can be useful if you wish to compare based on
combinations not currently supported in <code>sync</code>, such as
comparing all three of <code>size</code> AND <code>modtime</code> AND
<code>checksum</code> simultaneously (or just <code>modtime</code> AND
<code>checksum</code>).</p>
<p><code>--compare</code> takes a comma-separated list, with the
currently supported values being <code>size</code>,
<code>modtime</code>, and <code>checksum</code>. For example, if you
want to compare size and checksum, but not modtime, you would do:</p>
<div class="sourceCode" id="cb883"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb883-1"><a href="#cb883-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--compare</span> size,checksum</span></code></pre></div>
<p>Or if you want to compare all three:</p>
<div class="sourceCode" id="cb884"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb884-1"><a href="#cb884-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--compare</span> size,modtime,checksum</span></code></pre></div>
<p><code>--compare</code> overrides any conflicting flags. For example,
if you set the conflicting flags
<code>--compare checksum --size-only</code>, <code>--size-only</code>
will be ignored, and bisync will compare checksum and not size. To avoid
confusion, it is recommended to use <em>either</em>
<code>--compare</code> or the normal <code>sync</code> flags, but not
both.</p>
<p>If <code>--compare</code> includes <code>checksum</code> and both
remotes support checksums but have no hash types in common with each
other, checksums will be considered <em>only</em> for comparisons within
the same side (to determine what has changed since the prior sync), but
not for comparisons against the opposite side. If one side supports
checksums and the other does not, checksums will only be considered on
the side that supports them.</p>
<p>When comparing with <code>checksum</code> and/or <code>size</code>
without <code>modtime</code>, bisync cannot determine whether a file is
<code>newer</code> or <code>older</code> -- only whether it is
<code>changed</code> or <code>unchanged</code>. (If it is
<code>changed</code> on both sides, bisync still does the standard
equality-check to avoid declaring a sync conflict unless it absolutely
has to.)</p>
<p>It is recommended to do a <code>--resync</code> when changing
<code>--compare</code> settings, as otherwise your prior listing files
may not contain the attributes you wish to compare (for example, they
will not have stored checksums if you were not previously comparing
checksums.)</p>
<h3 id="ignore-listing-checksum">--ignore-listing-checksum</h3>
<p>When <code>--checksum</code> or <code>--compare checksum</code> is
set, bisync will retrieve (or generate) checksums (for backends that
support them) when creating the listings for both paths, and store the
checksums in the listing files. <code>--ignore-listing-checksum</code>
will disable this behavior, which may speed things up considerably,
especially on backends (such as <a
href="https://rclone.org/local/">local</a>) where hashes must be
computed on the fly instead of retrieved. Please note the following:</p>
<ul>
<li>As of <code>v1.66</code>, <code>--ignore-listing-checksum</code> is
now automatically set when neither <code>--checksum</code> nor
<code>--compare checksum</code> are in use (as the checksums would not
be used for anything.)</li>
<li><code>--ignore-listing-checksum</code> is NOT the same as <a
href="https://rclone.org/docs/#ignore-checksum"><code>--ignore-checksum</code></a>,
and you may wish to use one or the other, or both. In a nutshell:
<code>--ignore-listing-checksum</code> controls whether checksums are
considered when scanning for diffs, while <code>--ignore-checksum</code>
controls whether checksums are considered during the copy/sync
operations that follow, if there ARE diffs.</li>
<li>Unless <code>--ignore-listing-checksum</code> is passed, bisync
currently computes hashes for one path <em>even when there's no common
hash with the other path</em> (for example, a <a
href="https://rclone.org/crypt/#modification-times-and-hashes">crypt</a>
remote.) This can still be beneficial, as the hashes will still be used
to detect changes within the same side (if <code>--checksum</code> or
<code>--compare checksum</code> is set), even if they can't be used to
compare against the opposite side.</li>
<li>If you wish to ignore listing checksums <em>only</em> on remotes
where they are slow to compute, consider using <a
href="#no-slow-hash"><code>--no-slow-hash</code></a> (or <a
href="#slow-hash-sync-only"><code>--slow-hash-sync-only</code></a>)
instead of <code>--ignore-listing-checksum</code>.</li>
<li>If <code>--ignore-listing-checksum</code> is used simultaneously
with <code>--compare checksum</code> (or <code>--checksum</code>),
checksums will be ignored for bisync deltas, but still considered during
the sync operations that follow (if deltas are detected based on modtime
and/or size.)</li>
</ul>
<h3 id="no-slow-hash">--no-slow-hash</h3>
<p>On some remotes (notably <code>local</code>), checksums can
dramatically slow down a bisync run, because hashes cannot be stored and
need to be computed in real-time when they are requested. On other
remotes (such as <code>drive</code>), they add practically no time at
all. The <code>--no-slow-hash</code> flag will automatically skip
checksums on remotes where they are slow, while still comparing them on
others (assuming <a href="#compare"><code>--compare</code></a> includes
<code>checksum</code>.) This can be useful when one of your bisync paths
is slow but you still want to check checksums on the other, for a more
robust sync.</p>
<h3 id="slow-hash-sync-only">--slow-hash-sync-only</h3>
<p>Same as <a href="#no-slow-hash"><code>--no-slow-hash</code></a>,
except slow hashes are still considered during sync calls. They are
still NOT considered for determining deltas, nor or they included in
listings. They are also skipped during <code>--resync</code>. The main
use case for this flag is when you have a large number of files, but
relatively few of them change from run to run -- so you don't want to
check your entire tree every time (it would take too long), but you
still want to consider checksums for the smaller group of files for
which a <code>modtime</code> or <code>size</code> change was detected.
Keep in mind that this speed savings comes with a safety trade-off: if a
file's content were to change without a change to its
<code>modtime</code> or <code>size</code>, bisync would not detect it,
and it would not be synced.</p>
<p><code>--slow-hash-sync-only</code> is only useful if both remotes
share a common hash type (if they don't, bisync will automatically fall
back to <code>--no-slow-hash</code>.) Both <code>--no-slow-hash</code>
and <code>--slow-hash-sync-only</code> have no effect without
<code>--compare checksum</code> (or <code>--checksum</code>).</p>
<h3 id="download-hash">--download-hash</h3>
<p>If <code>--download-hash</code> is set, bisync will use best efforts
to obtain an MD5 checksum by downloading and computing on-the-fly, when
checksums are not otherwise available (for example, a remote that
doesn't support them.) Note that since rclone has to download the entire
file, this may dramatically slow down your bisync runs, and is also
likely to use a lot of data, so it is probably not practical for bisync
paths with a large total file size. However, it can be a good option for
syncing small-but-important files with maximum accuracy (for example, a
source code repo on a <code>crypt</code> remote.) An additional
advantage over methods like <a
href="https://rclone.org/commands/rclone_cryptcheck/"><code>cryptcheck</code></a>
is that the original file is not required for comparison (for example,
<code>--download-hash</code> can be used to bisync two different crypt
remotes with different passwords.)</p>
<p>When <code>--download-hash</code> is set, bisync still looks for more
efficient checksums first, and falls back to downloading only when none
are found. It takes priority over conflicting flags such as
<code>--no-slow-hash</code>. <code>--download-hash</code> is not
suitable for <a href="#gdocs">Google Docs</a> and other files of unknown
size, as their checksums would change from run to run (due to small
variances in the internals of the generated export file.) Therefore,
bisync automatically skips <code>--download-hash</code> for files with a
size less than 0.</p>
<p>See also: <a
href="https://rclone.org/hasher/"><code>Hasher</code></a> backend, <a
href="https://rclone.org/commands/rclone_cryptcheck/"><code>cryptcheck</code></a>
command, <a
href="https://rclone.org/commands/rclone_check/"><code>rclone check --download</code></a>
option, <a
href="https://rclone.org/commands/rclone_md5sum/"><code>md5sum</code></a>
command</p>
<h3 id="max-delete">--max-delete</h3>
<p>As a safety check, if greater than the <code>--max-delete</code>
percent of files were deleted on either the Path1 or Path2 filesystem,
then bisync will abort with a warning message, without making any
changes. The default <code>--max-delete</code> is <code>50%</code>. One
way to trigger this limit is to rename a directory that contains more
than half of your files. This will appear to bisync as a bunch of
deleted files and a bunch of new files. This safety check is intended to
block bisync from deleting all of the files on both filesystems due to a
temporary network access issue, or if the user had inadvertently deleted
the files on one side or the other. To force the sync, either set a
different delete percentage limit, e.g. <code>--max-delete 75</code>
(allows up to 75% deletion), or use <code>--force</code> to bypass the
check.</p>
<p>Also see the <a href="#all-files-changed">all files changed</a>
check.</p>
<h3 id="filters-file">--filters-file</h3>
<p>By using rclone filter features you can exclude file types or
directory sub-trees from the sync. See the <a href="#filtering">bisync
filters</a> section and generic <a
href="https://rclone.org/filtering/#filter-from-read-filtering-patterns-from-a-file">--filter-from</a>
documentation. An <a href="#example-filters-file">example filters
file</a> contains filters for non-allowed files for syncing with
Dropbox.</p>
<p>If you make changes to your filters file then bisync requires a run
with <code>--resync</code>. This is a safety feature, which prevents
existing files on the Path1 and/or Path2 side from seeming to disappear
from view (since they are excluded in the new listings), which would
fool bisync into seeing them as deleted (as compared to the prior run
listings), and then bisync would proceed to delete them for real.</p>
<p>To block this from happening, bisync calculates an MD5 hash of the
filters file and stores the hash in a <code>.md5</code> file in the same
place as your filters file. On the next run with
<code>--filters-file</code> set, bisync re-calculates the MD5 hash of
the current filters file and compares it to the hash stored in the
<code>.md5</code> file. If they don't match, the run aborts with a
critical error and thus forces you to do a <code>--resync</code>, likely
avoiding a disaster.</p>
<h3 id="conflict-resolve">--conflict-resolve CHOICE</h3>
<p>In bisync, a "conflict" is a file that is <em>new</em> or
<em>changed</em> on <em>both sides</em> (relative to the prior run) AND
is <em>not currently identical</em> on both sides.
<code>--conflict-resolve</code> controls how bisync handles such a
scenario. The currently supported options are:</p>
<ul>
<li><code>none</code> - (the default) - do not attempt to pick a winner,
keep and rename both files according to <a
href="#conflict-loser"><code>--conflict-loser</code></a> and <a
href="#conflict-suffix"><code>--conflict-suffix</code></a> settings. For
example, with the default settings, <code>file.txt</code> on Path1 is
renamed <code>file.txt.conflict1</code> and <code>file.txt</code> on
Path2 is renamed <code>file.txt.conflict2</code>. Both are copied to the
opposite path during the run, so both sides end up with a copy of both
files. (As <code>none</code> is the default, it is not necessary to
specify <code>--conflict-resolve none</code> -- you can just omit the
flag.)</li>
<li><code>newer</code> - the newer file (by <code>modtime</code>) is
considered the winner and is copied without renaming. The older file
(the "loser") is handled according to <code>--conflict-loser</code> and
<code>--conflict-suffix</code> settings (either renamed or deleted.) For
example, if <code>file.txt</code> on Path1 is newer than
<code>file.txt</code> on Path2, the result on both sides (with other
default settings) will be <code>file.txt</code> (winner from Path1) and
<code>file.txt.conflict1</code> (loser from Path2).</li>
<li><code>older</code> - same as <code>newer</code>, except the older
file is considered the winner, and the newer file is considered the
loser.</li>
<li><code>larger</code> - the larger file (by <code>size</code>) is
considered the winner (regardless of <code>modtime</code>, if any).</li>
<li><code>smaller</code> - the smaller file (by <code>size</code>) is
considered the winner (regardless of <code>modtime</code>, if any).</li>
<li><code>path1</code> - the version from Path1 is unconditionally
considered the winner (regardless of <code>modtime</code> and
<code>size</code>, if any). This can be useful if one side is usually
more trusted or up-to-date than the other.</li>
<li><code>path2</code> - same as <code>path1</code>, except the path2
version is considered the winner.</li>
</ul>
<p>For all of the above options, note the following:</p>
<ul>
<li>If either of the underlying remotes lacks support for the chosen
method, it will be ignored and fall back to <code>none</code>. (For
example, if <code>--conflict-resolve newer</code> is set, but one of the
paths uses a remote that doesn't support <code>modtime</code>.)</li>
<li>If a winner can't be determined because the chosen method's
attribute is missing or equal, it will be ignored and fall back to
<code>none</code>. (For example, if
<code>--conflict-resolve newer</code> is set, but the Path1 and Path2
modtimes are identical, even if the sizes may differ.)</li>
<li>If the file's content is currently identical on both sides, it is
not considered a "conflict", even if new or changed on both sides since
the prior sync. (For example, if you made a change on one side and then
synced it to the other side by other means.) Therefore, none of the
conflict resolution flags apply in this scenario.</li>
<li>The conflict resolution flags do not apply during a
<code>--resync</code>, as there is no "prior run" to speak of (but see
<a href="#resync-mode"><code>--resync-mode</code></a> for similar
options.)</li>
</ul>
<h3 id="conflict-loser">--conflict-loser CHOICE</h3>
<p><code>--conflict-loser</code> determines what happens to the "loser"
of a sync conflict (when <a
href="#conflict-resolve"><code>--conflict-resolve</code></a> determines
a winner) or to both files (when there is no winner.) The currently
supported options are:</p>
<ul>
<li><code>num</code> - (the default) - auto-number the conflicts by
automatically appending the next available number to the
<code>--conflict-suffix</code>, in chronological order. For example,
with the default settings, the first conflict for <code>file.txt</code>
will be renamed <code>file.txt.conflict1</code>. If
<code>file.txt.conflict1</code> already exists,
<code>file.txt.conflict2</code> will be used instead (etc., up to a
maximum of 9223372036854775807 conflicts.)</li>
<li><code>pathname</code> - rename the conflicts according to which side
they came from, which was the default behavior prior to
<code>v1.66</code>. For example, with
<code>--conflict-suffix path</code>, <code>file.txt</code> from Path1
will be renamed <code>file.txt.path1</code>, and <code>file.txt</code>
from Path2 will be renamed <code>file.txt.path2</code>. If two
non-identical suffixes are provided (ex.
<code>--conflict-suffix cloud,local</code>), the trailing digit is
omitted. Importantly, note that with <code>pathname</code>, there is no
auto-numbering beyond <code>2</code>, so if <code>file.txt.path2</code>
somehow already exists, it will be overwritten. Using a dynamic date
variable in your <code>--conflict-suffix</code> (see below) is one
possible way to avoid this. Note also that conflicts-of-conflicts are
possible, if the original conflict is not manually resolved -- for
example, if for some reason you edited <code>file.txt.path1</code> on
both sides, and those edits were different, the result would be
<code>file.txt.path1.path1</code> and <code>file.txt.path1.path2</code>
(in addition to <code>file.txt.path2</code>.)</li>
<li><code>delete</code> - keep the winner only and delete the loser,
instead of renaming it. If a winner cannot be determined (see
<code>--conflict-resolve</code> for details on how this could happen),
<code>delete</code> is ignored and the default <code>num</code> is used
instead (i.e. both versions are kept and renamed, and neither is
deleted.) <code>delete</code> is inherently the most destructive option,
so use it only with care.</li>
</ul>
<p>For all of the above options, note that if a winner cannot be
determined (see <code>--conflict-resolve</code> for details on how this
could happen), or if <code>--conflict-resolve</code> is not in use,
<em>both</em> files will be renamed.</p>
<h3 id="conflict-suffix">--conflict-suffix STRING[,STRING]</h3>
<p><code>--conflict-suffix</code> controls the suffix that is appended
when bisync renames a <a
href="#conflict-loser"><code>--conflict-loser</code></a> (default:
<code>conflict</code>). <code>--conflict-suffix</code> will accept
either one string or two comma-separated strings to assign different
suffixes to Path1 vs. Path2. This may be helpful later in identifying
the source of the conflict. (For example,
<code>--conflict-suffix dropboxconflict,laptopconflict</code>)</p>
<p>With <code>--conflict-loser num</code>, a number is always appended
to the suffix. With <code>--conflict-loser pathname</code>, a number is
appended only when one suffix is specified (or when two identical
suffixes are specified.) i.e. with
<code>--conflict-loser pathname</code>, all of the following would
produce exactly the same result:</p>
<div class="sourceCode" id="cb885"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb885-1"><a href="#cb885-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--conflict-suffix</span> path</span>
<span id="cb885-2"><a href="#cb885-2" aria-hidden="true" tabindex="-1"></a><span class="ex">--conflict-suffix</span> path,path</span>
<span id="cb885-3"><a href="#cb885-3" aria-hidden="true" tabindex="-1"></a><span class="ex">--conflict-suffix</span> path1,path2</span></code></pre></div>
<p>Suffixes may be as short as 1 character. By default, the suffix is
appended after any other extensions (ex.
<code>file.jpg.conflict1</code>), however, this can be changed with the
<a
href="https://rclone.org/docs/#suffix-keep-extension"><code>--suffix-keep-extension</code></a>
flag (i.e. to instead result in <code>file.conflict1.jpg</code>).</p>
<p><code>--conflict-suffix</code> supports several <em>dynamic date
variables</em> when enclosed in curly braces as globs. This can be
helpful to track the date and/or time that each conflict was handled by
bisync. For example:</p>
<div class="sourceCode" id="cb886"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb886-1"><a href="#cb886-1" aria-hidden="true" tabindex="-1"></a><span class="ex">--conflict-suffix</span> {DateOnly}-conflict</span>
<span id="cb886-2"><a href="#cb886-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> result: myfile.txt.2006-01-02-conflict1</span></code></pre></div>
<p>All of the formats described <a
href="https://pkg.go.dev/time#pkg-constants">here (go Time.Layout
constants)</a> and <a
href="https://pkg.go.dev/time#example-Time.Format">here (go Time.Format
examples)</a> are supported, but take care to ensure that your chosen
format does not use any characters that are illegal on your remotes (for
example, macOS does not allow colons in filenames, and slashes are also
best avoided as they are often interpreted as directory separators.) To
address this particular issue, an additional
<code>{MacFriendlyTime}</code> (or just <code>{mac}</code>) option is
supported, which results in <code>2006-01-02 0304PM</code>.</p>
<p>Note that <code>--conflict-suffix</code> is entirely separate from
rclone's main <a
href="https://rclone.org/docs/#suffix-string"><code>--sufix</code></a>
flag. This is intentional, as users may wish to use both flags
simultaneously, if also using <a
href="#backup-dir1-and-backup-dir2"><code>--backup-dir</code></a>.</p>
<p>Finally, note that the default in bisync prior to <code>v1.66</code>
was to rename conflicts with <code>..path1</code> and
<code>..path2</code> (with two periods, and <code>path</code> instead of
<code>conflict</code>.) Bisync now defaults to a single dot instead of a
double dot, but additional dots can be added by including them in the
specified suffix string. For example, for behavior equivalent to the
previous default, use:</p>
<div class="sourceCode" id="cb887"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb887-1"><a href="#cb887-1" aria-hidden="true" tabindex="-1"></a><span class="ex">[--conflict-resolve</span> none] <span class="at">--conflict-loser</span> pathname <span class="at">--conflict-suffix</span> .path</span></code></pre></div>
<h3 id="check-sync">--check-sync</h3>
<p>Enabled by default, the check-sync function checks that all of the
same files exist in both the Path1 and Path2 history listings. This
<em>check-sync</em> integrity check is performed at the end of the sync
run by default. Any untrapped failing copy/deletes between the two paths
might result in differences between the two listings and in the
untracked file content differences between the two paths. A resync run
would correct the error.</p>
<p>Note that the default-enabled integrity check locally executes a load
of both the final Path1 and Path2 listings, and thus adds to the run
time of a sync. Using <code>--check-sync=false</code> will disable it
and may significantly reduce the sync run times for very large numbers
of files.</p>
<p>The check may be run manually with <code>--check-sync=only</code>. It
runs only the integrity check and terminates without actually
syncing.</p>
<p>Note that currently, <code>--check-sync</code> <strong>only checks
listing snapshots and NOT the actual files on the remotes.</strong> Note
also that the listing snapshots will not know about any changes that
happened during or after the latest bisync run, as those will be
discovered on the next run. Therefore, while listings should always
match <em>each other</em> at the end of a bisync run, it is
<em>expected</em> that they will not match the underlying remotes, nor
will the remotes match each other, if there were changes during or after
the run. This is normal, and any differences will be detected and synced
on the next run.</p>
<p>For a robust integrity check of the current state of the remotes (as
opposed to just their listing snapshots), consider using <a
href="commands/rclone_check/"><code>check</code></a> (or <a
href="https://rclone.org/commands/rclone_cryptcheck/"><code>cryptcheck</code></a>,
if at least one path is a <code>crypt</code> remote) instead of
<code>--check-sync</code>, keeping in mind that differences are expected
if files changed during or after your last bisync run.</p>
<p>For example, a possible sequence could look like this:</p>
<ol type="1">
<li><p>Normally scheduled bisync run:</p>
<div class="sourceCode" id="cb888"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb888-1"><a href="#cb888-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> bisync Path1 Path2 <span class="at">-MPc</span> <span class="at">--check-access</span> <span class="at">--max-delete</span> 10 <span class="at">--filters-file</span> /path/to/filters.txt <span class="at">-v</span> <span class="at">--no-cleanup</span> <span class="at">--ignore-listing-checksum</span> <span class="at">--disable</span> ListR <span class="at">--checkers</span><span class="op">=</span>16 <span class="at">--drive-pacer-min-sleep</span><span class="op">=</span>10ms <span class="at">--create-empty-src-dirs</span> <span class="at">--resilient</span></span></code></pre></div></li>
<li><p>Periodic independent integrity check (perhaps scheduled nightly
or weekly):</p>
<div class="sourceCode" id="cb889"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb889-1"><a href="#cb889-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> check <span class="at">-MvPc</span> Path1 Path2 <span class="at">--filter-from</span> /path/to/filters.txt</span></code></pre></div></li>
<li><p>If diffs are found, you have some choices to correct them. If one
side is more up-to-date and you want to make the other side match it,
you could run:</p>
<div class="sourceCode" id="cb890"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb890-1"><a href="#cb890-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync Path1 Path2 <span class="at">--filter-from</span> /path/to/filters.txt <span class="at">--create-empty-src-dirs</span> <span class="at">-MPc</span> <span class="at">-v</span></span></code></pre></div></li>
</ol>
<p>(or switch Path1 and Path2 to make Path2 the source-of-truth)</p>
<p>Or, if neither side is totally up-to-date, you could run a
<code>--resync</code> to bring them back into agreement (but remember
that this could cause deleted files to re-appear.)</p>
<p>*Note also that <code>rclone check</code> does not currently include
empty directories, so if you want to know if any empty directories are
out of sync, consider alternatively running the above
<code>rclone sync</code> command with <code>--dry-run</code> added.</p>
<p>See also: <a href="#concurrent-modifications">Concurrent
modifications</a>, <a href="#resilient"><code>--resilient</code></a></p>
<h3 id="resilient">--resilient</h3>
<p>By default, most errors or interruptions will cause bisync to abort
and require <a href="#resync"><code>--resync</code></a> to recover. This
is a safety feature, to prevent bisync from running again until a user
checks things out. However, in some cases, bisync can go too far and
enforce a lockout when one isn't actually necessary, like for certain
less-serious errors that might resolve themselves on the next run. When
<code>--resilient</code> is specified, bisync tries its best to recover
and self-correct, and only requires <code>--resync</code> as a last
resort when a human's involvement is absolutely necessary. The intended
use case is for running bisync as a background process (such as via
scheduled <a href="#cron">cron</a>).</p>
<p>When using <code>--resilient</code> mode, bisync will still report
the error and abort, however it will not lock out future runs --
allowing the possibility of retrying at the next normally scheduled
time, without requiring a <code>--resync</code> first. Examples of such
retryable errors include access test failures, missing listing files,
and filter change detections. These safety features will still prevent
the <em>current</em> run from proceeding -- the difference is that if
conditions have improved by the time of the <em>next</em> run, that next
run will be allowed to proceed. Certain more serious errors will still
enforce a <code>--resync</code> lockout, even in
<code>--resilient</code> mode, to prevent data loss.</p>
<p>Behavior of <code>--resilient</code> may change in a future version.
(See also: <a href="#recover"><code>--recover</code></a>, <a
href="#max-lock"><code>--max-lock</code></a>, <a
href="#graceful-shutdown">Graceful Shutdown</a>)</p>
<h3 id="recover">--recover</h3>
<p>If <code>--recover</code> is set, in the event of a sudden
interruption or other un-graceful shutdown, bisync will attempt to
automatically recover on the next run, instead of requiring
<code>--resync</code>. Bisync is able to recover robustly by keeping one
"backup" listing at all times, representing the state of both paths
after the last known successful sync. Bisync can then compare the
current state with this snapshot to determine which changes it needs to
retry. Changes that were synced after this snapshot (during the run that
was later interrupted) will appear to bisync as if they are "new or
changed on both sides", but in most cases this is not a problem, as
bisync will simply do its usual "equality check" and learn that no
action needs to be taken on these files, since they are already
identical on both sides.</p>
<p>In the rare event that a file is synced successfully during a run
that later aborts, and then that same file changes AGAIN before the next
run, bisync will think it is a sync conflict, and handle it accordingly.
(From bisync's perspective, the file has changed on both sides since the
last trusted sync, and the files on either side are not currently
identical.) Therefore, <code>--recover</code> carries with it a slightly
increased chance of having conflicts -- though in practice this is
pretty rare, as the conditions required to cause it are quite specific.
This risk can be reduced by using bisync's <a
href="#graceful-shutdown">"Graceful Shutdown"</a> mode (triggered by
sending <code>SIGINT</code> or <code>Ctrl+C</code>), when you have the
choice, instead of forcing a sudden termination.</p>
<p><code>--recover</code> and <code>--resilient</code> are similar, but
distinct -- the main difference is that <code>--resilient</code> is
about <em>retrying</em>, while <code>--recover</code> is about
<em>recovering</em>. Most users will probably want both.
<code>--resilient</code> allows retrying when bisync has chosen to abort
itself due to safety features such as failing
<code>--check-access</code> or detecting a filter change.
<code>--resilient</code> does not cover external interruptions such as a
user shutting down their computer in the middle of a sync -- that is
what <code>--recover</code> is for.</p>
<h3 id="max-lock">--max-lock</h3>
<p>Bisync uses <a href="#lock-file">lock files</a> as a safety feature
to prevent interference from other bisync runs while it is running.
Bisync normally removes these lock files at the end of a run, but if
bisync is abruptly interrupted, these files will be left behind. By
default, they will lock out all future runs, until the user has a chance
to manually check things out and remove the lock. As an alternative,
<code>--max-lock</code> can be used to make them automatically expire
after a certain period of time, so that future runs are not locked out
forever, and auto-recovery is possible. <code>--max-lock</code> can be
any duration <code>2m</code> or greater (or <code>0</code> to disable).
If set, lock files older than this will be considered "expired", and
future runs will be allowed to disregard them and proceed. (Note that
the <code>--max-lock</code> duration must be set by the process that
left the lock file -- not the later one interpreting it.)</p>
<p>If set, bisync will also "renew" these lock files every
<code>--max-lock minus one minute</code> throughout a run, for extra
safety. (For example, with <code>--max-lock 5m</code>, bisync would
renew the lock file (for another 5 minutes) every 4 minutes until the
run has completed.) In other words, it should not be possible for a lock
file to pass its expiration time while the process that created it is
still running -- and you can therefore be reasonably sure that any
<em>expired</em> lock file you may find was left there by an interrupted
run, not one that is still running and just taking awhile.</p>
<p>If <code>--max-lock</code> is <code>0</code> or not set, the default
is that lock files will never expire, and will block future runs (of
these same two bisync paths) indefinitely.</p>
<p>For maximum resilience from disruptions, consider setting a
relatively short duration like <code>--max-lock 2m</code> along with <a
href="#resilient"><code>--resilient</code></a> and <a
href="#recover"><code>--recover</code></a>, and a relatively frequent <a
href="#cron">cron schedule</a>. The result will be a very robust
"set-it-and-forget-it" bisync run that can automatically bounce back
from almost any interruption it might encounter, without requiring the
user to get involved and run a <code>--resync</code>. (See also: <a
href="#graceful-shutdown">Graceful Shutdown</a> mode)</p>
<h3 id="backup-dir1-and---backup-dir2">--backup-dir1 and
--backup-dir2</h3>
<p>As of <code>v1.66</code>, <a
href="https://rclone.org/docs/#backup-dir-string"><code>--backup-dir</code></a>
is supported in bisync. Because <code>--backup-dir</code> must be a
non-overlapping path on the same remote, Bisync has introduced new
<code>--backup-dir1</code> and <code>--backup-dir2</code> flags to
support separate backup-dirs for <code>Path1</code> and
<code>Path2</code> (bisyncing between different remotes with
<code>--backup-dir</code> would not otherwise be possible.)
<code>--backup-dir1</code> and <code>--backup-dir2</code> can use
different remotes from each other, but <code>--backup-dir1</code> must
use the same remote as <code>Path1</code>, and
<code>--backup-dir2</code> must use the same remote as
<code>Path2</code>. Each backup directory must not overlap its
respective bisync Path without being excluded by a filter rule.</p>
<p>The standard <code>--backup-dir</code> will also work, if both paths
use the same remote (but note that deleted files from both paths would
be mixed together in the same dir). If either <code>--backup-dir1</code>
and <code>--backup-dir2</code> are set, they will override
<code>--backup-dir</code>.</p>
<p>Example:</p>
<div class="sourceCode" id="cb891"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb891-1"><a href="#cb891-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> bisync /Users/someuser/some/local/path/Bisync gdrive:Bisync <span class="at">--backup-dir1</span> /Users/someuser/some/local/path/BackupDir <span class="at">--backup-dir2</span> gdrive:BackupDir <span class="at">--suffix</span> <span class="at">-2023-08-26</span> <span class="at">--suffix-keep-extension</span> <span class="at">--check-access</span> <span class="at">--max-delete</span> 10 <span class="at">--filters-file</span> /Users/someuser/some/local/path/bisync_filters.txt <span class="at">--no-cleanup</span> <span class="at">--ignore-listing-checksum</span> <span class="at">--checkers</span><span class="op">=</span>16 <span class="at">--drive-pacer-min-sleep</span><span class="op">=</span>10ms <span class="at">--create-empty-src-dirs</span> <span class="at">--resilient</span> <span class="at">-MvP</span> <span class="at">--drive-skip-gdocs</span> <span class="at">--fix-case</span></span></code></pre></div>
<p>In this example, if the user deletes a file in
<code>/Users/someuser/some/local/path/Bisync</code>, bisync will
propagate the delete to the other side by moving the corresponding file
from <code>gdrive:Bisync</code> to <code>gdrive:BackupDir</code>. If the
user deletes a file from <code>gdrive:Bisync</code>, bisync moves it
from <code>/Users/someuser/some/local/path/Bisync</code> to
<code>/Users/someuser/some/local/path/BackupDir</code>.</p>
<p>In the event of a <a href="#conflict-loser">rename due to a sync
conflict</a>, the rename is not considered a delete, unless a previous
conflict with the same name already exists and would get
overwritten.</p>
<p>See also: <a
href="https://rclone.org/docs/#suffix-string"><code>--suffix</code></a>,
<a
href="https://rclone.org/docs/#suffix-keep-extension"><code>--suffix-keep-extension</code></a></p>
<h2 id="operation">Operation</h2>
<h3 id="runtime-flow-details">Runtime flow details</h3>
<p>bisync retains the listings of the <code>Path1</code> and
<code>Path2</code> filesystems from the prior run. On each successive
run it will:</p>
<ul>
<li>list files on <code>path1</code> and <code>path2</code>, and check
for changes on each side. Changes include <code>New</code>,
<code>Newer</code>, <code>Older</code>, and <code>Deleted</code>
files.</li>
<li>Propagate changes on <code>path1</code> to <code>path2</code>, and
vice-versa.</li>
</ul>
<h3 id="safety-measures">Safety measures</h3>
<ul>
<li>Lock file prevents multiple simultaneous runs when taking a while.
This can be particularly useful if bisync is run by cron scheduler.</li>
<li>Handle change conflicts non-destructively by creating
<code>.conflict1</code>, <code>.conflict2</code>, etc. file versions,
according to <a
href="#conflict-resolve"><code>--conflict-resolve</code></a>, <a
href="#conflict-loser"><code>--conflict-loser</code></a>, and <a
href="#conflict-suffix"><code>--conflict-suffix</code></a>
settings.</li>
<li>File system access health check using <code>RCLONE_TEST</code> files
(see the <code>--check-access</code> flag).</li>
<li>Abort on excessive deletes - protects against a failed listing being
interpreted as all the files were deleted. See the
<code>--max-delete</code> and <code>--force</code> flags.</li>
<li>If something evil happens, bisync goes into a safe state to block
damage by later runs. (See <a href="#error-handling">Error
Handling</a>)</li>
</ul>
<h3 id="normal-sync-checks">Normal sync checks</h3>
<table>
<colgroup>
<col style="width: 12%" />
<col style="width: 40%" />
<col style="width: 22%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="header">
<th>Type</th>
<th>Description</th>
<th>Result</th>
<th>Implementation</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Path2 new</td>
<td>File is new on Path2, does not exist on Path1</td>
<td>Path2 version survives</td>
<td><code>rclone copy</code> Path2 to Path1</td>
</tr>
<tr class="even">
<td>Path2 newer</td>
<td>File is newer on Path2, unchanged on Path1</td>
<td>Path2 version survives</td>
<td><code>rclone copy</code> Path2 to Path1</td>
</tr>
<tr class="odd">
<td>Path2 deleted</td>
<td>File is deleted on Path2, unchanged on Path1</td>
<td>File is deleted</td>
<td><code>rclone delete</code> Path1</td>
</tr>
<tr class="even">
<td>Path1 new</td>
<td>File is new on Path1, does not exist on Path2</td>
<td>Path1 version survives</td>
<td><code>rclone copy</code> Path1 to Path2</td>
</tr>
<tr class="odd">
<td>Path1 newer</td>
<td>File is newer on Path1, unchanged on Path2</td>
<td>Path1 version survives</td>
<td><code>rclone copy</code> Path1 to Path2</td>
</tr>
<tr class="even">
<td>Path1 older</td>
<td>File is older on Path1, unchanged on Path2</td>
<td><em>Path1 version survives</em></td>
<td><code>rclone copy</code> Path1 to Path2</td>
</tr>
<tr class="odd">
<td>Path2 older</td>
<td>File is older on Path2, unchanged on Path1</td>
<td><em>Path2 version survives</em></td>
<td><code>rclone copy</code> Path2 to Path1</td>
</tr>
<tr class="even">
<td>Path1 deleted</td>
<td>File no longer exists on Path1</td>
<td>File is deleted</td>
<td><code>rclone delete</code> Path2</td>
</tr>
</tbody>
</table>
<h3 id="unusual-sync-checks">Unusual sync checks</h3>
<table>
<colgroup>
<col style="width: 24%" />
<col style="width: 30%" />
<col style="width: 27%" />
<col style="width: 17%" />
</colgroup>
<thead>
<tr class="header">
<th>Type</th>
<th>Description</th>
<th>Result</th>
<th>Implementation</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Path1 new/changed AND Path2 new/changed AND Path1 == Path2</td>
<td>File is new/changed on Path1 AND new/changed on Path2 AND Path1
version is currently identical to Path2</td>
<td>No change</td>
<td>None</td>
</tr>
<tr class="even">
<td>Path1 new AND Path2 new</td>
<td>File is new on Path1 AND new on Path2 (and Path1 version is NOT
identical to Path2)</td>
<td>Conflicts handled according to <a
href="#conflict-resolve"><code>--conflict-resolve</code></a> &amp; <a
href="#conflict-loser"><code>--conflict-loser</code></a> settings</td>
<td>default: <code>rclone copy</code> renamed
<code>Path2.conflict2</code> file to Path1, <code>rclone copy</code>
renamed <code>Path1.conflict1</code> file to Path2</td>
</tr>
<tr class="odd">
<td>Path2 newer AND Path1 changed</td>
<td>File is newer on Path2 AND also changed (newer/older/size) on Path1
(and Path1 version is NOT identical to Path2)</td>
<td>Conflicts handled according to <a
href="#conflict-resolve"><code>--conflict-resolve</code></a> &amp; <a
href="#conflict-loser"><code>--conflict-loser</code></a> settings</td>
<td>default: <code>rclone copy</code> renamed
<code>Path2.conflict2</code> file to Path1, <code>rclone copy</code>
renamed <code>Path1.conflict1</code> file to Path2</td>
</tr>
<tr class="even">
<td>Path2 newer AND Path1 deleted</td>
<td>File is newer on Path2 AND also deleted on Path1</td>
<td>Path2 version survives</td>
<td><code>rclone copy</code> Path2 to Path1</td>
</tr>
<tr class="odd">
<td>Path2 deleted AND Path1 changed</td>
<td>File is deleted on Path2 AND changed (newer/older/size) on
Path1</td>
<td>Path1 version survives</td>
<td><code>rclone copy</code> Path1 to Path2</td>
</tr>
<tr class="even">
<td>Path1 deleted AND Path2 changed</td>
<td>File is deleted on Path1 AND changed (newer/older/size) on
Path2</td>
<td>Path2 version survives</td>
<td><code>rclone copy</code> Path2 to Path1</td>
</tr>
</tbody>
</table>
<p>As of <code>rclone v1.64</code>, bisync is now better at detecting
<em>false positive</em> sync conflicts, which would previously have
resulted in unnecessary renames and duplicates. Now, when bisync comes
to a file that it wants to rename (because it is new/changed on both
sides), it first checks whether the Path1 and Path2 versions are
currently <em>identical</em> (using the same underlying function as <a
href="commands/rclone_check/"><code>check</code></a>.) If bisync
concludes that the files are identical, it will skip them and move on.
Otherwise, it will create renamed duplicates, as before. This behavior
also <a
href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=Renamed%20directories">improves
the experience of renaming directories</a>, as a <code>--resync</code>
is no longer required, so long as the same change has been made on both
sides.</p>
<h3 id="all-files-changed">All files changed check</h3>
<p>If <em>all</em> prior existing files on either of the filesystems
have changed (e.g. timestamps have changed due to changing the system's
timezone) then bisync will abort without making any changes. Any new
files are not considered for this check. You could use
<code>--force</code> to force the sync (whichever side has the changed
timestamp files wins). Alternately, a <code>--resync</code> may be used
(Path1 versions will be pushed to Path2). Consider the situation
carefully and perhaps use <code>--dry-run</code> before you commit to
the changes.</p>
<h3 id="modification-times">Modification times</h3>
<p>By default, bisync compares files by modification time and size. If
you or your application should change the content of a file without
changing the modification time and size, then bisync will <em>not</em>
notice the change, and thus will not copy it to the other side. As an
alternative, consider comparing by checksum (if your remotes support
it). See <a href="#compare"><code>--compare</code></a> for details.</p>
<h3 id="error-handling">Error handling</h3>
<p>Certain bisync critical errors, such as file copy/move failing, will
result in a bisync lockout of following runs. The lockout is asserted
because the sync status and history of the Path1 and Path2 filesystems
cannot be trusted, so it is safer to block any further changes until
someone checks things out. The recovery is to do a <code>--resync</code>
again.</p>
<p>It is recommended to use <code>--resync --dry-run --verbose</code>
initially and <em>carefully</em> review what changes will be made before
running the <code>--resync</code> without <code>--dry-run</code>.</p>
<p>Most of these events come up due to an error status from an internal
call. On such a critical error the <code>{...}.path1.lst</code> and
<code>{...}.path2.lst</code> listing files are renamed to extension
<code>.lst-err</code>, which blocks any future bisync runs (since the
normal <code>.lst</code> files are not found). Bisync keeps them under
<code>bisync</code> subdirectory of the rclone cache directory,
typically at <code>${HOME}/.cache/rclone/bisync/</code> on Linux.</p>
<p>Some errors are considered temporary and re-running the bisync is not
blocked. The <em>critical return</em> blocks further bisync runs.</p>
<p>See also: <a href="#resilient"><code>--resilient</code></a>, <a
href="#recover"><code>--recover</code></a>, <a
href="#max-lock"><code>--max-lock</code></a>, <a
href="#graceful-shutdown">Graceful Shutdown</a></p>
<h3 id="lock-file">Lock file</h3>
<p>When bisync is running, a lock file is created in the bisync working
directory, typically at
<code>~/.cache/rclone/bisync/PATH1..PATH2.lck</code> on Linux. If bisync
should crash or hang, the lock file will remain in place and block any
further runs of bisync <em>for the same paths</em>. Delete the lock file
as part of debugging the situation. The lock file effectively blocks
follow-on (e.g., scheduled by <em>cron</em>) runs when the prior
invocation is taking a long time. The lock file contains <em>PID</em> of
the blocking process, which may help in debug. Lock files can be set to
automatically expire after a certain amount of time, using the <a
href="#max-lock"><code>--max-lock</code></a> flag.</p>
<p><strong>Note</strong> that while concurrent bisync runs are allowed,
<em>be very cautious</em> that there is no overlap in the trees being
synched between concurrent runs, lest there be replicated files, deleted
files and general mayhem.</p>
<h3 id="exit-codes">Exit codes</h3>
<p><code>rclone bisync</code> returns the following codes to calling
program:</p>
<ul>
<li><code>0</code> on a successful run,</li>
<li><code>1</code> for a non-critical failing run (a rerun may be
successful),</li>
<li><code>2</code> on syntax or usage error,</li>
<li><code>7</code> for a critically aborted run (requires a
<code>--resync</code> to recover).</li>
</ul>
<p>See also the section about <a
href="https://rclone.org/docs/#exit-code">exit codes</a> in main
docs.</p>
<h3 id="graceful-shutdown">Graceful Shutdown</h3>
<p>Bisync has a "Graceful Shutdown" mode which is activated by sending
<code>SIGINT</code> or pressing <code>Ctrl+C</code> during a run. Once
triggered, bisync will use best efforts to exit cleanly before the timer
runs out. If bisync is in the middle of transferring files, it will
attempt to cleanly empty its queue by finishing what it has started but
not taking more. If it cannot do so within 30 seconds, it will cancel
the in-progress transfers at that point and then give itself a maximum
of 60 seconds to wrap up, save its state for next time, and exit. With
the <code>-vP</code> flags you will see constant status updates and a
final confirmation of whether or not the graceful shutdown was
successful.</p>
<p>At any point during the "Graceful Shutdown" sequence, a second
<code>SIGINT</code> or <code>Ctrl+C</code> will trigger an immediate,
un-graceful exit, which will leave things in a messier state. Usually a
robust recovery will still be possible if using <a
href="#recover"><code>--recover</code></a> mode, otherwise you will need
to do a <code>--resync</code>.</p>
<p>If you plan to use Graceful Shutdown mode, it is recommended to use
<a href="#resilient"><code>--resilient</code></a> and <a
href="#recover"><code>--recover</code></a>, and it is important to NOT
use <a
href="https://rclone.org/docs/#inplace"><code>--inplace</code></a>,
otherwise you risk leaving partially-written files on one side, which
may be confused for real files on the next run. Note also that in the
event of an abrupt interruption, a <a href="#lock-file">lock file</a>
will be left behind to block concurrent runs. You will need to delete it
before you can proceed with the next run (or wait for it to expire on
its own, if using <code>--max-lock</code>.)</p>
<h2 id="limitations-4">Limitations</h2>
<h3 id="supported-backends">Supported backends</h3>
<p>Bisync is integration-tested against all rclone backends to verify
compatibility. Most backends (including all backends not listed below)
are deemed fully supported with no known issues. Occasionally, however,
these tests reveal issues with particular backends, usually related to a
provider-specific limitation beyond rclone's control (for example,
disallowed special characters and filename encodings.)</p>
<p>The following backends have known issues that need more
investigation:</p>
<!--- start list_failures - DO NOT EDIT THIS SECTION - use rclone gendocs --->
<ul>
<li><code>TestGoFile</code> (<code>gofile</code>)
<ul>
<li><a
href="https://pub.rclone.org/integration-tests/current/gofile-cmd.bisync-TestGoFile-1.txt"><code>TestBisyncRemoteLocal/all_changed</code></a></li>
<li><a
href="https://pub.rclone.org/integration-tests/current/gofile-cmd.bisync-TestGoFile-1.txt"><code>TestBisyncRemoteLocal/backupdir</code></a></li>
<li><a
href="https://pub.rclone.org/integration-tests/current/gofile-cmd.bisync-TestGoFile-1.txt"><code>TestBisyncRemoteLocal/basic</code></a></li>
<li><a
href="https://pub.rclone.org/integration-tests/current/gofile-cmd.bisync-TestGoFile-1.txt"><code>TestBisyncRemoteLocal/changes</code></a></li>
<li><a
href="https://pub.rclone.org/integration-tests/current/gofile-cmd.bisync-TestGoFile-1.txt"><code>TestBisyncRemoteLocal/check_access</code></a></li>
<li><a href="https://pub.rclone.org/integration-tests/current/">78
more</a></li>
</ul></li>
<li>Updated: 2025-08-21-010015
<!--- end list_failures - DO NOT EDIT THIS SECTION - use rclone gendocs ---></li>
</ul>
<p>The following backends either have not been tested recently or have
known issues that are deemed unfixable for the time being:</p>
<!--- start list_ignores - DO NOT EDIT THIS SECTION - use rclone gendocs --->
<ul>
<li><code>TestCache</code> (<code>cache</code>)</li>
<li><code>TestFileLu</code> (<code>filelu</code>)</li>
<li><code>TestFilesCom</code> (<code>filescom</code>)</li>
<li><code>TestImageKit</code> (<code>imagekit</code>)</li>
<li><code>TestJottacloud</code> (<code>jottacloud</code>)</li>
<li><code>TestLinkbox</code> (<code>linkbox</code>)</li>
<li><code>TestMailru</code> (<code>mailru</code>)</li>
<li><code>TestMega</code> (<code>mega</code>)</li>
<li><code>TestOpenDrive</code> (<code>opendrive</code>)</li>
<li><code>TestOracleObjectStorage</code>
(<code>oracleobjectstorage</code>)</li>
<li><code>TestPikPak</code> (<code>pikpak</code>)</li>
<li><code>TestPixeldrain</code> (<code>pixeldrain</code>)</li>
<li><code>TestProtonDrive</code> (<code>protondrive</code>)</li>
<li><code>TestPutio</code> (<code>putio</code>)</li>
<li><code>TestQuatrix</code> (<code>quatrix</code>)</li>
<li><code>TestS3GCS</code> (<code>s3</code>)
<ul>
<li><code>TestBisyncRemoteRemote/extended_filenames</code></li>
</ul></li>
<li><code>TestS3Rclone</code> (<code>s3</code>)</li>
<li><code>TestSFTPRsyncNet</code> (<code>sftp</code>)</li>
<li><code>TestStorj</code> (<code>storj</code>)</li>
<li><code>TestWebdavInfiniteScale</code> (<code>webdav</code>)</li>
<li><code>TestWebdavNextcloud</code> (<code>webdav</code>)</li>
<li><code>TestWebdavOwncloud</code> (<code>webdav</code>)</li>
<li><code>TestnStorage</code> (<code>netstorage</code>)
<!--- end list_ignores - DO NOT EDIT THIS SECTION - use rclone gendocs --->
(<a
href="https://github.com/rclone/rclone/blob/master/fstest/test_all/config.yaml">more
info</a>)</li>
</ul>
<p>The above lists are updated for each stable release of rclone. For
test results updated nightly based on the latest beta, visit rclone's <a
href="https://pub.rclone.org/integration-tests/current/">integration
test status page</a>.</p>
<p>Early beta versions of <code>rclone bisync</code> required both
underlying backends to support modification times, and refused to run
otherwise. This limitation has been lifted as of <code>v1.66</code>, as
bisync now supports comparing checksum and/or size instead of (or in
addition to) modtime. See <a href="#compare"><code>--compare</code></a>
for details.</p>
<h3 id="concurrent-modifications">Concurrent modifications</h3>
<p>When using <strong>Local, FTP or SFTP</strong> remotes with <a
href="https://rclone.org/docs/#inplace"><code>--inplace</code></a>,
rclone does not create <em>temporary</em> files at the destination when
copying, and thus if the connection is lost the created file may be
corrupt, which will likely propagate back to the original path on the
next sync, resulting in data loss. It is therefore recommended to
<em>omit</em> <code>--inplace</code>.</p>
<p>Files that <strong>change during</strong> a bisync run may result in
data loss. Prior to <code>rclone v1.66</code>, this was commonly seen in
highly dynamic environments, where the filesystem was getting hammered
by running processes during the sync. As of <code>rclone v1.66</code>,
bisync was redesigned to use a "snapshot" model, greatly reducing the
risks from changes during a sync. Changes that are not detected during
the current sync will now be detected during the following sync, and
will no longer cause the entire run to throw a critical error. There is
additionally a mechanism to mark files as needing to be internally
rechecked next time, for added safety. It should therefore no longer be
necessary to sync only at quiet times -- however, note that an error can
still occur if a file happens to change at the exact moment it's being
read/written by bisync (same as would happen in
<code>rclone sync</code>.) (See also: <a
href="https://rclone.org/docs/#ignore-checksum"><code>--ignore-checksum</code></a>,
<a
href="https://rclone.org/local/#local-no-check-updated"><code>--local-no-check-updated</code></a>)</p>
<h3 id="empty-directories">Empty directories</h3>
<p>By default, new/deleted empty directories on one path are
<em>not</em> propagated to the other side. This is because bisync (and
rclone) natively works on files, not directories. However, this can be
changed with the <code>--create-empty-src-dirs</code> flag, which works
in much the same way as in <a
href="https://rclone.org/commands/rclone_sync/"><code>sync</code></a>
and <a
href="https://rclone.org/commands/rclone_copy/"><code>copy</code></a>.
When used, empty directories created or deleted on one side will also be
created or deleted on the other side. The following should be noted:</p>
<ul>
<li><code>--create-empty-src-dirs</code> is not compatible with
<code>--remove-empty-dirs</code>. Use only one or the other (or
neither).</li>
<li>It is not recommended to switch back and forth between
<code>--create-empty-src-dirs</code> and the default (no
<code>--create-empty-src-dirs</code>) without running
<code>-- resync</code>. This is because it may appear as though all
directories (not just the empty ones) were created/deleted, when
actually you've just toggled between making them visible/invisible to
bisync. It looks scarier than it is, but it's still probably best to
stick to one or the other, and use <code>--resync</code> when you need
to switch.</li>
</ul>
<h3 id="renamed-directories">Renamed directories</h3>
<p>By default, renaming a folder on the Path1 side results in deleting
all files on the Path2 side and then copying all files again from Path1
to Path2. Bisync sees this as all files in the old directory name as
deleted and all files in the new directory name as new.</p>
<p>A recommended solution is to use <a
href="https://rclone.org/docs/#track-renames"><code>--track-renames</code></a>,
which is now supported in bisync as of <code>rclone v1.66</code>. Note
that <code>--track-renames</code> is not available during
<code>--resync</code>, as <code>--resync</code> does not delete anything
(<code>--track-renames</code> only supports <code>sync</code>, not
<code>copy</code>.)</p>
<p>Otherwise, the most effective and efficient method of renaming a
directory is to rename it to the same name on both sides. (As of
<code>rclone v1.64</code>, a <code>--resync</code> is no longer required
after doing so, as bisync will automatically detect that Path1 and Path2
are in agreement.)</p>
<h3 id="fast-list-used-by-default"><code>--fast-list</code> used by
default</h3>
<p>Unlike most other rclone commands, bisync uses <a
href="https://rclone.org/docs/#fast-list"><code>--fast-list</code></a>
by default, for backends that support it. In many cases this is
desirable, however, there are some scenarios in which bisync could be
faster <em>without</em> <code>--fast-list</code>, and there is also a <a
href="https://github.com/rclone/rclone/commit/cbf3d4356135814921382dd3285d859d15d0aa77">known
issue concerning Google Drive users with many empty directories</a>. For
now, the recommended way to avoid using <code>--fast-list</code> is to
add <code>--disable ListR</code> to all bisync commands. The default
behavior may change in a future version.</p>
<h3 id="case-sensitivity">Case (and unicode) sensitivity</h3>
<p>As of <code>v1.66</code>, case and unicode form differences no longer
cause critical errors, and normalization (when comparing between
filesystems) is handled according to the same flags and defaults as
<code>rclone sync</code>. See the following options (all of which are
supported by bisync) to control this behavior more granularly:</p>
<ul>
<li><a
href="https://rclone.org/docs/#fix-case"><code>--fix-case</code></a></li>
<li><a
href="https://rclone.org/docs/#ignore-case-sync"><code>--ignore-case-sync</code></a></li>
<li><a
href="https://rclone.org/docs/#no-unicode-normalization"><code>--no-unicode-normalization</code></a></li>
<li><a
href="https://rclone.org/local/#local-unicode-normalization"><code>--local-unicode-normalization</code></a>
and <a
href="https://rclone.org/local/#local-case-sensitive"><code>--local-case-sensitive</code></a>
(caution: these are normally not what you want.)</li>
</ul>
<p>Note that in the (probably rare) event that <code>--fix-case</code>
is used AND a file is new/changed on both sides AND the checksums match
AND the filename case does not match, the Path1 filename is considered
the winner, for the purposes of <code>--fix-case</code> (Path2 will be
renamed to match it).</p>
<h2 id="windows">Windows support</h2>
<p>Bisync has been tested on Windows 8.1, Windows 10 Pro 64-bit and on
Windows GitHub runners.</p>
<p>Drive letters are allowed, including drive letters mapped to network
drives (<code>rclone bisync J:\localsync GDrive:</code>). If a drive
letter is omitted, the shell current drive is the default. Drive letters
are a single character follows by <code>:</code>, so cloud names must be
more than one character long.</p>
<p>Absolute paths (with or without a drive letter), and relative paths
(with or without a drive letter) are supported.</p>
<p>Working directory is created at
<code>C:\Users\MyLogin\AppData\Local\rclone\bisync</code>.</p>
<p>Note that bisync output may show a mix of forward <code>/</code> and
back <code>\</code> slashes.</p>
<p>Be careful of case independent directory and file naming on Windows
vs. case dependent Linux</p>
<h2 id="filtering">Filtering</h2>
<p>See <a href="https://rclone.org/filtering/">filtering
documentation</a> for how filter rules are written and interpreted.</p>
<p>Bisync's <a href="#filters-file"><code>--filters-file</code></a> flag
slightly extends the rclone's <a
href="https://rclone.org/filtering/#filter-from-read-filtering-patterns-from-a-file">--filter-from</a>
filtering mechanism. For a given bisync run you may provide <em>only
one</em> <code>--filters-file</code>. The <code>--include*</code>,
<code>--exclude*</code>, and <code>--filter</code> flags are also
supported.</p>
<h3 id="how-to-filter-directories">How to filter directories</h3>
<p>Filtering portions of the directory tree is a critical feature for
syncing.</p>
<p>Examples of directory trees (always beneath the Path1/Path2 root
level) you may want to exclude from your sync:</p>
<ul>
<li>Directory trees containing only software build intermediate
files.</li>
<li>Directory trees containing application temporary files and data such
as the Windows <code>C:\Users\MyLogin\AppData\</code> tree.</li>
<li>Directory trees containing files that are large, less important, or
are getting thrashed continuously by ongoing processes.</li>
</ul>
<p>On the other hand, there may be only select directories that you
actually want to sync, and exclude all others. See the <a
href="#include-filters">Example include-style filters for Windows user
directories</a> below.</p>
<h3 id="filters-file-writing-guidelines">Filters file writing
guidelines</h3>
<ol type="1">
<li>Begin with excluding directory trees:
<ul>
<li>e.g. <code>- /AppData/</code></li>
<li><code>**</code> on the end is not necessary. Once a given directory
level is excluded then everything beneath it won't be looked at by
rclone.</li>
<li>Exclude such directories that are unneeded, are big, dynamically
thrashed, or where there may be access permission issues.</li>
<li>Excluding such dirs first will make rclone operations (much)
faster.</li>
<li>Specific files may also be excluded, as with the Dropbox exclusions
example below.</li>
</ul></li>
<li>Decide if it's easier (or cleaner) to:
<ul>
<li>Include select directories and therefore <em>exclude everything
else</em> -- or --</li>
<li>Exclude select directories and therefore <em>include everything
else</em></li>
</ul></li>
<li>Include select directories:
<ul>
<li>Add lines like: <code>+ /Documents/PersonalFiles/**</code> to select
which directories to include in the sync.</li>
<li><code>**</code> on the end specifies to include the full depth of
the specified tree.</li>
<li>With Include-style filters, files at the Path1/Path2 root are not
included. They may be included with <code>+ /*</code>.</li>
<li>Place RCLONE_TEST files within these included directory trees. They
will only be looked for in these directory trees.</li>
<li>Finish by excluding everything else by adding <code>- **</code> at
the end of the filters file.</li>
<li>Disregard step 4.</li>
</ul></li>
<li>Exclude select directories:
<ul>
<li>Add more lines like in step 1. For example:
<code>-/Desktop/tempfiles/</code>, or <code>- /testdir/</code>. Again, a
<code>**</code> on the end is not necessary.</li>
<li>Do <em>not</em> add a <code>- **</code> in the file. Without this
line, everything will be included that has not been explicitly
excluded.</li>
<li>Disregard step 3.</li>
</ul></li>
</ol>
<p>A few rules for the syntax of a filter file expanding on <a
href="https://rclone.org/filtering/">filtering documentation</a>:</p>
<ul>
<li>Lines may start with spaces and tabs - rclone strips leading
whitespace.</li>
<li>If the first non-whitespace character is a <code>#</code> then the
line is a comment and will be ignored.</li>
<li>Blank lines are ignored.</li>
<li>The first non-whitespace character on a filter line must be a
<code>+</code> or <code>-</code>.</li>
<li>Exactly 1 space is allowed between the <code>+/-</code> and the path
term.</li>
<li>Only forward slashes (<code>/</code>) are used in path terms, even
on Windows.</li>
<li>The rest of the line is taken as the path term. Trailing whitespace
is taken literally, and probably is an error.</li>
</ul>
<h3 id="include-filters">Example include-style filters for Windows user
directories</h3>
<p>This Windows <em>include-style</em> example is based on the sync root
(Path1) set to <code>C:\Users\MyLogin</code>. The strategy is to select
specific directories to be synched with a network drive (Path2).</p>
<ul>
<li><code>- /AppData/</code> excludes an entire tree of Windows stored
stuff that need not be synched. In my case, AppData has &gt;11 GB of
stuff I don't care about, and there are some subdirectories beneath
AppData that are not accessible to my user login, resulting in bisync
critical aborts.</li>
<li>Windows creates cache files starting with both upper and lowercase
<code>NTUSER</code> at <code>C:\Users\MyLogin</code>. These files may be
dynamic, locked, and are generally <em>don't care</em>.</li>
<li>There are just a few directories with <em>my</em> data that I do
want synched, in the form of <code>+ /&lt;path&gt;</code>. By selecting
only the directory trees I want to avoid the dozen plus directories that
various apps make at <code>C:\Users\MyLogin\Documents</code>.</li>
<li>Include files in the root of the sync point,
<code>C:\Users\MyLogin</code>, by adding the <code>+ /*</code>
line.</li>
<li>This is an Include-style filters file, therefore it ends with
<code>- **</code> which excludes everything not explicitly
included.</li>
</ul>
<pre class="text"><code>- /AppData/
- NTUSER*
- ntuser*
+ /Documents/Family/**
+ /Documents/Sketchup/**
+ /Documents/Microcapture_Photo/**
+ /Documents/Microcapture_Video/**
+ /Desktop/**
+ /Pictures/**
+ /*
- **</code></pre>
<p>Note also that Windows implements several "library" links such as
<code>C:\Users\MyLogin\My Documents\My Music</code> pointing to
<code>C:\Users\MyLogin\Music</code>. rclone sees these as links, so you
must add <code>--links</code> to the bisync command line if you which to
follow these links. I find that I get permission errors in trying to
follow the links, so I don't include the rclone <code>--links</code>
flag, but then you get lots of <code>Can't follow symlink…</code> noise
from rclone about not following the links. This noise can be quashed by
adding <code>--quiet</code> to the bisync command line.</p>
<h2 id="exclude-filters">Example exclude-style filters files for use
with Dropbox</h2>
<ul>
<li>Dropbox disallows syncing the listed temporary and
configuration/data files. The <code>- &lt;filename&gt;</code> filters
exclude these files where ever they may occur in the sync tree. Consider
adding similar exclusions for file types you don't need to sync, such as
core dump and software build files.</li>
<li>bisync testing creates <code>/testdir/</code> at the top level of
the sync tree, and usually deletes the tree after the test. If a normal
sync should run while the <code>/testdir/</code> tree exists the
<code>--check-access</code> phase may fail due to unbalanced RCLONE_TEST
files. The <code>- /testdir/</code> filter blocks this tree from being
synched. You don't need this exclusion if you are not doing bisync
development testing.</li>
<li>Everything else beneath the Path1/Path2 root will be synched.</li>
<li>RCLONE_TEST files may be placed anywhere within the tree, including
the root.</li>
</ul>
<h3 id="example-filters-file">Example filters file for Dropbox</h3>
<pre class="text"><code># Filter file for use with bisync
# See https://rclone.org/filtering/ for filtering rules
# NOTICE: If you make changes to this file you MUST do a --resync run.
#         Run with --dry-run to see what changes will be made.

# Dropbox won&#39;t sync some files so filter them away here.
# See https://help.dropbox.com/installs-integrations/sync-uploads/files-not-syncing
- .dropbox.attr
- ~*.tmp
- ~$*
- .~*
- desktop.ini
- .dropbox

# Used for bisync testing, so excluded from normal runs
- /testdir/

# Other example filters
#- /TiBU/
#- /Photos/</code></pre>
<h3 id="how---check-access-handles-filters">How --check-access handles
filters</h3>
<p>At the start of a bisync run, listings are gathered for Path1 and
Path2 while using the user's <code>--filters-file</code>. During the
check access phase, bisync scans these listings for
<code>RCLONE_TEST</code> files. Any <code>RCLONE_TEST</code> files
hidden by the <code>--filters-file</code> are <em>not</em> in the
listings and thus not checked during the check access phase.</p>
<h2 id="troubleshooting">Troubleshooting</h2>
<h3 id="reading-bisync-logs">Reading bisync logs</h3>
<p>Here are two normal runs. The first one has a newer file on the
remote. The second has no deltas between local and remote.</p>
<div class="sourceCode" id="cb894"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb894-1"><a href="#cb894-1" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:24:38 INFO  : Synching Path1 <span class="st">&quot;/path/to/local/tree/&quot;</span> with Path2 <span class="st">&quot;dropbox:/&quot;</span></span>
<span id="cb894-2"><a href="#cb894-2" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:24:38 INFO  : Path1 checking for diffs</span>
<span id="cb894-3"><a href="#cb894-3" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:24:38 INFO  : <span class="at">-</span> Path1    File is new                         <span class="at">-</span> file.txt</span>
<span id="cb894-4"><a href="#cb894-4" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:24:38 INFO  : Path1:    1 changes:    1 new,    0 newer,    0 older,    0 deleted</span>
<span id="cb894-5"><a href="#cb894-5" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:24:38 INFO  : Path2 checking for diffs</span>
<span id="cb894-6"><a href="#cb894-6" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:24:38 INFO  : Applying changes</span>
<span id="cb894-7"><a href="#cb894-7" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:24:38 INFO  : <span class="at">-</span> Path1    Queue copy to Path2                 <span class="at">-</span> dropbox:/file.txt</span>
<span id="cb894-8"><a href="#cb894-8" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:24:38 INFO  : <span class="at">-</span> Path1    Do queued copies to                 <span class="at">-</span> Path2</span>
<span id="cb894-9"><a href="#cb894-9" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:24:38 INFO  : Updating listings</span>
<span id="cb894-10"><a href="#cb894-10" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:24:38 INFO  : Validating listings for Path1 <span class="st">&quot;/path/to/local/tree/&quot;</span> vs Path2 <span class="st">&quot;dropbox:/&quot;</span></span>
<span id="cb894-11"><a href="#cb894-11" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:24:38 INFO  : Bisync successful</span>
<span id="cb894-12"><a href="#cb894-12" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb894-13"><a href="#cb894-13" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:36:52 INFO  : Synching Path1 <span class="st">&quot;/path/to/local/tree/&quot;</span> with Path2 <span class="st">&quot;dropbox:/&quot;</span></span>
<span id="cb894-14"><a href="#cb894-14" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:36:52 INFO  : Path1 checking for diffs</span>
<span id="cb894-15"><a href="#cb894-15" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:36:52 INFO  : Path2 checking for diffs</span>
<span id="cb894-16"><a href="#cb894-16" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:36:52 INFO  : No changes found</span>
<span id="cb894-17"><a href="#cb894-17" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:36:52 INFO  : Updating listings</span>
<span id="cb894-18"><a href="#cb894-18" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:36:52 INFO  : Validating listings for Path1 <span class="st">&quot;/path/to/local/tree/&quot;</span> vs Path2 <span class="st">&quot;dropbox:/&quot;</span></span>
<span id="cb894-19"><a href="#cb894-19" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/16</span> 00:36:52 INFO  : Bisync successful</span></code></pre></div>
<h3 id="dry-run-oddity">Dry run oddity</h3>
<p>The <code>--dry-run</code> messages may indicate that it would try to
delete some files. For example, if a file is new on Path2 and does not
exist on Path1 then it would normally be copied to Path1, but with
<code>--dry-run</code> enabled those copies don't happen, which leads to
the attempted delete on Path2, blocked again by --dry-run:
<code>... Not deleting as --dry-run</code>.</p>
<p>This whole confusing situation is an artifact of the
<code>--dry-run</code> flag. Scrutinize the proposed deletes carefully,
and if the files would have been copied to Path1 then the threatened
deletes on Path2 may be disregarded.</p>
<h3 id="retries">Retries</h3>
<p>Rclone has built-in retries. If you run with <code>--verbose</code>
you'll see error and retry messages such as shown below. This is usually
not a bug. If at the end of the run, you see
<code>Bisync successful</code> and not
<code>Bisync critical error</code> or <code>Bisync aborted</code> then
the run was successful, and you can ignore the error messages.</p>
<p>The following run shows an intermittent fail. Lines <em>5</em> and
<em>6</em> are low-level messages. Line <em>6</em> is a bubbled-up
<em>warning</em> message, conveying the error. Rclone normally retries
failing commands, so there may be numerous such messages in the log.</p>
<p>Since there are no final error/warning messages on line <em>7</em>,
rclone has recovered from failure after a retry, and the overall sync
was successful.</p>
<div class="sourceCode" id="cb895"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb895-1"><a href="#cb895-1" aria-hidden="true" tabindex="-1"></a><span class="ex">1:</span> 2021/05/14 00:44:12 INFO  : Synching Path1 <span class="st">&quot;/path/to/local/tree&quot;</span> with Path2 <span class="st">&quot;dropbox:&quot;</span></span>
<span id="cb895-2"><a href="#cb895-2" aria-hidden="true" tabindex="-1"></a><span class="ex">2:</span> 2021/05/14 00:44:12 INFO  : Path1 checking for diffs</span>
<span id="cb895-3"><a href="#cb895-3" aria-hidden="true" tabindex="-1"></a><span class="ex">3:</span> 2021/05/14 00:44:12 INFO  : Path2 checking for diffs</span>
<span id="cb895-4"><a href="#cb895-4" aria-hidden="true" tabindex="-1"></a><span class="ex">4:</span> 2021/05/14 00:44:12 INFO  : Path2:  113 changes:   22 new,    0 newer,    0 older,   91 deleted</span>
<span id="cb895-5"><a href="#cb895-5" aria-hidden="true" tabindex="-1"></a><span class="ex">5:</span> 2021/05/14 00:44:12 ERROR : /path/to/local/tree/objects/af: error listing: unexpected end of JSON input</span>
<span id="cb895-6"><a href="#cb895-6" aria-hidden="true" tabindex="-1"></a><span class="ex">6:</span> 2021/05/14 00:44:12 NOTICE: WARNING  listing try 1 failed.                 <span class="at">-</span> dropbox:</span>
<span id="cb895-7"><a href="#cb895-7" aria-hidden="true" tabindex="-1"></a><span class="ex">7:</span> 2021/05/14 00:44:12 INFO  : Bisync successful</span></code></pre></div>
<p>This log shows a <em>Critical failure</em> which requires a
<code>--resync</code> to recover from. See the <a
href="#error-handling">Runtime Error Handling</a> section.</p>
<div class="sourceCode" id="cb896"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb896-1"><a href="#cb896-1" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/12</span> 00:49:40 INFO  : Google drive root <span class="st">&#39;&#39;</span>: Waiting for checks to finish</span>
<span id="cb896-2"><a href="#cb896-2" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/12</span> 00:49:40 INFO  : Google drive root <span class="st">&#39;&#39;</span>: Waiting for transfers to finish</span>
<span id="cb896-3"><a href="#cb896-3" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/12</span> 00:49:40 INFO  : Google drive root <span class="st">&#39;&#39;</span>: not deleting files as there were IO errors</span>
<span id="cb896-4"><a href="#cb896-4" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/12</span> 00:49:40 ERROR : Attempt 3/3 failed with 3 errors and: not deleting files as there were IO errors</span>
<span id="cb896-5"><a href="#cb896-5" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/12</span> 00:49:40 ERROR : Failed to sync: not deleting files as there were IO errors</span>
<span id="cb896-6"><a href="#cb896-6" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/12</span> 00:49:40 NOTICE: WARNING  rclone sync try 3 failed.           <span class="at">-</span> /path/to/local/tree/</span>
<span id="cb896-7"><a href="#cb896-7" aria-hidden="true" tabindex="-1"></a><span class="ex">2021/05/12</span> 00:49:40 ERROR : Bisync aborted. Must run <span class="at">--resync</span> to recover.</span></code></pre></div>
<h3 id="denied-downloads-of-infected-or-abusive-files">Denied downloads
of "infected" or "abusive" files</h3>
<p>Google Drive has a filter for certain file types (<code>.exe</code>,
<code>.apk</code>, et cetera) that by default cannot be copied from
Google Drive to the local filesystem. If you are having problems, run
with <code>--verbose</code> to see specifically which files are
generating complaints. If the error is
<code>This file has been identified as malware or spam and cannot be downloaded</code>,
consider using the flag <a
href="https://rclone.org/drive/#drive-acknowledge-abuse">--drive-acknowledge-abuse</a>.</p>
<h3 id="gdocs">Google Docs (and other files of unknown size)</h3>
<p>As of <code>v1.66</code>, <a
href="https://rclone.org/drive/#import-export-of-google-documents">Google
Docs</a> (including Google Sheets, Slides, etc.) are now supported in
bisync, subject to the same options, defaults, and limitations as in
<code>rclone sync</code>. When bisyncing drive with non-drive backends,
the drive -&gt; non-drive direction is controlled by <a
href="https://rclone.org/drive/#drive-export-formats"><code>--drive-export-formats</code></a>
(default <code>"docx,xlsx,pptx,svg"</code>) and the non-drive -&gt;
drive direction is controlled by <a
href="https://rclone.org/drive/#drive-import-formats"><code>--drive-import-formats</code></a>
(default none.)</p>
<p>For example, with the default export/import formats, a Google Sheet
on the drive side will be synced to an <code>.xlsx</code> file on the
non-drive side. In the reverse direction, <code>.xlsx</code> files with
filenames that match an existing Google Sheet will be synced to that
Google Sheet, while <code>.xlsx</code> files that do NOT match an
existing Google Sheet will be copied to drive as normal
<code>.xlsx</code> files (without conversion to Sheets, although the
Google Drive web browser UI may still give you the option to open it as
one.)</p>
<p>If <code>--drive-import-formats</code> is set (it's not, by default),
then all of the specified formats will be converted to Google Docs, if
there is no existing Google Doc with a matching name. Caution: such
conversion can be quite lossy, and in most cases it's probably not what
you want!</p>
<p>To bisync Google Docs as URL shortcut links (in a manner similar to
"Drive for Desktop"), use: <code>--drive-export-formats url</code> (or
<a
href="https://rclone.org/drive/#exportformats:~:text=available%20Google%20Documents.-,Extension,macOS,-Standard%20options">alternatives</a>.)</p>
<p>Note that these link files cannot be edited on the non-drive side --
you will get errors if you try to sync an edited link file back to
drive. They CAN be deleted (it will result in deleting the corresponding
Google Doc.) If you create a <code>.url</code> file on the non-drive
side that does not match an existing Google Doc, bisyncing it will just
result in copying the literal <code>.url</code> file over to drive (no
Google Doc will be created.) So, as a general rule of thumb, think of
them as read-only placeholders on the non-drive side, and make all your
changes on the drive side.</p>
<p>Likewise, even with other export-formats, it is best to only
move/rename Google Docs on the drive side. This is because otherwise,
bisync will interpret this as a file deleted and another created, and
accordingly, it will delete the Google Doc and create a new file at the
new path. (Whether or not that new file is a Google Doc depends on
<code>--drive-import-formats</code>.)</p>
<p>Lastly, take note that all Google Docs on the drive side have a size
of <code>-1</code> and no checksum. Therefore, they cannot be reliably
synced with the <code>--checksum</code> or <code>--size-only</code>
flags. (To be exact: they will still get created/deleted, and bisync's
delta engine will notice changes and queue them for syncing, but the
underlying sync function will consider them identical and skip them.) To
work around this, use the default (modtime and size) instead of
<code>--checksum</code> or <code>--size-only</code>.</p>
<p>To ignore Google Docs entirely, use <a
href="https://rclone.org/drive/#drive-skip-gdocs"><code>--drive-skip-gdocs</code></a>.</p>
<h2 id="usage-examples">Usage examples</h2>
<h3 id="cron">Cron</h3>
<p>Rclone does not yet have a built-in capability to monitor the local
file system for changes and must be blindly run periodically. On Windows
this can be done using a <em>Task Scheduler</em>, on Linux you can use
<em>Cron</em> which is described below.</p>
<p>The 1st example runs a sync every 5 minutes between a local directory
and an OwnCloud server, with output logged to a runlog file:</p>
<div class="sourceCode" id="cb897"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb897-1"><a href="#cb897-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Minute (0-59)</span></span>
<span id="cb897-2"><a href="#cb897-2" aria-hidden="true" tabindex="-1"></a><span class="co">#      Hour (0-23)</span></span>
<span id="cb897-3"><a href="#cb897-3" aria-hidden="true" tabindex="-1"></a><span class="co">#           Day of Month (1-31)</span></span>
<span id="cb897-4"><a href="#cb897-4" aria-hidden="true" tabindex="-1"></a><span class="co">#                Month (1-12 or Jan-Dec)</span></span>
<span id="cb897-5"><a href="#cb897-5" aria-hidden="true" tabindex="-1"></a><span class="co">#                     Day of Week (0-6 or Sun-Sat)</span></span>
<span id="cb897-6"><a href="#cb897-6" aria-hidden="true" tabindex="-1"></a><span class="co">#                         Command</span></span>
<span id="cb897-7"><a href="#cb897-7" aria-hidden="true" tabindex="-1"></a>  <span class="ex">*/5</span>  <span class="pp">*</span>    <span class="pp">*</span>    <span class="pp">*</span>    <span class="pp">*</span>   /path/to/rclone bisync /local/files MyCloud: <span class="at">--check-access</span> <span class="at">--filters-file</span> /path/to/bysync-filters.txt <span class="at">--log-file</span> /path/to//bisync.log</span></code></pre></div>
<p>See <a
href="https://www.man7.org/linux/man-pages/man1/crontab.1p.html#INPUT_FILES">crontab
syntax</a> for the details of crontab time interval expressions.</p>
<p>If you run <code>rclone bisync</code> as a cron job, redirect
stdout/stderr to a file. The 2nd example runs a sync to Dropbox every
hour and logs all stdout (via the <code>&gt;&gt;</code>) and stderr (via
<code>2&gt;&amp;1</code>) to a log file.</p>
<div class="sourceCode" id="cb898"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb898-1"><a href="#cb898-1" aria-hidden="true" tabindex="-1"></a><span class="ex">0</span> <span class="pp">*</span> <span class="pp">*</span> <span class="pp">*</span> <span class="pp">*</span> /path/to/rclone bisync /path/to/local/dropbox Dropbox: <span class="at">--check-access</span> <span class="at">--filters-file</span> /home/user/filters.txt <span class="op">&gt;&gt;</span> /path/to/logs/dropbox-run.log <span class="dv">2</span><span class="op">&gt;&amp;</span><span class="dv">1</span></span></code></pre></div>
<h3 id="sharing-an-encrypted-folder-tree-between-hosts">Sharing an
encrypted folder tree between hosts</h3>
<p>bisync can keep a local folder in sync with a cloud service, but what
if you have some highly sensitive files to be synched?</p>
<p>Usage of a cloud service is for exchanging both routine and sensitive
personal files between one's home network, one's personal notebook when
on the road, and with one's work computer. The routine data is not
sensitive. For the sensitive data, configure an rclone <a
href="https://rclone.org/crypt/">crypt remote</a> to point to a
subdirectory within the local disk tree that is bisync'd to Dropbox, and
then set up an bisync for this local crypt directory to a directory
outside of the main sync tree.</p>
<h3 id="linux-server-setup">Linux server setup</h3>
<ul>
<li><code>/path/to/DBoxroot</code> is the root of my local sync tree.
There are numerous subdirectories.</li>
<li><code>/path/to/DBoxroot/crypt</code> is the root subdirectory for
files that are encrypted. This local directory target is setup as an
rclone crypt remote named <code>Dropcrypt:</code>. See <a
href="#rclone-conf-snippet">rclone.conf</a> snippet below.</li>
<li><code>/path/to/my/unencrypted/files</code> is the root of my
sensitive files - not encrypted, not within the tree synched to
Dropbox.</li>
<li>To sync my local unencrypted files with the encrypted Dropbox
versions I manually run
<code>bisync /path/to/my/unencrypted/files DropCrypt:</code>. This step
could be bundled into a script to run before and after the full Dropbox
tree sync in the last step, thus actively keeping the sensitive files in
sync.</li>
<li><code>bisync /path/to/DBoxroot Dropbox:</code> runs periodically via
cron, keeping my full local sync tree in sync with Dropbox.</li>
</ul>
<h3 id="windows-notebook-setup">Windows notebook setup</h3>
<ul>
<li>The Dropbox client runs keeping the local tree
<code>C:\Users\MyLogin\Dropbox</code> always in sync with Dropbox. I
could have used <code>rclone bisync</code> instead.</li>
<li>A separate directory tree at
<code>C:\Users\MyLogin\Documents\DropLocal</code> hosts the tree of
unencrypted files/folders.</li>
<li>To sync my local unencrypted files with the encrypted Dropbox
versions I manually run the following command:
<code>rclone bisync C:\Users\MyLogin\Documents\DropLocal Dropcrypt:</code>.</li>
<li>The Dropbox client then syncs the changes with Dropbox.</li>
</ul>
<h3 id="rclone-conf-snippet">rclone.conf snippet</h3>
<div class="sourceCode" id="cb899"><pre
class="sourceCode ini"><code class="sourceCode ini"><span id="cb899-1"><a href="#cb899-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[Dropbox]</span></span>
<span id="cb899-2"><a href="#cb899-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> dropbox</span></span>
<span id="cb899-3"><a href="#cb899-3" aria-hidden="true" tabindex="-1"></a><span class="dt">...</span></span>
<span id="cb899-4"><a href="#cb899-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb899-5"><a href="#cb899-5" aria-hidden="true" tabindex="-1"></a><span class="kw">[Dropcrypt]</span></span>
<span id="cb899-6"><a href="#cb899-6" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> crypt</span></span>
<span id="cb899-7"><a href="#cb899-7" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> /path/to/DBoxroot/crypt          # on the Linux server</span></span>
<span id="cb899-8"><a href="#cb899-8" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> C:\Users\MyLogin\Dropbox\crypt   # on the Windows notebook</span></span>
<span id="cb899-9"><a href="#cb899-9" aria-hidden="true" tabindex="-1"></a><span class="dt">filename_encryption </span><span class="ot">=</span><span class="st"> standard</span></span>
<span id="cb899-10"><a href="#cb899-10" aria-hidden="true" tabindex="-1"></a><span class="dt">directory_name_encryption </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span>
<span id="cb899-11"><a href="#cb899-11" aria-hidden="true" tabindex="-1"></a><span class="dt">password </span><span class="ot">=</span><span class="st"> ...</span></span>
<span id="cb899-12"><a href="#cb899-12" aria-hidden="true" tabindex="-1"></a><span class="dt">...</span></span></code></pre></div>
<h2 id="testing">Testing</h2>
<p>You should read this section only if you are developing for rclone.
You need to have rclone source code locally to work with bisync
tests.</p>
<p>Bisync has a dedicated test framework implemented in the
<code>bisync_test.go</code> file located in the rclone source tree. The
test suite is based on the <code>go test</code> command. Series of tests
are stored in subdirectories below the <code>cmd/bisync/testdata</code>
directory. Individual tests can be invoked by their directory name, e.g.
<code>go test . -case basic -remote local -remote2 gdrive: -v</code></p>
<p>Tests will make a temporary folder on remote and purge it afterwards.
If during test run there are intermittent errors and rclone retries,
these errors will be captured and flagged as invalid MISCOMPAREs.
Rerunning the test will let it pass. Consider such failures as
noise.</p>
<h3 id="test-command-syntax">Test command syntax</h3>
<div class="sourceCode" id="cb900"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb900-1"><a href="#cb900-1" aria-hidden="true" tabindex="-1"></a><span class="ex">usage:</span> go test ./cmd/bisync <span class="pp">[</span><span class="ss">options...</span><span class="pp">]</span></span>
<span id="cb900-2"><a href="#cb900-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb900-3"><a href="#cb900-3" aria-hidden="true" tabindex="-1"></a><span class="ex">Options:</span></span>
<span id="cb900-4"><a href="#cb900-4" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-case</span> NAME        Name<span class="er">(</span><span class="ex">s</span><span class="kw">)</span> <span class="ex">of</span> the test case<span class="er">(</span><span class="ex">s</span><span class="kw">)</span> <span class="ex">to</span> run. Multiple names should</span>
<span id="cb900-5"><a href="#cb900-5" aria-hidden="true" tabindex="-1"></a>                    <span class="ex">be</span> separated by commas. You can remove the <span class="kw">`</span><span class="ex">test_</span><span class="kw">`</span> prefix</span>
<span id="cb900-6"><a href="#cb900-6" aria-hidden="true" tabindex="-1"></a>                    <span class="ex">and</span> replace <span class="kw">`</span><span class="ex">_</span><span class="kw">`</span> by <span class="kw">`</span><span class="ex">-</span><span class="kw">`</span> in test name for convenience.</span>
<span id="cb900-7"><a href="#cb900-7" aria-hidden="true" tabindex="-1"></a>                    <span class="ex">If</span> not <span class="kw">`</span><span class="ex">all</span><span class="kw">`</span>, the name<span class="er">(</span><span class="ex">s</span><span class="kw">)</span> <span class="ex">should</span> map to a directory under</span>
<span id="cb900-8"><a href="#cb900-8" aria-hidden="true" tabindex="-1"></a>                    <span class="kw">`</span><span class="ex">./cmd/bisync/testdata</span><span class="kw">`</span>.</span>
<span id="cb900-9"><a href="#cb900-9" aria-hidden="true" tabindex="-1"></a>                    <span class="ex">Use</span> <span class="kw">`</span><span class="ex">all</span><span class="kw">`</span> to run all tests <span class="er">(</span><span class="ex">default:</span> all<span class="kw">)</span></span>
<span id="cb900-10"><a href="#cb900-10" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-remote</span> PATH1     <span class="kw">`</span><span class="bu">local</span><span class="kw">`</span> or name of cloud service with <span class="kw">`</span><span class="bu">:</span><span class="kw">`</span> <span class="er">(</span><span class="ex">default:</span> local<span class="kw">)</span></span>
<span id="cb900-11"><a href="#cb900-11" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-remote2</span> PATH2    <span class="kw">`</span><span class="bu">local</span><span class="kw">`</span> or name of cloud service with <span class="kw">`</span><span class="bu">:</span><span class="kw">`</span> <span class="er">(</span><span class="ex">default:</span> local<span class="kw">)</span></span>
<span id="cb900-12"><a href="#cb900-12" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-no-compare</span>       Disable comparing test results with the golden directory</span>
<span id="cb900-13"><a href="#cb900-13" aria-hidden="true" tabindex="-1"></a>                    <span class="kw">(</span><span class="ex">default:</span> compare<span class="kw">)</span></span>
<span id="cb900-14"><a href="#cb900-14" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-no-cleanup</span>       Disable cleanup of Path1 and Path2 testdirs.</span>
<span id="cb900-15"><a href="#cb900-15" aria-hidden="true" tabindex="-1"></a>                    <span class="ex">Useful</span> for troubleshooting. <span class="er">(</span><span class="ex">default:</span> cleanup<span class="kw">)</span></span>
<span id="cb900-16"><a href="#cb900-16" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-golden</span>           Store results in the golden directory <span class="er">(</span><span class="ex">default:</span> false<span class="kw">)</span></span>
<span id="cb900-17"><a href="#cb900-17" aria-hidden="true" tabindex="-1"></a>                    <span class="ex">This</span> flag can be used with multiple tests.</span>
<span id="cb900-18"><a href="#cb900-18" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-debug</span>            Print debug messages</span>
<span id="cb900-19"><a href="#cb900-19" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-stop-at</span> NUM      Stop test after given step number. <span class="er">(</span><span class="ex">default:</span> run to the end<span class="kw">)</span></span>
<span id="cb900-20"><a href="#cb900-20" aria-hidden="true" tabindex="-1"></a>                    <span class="ex">Implies</span> <span class="kw">`</span><span class="ex">-no-compare</span><span class="kw">`</span> and <span class="kw">`</span><span class="ex">-no-cleanup</span><span class="kw">`</span>, if the test really</span>
<span id="cb900-21"><a href="#cb900-21" aria-hidden="true" tabindex="-1"></a>                    <span class="ex">ends</span> prematurely. Only meaningful for a single test case.</span>
<span id="cb900-22"><a href="#cb900-22" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-refresh-times</span>    Force refreshing the target modtime, useful for Dropbox</span>
<span id="cb900-23"><a href="#cb900-23" aria-hidden="true" tabindex="-1"></a>                    <span class="kw">(</span><span class="ex">default:</span> false<span class="kw">)</span></span>
<span id="cb900-24"><a href="#cb900-24" aria-hidden="true" tabindex="-1"></a>  <span class="ex">-verbose</span>          Run tests verbosely</span></code></pre></div>
<p>Note: unlike rclone flags which must be prefixed by double dash
(<code>--</code>), the test command flags can be equally prefixed by a
single <code>-</code> or double dash.</p>
<h3 id="running-tests">Running tests</h3>
<ul>
<li><code>go test . -case basic -remote local -remote2 local</code> runs
the <code>test_basic</code> test case using only the local filesystem,
syncing one local directory with another local directory. Test script
output is to the console, while commands within scenario.txt have their
output sent to the <code>.../workdir/test.log</code> file, which is
finally compared to the golden copy.</li>
<li>The first argument after <code>go test</code> should be a relative
name of the directory containing bisync source code. If you run tests
right from there, the argument will be <code>.</code> (current
directory) as in most examples below. If you run bisync tests from the
rclone source directory, the command should be
<code>go test ./cmd/bisync ...</code>.</li>
<li>The test engine will mangle rclone output to ensure comparability
with golden listings and logs.</li>
<li>Test scenarios are located in <code>./cmd/bisync/testdata</code>.
The test <code>-case</code> argument should match the full name of a
subdirectory under that directory. Every test subdirectory name on disk
must start with <code>test_</code>, this prefix can be omitted on
command line for brevity. Also, underscores in the name can be replaced
by dashes for convenience.</li>
<li><code>go test . -remote local -remote2 local -case all</code> runs
all tests.</li>
<li>Path1 and Path2 may either be the keyword <code>local</code> or may
be names of configured cloud services.
<code>go test . -remote gdrive: -remote2 dropbox: -case basic</code>
will run the test between these two services, without transferring any
files to the local filesystem.</li>
<li>Test run stdout and stderr console output may be directed to a file,
e.g.
<code>go test . -remote gdrive: -remote2 local -case all &gt; runlog.txt 2&gt;&amp;1</code></li>
</ul>
<h3 id="test-execution-flow">Test execution flow</h3>
<ol type="1">
<li>The base setup in the <code>initial</code> directory of the testcase
is applied on the Path1 and Path2 filesystems (via rclone copy the
initial directory to Path1, then rclone sync Path1 to Path2).</li>
<li>The commands in the scenario.txt file are applied, with output
directed to the <code>test.log</code> file in the test working
directory. Typically, the first actual command in the
<code>scenario.txt</code> file is to do a <code>--resync</code>, which
establishes the baseline <code>{...}.path1.lst</code> and
<code>{...}.path2.lst</code> files in the test working directory
(<code>.../workdir/</code> relative to the temporary test directory).
Various commands and listing snapshots are done within the test.</li>
<li>Finally, the contents of the test working directory are compared to
the contents of the testcase's golden directory.</li>
</ol>
<h3 id="notes-about-testing">Notes about testing</h3>
<ul>
<li>Test cases are in individual directories beneath
<code>./cmd/bisync/testdata</code>. A command line reference to a test
is understood to reference a directory beneath <code>testdata</code>.
For example,
<code>go test ./cmd/bisync -case dry-run -remote gdrive: -remote2 local</code>
refers to the test case in
<code>./cmd/bisync/testdata/test_dry_run</code>.</li>
<li>The test working directory is located at <code>.../workdir</code>
relative to a temporary test directory, usually under <code>/tmp</code>
on Linux.</li>
<li>The local test sync tree is created at a temporary directory named
like <code>bisync.XXX</code> under system temporary directory.</li>
<li>The remote test sync tree is located at a temporary directory under
<code>&lt;remote:&gt;/bisync.XXX/</code>.</li>
<li><code>path1</code> and/or <code>path2</code> subdirectories are
created in a temporary directory under the respective local or cloud
test remote.</li>
<li>By default, the Path1 and Path2 test dirs and workdir will be
deleted after each test run. The <code>-no-cleanup</code> flag disables
purging these directories when validating and debugging a given test.
These directories will be flushed before running another test,
independent of the <code>-no-cleanup</code> usage.</li>
<li>You will likely want to add <code>- /testdir/</code> to your normal
bisync <code>--filters-file</code> so that normal syncs do not attempt
to sync the test temporary directories, which may have
<code>RCLONE_TEST</code> miscompares in some testcases which would
otherwise trip the <code>--check-access</code> system. The
<code>--check-access</code> mechanism is hard-coded to ignore
<code>RCLONE_TEST</code> files beneath <code>bisync/testdata</code>, so
the test cases may reside on the synched tree even if there are check
file mismatches in the test tree.</li>
<li>Some Dropbox tests can fail, notably printing the following message:
<code>src and dst identical but can't set mod time without deleting and re-uploading</code>
This is expected and happens due to the way Dropbox handles modification
times. You should use the <code>-refresh-times</code> test flag to make
up for this.</li>
<li>If Dropbox tests hit request limit for you and print error message
<code>too_many_requests/...: Too many requests or write operations.</code>
then follow the <a
href="https://rclone.org/dropbox/#get-your-own-dropbox-app-id">Dropbox
App ID instructions</a>.</li>
</ul>
<h3 id="updating-golden-results">Updating golden results</h3>
<p>Sometimes even a slight change in the bisync source can cause little
changes spread around many log files. Updating them manually would be a
nightmare.</p>
<p>The <code>-golden</code> flag will store the <code>test.log</code>
and <code>*.lst</code> listings from each test case into respective
golden directories. Golden results will automatically contain generic
strings instead of local or cloud paths which means that they should
match when run with a different cloud service.</p>
<p>Your normal workflow might be as follows:</p>
<ol type="1">
<li>Git-clone the rclone sources locally</li>
<li>Modify bisync source and check that it builds</li>
<li>Run the whole test suite
<code>go test ./cmd/bisync -remote local</code></li>
<li>If some tests show log difference, recheck them individually, e.g.:
<code>go test ./cmd/bisync -remote local -case basic</code></li>
<li>If you are convinced with the difference, goldenize all tests at
once: <code>go test ./cmd/bisync -remote local -golden</code></li>
<li>Use word diff:
<code>git diff --word-diff ./cmd/bisync/testdata/</code>. Please note
that normal line-level diff is generally useless here.</li>
<li>Check the difference <em>carefully</em>!</li>
<li>Commit the change (<code>git commit</code>) <em>only</em> if you are
sure. If unsure, save your code changes then wipe the log diffs from
git: <code>git reset [--hard]</code>.</li>
</ol>
<h3 id="structure-of-test-scenarios">Structure of test scenarios</h3>
<ul>
<li><code>&lt;testname&gt;/initial/</code> contains a tree of files that
will be set as the initial condition on both Path1 and Path2
testdirs.</li>
<li><code>&lt;testname&gt;/modfiles/</code> contains files that will be
used to modify the Path1 and/or Path2 filesystems.</li>
<li><code>&lt;testname&gt;/golden/</code> contains the expected content
of the test working directory (<code>workdir</code>) at the completion
of the testcase.</li>
<li><code>&lt;testname&gt;/scenario.txt</code> contains the body of the
test, in the form of various commands to modify files, run bisync, and
snapshot listings. Output from these commands is captured to
<code>.../workdir/test.log</code> for comparison to the golden
files.</li>
</ul>
<h3 id="supported-test-commands">Supported test commands</h3>
<ul>
<li><code>test &lt;some message&gt;</code> Print the line to the console
and to the <code>test.log</code>:
<code>test sync is working correctly with options x, y, z</code></li>
<li><code>copy-listings &lt;prefix&gt;</code> Save a copy of all
<code>.lst</code> listings in the test working directory with the
specified prefix: <code>save-listings exclude-pass-run</code></li>
<li><code>move-listings &lt;prefix&gt;</code> Similar to
<code>copy-listings</code> but removes the source</li>
<li><code>purge-children &lt;dir&gt;</code> This will delete all child
files and purge all child subdirs under given directory but keep the
parent intact. This behavior is important for tests with Google Drive
because removing and re-creating the parent would change its ID.</li>
<li><code>delete-file &lt;file&gt;</code> Delete a single file.</li>
<li><code>delete-glob &lt;dir&gt; &lt;pattern&gt;</code> Delete a group
of files located one level deep in the given directory with names
matching a given glob pattern.</li>
<li><code>touch-glob YYYY-MM-DD &lt;dir&gt; &lt;pattern&gt;</code>
Change modification time on a group of files.</li>
<li><code>touch-copy YYYY-MM-DD &lt;source-file&gt; &lt;dest-dir&gt;</code>
Change file modification time then copy it to destination.</li>
<li><code>copy-file &lt;source-file&gt; &lt;dest-dir&gt;</code> Copy a
single file to given directory.</li>
<li><code>copy-as &lt;source-file&gt; &lt;dest-file&gt;</code> Similar
to above but destination must include both directory and the new file
name at destination.</li>
<li><code>copy-dir &lt;src&gt; &lt;dst&gt;</code> and
<code>sync-dir &lt;src&gt; &lt;dst&gt;</code> Copy/sync a directory.
Equivalent of <code>rclone copy</code> and
<code>rclone sync</code>.</li>
<li><code>list-dirs &lt;dir&gt;</code> Equivalent to
<code>rclone lsf -R --dirs-only &lt;dir&gt;</code></li>
<li><code>bisync [options]</code> Runs bisync against
<code>-remote</code> and <code>-remote2</code>.</li>
</ul>
<h3 id="supported-substitution-terms">Supported substitution terms</h3>
<ul>
<li><code>{testdir/}</code> - the root dir of the testcase</li>
<li><code>{datadir/}</code> - the <code>modfiles</code> dir under the
testcase root</li>
<li><code>{workdir/}</code> - the temporary test working directory</li>
<li><code>{path1/}</code> - the root of the Path1 test directory
tree</li>
<li><code>{path2/}</code> - the root of the Path2 test directory
tree</li>
<li><code>{session}</code> - base name of the test listings</li>
<li><code>{/}</code> - OS-specific path separator</li>
<li><code>{spc}</code>, <code>{tab}</code>, <code>{eol}</code> -
whitespace</li>
<li><code>{chr:HH}</code> - raw byte with given hexadecimal code</li>
</ul>
<p>Substitution results of the terms named like <code>{dir/}</code> will
end with <code>/</code> (or backslash on Windows), so it is not
necessary to include slash in the usage, for example
<code>delete-file {path1/}file1.txt</code>.</p>
<h2 id="benchmarks">Benchmarks</h2>
<p><em>This section is work in progress.</em></p>
<p>Here are a few data points for scale, execution times, and memory
usage.</p>
<p>The first set of data was taken between a local disk to Dropbox. The
<a href="https://speedtest.net">speedtest.net</a> download speed was
~170 Mbps, and upload speed was ~10 Mbps. 500 files (~9.5 MB each) had
been already synched. 50 files were added in a new directory, each ~9.5
MB, ~475 MB total.</p>
<table>
<colgroup>
<col style="width: 33%" />
<col style="width: 50%" />
<col style="width: 16%" />
</colgroup>
<thead>
<tr class="header">
<th>Change</th>
<th>Operations and times</th>
<th>Overall run time</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>500 files synched (nothing to move)</td>
<td>1x listings for Path1 &amp; Path2</td>
<td>1.5 sec</td>
</tr>
<tr class="even">
<td>500 files synched with --check-access</td>
<td>1x listings for Path1 &amp; Path2</td>
<td>1.5 sec</td>
</tr>
<tr class="odd">
<td>50 new files on remote</td>
<td>Queued 50 copies down: 27 sec</td>
<td>29 sec</td>
</tr>
<tr class="even">
<td>Moved local dir</td>
<td>Queued 50 copies up: 410 sec, 50 deletes up: 9 sec</td>
<td>421 sec</td>
</tr>
<tr class="odd">
<td>Moved remote dir</td>
<td>Queued 50 copies down: 31 sec, 50 deletes down: &lt;1 sec</td>
<td>33 sec</td>
</tr>
<tr class="even">
<td>Delete local dir</td>
<td>Queued 50 deletes up: 9 sec</td>
<td>13 sec</td>
</tr>
</tbody>
</table>
<p>This next data is from a user's application. They had ~400GB of data
over 1.96 million files being sync'ed between a Windows local disk and
some remote cloud. The file full path length was on average 35
characters (which factors into load time and RAM required).</p>
<ul>
<li>Loading the prior listing into memory (1.96 million files, listing
file size 140 MB) took ~30 sec and occupied about 1 GB of RAM.</li>
<li>Getting a fresh listing of the local file system (producing the 140
MB output file) took about XXX sec.</li>
<li>Getting a fresh listing of the remote file system (producing the 140
MB output file) took about XXX sec. The network download speed was
measured at XXX Mb/s.</li>
<li>Once the prior and current Path1 and Path2 listings were loaded (a
total of four to be loaded, two at a time), determining the deltas was
pretty quick (a few seconds for this test case), and the transfer time
for any files to be copied was dominated by the network bandwidth.</li>
</ul>
<h2 id="references">References</h2>
<p>rclone's bisync implementation was derived from the <a
href="https://github.com/cjnaz/rclonesync-V2">rclonesync-V2</a> project,
including documentation and test mechanisms, with <a
href="https://github.com/cjnaz"><span class="citation"
data-cites="cjnaz">@cjnaz</span></a>'s full support and
encouragement.</p>
<p><code>rclone bisync</code> is similar in nature to a range of other
projects:</p>
<ul>
<li><a href="https://github.com/bcpierce00/unison">unison</a></li>
<li><a href="https://github.com/syncthing/syncthing">syncthing</a></li>
<li><a
href="https://github.com/cjnaz/rclonesync-V2">cjnaz/rclonesync</a></li>
<li><a
href="https://github.com/ConorWilliams/rsinc">ConorWilliams/rsinc</a></li>
<li><a
href="https://github.com/Jwink3101/syncrclone">jwink3101/syncrclone</a></li>
<li><a
href="https://github.com/DavideRossi/upback">DavideRossi/upback</a></li>
</ul>
<p>Bisync adopts the differential synchronization technique, which is
based on keeping history of changes performed by both synchronizing
sides. See the <em>Dual Shadow Method</em> section in <a
href="https://neil.fraser.name/writing/sync/">Neil Fraser's
article</a>.</p>
<p>Also note a number of academic publications by <a
href="http://www.cis.upenn.edu/%7Ebcpierce/papers/index.shtml#File%20Synchronization">Benjamin
Pierce</a> about <em>Unison</em> and synchronization in general.</p>
<h2 id="changelog">Changelog</h2>
<h3 id="v1.71"><code>v1.71</code></h3>
<ul>
<li><p><code>bisync</code> is now officially released from
beta.</p></li>
<li><p>Fixed an issue causing hash type to be set incorrectly if
<code>path2</code> had slow hashes and <code>--no-slow-hash</code> or
<code>--slow-hash-sync-only</code> was in use.</p></li>
<li><p>Fixed an issue causing errors when running concurrent bisync runs
through the <code>rc</code>.</p></li>
</ul>
<h3 id="v1.69.1"><code>v1.69.1</code></h3>
<ul>
<li>Fixed an issue causing listings to not capture concurrent
modifications under certain conditions</li>
</ul>
<h3 id="v1.68"><code>v1.68</code></h3>
<ul>
<li>Fixed an issue affecting backends that round modtimes to a lower
precision.</li>
</ul>
<h3 id="v1.67"><code>v1.67</code></h3>
<ul>
<li>Added integration tests against all backends.</li>
</ul>
<h3 id="v1.66"><code>v1.66</code></h3>
<ul>
<li><p>Copies and deletes are now handled in one operation instead of
two</p></li>
<li><p><code>--track-renames</code> and <code>--backup-dir</code> are
now supported</p></li>
<li><p>Partial uploads known issue on
<code>local</code>/<code>ftp</code>/<code>sftp</code> has been resolved
(unless using <code>--inplace</code>)</p></li>
<li><p>Final listings are now generated from sync results, to avoid
needing to re-list</p></li>
<li><p>Bisync is now much more resilient to changes that happen during a
bisync run, and far less prone to critical errors / undetected
changes</p></li>
<li><p>Bisync is now capable of rolling a file listing back in cases of
uncertainty, essentially marking the file as needing to be rechecked
next time.</p></li>
<li><p>A few basic terminal colors are now supported, controllable with
<a href="https://rclone.org/docs/#color"><code>--color</code></a>
(<code>AUTO</code>|<code>NEVER</code>|<code>ALWAYS</code>)</p></li>
<li><p>Initial listing snapshots of Path1 and Path2 are now generated
concurrently, using the same "march" infrastructure as
<code>check</code> and <code>sync</code>, for performance improvements
and less <a
href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=4.%20Listings%20should%20alternate%20between%20paths%20to%20minimize%20errors">risk
of error</a>.</p></li>
<li><p>Fixed handling of unicode normalization and case insensitivity,
support for <a
href="https://rclone.org/docs/#fix-case"><code>--fix-case</code></a>, <a
href="/docs/#ignore-case-sync"><code>--ignore-case-sync</code></a>, <a
href="https://rclone.org/docs/#no-unicode-normalization"><code>--no-unicode-normalization</code></a></p></li>
<li><p><code>--resync</code> is now much more efficient (especially for
users of <code>--create-empty-src-dirs</code>)</p></li>
<li><p>Google Docs (and other files of unknown size) are now supported
(with the same options as in <code>sync</code>)</p></li>
<li><p>Equality checks before a sync conflict rename now fall back to
<code>cryptcheck</code> (when possible) or <code>--download</code>,
instead of of <code>--size-only</code>, when <code>check</code> is not
available.</p></li>
<li><p>Bisync no longer fails to find the correct listing file when
configs are overridden with backend-specific flags.</p></li>
<li><p>Bisync now fully supports comparing based on any combination of
size, modtime, and checksum, lifting the prior restriction on backends
without modtime support.</p></li>
<li><p>Bisync now supports a "Graceful Shutdown" mode to cleanly cancel
a run early without requiring <code>--resync</code>.</p></li>
<li><p>New <code>--recover</code> flag allows robust recovery in the
event of interruptions, without requiring
<code>--resync</code>.</p></li>
<li><p>A new <code>--max-lock</code> setting allows lock files to
automatically renew and expire, for better automatic recovery when a run
is interrupted.</p></li>
<li><p>Bisync now supports auto-resolving sync conflicts and customizing
rename behavior with new <a
href="#conflict-resolve"><code>--conflict-resolve</code></a>, <a
href="#conflict-loser"><code>--conflict-loser</code></a>, and <a
href="#conflict-suffix"><code>--conflict-suffix</code></a>
flags.</p></li>
<li><p>A new <a href="#resync-mode"><code>--resync-mode</code></a> flag
allows more control over which version of a file gets kept during a
<code>--resync</code>.</p></li>
<li><p>Bisync now supports <a
href="https://rclone.org/docs/#retries-int"><code>--retries</code></a>
and <a href="/docs/#retries-sleep-time"><code>--retries-sleep</code></a>
(when <a href="#resilient"><code>--resilient</code></a> is
set.)</p></li>
</ul>
<h3 id="v1.64"><code>v1.64</code></h3>
<ul>
<li><p>Fixed an <a
href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=1.%20Dry%20runs%20are%20not%20completely%20dry">issue</a>
causing dry runs to inadvertently commit filter changes</p></li>
<li><p>Fixed an <a
href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=2.%20%2D%2Dresync%20deletes%20data%2C%20contrary%20to%20docs">issue</a>
causing <code>--resync</code> to erroneously delete empty folders and
duplicate files unique to Path2</p></li>
<li><p><code>--check-access</code> is now enforced during
<code>--resync</code>, preventing data loss in <a
href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=%2D%2Dcheck%2Daccess%20doesn%27t%20always%20fail%20when%20it%20should">certain
user error scenarios</a></p></li>
<li><p>Fixed an <a
href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=5.%20Bisync%20reads%20files%20in%20excluded%20directories%20during%20delete%20operations">issue</a>
causing bisync to consider more files than necessary due to overbroad
filters during delete operations</p></li>
<li><p><a
href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=1.%20Identical%20files%20should%20be%20left%20alone%2C%20even%20if%20new/newer/changed%20on%20both%20sides">Improved
detection of false positive change conflicts</a> (identical files are
now left alone instead of renamed)</p></li>
<li><p>Added <a
href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=3.%20Bisync%20should%20create/delete%20empty%20directories%20as%20sync%20does%2C%20when%20%2D%2Dcreate%2Dempty%2Dsrc%2Ddirs%20is%20passed">support
for <code>--create-empty-src-dirs</code></a></p></li>
<li><p>Added experimental <code>--resilient</code> mode to allow <a
href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=2.%20Bisync%20should%20be%20more%20resilient%20to%20self%2Dcorrectable%20errors">recovery
from self-correctable errors</a></p></li>
<li><p>Added <a
href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=6.%20%2D%2Dignore%2Dchecksum%20should%20be%20split%20into%20two%20flags%20for%20separate%20purposes">new
<code>--ignore-listing-checksum</code> flag</a> to distinguish from
<code>--ignore-checksum</code></p></li>
<li><p><a
href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=6.%20Deletes%20take%20several%20times%20longer%20than%20copies">Performance
improvements</a> for large remotes</p></li>
<li><p>Documentation and testing improvements</p></li>
</ul>
<h1 id="release-signing">Release signing</h1>
<p>The hashes of the binary artefacts of the rclone release are signed
with a public PGP/GPG key. This can be verified manually as described
below.</p>
<p>The same mechanism is also used by <a
href="https://rclone.org/commands/rclone_selfupdate/">rclone
selfupdate</a> to verify that the release has not been tampered with
before the new update is installed. This checks the SHA256 hash and the
signature with a public key compiled into the rclone binary.</p>
<h2 id="release-signing-key">Release signing key</h2>
<p>You may obtain the release signing key from:</p>
<ul>
<li>From <a href="/KEYS">KEYS</a> on this website - this file contains
all past signing keys also.</li>
<li>The git repository hosted on GitHub - <a
href="https://github.com/rclone/rclone/blob/master/docs/content/KEYS"
class="uri">https://github.com/rclone/rclone/blob/master/docs/content/KEYS</a></li>
<li><code>gpg --keyserver hkps://keys.openpgp.org --search nick@craig-wood.com</code></li>
<li><code>gpg --keyserver hkps://keyserver.ubuntu.com --search nick@craig-wood.com</code></li>
<li><a href="https://www.craig-wood.com/nick/pub/pgp-key.txt"
class="uri">https://www.craig-wood.com/nick/pub/pgp-key.txt</a></li>
</ul>
<p>After importing the key, verify that the fingerprint of one of the
keys matches: <code>FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA</code> ads
this key is used for signing.</p>
<p>We recommend that you cross-check the fingerprint shown above through
the domains listed below. By cross-checking the integrity of the
fingerprint across multiple domains you can be confident that you
obtained the correct key.</p>
<ul>
<li>The <a
href="https://github.com/rclone/rclone/blob/master/docs/content/release_signing.md">source
for this page on GitHub</a>.</li>
<li>Through DNS <code>dig key.rclone.org txt</code></li>
</ul>
<p>If you find anything that doesn't not match, please contact the
developers at once.</p>
<h2 id="how-to-verify-the-release">How to verify the release</h2>
<p>In the release directory you will see the release files and some
files called <code>MD5SUMS</code>, <code>SHA1SUMS</code> and
<code>SHA256SUMS</code>.</p>
<div class="sourceCode" id="cb901"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb901-1"><a href="#cb901-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone lsf <span class="at">--http-url</span> https://downloads.rclone.org/v1.63.1 :http:</span>
<span id="cb901-2"><a href="#cb901-2" aria-hidden="true" tabindex="-1"></a><span class="ex">MD5SUMS</span></span>
<span id="cb901-3"><a href="#cb901-3" aria-hidden="true" tabindex="-1"></a><span class="ex">SHA1SUMS</span></span>
<span id="cb901-4"><a href="#cb901-4" aria-hidden="true" tabindex="-1"></a><span class="ex">SHA256SUMS</span></span>
<span id="cb901-5"><a href="#cb901-5" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone-v1.63.1-freebsd-386.zip</span></span>
<span id="cb901-6"><a href="#cb901-6" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone-v1.63.1-freebsd-amd64.zip</span></span>
<span id="cb901-7"><a href="#cb901-7" aria-hidden="true" tabindex="-1"></a><span class="ex">...</span></span>
<span id="cb901-8"><a href="#cb901-8" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone-v1.63.1-windows-arm64.zip</span></span>
<span id="cb901-9"><a href="#cb901-9" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone-v1.63.1.tar.gz</span></span>
<span id="cb901-10"><a href="#cb901-10" aria-hidden="true" tabindex="-1"></a><span class="ex">version.txt</span></span></code></pre></div>
<p>The <code>MD5SUMS</code>, <code>SHA1SUMS</code> and
<code>SHA256SUMS</code> contain hashes of the binary files in the
release directory along with a signature.</p>
<p>For example:</p>
<div class="sourceCode" id="cb902"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb902-1"><a href="#cb902-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone cat <span class="at">--http-url</span> https://downloads.rclone.org/v1.63.1 :http:SHA256SUMS</span>
<span id="cb902-2"><a href="#cb902-2" aria-hidden="true" tabindex="-1"></a><span class="ex">-----BEGIN</span> PGP SIGNED MESSAGE-----</span>
<span id="cb902-3"><a href="#cb902-3" aria-hidden="true" tabindex="-1"></a><span class="ex">Hash:</span> SHA1</span>
<span id="cb902-4"><a href="#cb902-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb902-5"><a href="#cb902-5" aria-hidden="true" tabindex="-1"></a><span class="ex">f6d1b2d7477475ce681bdce8cb56f7870f174cb6b2a9ac5d7b3764296ea4a113</span>  rclone-v1.63.1-freebsd-386.zip</span>
<span id="cb902-6"><a href="#cb902-6" aria-hidden="true" tabindex="-1"></a><span class="ex">7266febec1f01a25d6575de51c44ddf749071a4950a6384e4164954dff7ac37e</span>  rclone-v1.63.1-freebsd-amd64.zip</span>
<span id="cb902-7"><a href="#cb902-7" aria-hidden="true" tabindex="-1"></a><span class="ex">...</span></span>
<span id="cb902-8"><a href="#cb902-8" aria-hidden="true" tabindex="-1"></a><span class="ex">66ca083757fb22198309b73879831ed2b42309892394bf193ff95c75dff69c73</span>  rclone-v1.63.1-windows-amd64.zip</span>
<span id="cb902-9"><a href="#cb902-9" aria-hidden="true" tabindex="-1"></a><span class="ex">bbb47c16882b6c5f2e8c1b04229378e28f68734c613321ef0ea2263760f74cd0</span>  rclone-v1.63.1-windows-arm64.zip</span>
<span id="cb902-10"><a href="#cb902-10" aria-hidden="true" tabindex="-1"></a><span class="ex">-----BEGIN</span> PGP SIGNATURE-----</span>
<span id="cb902-11"><a href="#cb902-11" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb902-12"><a href="#cb902-12" aria-hidden="true" tabindex="-1"></a><span class="ex">iF0EARECAB0WIQT79zfs6firGGBL0qyTk14C/ztU+gUCZLVKJQAKCRCTk14C/ztU</span></span>
<span id="cb902-13"><a href="#cb902-13" aria-hidden="true" tabindex="-1"></a><span class="ex">+pZuAJ0XJ+QWLP/3jCtkmgcgc4KAwd/rrwCcCRZQ7E+oye1FPY46HOVzCFU3L7g=</span></span>
<span id="cb902-14"><a href="#cb902-14" aria-hidden="true" tabindex="-1"></a><span class="ex">=8qrL</span></span>
<span id="cb902-15"><a href="#cb902-15" aria-hidden="true" tabindex="-1"></a><span class="ex">-----END</span> PGP SIGNATURE-----</span></code></pre></div>
<h3 id="download-the-files">Download the files</h3>
<p>The first step is to download the binary and SUMs file and verify
that the SUMs you have downloaded match. Here we download
<code>rclone-v1.63.1-windows-amd64.zip</code> - choose the binary (or
binaries) appropriate to your architecture. We've also chosen the
<code>SHA256SUMS</code> as these are the most secure. You could verify
the other types of hash also for extra security.
<code>rclone selfupdate</code> verifies just the
<code>SHA256SUMS</code>.</p>
<div class="sourceCode" id="cb903"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb903-1"><a href="#cb903-1" aria-hidden="true" tabindex="-1"></a><span class="fu">mkdir</span> /tmp/check</span>
<span id="cb903-2"><a href="#cb903-2" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> /tmp/check</span>
<span id="cb903-3"><a href="#cb903-3" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="at">--http-url</span> https://downloads.rclone.org/v1.63.1 :http:SHA256SUMS .</span>
<span id="cb903-4"><a href="#cb903-4" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="at">--http-url</span> https://downloads.rclone.org/v1.63.1 :http:rclone-v1.63.1-windows-amd64.zip .</span></code></pre></div>
<h3 id="verify-the-signatures">Verify the signatures</h3>
<p>First verify the signatures on the SHA256 file.</p>
<p>Import the key. See above for ways to verify this key is correct.</p>
<div class="sourceCode" id="cb904"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb904-1"><a href="#cb904-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> gpg <span class="at">--keyserver</span> keyserver.ubuntu.com <span class="at">--receive-keys</span> FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA</span>
<span id="cb904-2"><a href="#cb904-2" aria-hidden="true" tabindex="-1"></a><span class="ex">gpg:</span> key 93935E02FF3B54FA: public key <span class="st">&quot;Nick Craig-Wood &lt;nick@craig-wood.com&gt;&quot;</span> imported</span>
<span id="cb904-3"><a href="#cb904-3" aria-hidden="true" tabindex="-1"></a><span class="ex">gpg:</span> Total number processed: 1</span>
<span id="cb904-4"><a href="#cb904-4" aria-hidden="true" tabindex="-1"></a><span class="ex">gpg:</span>               imported: 1</span></code></pre></div>
<p>Then check the signature:</p>
<div class="sourceCode" id="cb905"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb905-1"><a href="#cb905-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> gpg <span class="at">--verify</span> SHA256SUMS </span>
<span id="cb905-2"><a href="#cb905-2" aria-hidden="true" tabindex="-1"></a><span class="ex">gpg:</span> Signature made Mon 17 Jul 2023 15:03:17 BST</span>
<span id="cb905-3"><a href="#cb905-3" aria-hidden="true" tabindex="-1"></a><span class="ex">gpg:</span>                using DSA key FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA</span>
<span id="cb905-4"><a href="#cb905-4" aria-hidden="true" tabindex="-1"></a><span class="ex">gpg:</span> Good signature from <span class="st">&quot;Nick Craig-Wood &lt;nick@craig-wood.com&gt;&quot;</span> <span class="pp">[</span><span class="ss">ultimate</span><span class="pp">]</span></span></code></pre></div>
<p>Verify the signature was good and is using the fingerprint shown
above.</p>
<p>Repeat for <code>MD5SUMS</code> and <code>SHA1SUMS</code> if
desired.</p>
<h3 id="verify-the-hashes">Verify the hashes</h3>
<p>Now that we know the signatures on the hashes are OK we can verify
the binaries match the hashes, completing the verification.</p>
<div class="sourceCode" id="cb906"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb906-1"><a href="#cb906-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> sha256sum <span class="at">-c</span> SHA256SUMS <span class="dv">2</span><span class="op">&gt;&amp;</span><span class="dv">1</span> <span class="kw">|</span> <span class="fu">grep</span> OK</span>
<span id="cb906-2"><a href="#cb906-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone-v1.63.1-windows-amd64.zip:</span> OK</span></code></pre></div>
<p>Or do the check with rclone</p>
<div class="sourceCode" id="cb907"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb907-1"><a href="#cb907-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone hashsum sha256 <span class="at">-C</span> SHA256SUMS rclone-v1.63.1-windows-amd64.zip </span>
<span id="cb907-2"><a href="#cb907-2" aria-hidden="true" tabindex="-1"></a><span class="ex">2023/09/11</span> 10:53:58 NOTICE: SHA256SUMS: improperly formatted checksum line 0</span>
<span id="cb907-3"><a href="#cb907-3" aria-hidden="true" tabindex="-1"></a><span class="ex">2023/09/11</span> 10:53:58 NOTICE: SHA256SUMS: improperly formatted checksum line 1</span>
<span id="cb907-4"><a href="#cb907-4" aria-hidden="true" tabindex="-1"></a><span class="ex">2023/09/11</span> 10:53:58 NOTICE: SHA256SUMS: improperly formatted checksum line 49</span>
<span id="cb907-5"><a href="#cb907-5" aria-hidden="true" tabindex="-1"></a><span class="ex">2023/09/11</span> 10:53:58 NOTICE: SHA256SUMS: 4 warning<span class="er">(</span><span class="ex">s</span><span class="kw">)</span> <span class="ex">suppressed...</span></span>
<span id="cb907-6"><a href="#cb907-6" aria-hidden="true" tabindex="-1"></a><span class="ex">=</span> rclone-v1.63.1-windows-amd64.zip</span>
<span id="cb907-7"><a href="#cb907-7" aria-hidden="true" tabindex="-1"></a><span class="ex">2023/09/11</span> 10:53:58 NOTICE: Local file system at /tmp/check: 0 differences found</span>
<span id="cb907-8"><a href="#cb907-8" aria-hidden="true" tabindex="-1"></a><span class="ex">2023/09/11</span> 10:53:58 NOTICE: Local file system at /tmp/check: 1 matching files</span></code></pre></div>
<h3 id="verify-signatures-and-hashes-together">Verify signatures and
hashes together</h3>
<p>You can verify the signatures and hashes in one command line like
this:</p>
<div class="sourceCode" id="cb908"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb908-1"><a href="#cb908-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> h=<span class="va">$(</span><span class="ex">gpg</span> <span class="at">--decrypt</span> SHA256SUMS<span class="va">)</span> <span class="kw">&amp;&amp;</span> <span class="bu">echo</span> <span class="st">&quot;</span><span class="va">$h</span><span class="st">&quot;</span> <span class="kw">|</span> <span class="fu">sha256sum</span> <span class="at">-</span> <span class="at">-c</span> <span class="at">--ignore-missing</span></span>
<span id="cb908-2"><a href="#cb908-2" aria-hidden="true" tabindex="-1"></a><span class="ex">gpg:</span> Signature made Mon 17 Jul 2023 15:03:17 BST</span>
<span id="cb908-3"><a href="#cb908-3" aria-hidden="true" tabindex="-1"></a><span class="ex">gpg:</span>                using DSA key FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA</span>
<span id="cb908-4"><a href="#cb908-4" aria-hidden="true" tabindex="-1"></a><span class="ex">gpg:</span> Good signature from <span class="st">&quot;Nick Craig-Wood &lt;nick@craig-wood.com&gt;&quot;</span> <span class="pp">[</span><span class="ss">ultimate</span><span class="pp">]</span></span>
<span id="cb908-5"><a href="#cb908-5" aria-hidden="true" tabindex="-1"></a><span class="ex">gpg:</span>                 aka <span class="st">&quot;Nick Craig-Wood &lt;nick@memset.com&gt;&quot;</span> <span class="pp">[</span><span class="ss">unknown</span><span class="pp">]</span></span>
<span id="cb908-6"><a href="#cb908-6" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone-v1.63.1-windows-amd64.zip:</span> OK</span></code></pre></div>
<h1 id="fichier">1Fichier</h1>
<p>This is a backend for the <a href="https://1fichier.com">1fichier</a>
cloud storage service. Note that a Premium subscription is required to
use the API.</p>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required, e.g.
<code>remote:directory/subdirectory</code>.</p>
<h2 id="configuration">Configuration</h2>
<p>The initial setup for 1Fichier involves getting the API key from the
website which you need to do in your browser.</p>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<div class="sourceCode" id="cb909"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb909-1"><a href="#cb909-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process:</p>
<pre class="text"><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / 1Fichier
   \ &quot;fichier&quot;
[snip]
Storage&gt; fichier
** See help for fichier backend at: https://rclone.org/fichier/ **

Your API Key, get it from https://1fichier.com/console/params.pl
Enter a string value. Press Enter for the default (&quot;&quot;).
api_key&gt; example_key

Edit advanced config? (y/n)
y) Yes
n) No
y/n&gt; 
Remote config
Configuration complete.
Options:
- type: fichier
- api_key: example_key
Keep this &quot;remote&quot; remote?
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your 1Fichier account</p>
<div class="sourceCode" id="cb911"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb911-1"><a href="#cb911-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsd remote:</span></code></pre></div>
<p>List all the files in your 1Fichier account</p>
<div class="sourceCode" id="cb912"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb912-1"><a href="#cb912-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> ls remote:</span></code></pre></div>
<p>To copy a local directory to a 1Fichier directory called backup</p>
<div class="sourceCode" id="cb913"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb913-1"><a href="#cb913-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy /home/source remote:backup</span></code></pre></div>
<h3 id="modification-times-and-hashes">Modification times and
hashes</h3>
<p>1Fichier does not support modification times. It supports the
Whirlpool hash algorithm.</p>
<h3 id="duplicated-files">Duplicated files</h3>
<p>1Fichier can have two files with exactly the same name and path
(unlike a normal file system).</p>
<p>Duplicated files cause problems with the syncing and you will see
messages in the log about duplicates.</p>
<h3 id="restricted-filename-characters">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
restricted characters set</a> the following characters are also
replaced:</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
<tr class="even">
<td>&lt;</td>
<td style="text-align: center;">0x3C</td>
<td style="text-align: center;">＜</td>
</tr>
<tr class="odd">
<td>&gt;</td>
<td style="text-align: center;">0x3E</td>
<td style="text-align: center;">＞</td>
</tr>
<tr class="even">
<td>"</td>
<td style="text-align: center;">0x22</td>
<td style="text-align: center;">＂</td>
</tr>
<tr class="odd">
<td>$</td>
<td style="text-align: center;">0x24</td>
<td style="text-align: center;">＄</td>
</tr>
<tr class="even">
<td>`</td>
<td style="text-align: center;">0x60</td>
<td style="text-align: center;">｀</td>
</tr>
<tr class="odd">
<td>'</td>
<td style="text-align: center;">0x27</td>
<td style="text-align: center;">＇</td>
</tr>
</tbody>
</table>
<p>File names can also not start or end with the following characters.
These only get replaced if they are the first or last character in the
name:</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>SP</td>
<td style="text-align: center;">0x20</td>
<td style="text-align: center;">␠</td>
</tr>
</tbody>
</table>
<p>Invalid UTF-8 bytes will also be <a
href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they
can't be used in JSON strings.</p>
<h3 id="standard-options">Standard options</h3>
<p>Here are the Standard options specific to fichier (1Fichier).</p>
<h4 id="fichier-api-key">--fichier-api-key</h4>
<p>Your API Key, get it from https://1fichier.com/console/params.pl.</p>
<p>Properties:</p>
<ul>
<li>Config: api_key</li>
<li>Env Var: RCLONE_FICHIER_API_KEY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options">Advanced options</h3>
<p>Here are the Advanced options specific to fichier (1Fichier).</p>
<h4 id="fichier-shared-folder">--fichier-shared-folder</h4>
<p>If you want to download a shared folder, add this parameter.</p>
<p>Properties:</p>
<ul>
<li>Config: shared_folder</li>
<li>Env Var: RCLONE_FICHIER_SHARED_FOLDER</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="fichier-file-password">--fichier-file-password</h4>
<p>If you want to download a shared file that is password protected, add
this parameter.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: file_password</li>
<li>Env Var: RCLONE_FICHIER_FILE_PASSWORD</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="fichier-folder-password">--fichier-folder-password</h4>
<p>If you want to list the files in a shared folder that is password
protected, add this parameter.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: folder_password</li>
<li>Env Var: RCLONE_FICHIER_FOLDER_PASSWORD</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="fichier-cdn">--fichier-cdn</h4>
<p>Set if you wish to use CDN download links.</p>
<p>Properties:</p>
<ul>
<li>Config: cdn</li>
<li>Env Var: RCLONE_FICHIER_CDN</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="fichier-encoding">--fichier-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_FICHIER_ENCODING</li>
<li>Type: Encoding</li>
<li>Default:
Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot</li>
</ul>
<h4 id="fichier-description">--fichier-description</h4>
<p>Description of the remote.</p>
<p>Properties:</p>
<ul>
<li>Config: description</li>
<li>Env Var: RCLONE_FICHIER_DESCRIPTION</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h2 id="limitations-5">Limitations</h2>
<p><code>rclone about</code> is not supported by the 1Fichier backend.
Backends without this capability cannot determine free space for an
rclone mount or use policy <code>mfs</code> (most free space) as a
member of an rclone union remote.</p>
<p>See <a href="https://rclone.org/overview/#optional-features">List of
backends that do not support rclone about</a> and <a
href="https://rclone.org/commands/rclone_about/">rclone about</a></p>
<h1 id="alias">Alias</h1>
<p>The <code>alias</code> remote provides a new name for another
remote.</p>
<p>Paths may be as deep as required or a local path, e.g.
<code>remote:directory/subdirectory</code> or
<code>/directory/subdirectory</code>.</p>
<p>During the initial setup with <code>rclone config</code> you will
specify the target remote. The target remote can either be a local path
or another remote.</p>
<p>Subfolders can be used in target remote. Assume an alias remote named
<code>backup</code> with the target <code>mydrive:private/backup</code>.
Invoking <code>rclone mkdir backup:desktop</code> is exactly the same as
invoking <code>rclone mkdir mydrive:private/backup/desktop</code>.</p>
<p>There will be no special handling of paths containing <code>..</code>
segments. Invoking <code>rclone mkdir backup:../desktop</code> is
exactly the same as invoking
<code>rclone mkdir mydrive:private/backup/../desktop</code>. The empty
path is not allowed as a remote. To alias the current directory use
<code>.</code> instead.</p>
<p>The target remote can also be a <a
href="https://rclone.org/docs/#connection-strings">connection
string</a>. This can be used to modify the config of a remote for
different uses, e.g. the alias <code>myDriveTrash</code> with the target
remote <code>myDrive,trashed_only:</code> can be used to only show the
trashed files in <code>myDrive</code>.</p>
<h2 id="configuration-1">Configuration</h2>
<p>Here is an example of how to make an alias called <code>remote</code>
for local folder. First run:</p>
<div class="sourceCode" id="cb914"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb914-1"><a href="#cb914-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process:</p>
<pre class="text"><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Alias for an existing remote
   \ &quot;alias&quot;
[snip]
Storage&gt; alias
Remote or path to alias.
Can be &quot;myremote:path/to/dir&quot;, &quot;myremote:bucket&quot;, &quot;myremote:&quot; or &quot;/local/path&quot;.
remote&gt; /mnt/storage/backup
Remote config
Configuration complete.
Options:
- type: alias
- remote: /mnt/storage/backup
Keep this &quot;remote&quot; remote?
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y
Current remotes:

Name                 Type
====                 ====
remote               alias

e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; q</code></pre>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level in <code>/mnt/storage/backup</code></p>
<div class="sourceCode" id="cb916"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb916-1"><a href="#cb916-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsd remote:</span></code></pre></div>
<p>List all the files in <code>/mnt/storage/backup</code></p>
<div class="sourceCode" id="cb917"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb917-1"><a href="#cb917-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> ls remote:</span></code></pre></div>
<p>Copy another local directory to the alias directory called source</p>
<div class="sourceCode" id="cb918"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb918-1"><a href="#cb918-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy /home/source remote:source</span></code></pre></div>
<h3 id="standard-options-1">Standard options</h3>
<p>Here are the Standard options specific to alias (Alias for an
existing remote).</p>
<h4 id="alias-remote">--alias-remote</h4>
<p>Remote or path to alias.</p>
<p>Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or
"/local/path".</p>
<p>Properties:</p>
<ul>
<li>Config: remote</li>
<li>Env Var: RCLONE_ALIAS_REMOTE</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h3 id="advanced-options-1">Advanced options</h3>
<p>Here are the Advanced options specific to alias (Alias for an
existing remote).</p>
<h4 id="alias-description">--alias-description</h4>
<p>Description of the remote.</p>
<p>Properties:</p>
<ul>
<li>Config: description</li>
<li>Env Var: RCLONE_ALIAS_DESCRIPTION</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h1 id="amazon-s3-storage-providers">Amazon S3 Storage Providers</h1>
<p>The S3 backend can be used with a number of different providers:</p>
<!-- markdownlint-capture -->
<!-- markdownlint-disable line-length no-bare-urls -->
<ul>
<li>AWS S3</li>
<li>Alibaba Cloud (Aliyun) Object Storage System (OSS)</li>
<li>Ceph</li>
<li>China Mobile Ecloud Elastic Object Storage (EOS)</li>
<li>Cloudflare R2</li>
<li>Arvan Cloud Object Storage (AOS)</li>
<li>DigitalOcean Spaces</li>
<li>Dreamhost</li>
<li>Exaba</li>
<li>GCS</li>
<li>Huawei OBS</li>
<li>IBM COS S3</li>
<li>IDrive e2</li>
<li>IONOS Cloud</li>
<li>Leviia Object Storage</li>
<li>Liara Object Storage</li>
<li>Linode Object Storage</li>
<li>Magalu Object Storage</li>
<li>MEGA S4 Object Storage</li>
<li>Minio</li>
<li>Outscale</li>
<li>OVHcloud</li>
<li>Petabox</li>
<li>Pure Storage FlashBlade</li>
<li>Qiniu Cloud Object Storage (Kodo)</li>
<li>RackCorp Object Storage</li>
<li>Rclone Serve S3</li>
<li>Scaleway</li>
<li>Seagate Lyve Cloud</li>
<li>SeaweedFS</li>
<li>Selectel</li>
<li>StackPath</li>
<li>Storj</li>
<li>Synology C2 Object Storage</li>
<li>Tencent Cloud Object Storage (COS)</li>
<li>Wasabi</li>
<li>Zata</li>
</ul>
<!-- markdownlint-restore -->
<p>Paths are specified as <code>remote:bucket</code> (or
<code>remote:</code> for the <code>lsd</code> command.) You may put
subdirectories in too, e.g. <code>remote:bucket/path/to/dir</code>.</p>
<p>Once you have made a remote (see the provider specific section above)
you can use it like this:</p>
<p>See all buckets</p>
<div class="sourceCode" id="cb919"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb919-1"><a href="#cb919-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsd remote:</span></code></pre></div>
<p>Make a new bucket</p>
<div class="sourceCode" id="cb920"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb920-1"><a href="#cb920-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mkdir remote:bucket</span></code></pre></div>
<p>List the contents of a bucket</p>
<div class="sourceCode" id="cb921"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb921-1"><a href="#cb921-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> ls remote:bucket</span></code></pre></div>
<p>Sync <code>/home/local/directory</code> to the remote bucket,
deleting any excess files in the bucket.</p>
<div class="sourceCode" id="cb922"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb922-1"><a href="#cb922-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--interactive</span> /home/local/directory remote:bucket</span></code></pre></div>
<h2 id="configuration-2">Configuration</h2>
<p>Here is an example of making an s3 configuration for the AWS S3
provider. Most applies to the other providers as well, any differences
are described <a href="#providers">below</a>.</p>
<p>First run</p>
<div class="sourceCode" id="cb923"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb923-1"><a href="#cb923-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ &quot;s3&quot;
[snip]
Storage&gt; s3
Choose your S3 provider.
Choose a number from below, or type in your own value
 1 / Amazon Web Services (AWS) S3
   \ &quot;AWS&quot;
 2 / Ceph Object Storage
   \ &quot;Ceph&quot;
 3 / DigitalOcean Spaces
   \ &quot;DigitalOcean&quot;
 4 / Dreamhost DreamObjects
   \ &quot;Dreamhost&quot;
 5 / IBM COS S3
   \ &quot;IBMCOS&quot;
 6 / Minio Object Storage
   \ &quot;Minio&quot;
 7 / Wasabi Object Storage
   \ &quot;Wasabi&quot;
 8 / Any other S3 compatible provider
   \ &quot;Other&quot;
provider&gt; 1
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID - leave blank for anonymous access or runtime credentials.
access_key_id&gt; XXX
AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
secret_access_key&gt; YYY
Region to connect to.
Choose a number from below, or type in your own value
   / The default endpoint - a good choice if you are unsure.
 1 | US Region, Northern Virginia, or Pacific Northwest.
   | Leave location constraint empty.
   \ &quot;us-east-1&quot;
   / US East (Ohio) Region
 2 | Needs location constraint us-east-2.
   \ &quot;us-east-2&quot;
   / US West (Oregon) Region
 3 | Needs location constraint us-west-2.
   \ &quot;us-west-2&quot;
   / US West (Northern California) Region
 4 | Needs location constraint us-west-1.
   \ &quot;us-west-1&quot;
   / Canada (Central) Region
 5 | Needs location constraint ca-central-1.
   \ &quot;ca-central-1&quot;
   / EU (Ireland) Region
 6 | Needs location constraint EU or eu-west-1.
   \ &quot;eu-west-1&quot;
   / EU (London) Region
 7 | Needs location constraint eu-west-2.
   \ &quot;eu-west-2&quot;
   / EU (Frankfurt) Region
 8 | Needs location constraint eu-central-1.
   \ &quot;eu-central-1&quot;
   / Asia Pacific (Singapore) Region
 9 | Needs location constraint ap-southeast-1.
   \ &quot;ap-southeast-1&quot;
   / Asia Pacific (Sydney) Region
10 | Needs location constraint ap-southeast-2.
   \ &quot;ap-southeast-2&quot;
   / Asia Pacific (Tokyo) Region
11 | Needs location constraint ap-northeast-1.
   \ &quot;ap-northeast-1&quot;
   / Asia Pacific (Seoul)
12 | Needs location constraint ap-northeast-2.
   \ &quot;ap-northeast-2&quot;
   / Asia Pacific (Mumbai)
13 | Needs location constraint ap-south-1.
   \ &quot;ap-south-1&quot;
   / Asia Pacific (Hong Kong) Region
14 | Needs location constraint ap-east-1.
   \ &quot;ap-east-1&quot;
   / South America (Sao Paulo) Region
15 | Needs location constraint sa-east-1.
   \ &quot;sa-east-1&quot;
region&gt; 1
Endpoint for S3 API.
Leave blank if using AWS to use the default endpoint for the region.
endpoint&gt;
Location constraint - must be set to match the Region. Used when creating buckets only.
Choose a number from below, or type in your own value
 1 / Empty for US Region, Northern Virginia, or Pacific Northwest.
   \ &quot;&quot;
 2 / US East (Ohio) Region.
   \ &quot;us-east-2&quot;
 3 / US West (Oregon) Region.
   \ &quot;us-west-2&quot;
 4 / US West (Northern California) Region.
   \ &quot;us-west-1&quot;
 5 / Canada (Central) Region.
   \ &quot;ca-central-1&quot;
 6 / EU (Ireland) Region.
   \ &quot;eu-west-1&quot;
 7 / EU (London) Region.
   \ &quot;eu-west-2&quot;
 8 / EU Region.
   \ &quot;EU&quot;
 9 / Asia Pacific (Singapore) Region.
   \ &quot;ap-southeast-1&quot;
10 / Asia Pacific (Sydney) Region.
   \ &quot;ap-southeast-2&quot;
11 / Asia Pacific (Tokyo) Region.
   \ &quot;ap-northeast-1&quot;
12 / Asia Pacific (Seoul)
   \ &quot;ap-northeast-2&quot;
13 / Asia Pacific (Mumbai)
   \ &quot;ap-south-1&quot;
14 / Asia Pacific (Hong Kong)
   \ &quot;ap-east-1&quot;
15 / South America (Sao Paulo) Region.
   \ &quot;sa-east-1&quot;
location_constraint&gt; 1
Canned ACL used when creating buckets and/or storing objects in S3.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Choose a number from below, or type in your own value
 1 / Owner gets FULL_CONTROL. No one else has access rights (default).
   \ &quot;private&quot;
 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access.
   \ &quot;public-read&quot;
   / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.
 3 | Granting this on a bucket is generally not recommended.
   \ &quot;public-read-write&quot;
 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.
   \ &quot;authenticated-read&quot;
   / Object owner gets FULL_CONTROL. Bucket owner gets READ access.
 5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ &quot;bucket-owner-read&quot;
   / Both the object owner and the bucket owner get FULL_CONTROL over the object.
 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ &quot;bucket-owner-full-control&quot;
acl&gt; 1
The server-side encryption algorithm used when storing this object in S3.
Choose a number from below, or type in your own value
 1 / None
   \ &quot;&quot;
 2 / AES256
   \ &quot;AES256&quot;
server_side_encryption&gt; 1
The storage class to use when storing objects in S3.
Choose a number from below, or type in your own value
 1 / Default
   \ &quot;&quot;
 2 / Standard storage class
   \ &quot;STANDARD&quot;
 3 / Reduced redundancy storage class
   \ &quot;REDUCED_REDUNDANCY&quot;
 4 / Standard Infrequent Access storage class
   \ &quot;STANDARD_IA&quot;
 5 / One Zone Infrequent Access storage class
   \ &quot;ONEZONE_IA&quot;
 6 / Glacier Flexible Retrieval storage class
   \ &quot;GLACIER&quot;
 7 / Glacier Deep Archive storage class
   \ &quot;DEEP_ARCHIVE&quot;
 8 / Intelligent-Tiering storage class
   \ &quot;INTELLIGENT_TIERING&quot;
 9 / Glacier Instant Retrieval storage class
   \ &quot;GLACIER_IR&quot;
storage_class&gt; 1
Remote config
Configuration complete.
Options:
- type: s3
- provider: AWS
- env_auth: false
- access_key_id: XXX
- secret_access_key: YYY
- region: us-east-1
- endpoint:
- location_constraint:
- acl: private
- server_side_encryption:
- storage_class:
Keep this &quot;remote&quot; remote?
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt;</code></pre>
<h3 id="modification-times-and-hashes-1">Modification times and
hashes</h3>
<h4 id="modification-times-1">Modification times</h4>
<p>The modified time is stored as metadata on the object as
<code>X-Amz-Meta-Mtime</code> as floating point since the epoch,
accurate to 1 ns.</p>
<p>If the modification time needs to be updated rclone will attempt to
perform a server side copy to update the modification if the object can
be copied in a single part. In the case the object is larger than 5Gb or
is in Glacier or Glacier Deep Archive storage the object will be
uploaded rather than copied.</p>
<p>Note that reading this from the object takes an additional
<code>HEAD</code> request as the metadata isn't returned in object
listings.</p>
<h4 id="hashes">Hashes</h4>
<p>For small objects which weren't uploaded as multipart uploads
(objects sized below <code>--s3-upload-cutoff</code> if uploaded with
rclone) rclone uses the <code>ETag:</code> header as an MD5
checksum.</p>
<p>However for objects which were uploaded as multipart uploads or with
server side encryption (SSE-AWS or SSE-C) the <code>ETag</code> header
is no longer the MD5 sum of the data, so rclone adds an additional piece
of metadata <code>X-Amz-Meta-Md5chksum</code> which is a base64 encoded
MD5 hash (in the same format as is required for
<code>Content-MD5</code>). You can use base64 -d and hexdump to check
this value manually:</p>
<div class="sourceCode" id="cb925"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb925-1"><a href="#cb925-1" aria-hidden="true" tabindex="-1"></a><span class="bu">echo</span> <span class="st">&#39;VWTGdNx3LyXQDfA0e2Edxw==&#39;</span> <span class="kw">|</span> <span class="fu">base64</span> <span class="at">-d</span> <span class="kw">|</span> <span class="fu">hexdump</span></span></code></pre></div>
<p>or you can use <code>rclone check</code> to verify the hashes are
OK.</p>
<p>For large objects, calculating this hash can take some time so the
addition of this hash can be disabled with
<code>--s3-disable-checksum</code>. This will mean that these objects do
not have an MD5 checksum.</p>
<p>Note that reading this from the object takes an additional
<code>HEAD</code> request as the metadata isn't returned in object
listings.</p>
<h3 id="reducing-costs">Reducing costs</h3>
<h4 id="avoiding-head-requests-to-read-the-modification-time">Avoiding
HEAD requests to read the modification time</h4>
<p>By default, rclone will use the modification time of objects stored
in S3 for syncing. This is stored in object metadata which unfortunately
takes an extra HEAD request to read which can be expensive (in time and
money).</p>
<p>The modification time is used by default for all operations that
require checking the time a file was last updated. It allows rclone to
treat the remote more like a true filesystem, but it is inefficient on
S3 because it requires an extra API call to retrieve the metadata.</p>
<p>The extra API calls can be avoided when syncing (using
<code>rclone sync</code> or <code>rclone copy</code>) in a few different
ways, each with its own tradeoffs.</p>
<ul>
<li><code>--size-only</code>
<ul>
<li>Only checks the size of files.</li>
<li>Uses no extra transactions.</li>
<li>If the file doesn't change size then rclone won't detect it has
changed.</li>
<li><code>rclone sync --size-only /path/to/source s3:bucket</code></li>
</ul></li>
<li><code>--checksum</code>
<ul>
<li>Checks the size and MD5 checksum of files.</li>
<li>Uses no extra transactions.</li>
<li>The most accurate detection of changes possible.</li>
<li>Will cause the source to read an MD5 checksum which, if it is a
local disk, will cause lots of disk activity.</li>
<li>If the source and destination are both S3 this is the
<strong>recommended</strong> flag to use for maximum efficiency.</li>
<li><code>rclone sync --checksum /path/to/source s3:bucket</code></li>
</ul></li>
<li><code>--update --use-server-modtime</code>
<ul>
<li>Uses no extra transactions.</li>
<li>Modification time becomes the time the object was uploaded.</li>
<li>For many operations this is sufficient to determine if it needs
uploading.</li>
<li>Using <code>--update</code> along with
<code>--use-server-modtime</code>, avoids the extra API call and uploads
files whose local modification time is newer than the time it was last
uploaded.</li>
<li>Files created with timestamps in the past will be missed by the
sync.</li>
<li><code>rclone sync --update --use-server-modtime /path/to/source s3:bucket</code></li>
</ul></li>
</ul>
<p>These flags can and should be used in combination with
<code>--fast-list</code> - see below.</p>
<p>If using <code>rclone mount</code> or any command using the VFS (eg
<code>rclone serve</code>) commands then you might want to consider
using the VFS flag <code>--no-modtime</code> which will stop rclone
reading the modification time for every object. You could also use
<code>--use-server-modtime</code> if you are happy with the modification
times of the objects being the time of upload.</p>
<h4 id="avoiding-get-requests-to-read-directory-listings">Avoiding GET
requests to read directory listings</h4>
<p>Rclone's default directory traversal is to process each directory
individually. This takes one API call per directory. Using the
<code>--fast-list</code> flag will read all info about the objects into
memory first using a smaller number of API calls (one per 1000 objects).
See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for
more details.</p>
<div class="sourceCode" id="cb926"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb926-1"><a href="#cb926-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--fast-list</span> <span class="at">--checksum</span> /path/to/source s3:bucket</span></code></pre></div>
<p><code>--fast-list</code> trades off API transactions for memory use.
As a rough guide rclone uses 1k of memory per object stored, so using
<code>--fast-list</code> on a sync of a million objects will use roughly
1 GiB of RAM.</p>
<p>If you are only copying a small number of files into a big repository
then using <code>--no-traverse</code> is a good idea. This finds objects
directly instead of through directory listings. You can do a "top-up"
sync very cheaply by using <code>--max-age</code> and
<code>--no-traverse</code> to copy only recent files, eg</p>
<div class="sourceCode" id="cb927"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb927-1"><a href="#cb927-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy <span class="at">--max-age</span> 24h <span class="at">--no-traverse</span> /path/to/source s3:bucket</span></code></pre></div>
<p>You'd then do a full <code>rclone sync</code> less often.</p>
<p>Note that <code>--fast-list</code> isn't required in the top-up
sync.</p>
<h4 id="avoiding-head-requests-after-put">Avoiding HEAD requests after
PUT</h4>
<p>By default, rclone will HEAD every object it uploads. It does this to
check the object got uploaded correctly.</p>
<p>You can disable this with the <a href="#s3-no-head">--s3-no-head</a>
option - see there for more details.</p>
<p>Setting this flag increases the chance for undetected upload
failures.</p>
<h3 id="increasing-performance">Increasing performance</h3>
<h4 id="using-server-side-copy">Using server-side copy</h4>
<p>If you are copying objects between S3 buckets in the same region, you
should use server-side copy. This is much faster than downloading and
re-uploading the objects, as no data is transferred.</p>
<p>For rclone to use server-side copy, you must use the same remote for
the source and destination.</p>
<div class="sourceCode" id="cb928"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb928-1"><a href="#cb928-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy s3:source-bucket s3:destination-bucket</span></code></pre></div>
<p>When using server-side copy, the performance is limited by the rate
at which rclone issues API requests to S3. See below for how to increase
the number of API requests rclone makes.</p>
<h4 id="increasing-the-rate-of-api-requests">Increasing the rate of API
requests</h4>
<p>You can increase the rate of API requests to S3 by increasing the
parallelism using <code>--transfers</code> and <code>--checkers</code>
options.</p>
<p>Rclone uses a very conservative defaults for these settings, as not
all providers support high rates of requests. Depending on your
provider, you can increase significantly the number of transfers and
checkers.</p>
<p>For example, with AWS S3, if you can increase the number of checkers
to values like 200. If you are doing a server-side copy, you can also
increase the number of transfers to 200.</p>
<div class="sourceCode" id="cb929"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb929-1"><a href="#cb929-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--transfers</span> 200 <span class="at">--checkers</span> 200 <span class="at">--checksum</span> s3:source-bucket s3:destination-bucket</span></code></pre></div>
<p>You will need to experiment with these values to find the optimal
settings for your setup.</p>
<h3 id="data-integrity">Data integrity</h3>
<p>Rclone does its best to verify every part of an upload or download to
the s3 provider using various hashes.</p>
<p>Every HTTP transaction to/from the provider has a
<code>X-Amz-Content-Sha256</code> or a <code>Content-Md5</code> header
to guard against corruption of the HTTP body. The HTTP Header is
protected by the signature passed in the <code>Authorization</code>
header.</p>
<p>All communications with the provider is done over https for
encryption and additional error protection.</p>
<h4 id="single-part-uploads">Single part uploads</h4>
<ul>
<li><p>Rclone uploads single part uploads with a
<code>Content-Md5</code> using the MD5 hash read from the source. The
provider checks this is correct on receipt of the data.</p></li>
<li><p>Rclone then does a HEAD request (disable with
<code>--s3-no-head</code>) to read the <code>ETag</code> back which is
the MD5 of the file and checks that with what it sent.</p></li>
</ul>
<p>Note that if the source does not have an MD5 then the single part
uploads will not have hash protection. In this case it is recommended to
use <code>--s3-upload-cutoff 0</code> so all files are uploaded as
multipart uploads.</p>
<h4 id="multipart-uploads">Multipart uploads</h4>
<p>For files above <code>--s3-upload-cutoff</code> rclone splits the
file into multiple parts for upload.</p>
<ul>
<li>Each part is protected with both an
<code>X-Amz-Content-Sha256</code> and a <code>Content-Md5</code></li>
</ul>
<p>When rclone has finished the upload of all the parts it then
completes the upload by sending:</p>
<ul>
<li>The MD5 hash of each part</li>
<li>The number of parts</li>
<li>This info is all protected with a
<code>X-Amz-Content-Sha256</code></li>
</ul>
<p>The provider checks the MD5 for all the parts it has received against
what rclone sends and if it is good it returns OK.</p>
<p>Rclone then does a HEAD request (disable with
<code>--s3-no-head</code>) and checks the ETag is what it expects (in
this case it should be the MD5 sum of all the MD5 sums of all the parts
with the number of parts on the end).</p>
<p>If the source has an MD5 sum then rclone will attach the
<code>X-Amz-Meta-Md5chksum</code> with it as the <code>ETag</code> for a
multipart upload can't easily be checked against the file as the chunk
size must be known in order to calculate it.</p>
<h4 id="downloads">Downloads</h4>
<p>Rclone checks the MD5 hash of the data downloaded against either the
ETag or the <code>X-Amz-Meta-Md5chksum</code> metadata (if present)
which rclone uploads with multipart uploads.</p>
<h4 id="further-checking">Further checking</h4>
<p>At each stage rclone and the provider are sending and checking hashes
of <strong>everything</strong>. Rclone deliberately HEADs each object
after upload to check it arrived safely for extra security. (You can
disable this with <code>--s3-no-head</code>).</p>
<p>If you require further assurance that your data is intact you can use
<code>rclone check</code> to check the hashes locally vs the remote.</p>
<p>And if you are feeling ultimately paranoid use
<code>rclone check --download</code> which will download the files and
check them against the local copies. (Note that this doesn't use disk to
do this - it streams them in memory).</p>
<h3 id="versions">Versions</h3>
<p>When bucket versioning is enabled (this can be done with rclone with
the <a href="#versioning"><code>rclone backend versioning</code></a>
command) when rclone uploads a new version of a file it creates a <a
href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html">new
version of it</a> Likewise when you delete a file, the old version will
be marked hidden and still be available.</p>
<p>Old versions of files, where available, are visible using the <a
href="#s3-versions"><code>--s3-versions</code></a> flag.</p>
<p>It is also possible to view a bucket as it was at a certain point in
time, using the <a
href="#s3-version-at"><code>--s3-version-at</code></a> flag. This will
show the file versions as they were at that time, showing files that
have been deleted afterwards, and hiding files that were created
since.</p>
<p>If you wish to remove all the old versions then you can use the <a
href="#cleanup-hidden"><code>rclone backend cleanup-hidden remote:bucket</code></a>
command which will delete all the old hidden versions of files, leaving
the current ones intact. You can also supply a path and only old
versions under that path will be deleted, e.g.
<code>rclone backend cleanup-hidden remote:bucket/path/to/stuff</code>.</p>
<p>When you <code>purge</code> a bucket, the current and the old
versions will be deleted then the bucket will be deleted.</p>
<p>However <code>delete</code> will cause the current versions of the
files to become hidden old versions.</p>
<p>Here is a session showing the listing and retrieval of an old version
followed by a <code>cleanup</code> of the old versions.</p>
<p>Show current version and all the versions with
<code>--s3-versions</code> flag.</p>
<div class="sourceCode" id="cb930"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb930-1"><a href="#cb930-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> ls s3:cleanup-test</span>
<span id="cb930-2"><a href="#cb930-2" aria-hidden="true" tabindex="-1"></a>        <span class="ex">9</span> one.txt</span>
<span id="cb930-3"><a href="#cb930-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb930-4"><a href="#cb930-4" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> <span class="at">--s3-versions</span> ls s3:cleanup-test</span>
<span id="cb930-5"><a href="#cb930-5" aria-hidden="true" tabindex="-1"></a>        <span class="ex">9</span> one.txt</span>
<span id="cb930-6"><a href="#cb930-6" aria-hidden="true" tabindex="-1"></a>        <span class="ex">8</span> one-v2016-07-04-141032-000.txt</span>
<span id="cb930-7"><a href="#cb930-7" aria-hidden="true" tabindex="-1"></a>       <span class="ex">16</span> one-v2016-07-04-141003-000.txt</span>
<span id="cb930-8"><a href="#cb930-8" aria-hidden="true" tabindex="-1"></a>       <span class="ex">15</span> one-v2016-07-02-155621-000.txt</span></code></pre></div>
<p>Retrieve an old version</p>
<div class="sourceCode" id="cb931"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb931-1"><a href="#cb931-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> <span class="at">--s3-versions</span> copy s3:cleanup-test/one-v2016-07-04-141003-000.txt /tmp</span>
<span id="cb931-2"><a href="#cb931-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb931-3"><a href="#cb931-3" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /tmp/one-v2016-07-04-141003-000.txt</span>
<span id="cb931-4"><a href="#cb931-4" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 ncw ncw 16 Jul  2 17:46 /tmp/one-v2016-07-04-141003-000.txt</span></code></pre></div>
<p>Clean up all the old versions and show that they've gone.</p>
<div class="sourceCode" id="cb932"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb932-1"><a href="#cb932-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> backend cleanup-hidden s3:cleanup-test</span>
<span id="cb932-2"><a href="#cb932-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb932-3"><a href="#cb932-3" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> ls s3:cleanup-test</span>
<span id="cb932-4"><a href="#cb932-4" aria-hidden="true" tabindex="-1"></a>        <span class="ex">9</span> one.txt</span>
<span id="cb932-5"><a href="#cb932-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb932-6"><a href="#cb932-6" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> <span class="at">--s3-versions</span> ls s3:cleanup-test</span>
<span id="cb932-7"><a href="#cb932-7" aria-hidden="true" tabindex="-1"></a>        <span class="ex">9</span> one.txt</span></code></pre></div>
<h4 id="versions-naming-caveat">Versions naming caveat</h4>
<p>When using <code>--s3-versions</code> flag rclone is relying on the
file name to work out whether the objects are versions or not. Versions'
names are created by inserting timestamp between file name and its
extension.</p>
<div class="sourceCode" id="cb933"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb933-1"><a href="#cb933-1" aria-hidden="true" tabindex="-1"></a>        <span class="ex">9</span> file.txt</span>
<span id="cb933-2"><a href="#cb933-2" aria-hidden="true" tabindex="-1"></a>        <span class="ex">8</span> file-v2023-07-17-161032-000.txt</span>
<span id="cb933-3"><a href="#cb933-3" aria-hidden="true" tabindex="-1"></a>       <span class="ex">16</span> file-v2023-06-15-141003-000.txt</span></code></pre></div>
<p>If there are real files present with the same names as versions, then
behaviour of <code>--s3-versions</code> can be unpredictable.</p>
<h3 id="cleanup-1">Cleanup</h3>
<p>If you run <code>rclone cleanup s3:bucket</code> then it will remove
all pending multipart uploads older than 24 hours. You can use the
<code>--interactive</code>/<code>i</code> or <code>--dry-run</code> flag
to see exactly what it will do. If you want more control over the expiry
date then run
<code>rclone backend cleanup s3:bucket -o max-age=1h</code> to expire
all uploads older than one hour. You can use
<code>rclone backend list-multipart-uploads s3:bucket</code> to see the
pending multipart uploads.</p>
<h3 id="restricted-filename-characters-1">Restricted filename
characters</h3>
<p>S3 allows any valid UTF-8 string as a key.</p>
<p>Invalid UTF-8 bytes will be <a
href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they
can't be used in XML.</p>
<p>The following characters are replaced since these are problematic
when dealing with the REST API:</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>NUL</td>
<td style="text-align: center;">0x00</td>
<td style="text-align: center;">␀</td>
</tr>
<tr class="even">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
</tbody>
</table>
<p>The encoding will also encode these file names as they don't seem to
work with the SDK properly:</p>
<table>
<thead>
<tr class="header">
<th>File name</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>.</td>
<td style="text-align: center;">．</td>
</tr>
<tr class="even">
<td>..</td>
<td style="text-align: center;">．．</td>
</tr>
</tbody>
</table>
<h3 id="multipart-uploads-1">Multipart uploads</h3>
<p>rclone supports multipart uploads with S3 which means that it can
upload files bigger than 5 GiB.</p>
<p>Note that files uploaded <em>both</em> with multipart upload
<em>and</em> through crypt remotes do not have MD5 sums.</p>
<p>rclone switches from single part uploads to multipart uploads at the
point specified by <code>--s3-upload-cutoff</code>. This can be a
maximum of 5 GiB and a minimum of 0 (ie always upload multipart
files).</p>
<p>The chunk sizes used in the multipart upload are specified by
<code>--s3-chunk-size</code> and the number of chunks uploaded
concurrently is specified by <code>--s3-upload-concurrency</code>.</p>
<p>Multipart uploads will use <code>--transfers</code> *
<code>--s3-upload-concurrency</code> * <code>--s3-chunk-size</code>
extra memory. Single part uploads to not use extra memory.</p>
<p>Single part transfers can be faster than multipart transfers or
slower depending on your latency from S3 - the more latency, the more
likely single part transfers will be faster.</p>
<p>Increasing <code>--s3-upload-concurrency</code> will increase
throughput (8 would be a sensible value) and increasing
<code>--s3-chunk-size</code> also increases throughput (16M would be
sensible). Increasing either of these will use more memory. The default
values are high enough to gain most of the possible performance without
using too much memory.</p>
<h3 id="buckets-and-regions">Buckets and Regions</h3>
<p>With Amazon S3 you can list buckets (<code>rclone lsd</code>) using
any region, but you can only access the content of a bucket from the
region it was created in. If you attempt to access a bucket from the
wrong region, you will get an error,
<code>incorrect region, the bucket is not in 'XXX' region</code>.</p>
<h3 id="authentication-6">Authentication</h3>
<p>There are a number of ways to supply <code>rclone</code> with a set
of AWS credentials, with and without using the environment.</p>
<p>The different authentication methods are tried in this order:</p>
<ul>
<li>Directly in the rclone configuration file
(<code>env_auth = false</code> in the config file):
<ul>
<li><code>access_key_id</code> and <code>secret_access_key</code> are
required.</li>
<li><code>session_token</code> can be optionally set when using AWS
STS.</li>
</ul></li>
<li>Runtime configuration (<code>env_auth = true</code> in the config
file):
<ul>
<li>Export the following environment variables before running
<code>rclone</code>:
<ul>
<li>Access Key ID: <code>AWS_ACCESS_KEY_ID</code> or
<code>AWS_ACCESS_KEY</code></li>
<li>Secret Access Key: <code>AWS_SECRET_ACCESS_KEY</code> or
<code>AWS_SECRET_KEY</code></li>
<li>Session Token: <code>AWS_SESSION_TOKEN</code> (optional)</li>
</ul></li>
<li>Or, use a <a
href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html">named
profile</a>:
<ul>
<li>Profile files are standard files used by AWS CLI tools</li>
<li>By default it will use the profile in your home directory (e.g.
<code>~/.aws/credentials</code> on unix based systems) file and the
"default" profile, to change set these environment variables or config
keys:
<ul>
<li><code>AWS_SHARED_CREDENTIALS_FILE</code> to control which file or
the <code>shared_credentials_file</code> config key.</li>
<li><code>AWS_PROFILE</code> to control which profile to use or the
<code>profile</code> config key.</li>
</ul></li>
</ul></li>
<li>Or, run <code>rclone</code> in an ECS task with an IAM role (AWS
only).</li>
<li>Or, run <code>rclone</code> on an EC2 instance with an IAM role (AWS
only).</li>
<li>Or, run <code>rclone</code> in an EKS pod with an IAM role that is
associated with a service account (AWS only).</li>
<li>Or, use <a
href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-process-credentials.html">process
credentials</a> to read config from an external program.</li>
</ul></li>
</ul>
<p>With <code>env_auth = true</code> rclone (which uses the SDK for Go
v2) should support <a
href="https://docs.aws.amazon.com/sdkref/latest/guide/standardized-credentials.html">all
authentication methods</a> that the <code>aws</code> CLI tool does and
the other AWS SDKs.</p>
<p>If none of these option actually end up providing <code>rclone</code>
with AWS credentials then S3 interaction will be non-authenticated (see
the <a href="#anonymous-access">anonymous access</a> section for more
info).</p>
<h3 id="s3-permissions">S3 Permissions</h3>
<p>When using the <code>sync</code> subcommand of <code>rclone</code>
the following minimum permissions are required to be available on the
bucket being written to:</p>
<ul>
<li><code>ListBucket</code></li>
<li><code>DeleteObject</code></li>
<li><code>GetObject</code></li>
<li><code>PutObject</code></li>
<li><code>PutObjectACL</code></li>
<li><code>CreateBucket</code> (unless using <a
href="#s3-no-check-bucket">s3-no-check-bucket</a>)</li>
</ul>
<p>When using the <code>lsd</code> subcommand, the
<code>ListAllMyBuckets</code> permission is required.</p>
<p>Example policy:</p>
<div class="sourceCode" id="cb934"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb934-1"><a href="#cb934-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb934-2"><a href="#cb934-2" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Version&quot;</span><span class="fu">:</span> <span class="st">&quot;2012-10-17&quot;</span><span class="fu">,</span></span>
<span id="cb934-3"><a href="#cb934-3" aria-hidden="true" tabindex="-1"></a>  <span class="dt">&quot;Statement&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
<span id="cb934-4"><a href="#cb934-4" aria-hidden="true" tabindex="-1"></a>    <span class="fu">{</span></span>
<span id="cb934-5"><a href="#cb934-5" aria-hidden="true" tabindex="-1"></a>      <span class="dt">&quot;Effect&quot;</span><span class="fu">:</span> <span class="st">&quot;Allow&quot;</span><span class="fu">,</span></span>
<span id="cb934-6"><a href="#cb934-6" aria-hidden="true" tabindex="-1"></a>      <span class="dt">&quot;Principal&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb934-7"><a href="#cb934-7" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;AWS&quot;</span><span class="fu">:</span> <span class="st">&quot;arn:aws:iam::USER_SID:user/USER_NAME&quot;</span></span>
<span id="cb934-8"><a href="#cb934-8" aria-hidden="true" tabindex="-1"></a>      <span class="fu">},</span></span>
<span id="cb934-9"><a href="#cb934-9" aria-hidden="true" tabindex="-1"></a>      <span class="dt">&quot;Action&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
<span id="cb934-10"><a href="#cb934-10" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;s3:ListBucket&quot;</span><span class="ot">,</span></span>
<span id="cb934-11"><a href="#cb934-11" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;s3:DeleteObject&quot;</span><span class="ot">,</span></span>
<span id="cb934-12"><a href="#cb934-12" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;s3:GetObject&quot;</span><span class="ot">,</span></span>
<span id="cb934-13"><a href="#cb934-13" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;s3:PutObject&quot;</span><span class="ot">,</span></span>
<span id="cb934-14"><a href="#cb934-14" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;s3:PutObjectAcl&quot;</span></span>
<span id="cb934-15"><a href="#cb934-15" aria-hidden="true" tabindex="-1"></a>      <span class="ot">]</span><span class="fu">,</span></span>
<span id="cb934-16"><a href="#cb934-16" aria-hidden="true" tabindex="-1"></a>      <span class="dt">&quot;Resource&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
<span id="cb934-17"><a href="#cb934-17" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;arn:aws:s3:::BUCKET_NAME/*&quot;</span><span class="ot">,</span></span>
<span id="cb934-18"><a href="#cb934-18" aria-hidden="true" tabindex="-1"></a>        <span class="st">&quot;arn:aws:s3:::BUCKET_NAME&quot;</span></span>
<span id="cb934-19"><a href="#cb934-19" aria-hidden="true" tabindex="-1"></a>      <span class="ot">]</span></span>
<span id="cb934-20"><a href="#cb934-20" aria-hidden="true" tabindex="-1"></a>    <span class="fu">}</span><span class="ot">,</span></span>
<span id="cb934-21"><a href="#cb934-21" aria-hidden="true" tabindex="-1"></a>    <span class="fu">{</span></span>
<span id="cb934-22"><a href="#cb934-22" aria-hidden="true" tabindex="-1"></a>      <span class="dt">&quot;Effect&quot;</span><span class="fu">:</span> <span class="st">&quot;Allow&quot;</span><span class="fu">,</span></span>
<span id="cb934-23"><a href="#cb934-23" aria-hidden="true" tabindex="-1"></a>      <span class="dt">&quot;Action&quot;</span><span class="fu">:</span> <span class="st">&quot;s3:ListAllMyBuckets&quot;</span><span class="fu">,</span></span>
<span id="cb934-24"><a href="#cb934-24" aria-hidden="true" tabindex="-1"></a>      <span class="dt">&quot;Resource&quot;</span><span class="fu">:</span> <span class="st">&quot;arn:aws:s3:::*&quot;</span></span>
<span id="cb934-25"><a href="#cb934-25" aria-hidden="true" tabindex="-1"></a>    <span class="fu">}</span></span>
<span id="cb934-26"><a href="#cb934-26" aria-hidden="true" tabindex="-1"></a>  <span class="ot">]</span></span>
<span id="cb934-27"><a href="#cb934-27" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Notes on above:</p>
<ol type="1">
<li>This is a policy that can be used when creating bucket. It assumes
that <code>USER_NAME</code> has been created.</li>
<li>The Resource entry must include both resource ARNs, as one implies
the bucket and the other implies the bucket's objects.</li>
<li>When using <a href="#s3-no-check-bucket">s3-no-check-bucket</a> and
the bucket already exists, the <code>"arn:aws:s3:::BUCKET_NAME"</code>
doesn't have to be included.</li>
</ol>
<p>For reference, <a
href="https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b">here's
an Ansible script</a> that will generate one or more buckets that will
work with <code>rclone sync</code>.</p>
<h3 id="key-management-system-kms">Key Management System (KMS)</h3>
<p>If you are using server-side encryption with KMS then you must make
sure rclone is configured with
<code>server_side_encryption = aws:kms</code> otherwise you will find
you can't transfer small objects - these will create checksum
errors.</p>
<h3 id="glacier-and-glacier-deep-archive">Glacier and Glacier Deep
Archive</h3>
<p>You can upload objects using the glacier storage class or transition
them to glacier using a <a
href="http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html">lifecycle
policy</a>. The bucket can still be synced or copied into normally, but
if rclone tries to access data from the glacier storage class you will
see an error like below.</p>
<pre class="text"><code>2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file</code></pre>
<p>In this case you need to <a
href="http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html">restore</a>
the object(s) in question before accessing object contents. The <a
href="#restore">restore</a> section below shows how to do this with
rclone.</p>
<p>Note that rclone only speaks the S3 API it does not speak the Glacier
Vault API, so rclone cannot directly access Glacier Vaults.</p>
<h3 id="object-lock-enabled-s3-bucket">Object-lock enabled S3
bucket</h3>
<p>According to AWS's <a
href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html#object-lock-permission">documentation
on S3 Object Lock</a>:</p>
<blockquote>
<p>If you configure a default retention period on a bucket, requests to
upload objects in such a bucket must include the Content-MD5 header.</p>
</blockquote>
<p>As mentioned in the <a
href="#modification-times-and-hashes">Modification times and hashes</a>
section, small files that are not uploaded as multipart, use a different
tag, causing the upload to fail. A simple solution is to set the
<code>--s3-upload-cutoff 0</code> and force all the files to be uploaded
as multipart.</p>
<h3 id="standard-options-2">Standard options</h3>
<p>Here are the Standard options specific to s3 (Amazon S3 Compliant
Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile,
Cloudflare, DigitalOcean, Dreamhost, Exaba, FlashBlade, GCS, HuaweiOBS,
IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Mega,
Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway,
SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi,
Qiniu, Zata and others).</p>
<h4 id="s3-provider">--s3-provider</h4>
<p>Choose your S3 provider.</p>
<p>Properties:</p>
<ul>
<li>Config: provider</li>
<li>Env Var: RCLONE_S3_PROVIDER</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>"AWS"
<ul>
<li>Amazon Web Services (AWS) S3</li>
</ul></li>
<li>"Alibaba"
<ul>
<li>Alibaba Cloud Object Storage System (OSS) formerly Aliyun</li>
</ul></li>
<li>"ArvanCloud"
<ul>
<li>Arvan Cloud Object Storage (AOS)</li>
</ul></li>
<li>"Ceph"
<ul>
<li>Ceph Object Storage</li>
</ul></li>
<li>"ChinaMobile"
<ul>
<li>China Mobile Ecloud Elastic Object Storage (EOS)</li>
</ul></li>
<li>"Cloudflare"
<ul>
<li>Cloudflare R2 Storage</li>
</ul></li>
<li>"DigitalOcean"
<ul>
<li>DigitalOcean Spaces</li>
</ul></li>
<li>"Dreamhost"
<ul>
<li>Dreamhost DreamObjects</li>
</ul></li>
<li>"Exaba"
<ul>
<li>Exaba Object Storage</li>
</ul></li>
<li>"FlashBlade"
<ul>
<li>Pure Storage FlashBlade Object Storage</li>
</ul></li>
<li>"GCS"
<ul>
<li>Google Cloud Storage</li>
</ul></li>
<li>"HuaweiOBS"
<ul>
<li>Huawei Object Storage Service</li>
</ul></li>
<li>"IBMCOS"
<ul>
<li>IBM COS S3</li>
</ul></li>
<li>"IDrive"
<ul>
<li>IDrive e2</li>
</ul></li>
<li>"IONOS"
<ul>
<li>IONOS Cloud</li>
</ul></li>
<li>"LyveCloud"
<ul>
<li>Seagate Lyve Cloud</li>
</ul></li>
<li>"Leviia"
<ul>
<li>Leviia Object Storage</li>
</ul></li>
<li>"Liara"
<ul>
<li>Liara Object Storage</li>
</ul></li>
<li>"Linode"
<ul>
<li>Linode Object Storage</li>
</ul></li>
<li>"Magalu"
<ul>
<li>Magalu Object Storage</li>
</ul></li>
<li>"Mega"
<ul>
<li>MEGA S4 Object Storage</li>
</ul></li>
<li>"Minio"
<ul>
<li>Minio Object Storage</li>
</ul></li>
<li>"Netease"
<ul>
<li>Netease Object Storage (NOS)</li>
</ul></li>
<li>"Outscale"
<ul>
<li>OUTSCALE Object Storage (OOS)</li>
</ul></li>
<li>"OVHcloud"
<ul>
<li>OVHcloud Object Storage</li>
</ul></li>
<li>"Petabox"
<ul>
<li>Petabox Object Storage</li>
</ul></li>
<li>"RackCorp"
<ul>
<li>RackCorp Object Storage</li>
</ul></li>
<li>"Rclone"
<ul>
<li>Rclone S3 Server</li>
</ul></li>
<li>"Scaleway"
<ul>
<li>Scaleway Object Storage</li>
</ul></li>
<li>"SeaweedFS"
<ul>
<li>SeaweedFS S3</li>
</ul></li>
<li>"Selectel"
<ul>
<li>Selectel Object Storage</li>
</ul></li>
<li>"StackPath"
<ul>
<li>StackPath Object Storage</li>
</ul></li>
<li>"Storj"
<ul>
<li>Storj (S3 Compatible Gateway)</li>
</ul></li>
<li>"Synology"
<ul>
<li>Synology C2 Object Storage</li>
</ul></li>
<li>"TencentCOS"
<ul>
<li>Tencent Cloud Object Storage (COS)</li>
</ul></li>
<li>"Wasabi"
<ul>
<li>Wasabi Object Storage</li>
</ul></li>
<li>"Qiniu"
<ul>
<li>Qiniu Object Storage (Kodo)</li>
</ul></li>
<li>"Zata"
<ul>
<li>Zata (S3 compatible Gateway)</li>
</ul></li>
<li>"Other"
<ul>
<li>Any other S3 compatible provider</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-env-auth">--s3-env-auth</h4>
<p>Get AWS credentials from runtime (environment variables or EC2/ECS
meta data if no env vars).</p>
<p>Only applies if access_key_id and secret_access_key is blank.</p>
<p>Properties:</p>
<ul>
<li>Config: env_auth</li>
<li>Env Var: RCLONE_S3_ENV_AUTH</li>
<li>Type: bool</li>
<li>Default: false</li>
<li>Examples:
<ul>
<li>"false"
<ul>
<li>Enter AWS credentials in the next step.</li>
</ul></li>
<li>"true"
<ul>
<li>Get AWS credentials from the environment (env vars or IAM).</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-access-key-id">--s3-access-key-id</h4>
<p>AWS Access Key ID.</p>
<p>Leave blank for anonymous access or runtime credentials.</p>
<p>Properties:</p>
<ul>
<li>Config: access_key_id</li>
<li>Env Var: RCLONE_S3_ACCESS_KEY_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-secret-access-key">--s3-secret-access-key</h4>
<p>AWS Secret Access Key (password).</p>
<p>Leave blank for anonymous access or runtime credentials.</p>
<p>Properties:</p>
<ul>
<li>Config: secret_access_key</li>
<li>Env Var: RCLONE_S3_SECRET_ACCESS_KEY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-region">--s3-region</h4>
<p>Region to connect to.</p>
<p>Properties:</p>
<ul>
<li>Config: region</li>
<li>Env Var: RCLONE_S3_REGION</li>
<li>Provider: AWS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>"us-east-1"
<ul>
<li>The default endpoint - a good choice if you are unsure.</li>
<li>US Region, Northern Virginia, or Pacific Northwest.</li>
<li>Leave location constraint empty.</li>
</ul></li>
<li>"us-east-2"
<ul>
<li>US East (Ohio) Region.</li>
<li>Needs location constraint us-east-2.</li>
</ul></li>
<li>"us-west-1"
<ul>
<li>US West (Northern California) Region.</li>
<li>Needs location constraint us-west-1.</li>
</ul></li>
<li>"us-west-2"
<ul>
<li>US West (Oregon) Region.</li>
<li>Needs location constraint us-west-2.</li>
</ul></li>
<li>"ca-central-1"
<ul>
<li>Canada (Central) Region.</li>
<li>Needs location constraint ca-central-1.</li>
</ul></li>
<li>"eu-west-1"
<ul>
<li>EU (Ireland) Region.</li>
<li>Needs location constraint EU or eu-west-1.</li>
</ul></li>
<li>"eu-west-2"
<ul>
<li>EU (London) Region.</li>
<li>Needs location constraint eu-west-2.</li>
</ul></li>
<li>"eu-west-3"
<ul>
<li>EU (Paris) Region.</li>
<li>Needs location constraint eu-west-3.</li>
</ul></li>
<li>"eu-north-1"
<ul>
<li>EU (Stockholm) Region.</li>
<li>Needs location constraint eu-north-1.</li>
</ul></li>
<li>"eu-south-1"
<ul>
<li>EU (Milan) Region.</li>
<li>Needs location constraint eu-south-1.</li>
</ul></li>
<li>"eu-central-1"
<ul>
<li>EU (Frankfurt) Region.</li>
<li>Needs location constraint eu-central-1.</li>
</ul></li>
<li>"ap-southeast-1"
<ul>
<li>Asia Pacific (Singapore) Region.</li>
<li>Needs location constraint ap-southeast-1.</li>
</ul></li>
<li>"ap-southeast-2"
<ul>
<li>Asia Pacific (Sydney) Region.</li>
<li>Needs location constraint ap-southeast-2.</li>
</ul></li>
<li>"ap-northeast-1"
<ul>
<li>Asia Pacific (Tokyo) Region.</li>
<li>Needs location constraint ap-northeast-1.</li>
</ul></li>
<li>"ap-northeast-2"
<ul>
<li>Asia Pacific (Seoul).</li>
<li>Needs location constraint ap-northeast-2.</li>
</ul></li>
<li>"ap-northeast-3"
<ul>
<li>Asia Pacific (Osaka-Local).</li>
<li>Needs location constraint ap-northeast-3.</li>
</ul></li>
<li>"ap-south-1"
<ul>
<li>Asia Pacific (Mumbai).</li>
<li>Needs location constraint ap-south-1.</li>
</ul></li>
<li>"ap-east-1"
<ul>
<li>Asia Pacific (Hong Kong) Region.</li>
<li>Needs location constraint ap-east-1.</li>
</ul></li>
<li>"sa-east-1"
<ul>
<li>South America (Sao Paulo) Region.</li>
<li>Needs location constraint sa-east-1.</li>
</ul></li>
<li>"il-central-1"
<ul>
<li>Israel (Tel Aviv) Region.</li>
<li>Needs location constraint il-central-1.</li>
</ul></li>
<li>"me-south-1"
<ul>
<li>Middle East (Bahrain) Region.</li>
<li>Needs location constraint me-south-1.</li>
</ul></li>
<li>"af-south-1"
<ul>
<li>Africa (Cape Town) Region.</li>
<li>Needs location constraint af-south-1.</li>
</ul></li>
<li>"cn-north-1"
<ul>
<li>China (Beijing) Region.</li>
<li>Needs location constraint cn-north-1.</li>
</ul></li>
<li>"cn-northwest-1"
<ul>
<li>China (Ningxia) Region.</li>
<li>Needs location constraint cn-northwest-1.</li>
</ul></li>
<li>"us-gov-east-1"
<ul>
<li>AWS GovCloud (US-East) Region.</li>
<li>Needs location constraint us-gov-east-1.</li>
</ul></li>
<li>"us-gov-west-1"
<ul>
<li>AWS GovCloud (US) Region.</li>
<li>Needs location constraint us-gov-west-1.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint">--s3-endpoint</h4>
<p>Endpoint for S3 API.</p>
<p>Leave blank if using AWS to use the default endpoint for the
region.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: AWS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-location-constraint">--s3-location-constraint</h4>
<p>Location constraint - must be set to match the Region.</p>
<p>Used when creating buckets only.</p>
<p>Properties:</p>
<ul>
<li>Config: location_constraint</li>
<li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li>
<li>Provider: AWS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>""
<ul>
<li>Empty for US Region, Northern Virginia, or Pacific Northwest</li>
</ul></li>
<li>"us-east-2"
<ul>
<li>US East (Ohio) Region</li>
</ul></li>
<li>"us-west-1"
<ul>
<li>US West (Northern California) Region</li>
</ul></li>
<li>"us-west-2"
<ul>
<li>US West (Oregon) Region</li>
</ul></li>
<li>"ca-central-1"
<ul>
<li>Canada (Central) Region</li>
</ul></li>
<li>"eu-west-1"
<ul>
<li>EU (Ireland) Region</li>
</ul></li>
<li>"eu-west-2"
<ul>
<li>EU (London) Region</li>
</ul></li>
<li>"eu-west-3"
<ul>
<li>EU (Paris) Region</li>
</ul></li>
<li>"eu-north-1"
<ul>
<li>EU (Stockholm) Region</li>
</ul></li>
<li>"eu-south-1"
<ul>
<li>EU (Milan) Region</li>
</ul></li>
<li>"EU"
<ul>
<li>EU Region</li>
</ul></li>
<li>"ap-southeast-1"
<ul>
<li>Asia Pacific (Singapore) Region</li>
</ul></li>
<li>"ap-southeast-2"
<ul>
<li>Asia Pacific (Sydney) Region</li>
</ul></li>
<li>"ap-northeast-1"
<ul>
<li>Asia Pacific (Tokyo) Region</li>
</ul></li>
<li>"ap-northeast-2"
<ul>
<li>Asia Pacific (Seoul) Region</li>
</ul></li>
<li>"ap-northeast-3"
<ul>
<li>Asia Pacific (Osaka-Local) Region</li>
</ul></li>
<li>"ap-south-1"
<ul>
<li>Asia Pacific (Mumbai) Region</li>
</ul></li>
<li>"ap-east-1"
<ul>
<li>Asia Pacific (Hong Kong) Region</li>
</ul></li>
<li>"sa-east-1"
<ul>
<li>South America (Sao Paulo) Region</li>
</ul></li>
<li>"il-central-1"
<ul>
<li>Israel (Tel Aviv) Region</li>
</ul></li>
<li>"me-south-1"
<ul>
<li>Middle East (Bahrain) Region</li>
</ul></li>
<li>"af-south-1"
<ul>
<li>Africa (Cape Town) Region</li>
</ul></li>
<li>"cn-north-1"
<ul>
<li>China (Beijing) Region</li>
</ul></li>
<li>"cn-northwest-1"
<ul>
<li>China (Ningxia) Region</li>
</ul></li>
<li>"us-gov-east-1"
<ul>
<li>AWS GovCloud (US-East) Region</li>
</ul></li>
<li>"us-gov-west-1"
<ul>
<li>AWS GovCloud (US) Region</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-acl">--s3-acl</h4>
<p>Canned ACL used when creating buckets and storing or copying
objects.</p>
<p>This ACL is used for creating objects and if bucket_acl isn't set,
for creating buckets too.</p>
<p>For more info visit
https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl</p>
<p>Note that this ACL is applied when server-side copying objects as S3
doesn't copy the ACL from the source but rather writes a fresh one.</p>
<p>If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.</p>
<p>Properties:</p>
<ul>
<li>Config: acl</li>
<li>Env Var: RCLONE_S3_ACL</li>
<li>Provider: !Storj,Selectel,Synology,Cloudflare,FlashBlade,Mega</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>"default"
<ul>
<li>Owner gets Full_CONTROL.</li>
<li>No one else has access rights (default).</li>
</ul></li>
<li>"private"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>No one else has access rights (default).</li>
</ul></li>
<li>"public-read"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AllUsers group gets READ access.</li>
</ul></li>
<li>"public-read-write"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AllUsers group gets READ and WRITE access.</li>
<li>Granting this on a bucket is generally not recommended.</li>
</ul></li>
<li>"authenticated-read"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AuthenticatedUsers group gets READ access.</li>
</ul></li>
<li>"bucket-owner-read"
<ul>
<li>Object owner gets FULL_CONTROL.</li>
<li>Bucket owner gets READ access.</li>
<li>If you specify this canned ACL when creating a bucket, Amazon S3
ignores it.</li>
</ul></li>
<li>"bucket-owner-full-control"
<ul>
<li>Both the object owner and the bucket owner get FULL_CONTROL over the
object.</li>
<li>If you specify this canned ACL when creating a bucket, Amazon S3
ignores it.</li>
</ul></li>
<li>"private"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>No one else has access rights (default).</li>
<li>This acl is available on IBM Cloud (Infra), IBM Cloud (Storage),
On-Premise COS.</li>
</ul></li>
<li>"public-read"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AllUsers group gets READ access.</li>
<li>This acl is available on IBM Cloud (Infra), IBM Cloud (Storage),
On-Premise IBM COS.</li>
</ul></li>
<li>"public-read-write"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AllUsers group gets READ and WRITE access.</li>
<li>This acl is available on IBM Cloud (Infra), On-Premise IBM COS.</li>
</ul></li>
<li>"authenticated-read"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AuthenticatedUsers group gets READ access.</li>
<li>Not supported on Buckets.</li>
<li>This acl is available on IBM Cloud (Infra) and On-Premise IBM
COS.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-server-side-encryption">--s3-server-side-encryption</h4>
<p>The server-side encryption algorithm used when storing this object in
S3.</p>
<p>Properties:</p>
<ul>
<li>Config: server_side_encryption</li>
<li>Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION</li>
<li>Provider: AWS,Ceph,ChinaMobile,Minio</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>""
<ul>
<li>None</li>
</ul></li>
<li>"AES256"
<ul>
<li>AES256</li>
</ul></li>
<li>"aws:kms"
<ul>
<li>aws:kms</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-sse-kms-key-id">--s3-sse-kms-key-id</h4>
<p>If using KMS ID you must provide the ARN of Key.</p>
<p>Properties:</p>
<ul>
<li>Config: sse_kms_key_id</li>
<li>Env Var: RCLONE_S3_SSE_KMS_KEY_ID</li>
<li>Provider: AWS,Ceph,Minio</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>""
<ul>
<li>None</li>
</ul></li>
<li>"arn:aws:kms:us-east-1:*"
<ul>
<li>arn:aws:kms:*</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-storage-class">--s3-storage-class</h4>
<p>The storage class to use when storing new objects in S3.</p>
<p>Properties:</p>
<ul>
<li>Config: storage_class</li>
<li>Env Var: RCLONE_S3_STORAGE_CLASS</li>
<li>Provider: AWS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>""
<ul>
<li>Default</li>
</ul></li>
<li>"STANDARD"
<ul>
<li>Standard storage class</li>
</ul></li>
<li>"REDUCED_REDUNDANCY"
<ul>
<li>Reduced redundancy storage class</li>
</ul></li>
<li>"STANDARD_IA"
<ul>
<li>Standard Infrequent Access storage class</li>
</ul></li>
<li>"ONEZONE_IA"
<ul>
<li>One Zone Infrequent Access storage class</li>
</ul></li>
<li>"GLACIER"
<ul>
<li>Glacier Flexible Retrieval storage class</li>
</ul></li>
<li>"DEEP_ARCHIVE"
<ul>
<li>Glacier Deep Archive storage class</li>
</ul></li>
<li>"INTELLIGENT_TIERING"
<ul>
<li>Intelligent-Tiering storage class</li>
</ul></li>
<li>"GLACIER_IR"
<ul>
<li>Glacier Instant Retrieval storage class</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-ibm-api-key">--s3-ibm-api-key</h4>
<p>IBM API Key to be used to obtain IAM token</p>
<p>Properties:</p>
<ul>
<li>Config: ibm_api_key</li>
<li>Env Var: RCLONE_S3_IBM_API_KEY</li>
<li>Provider: IBMCOS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-ibm-resource-instance-id">--s3-ibm-resource-instance-id</h4>
<p>IBM service instance id</p>
<p>Properties:</p>
<ul>
<li>Config: ibm_resource_instance_id</li>
<li>Env Var: RCLONE_S3_IBM_RESOURCE_INSTANCE_ID</li>
<li>Provider: IBMCOS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options-2">Advanced options</h3>
<p>Here are the Advanced options specific to s3 (Amazon S3 Compliant
Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile,
Cloudflare, DigitalOcean, Dreamhost, Exaba, FlashBlade, GCS, HuaweiOBS,
IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Mega,
Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway,
SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi,
Qiniu, Zata and others).</p>
<h4 id="s3-bucket-acl">--s3-bucket-acl</h4>
<p>Canned ACL used when creating buckets.</p>
<p>For more info visit
https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl</p>
<p>Note that this ACL is applied when only when creating buckets. If it
isn't set then "acl" is used instead.</p>
<p>If the "acl" and "bucket_acl" are empty strings then no X-Amz-Acl:
header is added and the default (private) will be used.</p>
<p>Properties:</p>
<ul>
<li>Config: bucket_acl</li>
<li>Env Var: RCLONE_S3_BUCKET_ACL</li>
<li>Provider: !Storj,Selectel,Synology,Cloudflare,FlashBlade</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>"private"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>No one else has access rights (default).</li>
</ul></li>
<li>"public-read"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AllUsers group gets READ access.</li>
</ul></li>
<li>"public-read-write"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AllUsers group gets READ and WRITE access.</li>
<li>Granting this on a bucket is generally not recommended.</li>
</ul></li>
<li>"authenticated-read"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AuthenticatedUsers group gets READ access.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-requester-pays">--s3-requester-pays</h4>
<p>Enables requester pays option when interacting with S3 bucket.</p>
<p>Properties:</p>
<ul>
<li>Config: requester_pays</li>
<li>Env Var: RCLONE_S3_REQUESTER_PAYS</li>
<li>Provider: AWS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-sse-customer-algorithm">--s3-sse-customer-algorithm</h4>
<p>If using SSE-C, the server-side encryption algorithm used when
storing this object in S3.</p>
<p>Properties:</p>
<ul>
<li>Config: sse_customer_algorithm</li>
<li>Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM</li>
<li>Provider: AWS,Ceph,ChinaMobile,Minio</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>""
<ul>
<li>None</li>
</ul></li>
<li>"AES256"
<ul>
<li>AES256</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-sse-customer-key">--s3-sse-customer-key</h4>
<p>To use SSE-C you may provide the secret encryption key used to
encrypt/decrypt your data.</p>
<p>Alternatively you can provide --sse-customer-key-base64.</p>
<p>Properties:</p>
<ul>
<li>Config: sse_customer_key</li>
<li>Env Var: RCLONE_S3_SSE_CUSTOMER_KEY</li>
<li>Provider: AWS,Ceph,ChinaMobile,Minio</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>""
<ul>
<li>None</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-sse-customer-key-base64">--s3-sse-customer-key-base64</h4>
<p>If using SSE-C you must provide the secret encryption key encoded in
base64 format to encrypt/decrypt your data.</p>
<p>Alternatively you can provide --sse-customer-key.</p>
<p>Properties:</p>
<ul>
<li>Config: sse_customer_key_base64</li>
<li>Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_BASE64</li>
<li>Provider: AWS,Ceph,ChinaMobile,Minio</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>""
<ul>
<li>None</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-sse-customer-key-md5">--s3-sse-customer-key-md5</h4>
<p>If using SSE-C you may provide the secret encryption key MD5 checksum
(optional).</p>
<p>If you leave it blank, this is calculated automatically from the
sse_customer_key provided.</p>
<p>Properties:</p>
<ul>
<li>Config: sse_customer_key_md5</li>
<li>Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5</li>
<li>Provider: AWS,Ceph,ChinaMobile,Minio</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>""
<ul>
<li>None</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-upload-cutoff">--s3-upload-cutoff</h4>
<p>Cutoff for switching to chunked upload.</p>
<p>Any files larger than this will be uploaded in chunks of chunk_size.
The minimum is 0 and the maximum is 5 GiB.</p>
<p>Properties:</p>
<ul>
<li>Config: upload_cutoff</li>
<li>Env Var: RCLONE_S3_UPLOAD_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 200Mi</li>
</ul>
<h4 id="s3-chunk-size">--s3-chunk-size</h4>
<p>Chunk size to use for uploading.</p>
<p>When uploading files larger than upload_cutoff or files with unknown
size (e.g. from "rclone rcat" or uploaded with "rclone mount" or google
photos or google docs) they will be uploaded as multipart uploads using
this chunk size.</p>
<p>Note that "--s3-upload-concurrency" chunks of this size are buffered
in memory per transfer.</p>
<p>If you are transferring large files over high-speed links and you
have enough memory, then increasing this will speed up the
transfers.</p>
<p>Rclone will automatically increase the chunk size when uploading a
large file of known size to stay below the 10,000 chunks limit.</p>
<p>Files of unknown size are uploaded with the configured chunk_size.
Since the default chunk size is 5 MiB and there can be at most 10,000
chunks, this means that by default the maximum size of a file you can
stream upload is 48 GiB. If you wish to stream upload larger files then
you will need to increase chunk_size.</p>
<p>Increasing the chunk size decreases the accuracy of the progress
statistics displayed with "-P" flag. Rclone treats chunk as sent when
it's buffered by the AWS SDK, when in fact it may still be uploading. A
bigger chunk size means a bigger AWS SDK buffer and progress reporting
more deviating from the truth.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_S3_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 5Mi</li>
</ul>
<h4 id="s3-max-upload-parts">--s3-max-upload-parts</h4>
<p>Maximum number of parts in a multipart upload.</p>
<p>This option defines the maximum number of multipart chunks to use
when doing a multipart upload.</p>
<p>This can be useful if a service does not support the AWS S3
specification of 10,000 chunks.</p>
<p>Rclone will automatically increase the chunk size when uploading a
large file of a known size to stay below this number of chunks
limit.</p>
<p>Properties:</p>
<ul>
<li>Config: max_upload_parts</li>
<li>Env Var: RCLONE_S3_MAX_UPLOAD_PARTS</li>
<li>Type: int</li>
<li>Default: 10000</li>
</ul>
<h4 id="s3-copy-cutoff">--s3-copy-cutoff</h4>
<p>Cutoff for switching to multipart copy.</p>
<p>Any files larger than this that need to be server-side copied will be
copied in chunks of this size.</p>
<p>The minimum is 0 and the maximum is 5 GiB.</p>
<p>Properties:</p>
<ul>
<li>Config: copy_cutoff</li>
<li>Env Var: RCLONE_S3_COPY_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 4.656Gi</li>
</ul>
<h4 id="s3-disable-checksum">--s3-disable-checksum</h4>
<p>Don't store MD5 checksum with object metadata.</p>
<p>Normally rclone will calculate the MD5 checksum of the input before
uploading it so it can add it to metadata on the object. This is great
for data integrity checking but can cause long delays for large files to
start uploading.</p>
<p>Properties:</p>
<ul>
<li>Config: disable_checksum</li>
<li>Env Var: RCLONE_S3_DISABLE_CHECKSUM</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-shared-credentials-file">--s3-shared-credentials-file</h4>
<p>Path to the shared credentials file.</p>
<p>If env_auth = true then rclone can use a shared credentials file.</p>
<p>If this variable is empty rclone will look for the
"AWS_SHARED_CREDENTIALS_FILE" env variable. If the env value is empty it
will default to the current user's home directory.</p>
<pre><code>Linux/OSX: &quot;$HOME/.aws/credentials&quot;
Windows:   &quot;%USERPROFILE%\.aws\credentials&quot;</code></pre>
<p>Properties:</p>
<ul>
<li>Config: shared_credentials_file</li>
<li>Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-profile">--s3-profile</h4>
<p>Profile to use in the shared credentials file.</p>
<p>If env_auth = true then rclone can use a shared credentials file.
This variable controls which profile is used in that file.</p>
<p>If empty it will default to the environment variable "AWS_PROFILE" or
"default" if that environment variable is also not set.</p>
<p>Properties:</p>
<ul>
<li>Config: profile</li>
<li>Env Var: RCLONE_S3_PROFILE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-session-token">--s3-session-token</h4>
<p>An AWS session token.</p>
<p>Properties:</p>
<ul>
<li>Config: session_token</li>
<li>Env Var: RCLONE_S3_SESSION_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-upload-concurrency">--s3-upload-concurrency</h4>
<p>Concurrency for multipart uploads and copies.</p>
<p>This is the number of chunks of the same file that are uploaded
concurrently for multipart uploads and copies.</p>
<p>If you are uploading small numbers of large files over high-speed
links and these uploads do not fully utilize your bandwidth, then
increasing this may help to speed up the transfers.</p>
<p>Properties:</p>
<ul>
<li>Config: upload_concurrency</li>
<li>Env Var: RCLONE_S3_UPLOAD_CONCURRENCY</li>
<li>Type: int</li>
<li>Default: 4</li>
</ul>
<h4 id="s3-force-path-style">--s3-force-path-style</h4>
<p>If true use path style access if false use virtual hosted style.</p>
<p>If this is true (the default) then rclone will use path style access,
if false then rclone will use virtual path style. See <a
href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">the
AWS S3 docs</a> for more info.</p>
<p>Some providers (e.g. AWS, Aliyun OSS, Netease COS, or Tencent COS)
require this set to false - rclone will do this automatically based on
the provider setting.</p>
<p>Note that if your bucket isn't a valid DNS name, i.e. has '.' or '_'
in, you'll need to set this to true.</p>
<p>Properties:</p>
<ul>
<li>Config: force_path_style</li>
<li>Env Var: RCLONE_S3_FORCE_PATH_STYLE</li>
<li>Type: bool</li>
<li>Default: true</li>
</ul>
<h4 id="s3-v2-auth">--s3-v2-auth</h4>
<p>If true use v2 authentication.</p>
<p>If this is false (the default) then rclone will use v4
authentication. If it is set then rclone will use v2 authentication.</p>
<p>Use this only if v4 signatures don't work, e.g. pre Jewel/v10
CEPH.</p>
<p>Properties:</p>
<ul>
<li>Config: v2_auth</li>
<li>Env Var: RCLONE_S3_V2_AUTH</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-use-dual-stack">--s3-use-dual-stack</h4>
<p>If true use AWS S3 dual-stack endpoint (IPv6 support).</p>
<p>See <a
href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/dual-stack-endpoints.html">AWS
Docs on Dualstack Endpoints</a></p>
<p>Properties:</p>
<ul>
<li>Config: use_dual_stack</li>
<li>Env Var: RCLONE_S3_USE_DUAL_STACK</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-use-accelerate-endpoint">--s3-use-accelerate-endpoint</h4>
<p>If true use the AWS S3 accelerated endpoint.</p>
<p>See: <a
href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html">AWS
S3 Transfer acceleration</a></p>
<p>Properties:</p>
<ul>
<li>Config: use_accelerate_endpoint</li>
<li>Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT</li>
<li>Provider: AWS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-use-arn-region">--s3-use-arn-region</h4>
<p>If true, enables arn region support for the service.</p>
<p>Properties:</p>
<ul>
<li>Config: use_arn_region</li>
<li>Env Var: RCLONE_S3_USE_ARN_REGION</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-leave-parts-on-error">--s3-leave-parts-on-error</h4>
<p>If true avoid calling abort upload on a failure, leaving all
successfully uploaded parts on S3 for manual recovery.</p>
<p>It should be set to true for resuming uploads across different
sessions.</p>
<p>WARNING: Storing parts of an incomplete multipart upload counts
towards space usage on S3 and will add additional costs if not cleaned
up.</p>
<p>Properties:</p>
<ul>
<li>Config: leave_parts_on_error</li>
<li>Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR</li>
<li>Provider: AWS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-list-chunk">--s3-list-chunk</h4>
<p>Size of listing chunk (response list for each ListObject S3
request).</p>
<p>This option is also known as "MaxKeys", "max-items", or "page-size"
from the AWS S3 specification. Most services truncate the response list
to 1000 objects even if requested more than that. In AWS S3 this is a
global maximum and cannot be changed, see <a
href="https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html">AWS
S3</a>. In Ceph, this can be increased with the "rgw list buckets max
chunk" option.</p>
<p>Properties:</p>
<ul>
<li>Config: list_chunk</li>
<li>Env Var: RCLONE_S3_LIST_CHUNK</li>
<li>Type: int</li>
<li>Default: 1000</li>
</ul>
<h4 id="s3-list-version">--s3-list-version</h4>
<p>Version of ListObjects to use: 1,2 or 0 for auto.</p>
<p>When S3 originally launched it only provided the ListObjects call to
enumerate objects in a bucket.</p>
<p>However in May 2016 the ListObjectsV2 call was introduced. This is
much higher performance and should be used if at all possible.</p>
<p>If set to the default, 0, rclone will guess according to the provider
set which list objects method to call. If it guesses wrong, then it may
be set manually here.</p>
<p>Properties:</p>
<ul>
<li>Config: list_version</li>
<li>Env Var: RCLONE_S3_LIST_VERSION</li>
<li>Type: int</li>
<li>Default: 0</li>
</ul>
<h4 id="s3-list-url-encode">--s3-list-url-encode</h4>
<p>Whether to url encode listings: true/false/unset</p>
<p>Some providers support URL encoding listings and where this is
available this is more reliable when using control characters in file
names. If this is set to unset (the default) then rclone will choose
according to the provider setting what to apply, but you can override
rclone's choice here.</p>
<p>Properties:</p>
<ul>
<li>Config: list_url_encode</li>
<li>Env Var: RCLONE_S3_LIST_URL_ENCODE</li>
<li>Type: Tristate</li>
<li>Default: unset</li>
</ul>
<h4 id="s3-no-check-bucket">--s3-no-check-bucket</h4>
<p>If set, don't attempt to check the bucket exists or create it.</p>
<p>This can be useful when trying to minimise the number of transactions
rclone does if you know the bucket exists already.</p>
<p>It can also be needed if the user you are using does not have bucket
creation permissions. Before v1.52.0 this would have passed silently due
to a bug.</p>
<p>Properties:</p>
<ul>
<li>Config: no_check_bucket</li>
<li>Env Var: RCLONE_S3_NO_CHECK_BUCKET</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-no-head">--s3-no-head</h4>
<p>If set, don't HEAD uploaded objects to check integrity.</p>
<p>This can be useful when trying to minimise the number of transactions
rclone does.</p>
<p>Setting it means that if rclone receives a 200 OK message after
uploading an object with PUT then it will assume that it got uploaded
properly.</p>
<p>In particular it will assume:</p>
<ul>
<li>the metadata, including modtime, storage class and content type was
as uploaded</li>
<li>the size was as uploaded</li>
</ul>
<p>It reads the following items from the response for a single part
PUT:</p>
<ul>
<li>the MD5SUM</li>
<li>The uploaded date</li>
</ul>
<p>For multipart uploads these items aren't read.</p>
<p>If an source object of unknown length is uploaded then rclone
<strong>will</strong> do a HEAD request.</p>
<p>Setting this flag increases the chance for undetected upload
failures, in particular an incorrect size, so it isn't recommended for
normal operation. In practice the chance of an undetected upload failure
is very small even with this flag.</p>
<p>Properties:</p>
<ul>
<li>Config: no_head</li>
<li>Env Var: RCLONE_S3_NO_HEAD</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-no-head-object">--s3-no-head-object</h4>
<p>If set, do not do HEAD before GET when getting objects.</p>
<p>Properties:</p>
<ul>
<li>Config: no_head_object</li>
<li>Env Var: RCLONE_S3_NO_HEAD_OBJECT</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-encoding">--s3-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_S3_ENCODING</li>
<li>Type: Encoding</li>
<li>Default: Slash,InvalidUtf8,Dot</li>
</ul>
<h4 id="s3-memory-pool-flush-time">--s3-memory-pool-flush-time</h4>
<p>How often internal memory buffer pools will be flushed. (no longer
used)</p>
<p>Properties:</p>
<ul>
<li>Config: memory_pool_flush_time</li>
<li>Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME</li>
<li>Type: Duration</li>
<li>Default: 1m0s</li>
</ul>
<h4 id="s3-memory-pool-use-mmap">--s3-memory-pool-use-mmap</h4>
<p>Whether to use mmap buffers in internal memory pool. (no longer
used)</p>
<p>Properties:</p>
<ul>
<li>Config: memory_pool_use_mmap</li>
<li>Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-disable-http2">--s3-disable-http2</h4>
<p>Disable usage of http2 for S3 backends.</p>
<p>There is currently an unsolved issue with the s3 (specifically minio)
backend and HTTP/2. HTTP/2 is enabled by default for the s3 backend but
can be disabled here. When the issue is solved this flag will be
removed.</p>
<p>See: https://github.com/rclone/rclone/issues/4673,
https://github.com/rclone/rclone/issues/3631</p>
<p>Properties:</p>
<ul>
<li>Config: disable_http2</li>
<li>Env Var: RCLONE_S3_DISABLE_HTTP2</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-download-url">--s3-download-url</h4>
<p>Custom endpoint for downloads. This is usually set to a CloudFront
CDN URL as AWS S3 offers cheaper egress for data downloaded through the
CloudFront network.</p>
<p>Properties:</p>
<ul>
<li>Config: download_url</li>
<li>Env Var: RCLONE_S3_DOWNLOAD_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-directory-markers">--s3-directory-markers</h4>
<p>Upload an empty object with a trailing slash when a new directory is
created</p>
<p>Empty folders are unsupported for bucket based remotes, this option
creates an empty object ending with "/", to persist the folder.</p>
<p>Properties:</p>
<ul>
<li>Config: directory_markers</li>
<li>Env Var: RCLONE_S3_DIRECTORY_MARKERS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-use-multipart-etag">--s3-use-multipart-etag</h4>
<p>Whether to use ETag in multipart uploads for verification</p>
<p>This should be true, false or left unset to use the default for the
provider.</p>
<p>Properties:</p>
<ul>
<li>Config: use_multipart_etag</li>
<li>Env Var: RCLONE_S3_USE_MULTIPART_ETAG</li>
<li>Type: Tristate</li>
<li>Default: unset</li>
</ul>
<h4 id="s3-use-unsigned-payload">--s3-use-unsigned-payload</h4>
<p>Whether to use an unsigned payload in PutObject</p>
<p>Rclone has to avoid the AWS SDK seeking the body when calling
PutObject. The AWS provider can add checksums in the trailer to avoid
seeking but other providers can't.</p>
<p>This should be true, false or left unset to use the default for the
provider.</p>
<p>Properties:</p>
<ul>
<li>Config: use_unsigned_payload</li>
<li>Env Var: RCLONE_S3_USE_UNSIGNED_PAYLOAD</li>
<li>Type: Tristate</li>
<li>Default: unset</li>
</ul>
<h4 id="s3-use-presigned-request">--s3-use-presigned-request</h4>
<p>Whether to use a presigned request or PutObject for single part
uploads</p>
<p>If this is false rclone will use PutObject from the AWS SDK to upload
an object.</p>
<p>Versions of rclone &lt; 1.59 use presigned requests to upload a
single part object and setting this flag to true will re-enable that
functionality. This shouldn't be necessary except in exceptional
circumstances or for testing.</p>
<p>Properties:</p>
<ul>
<li>Config: use_presigned_request</li>
<li>Env Var: RCLONE_S3_USE_PRESIGNED_REQUEST</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-versions">--s3-versions</h4>
<p>Include old versions in directory listings.</p>
<p>Properties:</p>
<ul>
<li>Config: versions</li>
<li>Env Var: RCLONE_S3_VERSIONS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-version-at">--s3-version-at</h4>
<p>Show file versions as they were at the specified time.</p>
<p>The parameter should be a date, "2006-01-02", datetime "2006-01-02
15:04:05" or a duration for that long ago, eg "100d" or "1h".</p>
<p>Note that when using this no file write operations are permitted, so
you can't upload files or delete them.</p>
<p>See <a href="https://rclone.org/docs/#time-options">the time option
docs</a> for valid formats.</p>
<p>Properties:</p>
<ul>
<li>Config: version_at</li>
<li>Env Var: RCLONE_S3_VERSION_AT</li>
<li>Type: Time</li>
<li>Default: off</li>
</ul>
<h4 id="s3-version-deleted">--s3-version-deleted</h4>
<p>Show deleted file markers when using versions.</p>
<p>This shows deleted file markers in the listing when using versions.
These will appear as 0 size files. The only operation which can be
performed on them is deletion.</p>
<p>Deleting a delete marker will reveal the previous version.</p>
<p>Deleted files will always show with a timestamp.</p>
<p>Properties:</p>
<ul>
<li>Config: version_deleted</li>
<li>Env Var: RCLONE_S3_VERSION_DELETED</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-decompress">--s3-decompress</h4>
<p>If set this will decompress gzip encoded objects.</p>
<p>It is possible to upload objects to S3 with "Content-Encoding: gzip"
set. Normally rclone will download these files as compressed
objects.</p>
<p>If this flag is set then rclone will decompress these files with
"Content-Encoding: gzip" as they are received. This means that rclone
can't check the size and hash but the file contents will be
decompressed.</p>
<p>Properties:</p>
<ul>
<li>Config: decompress</li>
<li>Env Var: RCLONE_S3_DECOMPRESS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-might-gzip">--s3-might-gzip</h4>
<p>Set this if the backend might gzip objects.</p>
<p>Normally providers will not alter objects when they are downloaded.
If an object was not uploaded with <code>Content-Encoding: gzip</code>
then it won't be set on download.</p>
<p>However some providers may gzip objects even if they weren't uploaded
with <code>Content-Encoding: gzip</code> (eg Cloudflare).</p>
<p>A symptom of this would be receiving errors like</p>
<pre><code>ERROR corrupted on transfer: sizes differ NNN vs MMM</code></pre>
<p>If you set this flag and rclone downloads an object with
Content-Encoding: gzip set and chunked transfer encoding, then rclone
will decompress the object on the fly.</p>
<p>If this is set to unset (the default) then rclone will choose
according to the provider setting what to apply, but you can override
rclone's choice here.</p>
<p>Properties:</p>
<ul>
<li>Config: might_gzip</li>
<li>Env Var: RCLONE_S3_MIGHT_GZIP</li>
<li>Type: Tristate</li>
<li>Default: unset</li>
</ul>
<h4 id="s3-use-accept-encoding-gzip">--s3-use-accept-encoding-gzip</h4>
<p>Whether to send <code>Accept-Encoding: gzip</code> header.</p>
<p>By default, rclone will append <code>Accept-Encoding: gzip</code> to
the request to download compressed objects whenever possible.</p>
<p>However some providers such as Google Cloud Storage may alter the
HTTP headers, breaking the signature of the request.</p>
<p>A symptom of this would be receiving errors like</p>
<pre><code>SignatureDoesNotMatch: The request signature we calculated does not match the signature you provided.</code></pre>
<p>In this case, you might want to try disabling this option.</p>
<p>Properties:</p>
<ul>
<li>Config: use_accept_encoding_gzip</li>
<li>Env Var: RCLONE_S3_USE_ACCEPT_ENCODING_GZIP</li>
<li>Type: Tristate</li>
<li>Default: unset</li>
</ul>
<h4 id="s3-no-system-metadata">--s3-no-system-metadata</h4>
<p>Suppress setting and reading of system metadata</p>
<p>Properties:</p>
<ul>
<li>Config: no_system_metadata</li>
<li>Env Var: RCLONE_S3_NO_SYSTEM_METADATA</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-sts-endpoint">--s3-sts-endpoint</h4>
<p>Endpoint for STS (deprecated).</p>
<p>Leave blank if using AWS to use the default endpoint for the
region.</p>
<p>Properties:</p>
<ul>
<li>Config: sts_endpoint</li>
<li>Env Var: RCLONE_S3_STS_ENDPOINT</li>
<li>Provider: AWS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-use-already-exists">--s3-use-already-exists</h4>
<p>Set if rclone should report BucketAlreadyExists errors on bucket
creation.</p>
<p>At some point during the evolution of the s3 protocol, AWS started
returning an <code>AlreadyOwnedByYou</code> error when attempting to
create a bucket that the user already owned, rather than a
<code>BucketAlreadyExists</code> error.</p>
<p>Unfortunately exactly what has been implemented by s3 clones is a
little inconsistent, some return <code>AlreadyOwnedByYou</code>, some
return <code>BucketAlreadyExists</code> and some return no error at
all.</p>
<p>This is important to rclone because it ensures the bucket exists by
creating it on quite a lot of operations (unless
<code>--s3-no-check-bucket</code> is used).</p>
<p>If rclone knows the provider can return
<code>AlreadyOwnedByYou</code> or returns no error then it can report
<code>BucketAlreadyExists</code> errors when the user attempts to create
a bucket not owned by them. Otherwise rclone ignores the
<code>BucketAlreadyExists</code> error which can lead to confusion.</p>
<p>This should be automatically set correctly for all providers rclone
knows about - please make a bug report if not.</p>
<p>Properties:</p>
<ul>
<li>Config: use_already_exists</li>
<li>Env Var: RCLONE_S3_USE_ALREADY_EXISTS</li>
<li>Type: Tristate</li>
<li>Default: unset</li>
</ul>
<h4 id="s3-use-multipart-uploads">--s3-use-multipart-uploads</h4>
<p>Set if rclone should use multipart uploads.</p>
<p>You can change this if you want to disable the use of multipart
uploads. This shouldn't be necessary in normal operation.</p>
<p>This should be automatically set correctly for all providers rclone
knows about - please make a bug report if not.</p>
<p>Properties:</p>
<ul>
<li>Config: use_multipart_uploads</li>
<li>Env Var: RCLONE_S3_USE_MULTIPART_UPLOADS</li>
<li>Type: Tristate</li>
<li>Default: unset</li>
</ul>
<h4 id="s3-use-x-id">--s3-use-x-id</h4>
<p>Set if rclone should add x-id URL parameters.</p>
<p>You can change this if you want to disable the AWS SDK from adding
x-id URL parameters.</p>
<p>This shouldn't be necessary in normal operation.</p>
<p>This should be automatically set correctly for all providers rclone
knows about - please make a bug report if not.</p>
<p>Properties:</p>
<ul>
<li>Config: use_x_id</li>
<li>Env Var: RCLONE_S3_USE_X_ID</li>
<li>Type: Tristate</li>
<li>Default: unset</li>
</ul>
<h4 id="s3-sign-accept-encoding">--s3-sign-accept-encoding</h4>
<p>Set if rclone should include Accept-Encoding as part of the
signature.</p>
<p>You can change this if you want to stop rclone including
Accept-Encoding as part of the signature.</p>
<p>This shouldn't be necessary in normal operation.</p>
<p>This should be automatically set correctly for all providers rclone
knows about - please make a bug report if not.</p>
<p>Properties:</p>
<ul>
<li>Config: sign_accept_encoding</li>
<li>Env Var: RCLONE_S3_SIGN_ACCEPT_ENCODING</li>
<li>Type: Tristate</li>
<li>Default: unset</li>
</ul>
<h4 id="s3-directory-bucket">--s3-directory-bucket</h4>
<p>Set to use AWS Directory Buckets</p>
<p>If you are using an AWS Directory Bucket then set this flag.</p>
<p>This will ensure no <code>Content-Md5</code> headers are sent and
ensure <code>ETag</code> headers are not interpreted as MD5 sums.
<code>X-Amz-Meta-Md5chksum</code> will be set on all objects whether
single or multipart uploaded.</p>
<p>This also sets <code>no_check_bucket = true</code>.</p>
<p>Note that Directory Buckets do not support:</p>
<ul>
<li>Versioning</li>
<li><code>Content-Encoding: gzip</code></li>
</ul>
<p>Rclone limitations with Directory Buckets:</p>
<ul>
<li>rclone does not support creating Directory Buckets with
<code>rclone mkdir</code></li>
<li>... or removing them with <code>rclone rmdir</code> yet</li>
<li>Directory Buckets do not appear when doing <code>rclone lsf</code>
at the top level.</li>
<li>Rclone can't remove auto created directories yet. In theory this
should work with <code>directory_markers = true</code> but it
doesn't.</li>
<li>Directories don't seem to appear in recursive (ListR) listings.</li>
</ul>
<p>Properties:</p>
<ul>
<li>Config: directory_bucket</li>
<li>Env Var: RCLONE_S3_DIRECTORY_BUCKET</li>
<li>Provider: AWS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-sdk-log-mode">--s3-sdk-log-mode</h4>
<p>Set to debug the SDK</p>
<p>This can be set to a comma separated list of the following
functions:</p>
<ul>
<li><code>Signing</code></li>
<li><code>Retries</code></li>
<li><code>Request</code></li>
<li><code>RequestWithBody</code></li>
<li><code>Response</code></li>
<li><code>ResponseWithBody</code></li>
<li><code>DeprecatedUsage</code></li>
<li><code>RequestEventMessage</code></li>
<li><code>ResponseEventMessage</code></li>
</ul>
<p>Use <code>Off</code> to disable and <code>All</code> to set all log
levels. You will need to use <code>-vv</code> to see the debug level
logs.</p>
<p>Properties:</p>
<ul>
<li>Config: sdk_log_mode</li>
<li>Env Var: RCLONE_S3_SDK_LOG_MODE</li>
<li>Type: Bits</li>
<li>Default: Off</li>
</ul>
<h4 id="s3-description">--s3-description</h4>
<p>Description of the remote.</p>
<p>Properties:</p>
<ul>
<li>Config: description</li>
<li>Env Var: RCLONE_S3_DESCRIPTION</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="metadata-3">Metadata</h3>
<p>User metadata is stored as x-amz-meta- keys. S3 metadata keys are
case insensitive and are always returned in lower case.</p>
<p>Here are the possible system metadata items for the s3 backend.</p>
<table>
<colgroup>
<col style="width: 15%" />
<col style="width: 15%" />
<col style="width: 15%" />
<col style="width: 23%" />
<col style="width: 28%" />
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
<th>Help</th>
<th>Type</th>
<th>Example</th>
<th>Read Only</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>btime</td>
<td>Time of file birth (creation) read from Last-Modified header</td>
<td>RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
<td><strong>Y</strong></td>
</tr>
<tr class="even">
<td>cache-control</td>
<td>Cache-Control header</td>
<td>string</td>
<td>no-cache</td>
<td>N</td>
</tr>
<tr class="odd">
<td>content-disposition</td>
<td>Content-Disposition header</td>
<td>string</td>
<td>inline</td>
<td>N</td>
</tr>
<tr class="even">
<td>content-encoding</td>
<td>Content-Encoding header</td>
<td>string</td>
<td>gzip</td>
<td>N</td>
</tr>
<tr class="odd">
<td>content-language</td>
<td>Content-Language header</td>
<td>string</td>
<td>en-US</td>
<td>N</td>
</tr>
<tr class="even">
<td>content-type</td>
<td>Content-Type header</td>
<td>string</td>
<td>text/plain</td>
<td>N</td>
</tr>
<tr class="odd">
<td>mtime</td>
<td>Time of last modification, read from rclone metadata</td>
<td>RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
<td>N</td>
</tr>
<tr class="even">
<td>tier</td>
<td>Tier of the object</td>
<td>string</td>
<td>GLACIER</td>
<td><strong>Y</strong></td>
</tr>
</tbody>
</table>
<p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs
for more info.</p>
<h2 id="backend-commands">Backend commands</h2>
<p>Here are the commands specific to the s3 backend.</p>
<p>Run them with</p>
<pre><code>rclone backend COMMAND remote:</code></pre>
<p>The help below will explain what arguments each command takes.</p>
<p>See the <a
href="https://rclone.org/commands/rclone_backend/">backend</a> command
for more info on how to pass options and arguments.</p>
<p>These can be run on a running backend using the rc command <a
href="https://rclone.org/rc/#backend-command">backend/command</a>.</p>
<h3 id="restore">restore</h3>
<p>Restore objects from GLACIER or INTELLIGENT-TIERING archive tier</p>
<pre><code>rclone backend restore remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command can be used to restore one or more objects from GLACIER
to normal storage or from INTELLIGENT-TIERING Archive Access / Deep
Archive Access tier to the Frequent Access tier.</p>
<p>Usage Examples:</p>
<pre><code>rclone backend restore s3:bucket/path/to/ --include /object -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY</code></pre>
<p>This flag also obeys the filters. Test first with --interactive/-i or
--dry-run flags</p>
<pre><code>rclone --interactive backend restore --include &quot;*.txt&quot; s3:bucket/path -o priority=Standard -o lifetime=1</code></pre>
<p>All the objects shown will be marked for restore, then</p>
<pre><code>rclone backend restore --include &quot;*.txt&quot; s3:bucket/path -o priority=Standard -o lifetime=1</code></pre>
<p>It returns a list of status dictionaries with Remote and Status keys.
The Status will be OK if it was successful or an error message if
not.</p>
<pre><code>[
    {
        &quot;Status&quot;: &quot;OK&quot;,
        &quot;Remote&quot;: &quot;test.txt&quot;
    },
    {
        &quot;Status&quot;: &quot;OK&quot;,
        &quot;Remote&quot;: &quot;test/file4.txt&quot;
    }
]</code></pre>
<p>Options:</p>
<ul>
<li>"description": The optional description for the job.</li>
<li>"lifetime": Lifetime of the active copy in days, ignored for
INTELLIGENT-TIERING storage</li>
<li>"priority": Priority of restore: Standard|Expedited|Bulk</li>
</ul>
<h3 id="restore-status">restore-status</h3>
<p>Show the restore status for objects being restored from GLACIER or
INTELLIGENT-TIERING storage</p>
<pre><code>rclone backend restore-status remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command can be used to show the status for objects being
restored from GLACIER to normal storage or from INTELLIGENT-TIERING
Archive Access / Deep Archive Access tier to the Frequent Access
tier.</p>
<p>Usage Examples:</p>
<pre><code>rclone backend restore-status s3:bucket/path/to/object
rclone backend restore-status s3:bucket/path/to/directory
rclone backend restore-status -o all s3:bucket/path/to/directory</code></pre>
<p>This command does not obey the filters.</p>
<p>It returns a list of status dictionaries.</p>
<pre><code>[
    {
        &quot;Remote&quot;: &quot;file.txt&quot;,
        &quot;VersionID&quot;: null,
        &quot;RestoreStatus&quot;: {
            &quot;IsRestoreInProgress&quot;: true,
            &quot;RestoreExpiryDate&quot;: &quot;2023-09-06T12:29:19+01:00&quot;
        },
        &quot;StorageClass&quot;: &quot;GLACIER&quot;
    },
    {
        &quot;Remote&quot;: &quot;test.pdf&quot;,
        &quot;VersionID&quot;: null,
        &quot;RestoreStatus&quot;: {
            &quot;IsRestoreInProgress&quot;: false,
            &quot;RestoreExpiryDate&quot;: &quot;2023-09-06T12:29:19+01:00&quot;
        },
        &quot;StorageClass&quot;: &quot;DEEP_ARCHIVE&quot;
    },
    {
        &quot;Remote&quot;: &quot;test.gz&quot;,
        &quot;VersionID&quot;: null,
        &quot;RestoreStatus&quot;: {
            &quot;IsRestoreInProgress&quot;: true,
            &quot;RestoreExpiryDate&quot;: &quot;null&quot;
        },
        &quot;StorageClass&quot;: &quot;INTELLIGENT_TIERING&quot;
    }
]</code></pre>
<p>Options:</p>
<ul>
<li>"all": if set then show all objects, not just ones with restore
status</li>
</ul>
<h3 id="list-multipart-uploads">list-multipart-uploads</h3>
<p>List the unfinished multipart uploads</p>
<pre><code>rclone backend list-multipart-uploads remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command lists the unfinished multipart uploads in JSON
format.</p>
<pre><code>rclone backend list-multipart s3:bucket/path/to/object</code></pre>
<p>It returns a dictionary of buckets with values as lists of unfinished
multipart uploads.</p>
<p>You can call it with no bucket in which case it lists all bucket,
with a bucket or with a bucket and path.</p>
<pre><code>{
  &quot;rclone&quot;: [
    {
      &quot;Initiated&quot;: &quot;2020-06-26T14:20:36Z&quot;,
      &quot;Initiator&quot;: {
        &quot;DisplayName&quot;: &quot;XXX&quot;,
        &quot;ID&quot;: &quot;arn:aws:iam::XXX:user/XXX&quot;
      },
      &quot;Key&quot;: &quot;KEY&quot;,
      &quot;Owner&quot;: {
        &quot;DisplayName&quot;: null,
        &quot;ID&quot;: &quot;XXX&quot;
      },
      &quot;StorageClass&quot;: &quot;STANDARD&quot;,
      &quot;UploadId&quot;: &quot;XXX&quot;
    }
  ],
  &quot;rclone-1000files&quot;: [],
  &quot;rclone-dst&quot;: []
}</code></pre>
<h3 id="cleanup-2">cleanup</h3>
<p>Remove unfinished multipart uploads.</p>
<pre><code>rclone backend cleanup remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command removes unfinished multipart uploads of age greater than
max-age which defaults to 24 hours.</p>
<p>Note that you can use --interactive/-i or --dry-run with this command
to see what it would do.</p>
<pre><code>rclone backend cleanup s3:bucket/path/to/object
rclone backend cleanup -o max-age=7w s3:bucket/path/to/object</code></pre>
<p>Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.</p>
<p>Options:</p>
<ul>
<li>"max-age": Max age of upload to delete</li>
</ul>
<h3 id="cleanup-hidden">cleanup-hidden</h3>
<p>Remove old versions of files.</p>
<pre><code>rclone backend cleanup-hidden remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command removes any old hidden versions of files on a versions
enabled bucket.</p>
<p>Note that you can use --interactive/-i or --dry-run with this command
to see what it would do.</p>
<pre><code>rclone backend cleanup-hidden s3:bucket/path/to/dir</code></pre>
<h3 id="versioning">versioning</h3>
<p>Set/get versioning support for a bucket.</p>
<pre><code>rclone backend versioning remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command sets versioning support if a parameter is passed and
then returns the current versioning status for the bucket supplied.</p>
<pre><code>rclone backend versioning s3:bucket # read status only
rclone backend versioning s3:bucket Enabled
rclone backend versioning s3:bucket Suspended</code></pre>
<p>It may return "Enabled", "Suspended" or "Unversioned". Note that once
versioning has been enabled the status can't be set back to
"Unversioned".</p>
<h3 id="set">set</h3>
<p>Set command for updating the config parameters.</p>
<pre><code>rclone backend set remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This set command can be used to update the config parameters for a
running s3 backend.</p>
<p>Usage Examples:</p>
<pre><code>rclone backend set s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
rclone rc backend/command command=set fs=s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
rclone rc backend/command command=set fs=s3: -o session_token=X -o access_key_id=X -o secret_access_key=X</code></pre>
<p>The option keys are named as they are in the config file.</p>
<p>This rebuilds the connection to the s3 backend when it is called with
the new parameters. Only new parameters need be passed as the values
will default to those currently in use.</p>
<p>It doesn't return anything.</p>
<h3 id="anonymous-access">Anonymous access to public buckets</h3>
<p>If you want to use rclone to access a public bucket, configure with a
blank <code>access_key_id</code> and <code>secret_access_key</code>.
Your config should end up looking like this:</p>
<pre><code>[anons3]
type = s3
provider = AWS</code></pre>
<p>Then use it as normal with the name of the public bucket, e.g.</p>
<pre><code>rclone lsd anons3:1000genomes</code></pre>
<p>You will be able to list and copy data but not upload it.</p>
<p>You can also do this entirely on the command line</p>
<pre><code>rclone lsd :s3,provider=AWS:1000genomes</code></pre>
<h2 id="providers-1">Providers</h2>
<h3 id="aws-s3">AWS S3</h3>
<p>This is the provider used as main example and described in the <a
href="#configuration">configuration</a> section above.</p>
<h3 id="aws-directory-buckets">AWS Directory Buckets</h3>
<p>From rclone v1.69 <a
href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory
Buckets</a> are supported.</p>
<p>You will need to set the <code>directory_buckets = true</code> config
parameter or use <code>--s3-directory-buckets</code>.</p>
<p>Note that rclone cannot yet:</p>
<ul>
<li>Create directory buckets</li>
<li>List directory buckets</li>
</ul>
<p>See <a href="#s3-directory-buckets">the --s3-directory-buckets
flag</a> for more info</p>
<h3 id="aws-snowball-edge">AWS Snowball Edge</h3>
<p><a href="https://aws.amazon.com/snowball/">AWS Snowball</a> is a
hardware appliance used for transferring bulk data back to AWS. Its main
software interface is S3 object storage.</p>
<p>To use rclone with AWS Snowball Edge devices, configure as standard
for an 'S3 Compatible Service'.</p>
<p>If using rclone pre v1.59 be sure to set
<code>upload_cutoff = 0</code> otherwise you will run into
authentication header issues as the snowball device does not support
query parameter based authentication.</p>
<p>With rclone v1.59 or later setting <code>upload_cutoff</code> should
not be necessary.</p>
<p>eg.</p>
<pre><code>[snowball]
type = s3
provider = Other
access_key_id = YOUR_ACCESS_KEY
secret_access_key = YOUR_SECRET_KEY
endpoint = http://[IP of Snowball]:8080
upload_cutoff = 0</code></pre>
<h3 id="alibaba-oss">Alibaba OSS</h3>
<p>Here is an example of making an <a
href="https://www.alibabacloud.com/product/oss/">Alibaba Cloud (Aliyun)
OSS</a> configuration. First run:</p>
<div class="sourceCode" id="cb963"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb963-1"><a href="#cb963-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; oss
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ &quot;s3&quot;
[snip]
Storage&gt; s3
Choose your S3 provider.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Amazon Web Services (AWS) S3
   \ &quot;AWS&quot;
 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun
   \ &quot;Alibaba&quot;
 3 / Ceph Object Storage
   \ &quot;Ceph&quot;
[snip]
provider&gt; Alibaba
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Enter a boolean value (true or false). Press Enter for the default (&quot;false&quot;).
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
access_key_id&gt; accesskeyid
AWS Secret Access Key (password)
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
secret_access_key&gt; secretaccesskey
Endpoint for OSS API.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / East China 1 (Hangzhou)
   \ &quot;oss-cn-hangzhou.aliyuncs.com&quot;
 2 / East China 2 (Shanghai)
   \ &quot;oss-cn-shanghai.aliyuncs.com&quot;
 3 / North China 1 (Qingdao)
   \ &quot;oss-cn-qingdao.aliyuncs.com&quot;
[snip]
endpoint&gt; 1
Canned ACL used when creating buckets and storing or copying objects.

Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Owner gets FULL_CONTROL. No one else has access rights (default).
   \ &quot;private&quot;
 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access.
   \ &quot;public-read&quot;
   / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.
[snip]
acl&gt; 1
The storage class to use when storing new objects in OSS.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Default
   \ &quot;&quot;
 2 / Standard storage class
   \ &quot;STANDARD&quot;
 3 / Archive storage mode.
   \ &quot;GLACIER&quot;
 4 / Infrequent access storage mode.
   \ &quot;STANDARD_IA&quot;
storage_class&gt; 1
Edit advanced config? (y/n)
y) Yes
n) No
y/n&gt; n
Remote config
--------------------
[oss]
type = s3
provider = Alibaba
env_auth = false
access_key_id = accesskeyid
secret_access_key = secretaccesskey
endpoint = oss-cn-hangzhou.aliyuncs.com
acl = private
storage_class = Standard
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<h3 id="arvan-cloud">ArvanCloud</h3>
<p><a
href="https://www.arvancloud.com/en/products/cloud-storage">ArvanCloud</a>
ArvanCloud Object Storage goes beyond the limited traditional file
storage. It gives you access to backup and archived files and allows
sharing. Files like profile image in the app, images sent by users or
scanned documents can be stored securely and easily in our Object
Storage service.</p>
<p>ArvanCloud provides an S3 interface which can be configured for use
with rclone like this.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
n/s&gt; n
name&gt; ArvanCloud
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, ArvanCloud, Liara, Minio)
   \ &quot;s3&quot;
[snip]
Storage&gt; s3
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID - leave blank for anonymous access or runtime credentials.
access_key_id&gt; YOURACCESSKEY
AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
secret_access_key&gt; YOURSECRETACCESSKEY
Region to connect to.
Choose a number from below, or type in your own value
   / The default endpoint - a good choice if you are unsure.
 1 | US Region, Northern Virginia, or Pacific Northwest.
   | Leave location constraint empty.
   \ &quot;us-east-1&quot;
[snip]
region&gt; 
Endpoint for S3 API.
Leave blank if using ArvanCloud to use the default endpoint for the region.
Specify if using an S3 clone such as Ceph.
endpoint&gt; s3.arvanstorage.com
Location constraint - must be set to match the Region. Used when creating buckets only.
Choose a number from below, or type in your own value
 1 / Empty for Iran-Tehran Region.
   \ &quot;&quot;
[snip]
location_constraint&gt;
Canned ACL used when creating buckets and/or storing objects in S3.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Choose a number from below, or type in your own value
 1 / Owner gets FULL_CONTROL. No one else has access rights (default).
   \ &quot;private&quot;
[snip]
acl&gt;
The server-side encryption algorithm used when storing this object in S3.
Choose a number from below, or type in your own value
 1 / None
   \ &quot;&quot;
 2 / AES256
   \ &quot;AES256&quot;
server_side_encryption&gt;
The storage class to use when storing objects in S3.
Choose a number from below, or type in your own value
 1 / Default
   \ &quot;&quot;
 2 / Standard storage class
   \ &quot;STANDARD&quot;
storage_class&gt;
Remote config
--------------------
[ArvanCloud]
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region = ir-thr-at1
endpoint = s3.arvanstorage.com
location_constraint =
acl =
server_side_encryption =
storage_class =
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This will leave the config file looking like this.</p>
<pre><code>[ArvanCloud]
type = s3
provider = ArvanCloud
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region =
endpoint = s3.arvanstorage.com
location_constraint =
acl =
server_side_encryption =
storage_class =</code></pre>
<h3 id="ceph">Ceph</h3>
<p><a href="https://ceph.com/">Ceph</a> is an open-source, unified,
distributed storage system designed for excellent performance,
reliability and scalability. It has an S3 compatible object storage
interface.</p>
<p>To use rclone with Ceph, configure as above but leave the region
blank and set the endpoint. You should end up with something like this
in your config:</p>
<pre><code>[ceph]
type = s3
provider = Ceph
env_auth = false
access_key_id = XXX
secret_access_key = YYY
region =
endpoint = https://ceph.endpoint.example.com
location_constraint =
acl =
server_side_encryption =
storage_class =</code></pre>
<p>If you are using an older version of CEPH (e.g. 10.2.x Jewel) and a
version of rclone before v1.59 then you may need to supply the parameter
<code>--s3-upload-cutoff 0</code> or put this in the config file as
<code>upload_cutoff 0</code> to work around a bug which causes uploading
of small files to fail.</p>
<p>Note also that Ceph sometimes puts <code>/</code> in the passwords it
gives users. If you read the secret access key using the command line
tools you will get a JSON blob with the <code>/</code> escaped as
<code>\/</code>. Make sure you only write <code>/</code> in the secret
access key.</p>
<p>Eg the dump from Ceph looks something like this (irrelevant keys
removed).</p>
<pre><code>{
    &quot;user_id&quot;: &quot;xxx&quot;,
    &quot;display_name&quot;: &quot;xxxx&quot;,
    &quot;keys&quot;: [
        {
            &quot;user&quot;: &quot;xxx&quot;,
            &quot;access_key&quot;: &quot;xxxxxx&quot;,
            &quot;secret_key&quot;: &quot;xxxxxx\/xxxx&quot;
        }
    ],
}</code></pre>
<p>Because this is a json dump, it is encoding the <code>/</code> as
<code>\/</code>, so if you use the secret key as
<code>xxxxxx/xxxx</code> it will work fine.</p>
<h3 id="china-mobile-ecloud-eos">China Mobile Ecloud Elastic Object
Storage (EOS)</h3>
<p>Here is an example of making an <a
href="https:///ecloud.10086.cn/home/product-introduction/eos/">China
Mobile Ecloud Elastic Object Storage (EOS)</a> configuration. First
run:</p>
<div class="sourceCode" id="cb969"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb969-1"><a href="#cb969-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; ChinaMobile
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
 ...
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
 ...
Storage&gt; s3
Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 ...
 4 / China Mobile Ecloud Elastic Object Storage (EOS)
   \ (ChinaMobile)
 ...
provider&gt; ChinaMobile
Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt;
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; accesskeyid
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; secretaccesskey
Option endpoint.
Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / The default endpoint - a good choice if you are unsure.
 1 | East China (Suzhou)
   \ (eos-wuxi-1.cmecloud.cn)
 2 / East China (Jinan)
   \ (eos-jinan-1.cmecloud.cn)
 3 / East China (Hangzhou)
   \ (eos-ningbo-1.cmecloud.cn)
 4 / East China (Shanghai-1)
   \ (eos-shanghai-1.cmecloud.cn)
 5 / Central China (Zhengzhou)
   \ (eos-zhengzhou-1.cmecloud.cn)
 6 / Central China (Changsha-1)
   \ (eos-hunan-1.cmecloud.cn)
 7 / Central China (Changsha-2)
   \ (eos-zhuzhou-1.cmecloud.cn)
 8 / South China (Guangzhou-2)
   \ (eos-guangzhou-1.cmecloud.cn)
 9 / South China (Guangzhou-3)
   \ (eos-dongguan-1.cmecloud.cn)
10 / North China (Beijing-1)
   \ (eos-beijing-1.cmecloud.cn)
11 / North China (Beijing-2)
   \ (eos-beijing-2.cmecloud.cn)
12 / North China (Beijing-3)
   \ (eos-beijing-4.cmecloud.cn)
13 / North China (Huhehaote)
   \ (eos-huhehaote-1.cmecloud.cn)
14 / Southwest China (Chengdu)
   \ (eos-chengdu-1.cmecloud.cn)
15 / Southwest China (Chongqing)
   \ (eos-chongqing-1.cmecloud.cn)
16 / Southwest China (Guiyang)
   \ (eos-guiyang-1.cmecloud.cn)
17 / Nouthwest China (Xian)
   \ (eos-xian-1.cmecloud.cn)
18 / Yunnan China (Kunming)
   \ (eos-yunnan.cmecloud.cn)
19 / Yunnan China (Kunming-2)
   \ (eos-yunnan-2.cmecloud.cn)
20 / Tianjin China (Tianjin)
   \ (eos-tianjin-1.cmecloud.cn)
21 / Jilin China (Changchun)
   \ (eos-jilin-1.cmecloud.cn)
22 / Hubei China (Xiangyan)
   \ (eos-hubei-1.cmecloud.cn)
23 / Jiangxi China (Nanchang)
   \ (eos-jiangxi-1.cmecloud.cn)
24 / Gansu China (Lanzhou)
   \ (eos-gansu-1.cmecloud.cn)
25 / Shanxi China (Taiyuan)
   \ (eos-shanxi-1.cmecloud.cn)
26 / Liaoning China (Shenyang)
   \ (eos-liaoning-1.cmecloud.cn)
27 / Hebei China (Shijiazhuang)
   \ (eos-hebei-1.cmecloud.cn)
28 / Fujian China (Xiamen)
   \ (eos-fujian-1.cmecloud.cn)
29 / Guangxi China (Nanning)
   \ (eos-guangxi-1.cmecloud.cn)
30 / Anhui China (Huainan)
   \ (eos-anhui-1.cmecloud.cn)
endpoint&gt; 1
Option location_constraint.
Location constraint - must match endpoint.
Used when creating buckets only.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / East China (Suzhou)
   \ (wuxi1)
 2 / East China (Jinan)
   \ (jinan1)
 3 / East China (Hangzhou)
   \ (ningbo1)
 4 / East China (Shanghai-1)
   \ (shanghai1)
 5 / Central China (Zhengzhou)
   \ (zhengzhou1)
 6 / Central China (Changsha-1)
   \ (hunan1)
 7 / Central China (Changsha-2)
   \ (zhuzhou1)
 8 / South China (Guangzhou-2)
   \ (guangzhou1)
 9 / South China (Guangzhou-3)
   \ (dongguan1)
10 / North China (Beijing-1)
   \ (beijing1)
11 / North China (Beijing-2)
   \ (beijing2)
12 / North China (Beijing-3)
   \ (beijing4)
13 / North China (Huhehaote)
   \ (huhehaote1)
14 / Southwest China (Chengdu)
   \ (chengdu1)
15 / Southwest China (Chongqing)
   \ (chongqing1)
16 / Southwest China (Guiyang)
   \ (guiyang1)
17 / Nouthwest China (Xian)
   \ (xian1)
18 / Yunnan China (Kunming)
   \ (yunnan)
19 / Yunnan China (Kunming-2)
   \ (yunnan2)
20 / Tianjin China (Tianjin)
   \ (tianjin1)
21 / Jilin China (Changchun)
   \ (jilin1)
22 / Hubei China (Xiangyan)
   \ (hubei1)
23 / Jiangxi China (Nanchang)
   \ (jiangxi1)
24 / Gansu China (Lanzhou)
   \ (gansu1)
25 / Shanxi China (Taiyuan)
   \ (shanxi1)
26 / Liaoning China (Shenyang)
   \ (liaoning1)
27 / Hebei China (Shijiazhuang)
   \ (hebei1)
28 / Fujian China (Xiamen)
   \ (fujian1)
29 / Guangxi China (Nanning)
   \ (guangxi1)
30 / Anhui China (Huainan)
   \ (anhui1)
location_constraint&gt; 1
Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
   / Owner gets FULL_CONTROL.
 3 | The AllUsers group gets READ and WRITE access.
   | Granting this on a bucket is generally not recommended.
   \ (public-read-write)
   / Owner gets FULL_CONTROL.
 4 | The AuthenticatedUsers group gets READ access.
   \ (authenticated-read)
   / Object owner gets FULL_CONTROL.
acl&gt; private
Option server_side_encryption.
The server-side encryption algorithm used when storing this object in S3.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / None
   \ ()
 2 / AES256
   \ (AES256)
server_side_encryption&gt;
Option storage_class.
The storage class to use when storing new objects in ChinaMobile.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Default
   \ ()
 2 / Standard storage class
   \ (STANDARD)
 3 / Archive storage mode
   \ (GLACIER)
 4 / Infrequent access storage mode
   \ (STANDARD_IA)
storage_class&gt;
Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n
--------------------
[ChinaMobile]
type = s3
provider = ChinaMobile
access_key_id = accesskeyid
secret_access_key = secretaccesskey
endpoint = eos-wuxi-1.cmecloud.cn
location_constraint = wuxi1
acl = private
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<h3 id="cloudflare-r2">Cloudflare R2</h3>
<p><a href="https://blog.cloudflare.com/r2-open-beta/">Cloudflare R2</a>
Storage allows developers to store large amounts of unstructured data
without the costly egress bandwidth fees associated with typical cloud
storage services.</p>
<p>Here is an example of making a Cloudflare R2 configuration. First
run:</p>
<div class="sourceCode" id="cb971"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb971-1"><a href="#cb971-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process.</p>
<p>Note that all buckets are private, and all are stored in the same
"auto" region. It is necessary to use Cloudflare workers to share the
content of a bucket publicly.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; r2
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
...
XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Magalu, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Synology, Tencent COS and Wasabi
   \ (s3)
...
Storage&gt; s3
Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
...
XX / Cloudflare R2 Storage
   \ (Cloudflare)
...
provider&gt; Cloudflare
Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; 1
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; ACCESS_KEY
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; SECRET_ACCESS_KEY
Option region.
Region to connect to.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / R2 buckets are automatically distributed across Cloudflare&#39;s data centers for low latency.
   \ (auto)
region&gt; 1
Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Enter a value. Press Enter to leave empty.
endpoint&gt; https://ACCOUNT_ID.r2.cloudflarestorage.com
Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This will leave your config looking something like:</p>
<pre><code>[r2]
type = s3
provider = Cloudflare
access_key_id = ACCESS_KEY
secret_access_key = SECRET_ACCESS_KEY
region = auto
endpoint = https://ACCOUNT_ID.r2.cloudflarestorage.com
acl = private</code></pre>
<p>Now run <code>rclone lsf r2:</code> to see your buckets and
<code>rclone lsf r2:bucket</code> to look within a bucket.</p>
<p>For R2 tokens with the "Object Read &amp; Write" permission, you may
also need to add <code>no_check_bucket = true</code> for object uploads
to work correctly.</p>
<p>Note that Cloudflare decompresses files uploaded with
<code>Content-Encoding: gzip</code> by default which is a deviation from
what AWS does. If this is causing a problem then upload the files with
<code>--header-upload "Cache-Control: no-transform"</code></p>
<p>A consequence of this is that <code>Content-Encoding: gzip</code>
will never appear in the metadata on Cloudflare.</p>
<h3 id="digitalocean-spaces">DigitalOcean Spaces</h3>
<p><a
href="https://www.digitalocean.com/products/object-storage/">Spaces</a>
is an <a
href="https://developers.digitalocean.com/documentation/spaces/">S3-interoperable</a>
object storage service from cloud provider DigitalOcean.</p>
<p>To connect to DigitalOcean Spaces you will need an access key and
secret key. These can be retrieved on the "<a
href="https://cloud.digitalocean.com/settings/api/tokens">Applications
&amp; API</a>" page of the DigitalOcean control panel. They will be
needed when prompted by <code>rclone config</code> for your
<code>access_key_id</code> and <code>secret_access_key</code>.</p>
<p>When prompted for a <code>region</code> or
<code>location_constraint</code>, press enter to use the default value.
The region must be included in the <code>endpoint</code> setting (e.g.
<code>nyc3.digitaloceanspaces.com</code>). The default values can be
used for other settings.</p>
<p>Going through the whole process of creating a new remote by running
<code>rclone config</code>, each prompt should be answered as shown
below:</p>
<pre><code>Storage&gt; s3
env_auth&gt; 1
access_key_id&gt; YOUR_ACCESS_KEY
secret_access_key&gt; YOUR_SECRET_KEY
region&gt;
endpoint&gt; nyc3.digitaloceanspaces.com
location_constraint&gt;
acl&gt;
storage_class&gt;</code></pre>
<p>The resulting configuration file should look like:</p>
<pre><code>[spaces]
type = s3
provider = DigitalOcean
env_auth = false
access_key_id = YOUR_ACCESS_KEY
secret_access_key = YOUR_SECRET_KEY
region =
endpoint = nyc3.digitaloceanspaces.com
location_constraint =
acl =
server_side_encryption =
storage_class =</code></pre>
<p>Once configured, you can create a new Space and begin copying files.
For example:</p>
<pre><code>rclone mkdir spaces:my-new-space
rclone copy /path/to/files spaces:my-new-space</code></pre>
<h3 id="dreamhost">Dreamhost</h3>
<p>Dreamhost <a
href="https://www.dreamhost.com/cloud/storage/">DreamObjects</a> is an
object storage system based on CEPH.</p>
<p>To use rclone with Dreamhost, configure as above but leave the region
blank and set the endpoint. You should end up with something like this
in your config:</p>
<pre><code>[dreamobjects]
type = s3
provider = DreamHost
env_auth = false
access_key_id = your_access_key
secret_access_key = your_secret_key
region =
endpoint = objects-us-west-1.dream.io
location_constraint =
acl = private
server_side_encryption =
storage_class =</code></pre>
<h3 id="exaba">Exaba</h3>
<p><a href="https://exaba.com/">Exaba</a> is an on-premises,
S3-compatible storage for service providers and large enterprises. It is
quick to deploy, with dynamic node management, tenant accounting, and a
built-in key management system. It delivers secure, high-performance
data storage with flexible, usage-based pricing.</p>
<p>A container version <a
href="https://hub.docker.com/r/exaba/exaba">exaba/exaba</a> is free for
end-users and on that page you can find instructions on how to set it
up. You will need to log into the admin first (on port 9006 by default)
to set up the container, then you can use the service on port 9000.</p>
<p>You can also join the <a
href="https://join.slack.com/t/exabasupport/shared_invite/zt-3b5jycjs3-0gDNyv60xKsAdNgjX72amQ">exaba
support slack</a> if you need more help.</p>
<p>An <code>rclone config</code> walkthrough might look like this but
details may vary depending exactly on how you have set up the
container.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n

Enter name for new remote.
name&gt; exaba

Option Storage.
Type of storage to configure.
Storage&gt; s3

Option provider.
Choose your S3 provider.
provider&gt; Exaba

Option env_auth.
env_auth&gt; 1

Option access_key_id.
access_key_id&gt; XXX

Option secret_access_key.
secret_access_key&gt; YYY

Option region.
region&gt;

Option endpoint.
endpoint&gt; http://127.0.0.1:9000/

Option location_constraint.
location_constraint&gt;

Option acl.
acl&gt;

Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n</code></pre>
<p>And the config generated will end up looking like this:</p>
<pre><code>[exaba]
type = s3
provider = Exaba
access_key_id = XXX
secret_access_key = XXX
endpoint = http://127.0.0.1:9000/</code></pre>
<h3 id="google-cloud-storage">Google Cloud Storage</h3>
<p><a
href="https://cloud.google.com/storage/docs">GoogleCloudStorage</a> is
an <a
href="https://cloud.google.com/storage/docs/interoperability">S3-interoperable</a>
object storage service from Google Cloud Platform.</p>
<p>To connect to Google Cloud Storage you will need an access key and
secret key. These can be retrieved by creating an <a
href="https://cloud.google.com/storage/docs/authentication/managing-hmackeys">HMAC
key</a>.</p>
<pre><code>[gs]
type = s3
provider = GCS
access_key_id = your_access_key
secret_access_key = your_secret_key
endpoint = https://storage.googleapis.com</code></pre>
<p><strong>Note</strong> that <code>--s3-versions</code> does not work
with GCS when it needs to do directory paging. Rclone will return the
error:</p>
<pre><code>s3 protocol error: received versions listing with IsTruncated set with no NextKeyMarker</code></pre>
<p>This is Google bug <a
href="https://issuetracker.google.com/u/0/issues/312292516">#312292516</a>.</p>
<h3 id="huawei-obs">Huawei OBS</h3>
<p>Object Storage Service (OBS) provides stable, secure, efficient, and
easy-to-use cloud storage that lets you store virtually any volume of
unstructured data in any format and access it from anywhere.</p>
<p>OBS provides an S3 interface, you can copy and modify the following
configuration and add it to your rclone configuration file.</p>
<pre><code>[obs]
type = s3
provider = HuaweiOBS
access_key_id = your-access-key-id
secret_access_key = your-secret-access-key
region = af-south-1
endpoint = obs.af-south-1.myhuaweicloud.com
acl = private</code></pre>
<p>Or you can also configure via the interactive command line:</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; obs
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage&gt; s3
Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
 9 / Huawei Object Storage Service
   \ (HuaweiOBS)
[snip]
provider&gt; 9
Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; 1
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; your-access-key-id
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; your-secret-access-key
Option region.
Region to connect to.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / AF-Johannesburg
   \ (af-south-1)
 2 / AP-Bangkok
   \ (ap-southeast-2)
[snip]
region&gt; 1
Option endpoint.
Endpoint for OBS API.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / AF-Johannesburg
   \ (obs.af-south-1.myhuaweicloud.com)
 2 / AP-Bangkok
   \ (obs.ap-southeast-2.myhuaweicloud.com)
[snip]
endpoint&gt; 1
Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
[snip]
acl&gt; 1
Edit advanced config?
y) Yes
n) No (default)
y/n&gt;
--------------------
[obs]
type = s3
provider = HuaweiOBS
access_key_id = your-access-key-id
secret_access_key = your-secret-access-key
region = af-south-1
endpoint = obs.af-south-1.myhuaweicloud.com
acl = private
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y
Current remotes:

Name                 Type
====                 ====
obs                  s3

e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; q</code></pre>
<h3 id="ibm-cos-s3">IBM COS (S3)</h3>
<p>Information stored with IBM Cloud Object Storage is encrypted and
dispersed across multiple geographic locations, and accessed through an
implementation of the S3 API. This service makes use of the distributed
storage technologies provided by IBM’s Cloud Object Storage System
(formerly Cleversafe). For more information visit:
(http://www.ibm.com/cloud/object-storage)</p>
<p>To configure access to IBM COS S3, follow the steps below:</p>
<ol type="1">
<li>Run rclone config and select n for a new remote.</li>
</ol>
<pre><code>    2018/02/14 14:13:11 NOTICE: Config file &quot;C:\\Users\\a\\.config\\rclone\\rclone.conf&quot; not found - using defaults
    No remotes found, make a new one?
    n) New remote
    s) Set configuration password
    q) Quit config
    n/s/q&gt; n</code></pre>
<ol start="2" type="1">
<li>Enter the name for the configuration</li>
</ol>
<pre><code>    name&gt; &lt;YOUR NAME&gt;</code></pre>
<ol start="3" type="1">
<li>Select "s3" storage.</li>
</ol>
<pre><code>Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ &quot;s3&quot;
[snip]
Storage&gt; s3</code></pre>
<ol start="4" type="1">
<li>Select IBM COS as the S3 Storage Provider.</li>
</ol>
<pre><code>Choose the S3 provider.
Choose a number from below, or type in your own value
     1 / Choose this option to configure Storage to AWS S3
       \ &quot;AWS&quot;
     2 / Choose this option to configure Storage to Ceph Systems
     \ &quot;Ceph&quot;
     3 /  Choose this option to configure Storage to Dreamhost
     \ &quot;Dreamhost&quot;
   4 / Choose this option to the configure Storage to IBM COS S3
     \ &quot;IBMCOS&quot;
     5 / Choose this option to the configure Storage to Minio
     \ &quot;Minio&quot;
     Provider&gt;4</code></pre>
<ol start="5" type="1">
<li>Enter the Access Key and Secret.</li>
</ol>
<pre><code>    AWS Access Key ID - leave blank for anonymous access or runtime credentials.
    access_key_id&gt; &lt;&gt;
    AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
    secret_access_key&gt; &lt;&gt;</code></pre>
<ol start="6" type="1">
<li>Specify the endpoint for IBM COS. For Public IBM COS, choose from
the option below. For On Premise IBM COS, enter an endpoint
address.</li>
</ol>
<pre><code>    Endpoint for IBM COS S3 API.
    Specify if using an IBM COS On Premise.
    Choose a number from below, or type in your own value
     1 / US Cross Region Endpoint
       \ &quot;s3-api.us-geo.objectstorage.softlayer.net&quot;
     2 / US Cross Region Dallas Endpoint
       \ &quot;s3-api.dal.us-geo.objectstorage.softlayer.net&quot;
     3 / US Cross Region Washington DC Endpoint
       \ &quot;s3-api.wdc-us-geo.objectstorage.softlayer.net&quot;
     4 / US Cross Region San Jose Endpoint
       \ &quot;s3-api.sjc-us-geo.objectstorage.softlayer.net&quot;
     5 / US Cross Region Private Endpoint
       \ &quot;s3-api.us-geo.objectstorage.service.networklayer.com&quot;
     6 / US Cross Region Dallas Private Endpoint
       \ &quot;s3-api.dal-us-geo.objectstorage.service.networklayer.com&quot;
     7 / US Cross Region Washington DC Private Endpoint
       \ &quot;s3-api.wdc-us-geo.objectstorage.service.networklayer.com&quot;
     8 / US Cross Region San Jose Private Endpoint
       \ &quot;s3-api.sjc-us-geo.objectstorage.service.networklayer.com&quot;
     9 / US Region East Endpoint
       \ &quot;s3.us-east.objectstorage.softlayer.net&quot;
    10 / US Region East Private Endpoint
       \ &quot;s3.us-east.objectstorage.service.networklayer.com&quot;
    11 / US Region South Endpoint
[snip]
    34 / Toronto Single Site Private Endpoint
       \ &quot;s3.tor01.objectstorage.service.networklayer.com&quot;
    endpoint&gt;1</code></pre>
<ol start="7" type="1">
<li>Specify a IBM COS Location Constraint. The location constraint must
match endpoint when using IBM Cloud Public. For on-prem COS, do not make
a selection from this list, hit enter</li>
</ol>
<pre><code>     1 / US Cross Region Standard
       \ &quot;us-standard&quot;
     2 / US Cross Region Vault
       \ &quot;us-vault&quot;
     3 / US Cross Region Cold
       \ &quot;us-cold&quot;
     4 / US Cross Region Flex
       \ &quot;us-flex&quot;
     5 / US East Region Standard
       \ &quot;us-east-standard&quot;
     6 / US East Region Vault
       \ &quot;us-east-vault&quot;
     7 / US East Region Cold
       \ &quot;us-east-cold&quot;
     8 / US East Region Flex
       \ &quot;us-east-flex&quot;
     9 / US South Region Standard
       \ &quot;us-south-standard&quot;
    10 / US South Region Vault
       \ &quot;us-south-vault&quot;
[snip]
    32 / Toronto Flex
       \ &quot;tor01-flex&quot;
location_constraint&gt;1</code></pre>
<ol start="8" type="1">
<li>Specify a canned ACL. IBM Cloud (Storage) supports "public-read" and
"private". IBM Cloud(Infra) supports all the canned ACLs. On-Premise COS
supports all the canned ACLs.</li>
</ol>
<pre><code>Canned ACL used when creating buckets and/or storing objects in S3.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Choose a number from below, or type in your own value
      1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS
      \ &quot;private&quot;
      2  / Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS
      \ &quot;public-read&quot;
      3 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS
      \ &quot;public-read-write&quot;
      4  / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS
      \ &quot;authenticated-read&quot;
acl&gt; 1</code></pre>
<ol start="9" type="1">
<li>Review the displayed configuration and accept to save the "remote"
then quit. The config file should look like this</li>
</ol>
<pre><code>    [xxx]
    type = s3
    Provider = IBMCOS
    access_key_id = xxx
    secret_access_key = yyy
    endpoint = s3-api.us-geo.objectstorage.softlayer.net
    location_constraint = us-standard
    acl = private</code></pre>
<ol start="10" type="1">
<li>Execute rclone commands</li>
</ol>
<pre><code>    1)  Create a bucket.
        rclone mkdir IBM-COS-XREGION:newbucket
    2)  List available buckets.
        rclone lsd IBM-COS-XREGION:
        -1 2017-11-08 21:16:22        -1 test
        -1 2018-02-14 20:16:39        -1 newbucket
    3)  List contents of a bucket.
        rclone ls IBM-COS-XREGION:newbucket
        18685952 test.exe
    4)  Copy a file from local to remote.
        rclone copy /Users/file.txt IBM-COS-XREGION:newbucket
    5)  Copy a file from remote to local.
        rclone copy IBM-COS-XREGION:newbucket/file.txt .
    6)  Delete a file on remote.
        rclone delete IBM-COS-XREGION:newbucket/file.txt</code></pre>
<h4 id="ibm-iam-authentication">IBM IAM authentication</h4>
<p>If using IBM IAM authentication with IBM API KEY you need to fill in
these additional parameters 1. Select false for env_auth 2. Leave
<code>access_key_id</code> and <code>secret_access_key</code> blank 3.
Paste your <code>ibm_api_key</code></p>
<pre><code>Option ibm_api_key.
IBM API Key to be used to obtain IAM token
Enter a value of type string. Press Enter for the default (1).
ibm_api_key&gt;</code></pre>
<ol start="4" type="1">
<li>Paste your <code>ibm_resource_instance_id</code></li>
</ol>
<pre><code>Option ibm_resource_instance_id.
IBM service instance id
Enter a value of type string. Press Enter for the default (2).
ibm_resource_instance_id&gt;</code></pre>
<ol start="5" type="1">
<li>In advanced settings type true for <code>v2_auth</code></li>
</ol>
<pre><code>Option v2_auth.
If true use v2 authentication.
If this is false (the default) then rclone will use v4 authentication.
If it is set then rclone will use v2 authentication.
Use this only if v4 signatures don&#39;t work, e.g. pre Jewel/v10 CEPH.
Enter a boolean value (true or false). Press Enter for the default (true).
v2_auth&gt;</code></pre>
<h3 id="idrive-e2">IDrive e2</h3>
<p>Here is an example of making an <a
href="https://www.idrive.com/e2/">IDrive e2</a> configuration. First
run:</p>
<div class="sourceCode" id="cb997"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb997-1"><a href="#cb997-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n

Enter name for new remote.
name&gt; e2

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage&gt; s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / IDrive e2
   \ (IDrive)
[snip]
provider&gt; IDrive

Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; 

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; YOUR_ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; YOUR_SECRET_KEY

Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
   / Owner gets FULL_CONTROL.
 3 | The AllUsers group gets READ and WRITE access.
   | Granting this on a bucket is generally not recommended.
   \ (public-read-write)
   / Owner gets FULL_CONTROL.
 4 | The AuthenticatedUsers group gets READ access.
   \ (authenticated-read)
   / Object owner gets FULL_CONTROL.
 5 | Bucket owner gets READ access.
   | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ (bucket-owner-read)
   / Both the object owner and the bucket owner get FULL_CONTROL over the object.
 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ (bucket-owner-full-control)
acl&gt; 

Edit advanced config?
y) Yes
n) No (default)
y/n&gt; 

Configuration complete.
Options:
- type: s3
- provider: IDrive
- access_key_id: YOUR_ACCESS_KEY
- secret_access_key: YOUR_SECRET_KEY
- endpoint: q9d9.la12.idrivee2-5.com
Keep this &quot;e2&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<h3 id="ionos">IONOS Cloud</h3>
<p><a href="https://cloud.ionos.com/storage/object-storage">IONOS S3
Object Storage</a> is a service offered by IONOS for storing and
accessing unstructured data. To connect to the service, you will need an
access key and a secret key. These can be found in the <a
href="https://dcd.ionos.com/">Data Center Designer</a>, by selecting
<strong>Manager resources</strong> &gt; <strong>Object Storage Key
Manager</strong>.</p>
<p>Here is an example of a configuration. First, run
<code>rclone config</code>. This will walk you through an interactive
setup process. Type <code>n</code> to add the new remote, and then enter
a name:</p>
<pre><code>Enter name for new remote.
name&gt; ionos-fra</code></pre>
<p>Type <code>s3</code> to choose the connection type:</p>
<pre><code>Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage&gt; s3</code></pre>
<p>Type <code>IONOS</code>:</p>
<pre><code>Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / IONOS Cloud
   \ (IONOS)
[snip]
provider&gt; IONOS</code></pre>
<p>Press Enter to choose the default option
<code>Enter AWS credentials in the next step</code>:</p>
<pre><code>Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt;</code></pre>
<p>Enter your Access Key and Secret key. These can be retrieved in the
<a href="https://dcd.ionos.com/">Data Center Designer</a>, click on the
menu “Manager resources” / "Object Storage Key Manager".</p>
<pre><code>Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; YOUR_ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; YOUR_SECRET_KEY</code></pre>
<p>Choose the region where your bucket is located:</p>
<pre><code>Option region.
Region where your bucket will be created and your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Frankfurt, Germany
   \ (de)
 2 / Berlin, Germany
   \ (eu-central-2)
 3 / Logrono, Spain
   \ (eu-south-2)
region&gt; 2</code></pre>
<p>Choose the endpoint from the same region:</p>
<pre><code>Option endpoint.
Endpoint for IONOS S3 Object Storage.
Specify the endpoint from the same region.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Frankfurt, Germany
   \ (s3-eu-central-1.ionoscloud.com)
 2 / Berlin, Germany
   \ (s3-eu-central-2.ionoscloud.com)
 3 / Logrono, Spain
   \ (s3-eu-south-2.ionoscloud.com)
endpoint&gt; 1</code></pre>
<p>Press Enter to choose the default option or choose the desired ACL
setting:</p>
<pre><code>Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
[snip]
acl&gt;</code></pre>
<p>Press Enter to skip the advanced config:</p>
<pre><code>Edit advanced config?
y) Yes
n) No (default)
y/n&gt;</code></pre>
<p>Press Enter to save the configuration, and then <code>q</code> to
quit the configuration process:</p>
<pre><code>Configuration complete.
Options:
- type: s3
- provider: IONOS
- access_key_id: YOUR_ACCESS_KEY
- secret_access_key: YOUR_SECRET_KEY
- endpoint: s3-eu-central-1.ionoscloud.com
Keep this &quot;ionos-fra&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>Done! Now you can try some commands (for macOS, use
<code>./rclone</code> instead of <code>rclone</code>).</p>
<ol type="1">
<li>Create a bucket (the name must be unique within the whole IONOS
S3)</li>
</ol>
<pre><code>rclone mkdir ionos-fra:my-bucket</code></pre>
<ol start="2" type="1">
<li>List available buckets</li>
</ol>
<pre><code>rclone lsd ionos-fra:</code></pre>
<ol start="4" type="1">
<li>Copy a file from local to remote</li>
</ol>
<pre><code>rclone copy /Users/file.txt ionos-fra:my-bucket</code></pre>
<ol start="3" type="1">
<li>List contents of a bucket</li>
</ol>
<pre><code>rclone ls ionos-fra:my-bucket</code></pre>
<ol start="5" type="1">
<li>Copy a file from remote to local</li>
</ol>
<pre><code>rclone copy ionos-fra:my-bucket/file.txt</code></pre>
<h3 id="leviia">Leviia Cloud Object Storage</h3>
<p><a href="https://www.leviia.com/object-storage/">Leviia Object
Storage</a>, backup and secure your data in a 100% French cloud,
independent of GAFAM..</p>
<p>To configure access to Leviia, follow the steps below:</p>
<ol type="1">
<li>Run <code>rclone config</code> and select <code>n</code> for a new
remote.</li>
</ol>
<pre><code>rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n</code></pre>
<ol start="2" type="1">
<li>Give the name of the configuration. For example, name it
'leviia'.</li>
</ol>
<pre><code>name&gt; leviia</code></pre>
<ol start="3" type="1">
<li>Select <code>s3</code> storage.</li>
</ol>
<pre><code>Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage&gt; s3</code></pre>
<ol start="4" type="1">
<li>Select <code>Leviia</code> provider.</li>
</ol>
<pre><code>Choose a number from below, or type in your own value
1 / Amazon Web Services (AWS) S3
   \ &quot;AWS&quot;
[snip]
15 / Leviia Object Storage
   \ (Leviia)
[snip]
provider&gt; Leviia</code></pre>
<ol start="5" type="1">
<li>Enter your SecretId and SecretKey of Leviia.</li>
</ol>
<pre><code>Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Enter a boolean value (true or false). Press Enter for the default (&quot;false&quot;).
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
access_key_id&gt; ZnIx.xxxxxxxxxxxxxxx
AWS Secret Access Key (password)
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
secret_access_key&gt; xxxxxxxxxxx</code></pre>
<ol start="6" type="1">
<li>Select endpoint for Leviia.</li>
</ol>
<pre><code>   / The default endpoint
 1 | Leviia.
   \ (s3.leviia.com)
[snip]
endpoint&gt; 1</code></pre>
<ol start="7" type="1">
<li>Choose acl.</li>
</ol>
<pre><code>Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
[snip]
acl&gt; 1
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n&gt; n
Remote config
--------------------
[leviia]
- type: s3
- provider: Leviia
- access_key_id: ZnIx.xxxxxxx
- secret_access_key: xxxxxxxx
- endpoint: s3.leviia.com
- acl: private
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y
Current remotes:

Name                 Type
====                 ====
leviia                s3</code></pre>
<h3 id="liara-cloud">Liara</h3>
<p>Here is an example of making a <a
href="https://liara.ir/landing/object-storage">Liara Object Storage</a>
configuration. First run:</p>
<div class="sourceCode" id="cb1021"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1021-1"><a href="#cb1021-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
n/s&gt; n
name&gt; Liara
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, ArvanCloud, Liara, Minio)
   \ &quot;s3&quot;
[snip]
Storage&gt; s3
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID - leave blank for anonymous access or runtime credentials.
access_key_id&gt; YOURACCESSKEY
AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
secret_access_key&gt; YOURSECRETACCESSKEY
Region to connect to.
Choose a number from below, or type in your own value
   / The default endpoint
 1 | US Region, Northern Virginia, or Pacific Northwest.
   | Leave location constraint empty.
   \ &quot;us-east-1&quot;
[snip]
region&gt;
Endpoint for S3 API.
Leave blank if using Liara to use the default endpoint for the region.
Specify if using an S3 clone such as Ceph.
endpoint&gt; storage.iran.liara.space
Canned ACL used when creating buckets and/or storing objects in S3.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Choose a number from below, or type in your own value
 1 / Owner gets FULL_CONTROL. No one else has access rights (default).
   \ &quot;private&quot;
[snip]
acl&gt;
The server-side encryption algorithm used when storing this object in S3.
Choose a number from below, or type in your own value
 1 / None
   \ &quot;&quot;
 2 / AES256
   \ &quot;AES256&quot;
server_side_encryption&gt;
The storage class to use when storing objects in S3.
Choose a number from below, or type in your own value
 1 / Default
   \ &quot;&quot;
 2 / Standard storage class
   \ &quot;STANDARD&quot;
storage_class&gt;
Remote config
--------------------
[Liara]
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
endpoint = storage.iran.liara.space
location_constraint =
acl =
server_side_encryption =
storage_class =
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This will leave the config file looking like this.</p>
<pre><code>[Liara]
type = s3
provider = Liara
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region =
endpoint = storage.iran.liara.space
location_constraint =
acl =
server_side_encryption =
storage_class =</code></pre>
<h3 id="linode">Linode</h3>
<p>Here is an example of making a <a
href="https://www.linode.com/products/object-storage/">Linode Object
Storage</a> configuration. First run:</p>
<div class="sourceCode" id="cb1024"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1024-1"><a href="#cb1024-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n

Enter name for new remote.
name&gt; linode

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...Linode, ...and others
   \ (s3)
[snip]
Storage&gt; s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Linode Object Storage
   \ (Linode)
[snip]
provider&gt; Linode

Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; 

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; SECRET_ACCESS_KEY

Option endpoint.
Endpoint for Linode Object Storage API.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Amsterdam (Netherlands), nl-ams-1
   \ (nl-ams-1.linodeobjects.com)
 2 / Atlanta, GA (USA), us-southeast-1
   \ (us-southeast-1.linodeobjects.com)
 3 / Chennai (India), in-maa-1
   \ (in-maa-1.linodeobjects.com)
 4 / Chicago, IL (USA), us-ord-1
   \ (us-ord-1.linodeobjects.com)
 5 / Frankfurt (Germany), eu-central-1
   \ (eu-central-1.linodeobjects.com)
 6 / Jakarta (Indonesia), id-cgk-1
   \ (id-cgk-1.linodeobjects.com)
 7 / London 2 (Great Britain), gb-lon-1
   \ (gb-lon-1.linodeobjects.com)
 8 / Los Angeles, CA (USA), us-lax-1
   \ (us-lax-1.linodeobjects.com)
 9 / Madrid (Spain), es-mad-1
   \ (es-mad-1.linodeobjects.com)
10 / Melbourne (Australia), au-mel-1
   \ (au-mel-1.linodeobjects.com)
11 / Miami, FL (USA), us-mia-1
   \ (us-mia-1.linodeobjects.com)
12 / Milan (Italy), it-mil-1
   \ (it-mil-1.linodeobjects.com)
13 / Newark, NJ (USA), us-east-1
   \ (us-east-1.linodeobjects.com)
14 / Osaka (Japan), jp-osa-1
   \ (jp-osa-1.linodeobjects.com)
15 / Paris (France), fr-par-1
   \ (fr-par-1.linodeobjects.com)
16 / São Paulo (Brazil), br-gru-1
   \ (br-gru-1.linodeobjects.com)
17 / Seattle, WA (USA), us-sea-1
   \ (us-sea-1.linodeobjects.com)
18 / Singapore, ap-south-1
   \ (ap-south-1.linodeobjects.com)
19 / Singapore 2, sg-sin-1
   \ (sg-sin-1.linodeobjects.com)
20 / Stockholm (Sweden), se-sto-1
   \ (se-sto-1.linodeobjects.com)
21 / Washington, DC, (USA), us-iad-1
   \ (us-iad-1.linodeobjects.com)
endpoint&gt; 5

Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
[snip]
acl&gt; 

Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n

Configuration complete.
Options:
- type: s3
- provider: Linode
- access_key_id: ACCESS_KEY
- secret_access_key: SECRET_ACCESS_KEY
- endpoint: eu-central-1.linodeobjects.com
Keep this &quot;linode&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This will leave the config file looking like this.</p>
<pre><code>[linode]
type = s3
provider = Linode
access_key_id = ACCESS_KEY
secret_access_key = SECRET_ACCESS_KEY
endpoint = eu-central-1.linodeobjects.com</code></pre>
<h3 id="magalu">Magalu</h3>
<p>Here is an example of making a <a
href="https://magalu.cloud/object-storage/">Magalu Object Storage</a>
configuration. First run:</p>
<div class="sourceCode" id="cb1027"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1027-1"><a href="#cb1027-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n

Enter name for new remote.
name&gt; magalu

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...Magalu, ...and others
   \ (s3)
[snip]
Storage&gt; s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Magalu Object Storage
   \ (Magalu)
[snip]
provider&gt; Magalu

Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; 1

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; SECRET_ACCESS_KEY

Option endpoint.
Endpoint for Magalu Object Storage API.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / São Paulo, SP (BR), br-se1
   \ (br-se1.magaluobjects.com)
 2 / Fortaleza, CE (BR), br-ne1
   \ (br-ne1.magaluobjects.com)
endpoint&gt; 2

Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
[snip]
acl&gt; 

Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n

Configuration complete.
Options:
- type: s3
- provider: magalu
- access_key_id: ACCESS_KEY
- secret_access_key: SECRET_ACCESS_KEY
- endpoint: br-ne1.magaluobjects.com
Keep this &quot;magalu&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This will leave the config file looking like this.</p>
<pre><code>[magalu]
type = s3
provider = Magalu
access_key_id = ACCESS_KEY
secret_access_key = SECRET_ACCESS_KEY
endpoint = br-ne1.magaluobjects.com</code></pre>
<h3 id="mega">MEGA S4</h3>
<p><a href="https://mega.io/objectstorage">MEGA S4 Object Storage</a> is
an S3 compatible object storage system. It has a single pricing tier
with no additional charges for data transfers or API requests and it is
included in existing Pro plans.</p>
<p>Here is an example of making a configuration. First run:</p>
<div class="sourceCode" id="cb1030"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1030-1"><a href="#cb1030-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n

Enter name for new remote.
name&gt; megas4

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS,... Mega, ...
   \ (s3)
[snip]
Storage&gt; s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / MEGA S4 Object Storage
   \ (Mega)
[snip]
provider&gt; Mega

Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt;

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; XXX

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; XXX

Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Mega S4 eu-central-1 (Amsterdam)
   \ (s3.eu-central-1.s4.mega.io)
 2 / Mega S4 eu-central-2 (Bettembourg)
   \ (s3.eu-central-2.s4.mega.io)
 3 / Mega S4 ca-central-1 (Montreal)
   \ (s3.ca-central-1.s4.mega.io)
 4 / Mega S4 ca-west-1 (Vancouver)
   \ (s3.ca-west-1.s4.mega.io)
endpoint&gt; 1

Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n

Configuration complete.
Options:
- type: s3
- provider: Mega
- access_key_id: XXX
- secret_access_key: XXX
- endpoint: s3.eu-central-1.s4.mega.io
Keep this &quot;megas4&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This will leave the config file looking like this.</p>
<pre><code>[megas4]
type = s3
provider = Mega
access_key_id = XXX
secret_access_key = XXX
endpoint = s3.eu-central-1.s4.mega.io</code></pre>
<h3 id="minio">Minio</h3>
<p><a href="https://minio.io/">Minio</a> is an object storage server
built for cloud application developers and devops.</p>
<p>It is very easy to install and provides an S3 compatible server which
can be used by rclone.</p>
<p>To use it, install Minio following the instructions <a
href="https://docs.minio.io/docs/minio-quickstart-guide">here</a>.</p>
<p>When it configures itself Minio will print something like this</p>
<pre><code>Endpoint:  http://192.168.1.106:9000  http://172.23.0.1:9000
AccessKey: USWUXHGYZQYFYFFIT3RE
SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
Region:    us-east-1
SQS ARNs:  arn:minio:sqs:us-east-1:1:redis arn:minio:sqs:us-east-1:2:redis

Browser Access:
   http://192.168.1.106:9000  http://172.23.0.1:9000

Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide
   $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03

Object API (Amazon S3 compatible):
   Go:         https://docs.minio.io/docs/golang-client-quickstart-guide
   Java:       https://docs.minio.io/docs/java-client-quickstart-guide
   Python:     https://docs.minio.io/docs/python-client-quickstart-guide
   JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide
   .NET:       https://docs.minio.io/docs/dotnet-client-quickstart-guide

Drive Capacity: 26 GiB Free, 165 GiB Total</code></pre>
<p>These details need to go into <code>rclone config</code> like this.
Note that it is important to put the region in as stated above.</p>
<pre><code>env_auth&gt; 1
access_key_id&gt; USWUXHGYZQYFYFFIT3RE
secret_access_key&gt; MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
region&gt; us-east-1
endpoint&gt; http://192.168.1.106:9000
location_constraint&gt;
server_side_encryption&gt;</code></pre>
<p>Which makes the config file look like this</p>
<pre><code>[minio]
type = s3
provider = Minio
env_auth = false
access_key_id = USWUXHGYZQYFYFFIT3RE
secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
region = us-east-1
endpoint = http://192.168.1.106:9000
location_constraint =
server_side_encryption =</code></pre>
<p>So once set up, for example, to copy files into a bucket</p>
<pre><code>rclone copy /path/to/files minio:bucket</code></pre>
<h3 id="netease-nos">Netease NOS</h3>
<p>For Netease NOS configure as per the configurator
<code>rclone config</code> setting the provider <code>Netease</code>.
This will automatically set <code>force_path_style = false</code> which
is necessary for it to run properly.</p>
<h3 id="outscale">Outscale</h3>
<p><a
href="https://en.outscale.com/storage/outscale-object-storage/">OUTSCALE
Object Storage (OOS)</a> is an enterprise-grade, S3-compatible storage
service provided by OUTSCALE, a brand of Dassault Systèmes. For more
information about OOS, see the <a
href="https://docs.outscale.com/en/userguide/OUTSCALE-Object-Storage-OOS.html">official
documentation</a>.</p>
<p>Here is an example of an OOS configuration that you can paste into
your rclone configuration file:</p>
<pre><code>[outscale]
type = s3
provider = Outscale
env_auth = false
access_key_id = ABCDEFGHIJ0123456789
secret_access_key = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
region = eu-west-2
endpoint = oos.eu-west-2.outscale.com
acl = private</code></pre>
<p>You can also run <code>rclone config</code> to go through the
interactive setup process:</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n</code></pre>
<pre><code>Enter name for new remote.
name&gt; outscale</code></pre>
<pre><code>Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
 X / Amazon S3 Compliant Storage Providers including AWS, ...Outscale, ...and others
   \ (s3)
[snip]
Storage&gt; outscale</code></pre>
<pre><code>Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / OUTSCALE Object Storage (OOS)
   \ (Outscale)
[snip]
provider&gt; Outscale</code></pre>
<pre><code>Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; </code></pre>
<pre><code>Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; ABCDEFGHIJ0123456789</code></pre>
<pre><code>Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</code></pre>
<pre><code>Option region.
Region where your bucket will be created and your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Paris, France
   \ (eu-west-2)
 2 / New Jersey, USA
   \ (us-east-2)
 3 / California, USA
   \ (us-west-1)
 4 / SecNumCloud, Paris, France
   \ (cloudgouv-eu-west-1)
 5 / Tokyo, Japan
   \ (ap-northeast-1)
region&gt; 1</code></pre>
<pre><code>Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Outscale EU West 2 (Paris)
   \ (oos.eu-west-2.outscale.com)
 2 / Outscale US east 2 (New Jersey)
   \ (oos.us-east-2.outscale.com)
 3 / Outscale EU West 1 (California)
   \ (oos.us-west-1.outscale.com)
 4 / Outscale SecNumCloud (Paris)
   \ (oos.cloudgouv-eu-west-1.outscale.com)
 5 / Outscale AP Northeast 1 (Japan)
   \ (oos.ap-northeast-1.outscale.com)
endpoint&gt; 1</code></pre>
<pre><code>Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
[snip]
acl&gt; 1</code></pre>
<pre><code>Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n</code></pre>
<pre><code>Configuration complete.
Options:
- type: s3
- provider: Outscale
- access_key_id: ABCDEFGHIJ0123456789
- secret_access_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
- endpoint: oos.eu-west-2.outscale.com
Keep this &quot;outscale&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<h3 id="ovhcloud">OVHcloud</h3>
<p><a
href="https://www.ovhcloud.com/en-ie/public-cloud/object-storage/">OVHcloud
Object Storage</a> is an S3-compatible general-purpose object storage
platform available in all OVHcloud regions. To use the platform, you
will need an access key and secret key. To know more about it and how to
interact with the platform, take a look at the <a
href="https://ovh.to/8stqhuo">documentation</a>.</p>
<p>Here is an example of making an OVHcloud Object Storage configuration
with <code>rclone config</code>:</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n

Enter name for new remote.
name&gt; ovhcloud-rbx

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[...]
 XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
   \ (s3)
[...]
Storage&gt; s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[...]
XX / OVHcloud Object Storage
   \ (OVHcloud)
[...]
provider&gt; OVHcloud

Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; 1

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; my_access

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; my_secret

Option region.
Region where your bucket will be created and your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Gravelines, France
   \ (gra)
 2 / Roubaix, France
   \ (rbx)
 3 / Strasbourg, France
   \ (sbg)
 4 / Paris, France (3AZ)
   \ (eu-west-par)
 5 / Frankfurt, Germany
   \ (de)
 6 / London, United Kingdom
   \ (uk)
 7 / Warsaw, Poland
   \ (waw)
 8 / Beauharnois, Canada
   \ (bhs)
 9 / Toronto, Canada
   \ (ca-east-tor)
10 / Singapore
   \ (sgp)
11 / Sydney, Australia
   \ (ap-southeast-syd)
12 / Mumbai, India
   \ (ap-south-mum)
13 / Vint Hill, Virginia, USA
   \ (us-east-va)
14 / Hillsboro, Oregon, USA
   \ (us-west-or)
15 / Roubaix, France (Cold Archive)
   \ (rbx-archive)
region&gt; 2

Option endpoint.
Endpoint for OVHcloud Object Storage.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / OVHcloud Gravelines, France
   \ (s3.gra.io.cloud.ovh.net)
 2 / OVHcloud Roubaix, France
   \ (s3.rbx.io.cloud.ovh.net)
 3 / OVHcloud Strasbourg, France
   \ (s3.sbg.io.cloud.ovh.net)
 4 / OVHcloud Paris, France (3AZ)
   \ (s3.eu-west-par.io.cloud.ovh.net)
 5 / OVHcloud Frankfurt, Germany
   \ (s3.de.io.cloud.ovh.net)
 6 / OVHcloud London, United Kingdom
   \ (s3.uk.io.cloud.ovh.net)
 7 / OVHcloud Warsaw, Poland
   \ (s3.waw.io.cloud.ovh.net)
 8 / OVHcloud Beauharnois, Canada
   \ (s3.bhs.io.cloud.ovh.net)
 9 / OVHcloud Toronto, Canada
   \ (s3.ca-east-tor.io.cloud.ovh.net)
10 / OVHcloud Singapore
   \ (s3.sgp.io.cloud.ovh.net)
11 / OVHcloud Sydney, Australia
   \ (s3.ap-southeast-syd.io.cloud.ovh.net)
12 / OVHcloud Mumbai, India
   \ (s3.ap-south-mum.io.cloud.ovh.net)
13 / OVHcloud Vint Hill, Virginia, USA
   \ (s3.us-east-va.io.cloud.ovh.us)
14 / OVHcloud Hillsboro, Oregon, USA
   \ (s3.us-west-or.io.cloud.ovh.us)
15 / OVHcloud Roubaix, France (Cold Archive)
   \ (s3.rbx-archive.io.cloud.ovh.net)
endpoint&gt; 2

Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
   / Owner gets FULL_CONTROL.
 3 | The AllUsers group gets READ and WRITE access.
   | Granting this on a bucket is generally not recommended.
   \ (public-read-write)
   / Owner gets FULL_CONTROL.
 4 | The AuthenticatedUsers group gets READ access.
   \ (authenticated-read)
   / Object owner gets FULL_CONTROL.
 5 | Bucket owner gets READ access.
   | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ (bucket-owner-read)
   / Both the object owner and the bucket owner get FULL_CONTROL over the object.
 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ (bucket-owner-full-control)
acl&gt; 1

Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n

Configuration complete.
Options:
- type: s3
- provider: OVHcloud
- access_key_id: my_access
- secret_access_key: my_secret
- region: rbx
- endpoint: s3.rbx.io.cloud.ovh.net
- acl: private
Keep this &quot;ovhcloud-rbx&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>Your configuration file should now look like this:</p>
<pre><code>[ovhcloud-rbx]
type = s3
provider = OVHcloud
access_key_id = my_access
secret_access_key = my_secret
region = rbx
endpoint = s3.rbx.io.cloud.ovh.net
acl = private</code></pre>
<h3 id="petabox">Petabox</h3>
<p>Here is an example of making a <a
href="https://petabox.io/">Petabox</a> configuration. First run:</p>
<div class="sourceCode" id="cb1052"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1052-1"><a href="#cb1052-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
n/s&gt; n

Enter name for new remote.
name&gt; My Petabox Storage

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ &quot;s3&quot;
[snip]
Storage&gt; s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Petabox Object Storage
   \ (Petabox)
[snip]
provider&gt; Petabox

Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; 1

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; YOUR_ACCESS_KEY_ID

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; YOUR_SECRET_ACCESS_KEY

Option region.
Region where your bucket will be created and your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / US East (N. Virginia)
   \ (us-east-1)
 2 / Europe (Frankfurt)
   \ (eu-central-1)
 3 / Asia Pacific (Singapore)
   \ (ap-southeast-1)
 4 / Middle East (Bahrain)
   \ (me-south-1)
 5 / South America (São Paulo)
   \ (sa-east-1)
region&gt; 1

Option endpoint.
Endpoint for Petabox S3 Object Storage.
Specify the endpoint from the same region.
Choose a number from below, or type in your own value.
 1 / US East (N. Virginia)
   \ (s3.petabox.io)
 2 / US East (N. Virginia)
   \ (s3.us-east-1.petabox.io)
 3 / Europe (Frankfurt)
   \ (s3.eu-central-1.petabox.io)
 4 / Asia Pacific (Singapore)
   \ (s3.ap-southeast-1.petabox.io)
 5 / Middle East (Bahrain)
   \ (s3.me-south-1.petabox.io)
 6 / South America (São Paulo)
   \ (s3.sa-east-1.petabox.io)
endpoint&gt; 1

Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
   / Owner gets FULL_CONTROL.
 3 | The AllUsers group gets READ and WRITE access.
   | Granting this on a bucket is generally not recommended.
   \ (public-read-write)
   / Owner gets FULL_CONTROL.
 4 | The AuthenticatedUsers group gets READ access.
   \ (authenticated-read)
   / Object owner gets FULL_CONTROL.
 5 | Bucket owner gets READ access.
   | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ (bucket-owner-read)
   / Both the object owner and the bucket owner get FULL_CONTROL over the object.
 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ (bucket-owner-full-control)
acl&gt; 1

Edit advanced config?
y) Yes
n) No (default)
y/n&gt; No

Configuration complete.
Options:
- type: s3
- provider: Petabox
- access_key_id: YOUR_ACCESS_KEY_ID
- secret_access_key: YOUR_SECRET_ACCESS_KEY
- region: us-east-1
- endpoint: s3.petabox.io
Keep this &quot;My Petabox Storage&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This will leave the config file looking like this.</p>
<pre><code>[My Petabox Storage]
type = s3
provider = Petabox
access_key_id = YOUR_ACCESS_KEY_ID
secret_access_key = YOUR_SECRET_ACCESS_KEY
region = us-east-1
endpoint = s3.petabox.io</code></pre>
<h3 id="pure-storage-flashblade">Pure Storage FlashBlade</h3>
<p><a
href="https://www.purestorage.com/products/unstructured-data-storage.html">Pure
Storage FlashBlade</a> is a high performance S3-compatible object
store.</p>
<p>FlashBlade supports most modern S3 features including:</p>
<ul>
<li>ListObjectsV2</li>
<li>Multipart uploads with AWS-compatible ETags</li>
<li>Advanced checksum algorithms (SHA256, CRC32, CRC32C) with trailer
support (Purity//FB 4.4.2+)</li>
<li>Object versioning and lifecycle management</li>
<li>Virtual hosted-style requests (requires DNS configuration)</li>
</ul>
<p>To configure rclone for Pure Storage FlashBlade:</p>
<p>First run:</p>
<div class="sourceCode" id="cb1055"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1055-1"><a href="#cb1055-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process:</p>
<pre class="text"><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n

Enter name for new remote.
name&gt; flashblade

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
   \ (s3)
[snip]
Storage&gt; s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
 9 / Pure Storage FlashBlade Object Storage
   \ (FlashBlade)
[snip]
provider&gt; FlashBlade

Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; 1

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; ACCESS_KEY_ID

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; SECRET_ACCESS_KEY

Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Enter a value. Press Enter to leave empty.
endpoint&gt; https://s3.flashblade.example.com

Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n

Configuration complete.
Options:
- type: s3
- provider: FlashBlade
- access_key_id: ACCESS_KEY_ID
- secret_access_key: SECRET_ACCESS_KEY
- endpoint: https://s3.flashblade.example.com
Keep this &quot;flashblade&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This results in the following configuration being stored in
<code>~/.config/rclone/rclone.conf</code>:</p>
<pre><code>[flashblade]
type = s3
provider = FlashBlade
access_key_id = ACCESS_KEY_ID
secret_access_key = SECRET_ACCESS_KEY
endpoint = https://s3.flashblade.example.com</code></pre>
<p>Note: The FlashBlade endpoint should be the S3 data VIP. For
virtual-hosted style requests, ensure proper DNS configuration:
subdomains of the endpoint hostname should resolve to a FlashBlade data
VIP. For example, if your endpoint is
<code>https://s3.flashblade.example.com</code>, then
<code>bucket-name.s3.flashblade.example.com</code> should also resolve
to the data VIP.</p>
<h3 id="qiniu">Qiniu Cloud Object Storage (Kodo)</h3>
<p><a href="https://www.qiniu.com/en/products/kodo">Qiniu Cloud Object
Storage (Kodo)</a>, a completely independent-researched core technology
which is proven by repeated customer experience has occupied absolute
leading market leader position. Kodo can be widely applied to mass data
management.</p>
<p>To configure access to Qiniu Kodo, follow the steps below:</p>
<ol type="1">
<li>Run <code>rclone config</code> and select <code>n</code> for a new
remote.</li>
</ol>
<pre><code>rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n</code></pre>
<ol start="2" type="1">
<li>Give the name of the configuration. For example, name it
'qiniu'.</li>
</ol>
<pre><code>name&gt; qiniu</code></pre>
<ol start="3" type="1">
<li>Select <code>s3</code> storage.</li>
</ol>
<pre><code>Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage&gt; s3</code></pre>
<ol start="4" type="1">
<li>Select <code>Qiniu</code> provider.</li>
</ol>
<pre><code>Choose a number from below, or type in your own value
1 / Amazon Web Services (AWS) S3
   \ &quot;AWS&quot;
[snip]
22 / Qiniu Object Storage (Kodo)
   \ (Qiniu)
[snip]
provider&gt; Qiniu</code></pre>
<ol start="5" type="1">
<li>Enter your SecretId and SecretKey of Qiniu Kodo.</li>
</ol>
<pre><code>Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Enter a boolean value (true or false). Press Enter for the default (&quot;false&quot;).
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
access_key_id&gt; AKIDxxxxxxxxxx
AWS Secret Access Key (password)
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
secret_access_key&gt; xxxxxxxxxxx</code></pre>
<ol start="6" type="1">
<li>Select endpoint for Qiniu Kodo. This is the standard endpoint for
different region.</li>
</ol>
<pre><code>   / The default endpoint - a good choice if you are unsure.
 1 | East China Region 1.
   | Needs location constraint cn-east-1.
   \ (cn-east-1)
   / East China Region 2.
 2 | Needs location constraint cn-east-2.
   \ (cn-east-2)
   / North China Region 1.
 3 | Needs location constraint cn-north-1.
   \ (cn-north-1)
   / South China Region 1.
 4 | Needs location constraint cn-south-1.
   \ (cn-south-1)
   / North America Region.
 5 | Needs location constraint us-north-1.
   \ (us-north-1)
   / Southeast Asia Region 1.
 6 | Needs location constraint ap-southeast-1.
   \ (ap-southeast-1)
   / Northeast Asia Region 1.
 7 | Needs location constraint ap-northeast-1.
   \ (ap-northeast-1)
[snip]
endpoint&gt; 1

Option endpoint.
Endpoint for Qiniu Object Storage.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / East China Endpoint 1
   \ (s3-cn-east-1.qiniucs.com)
 2 / East China Endpoint 2
   \ (s3-cn-east-2.qiniucs.com)
 3 / North China Endpoint 1
   \ (s3-cn-north-1.qiniucs.com)
 4 / South China Endpoint 1
   \ (s3-cn-south-1.qiniucs.com)
 5 / North America Endpoint 1
   \ (s3-us-north-1.qiniucs.com)
 6 / Southeast Asia Endpoint 1
   \ (s3-ap-southeast-1.qiniucs.com)
 7 / Northeast Asia Endpoint 1
   \ (s3-ap-northeast-1.qiniucs.com)
endpoint&gt; 1

Option location_constraint.
Location constraint - must be set to match the Region.
Used when creating buckets only.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / East China Region 1
   \ (cn-east-1)
 2 / East China Region 2
   \ (cn-east-2)
 3 / North China Region 1
   \ (cn-north-1)
 4 / South China Region 1
   \ (cn-south-1)
 5 / North America Region 1
   \ (us-north-1)
 6 / Southeast Asia Region 1
   \ (ap-southeast-1)
 7 / Northeast Asia Region 1
   \ (ap-northeast-1)
location_constraint&gt; 1</code></pre>
<ol start="7" type="1">
<li>Choose acl and storage class.</li>
</ol>
<pre><code>Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
[snip]
acl&gt; 2
The storage class to use when storing new objects in Tencent COS.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Standard storage class
   \ (STANDARD)
 2 / Infrequent access storage mode
   \ (LINE)
 3 / Archive storage mode
   \ (GLACIER)
 4 / Deep archive storage mode
   \ (DEEP_ARCHIVE)
[snip]
storage_class&gt; 1
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n&gt; n
Remote config
--------------------
[qiniu]
- type: s3
- provider: Qiniu
- access_key_id: xxx
- secret_access_key: xxx
- region: cn-east-1
- endpoint: s3-cn-east-1.qiniucs.com
- location_constraint: cn-east-1
- acl: public-read
- storage_class: STANDARD
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y
Current remotes:

Name                 Type
====                 ====
qiniu                s3</code></pre>
<h3 id="RackCorp">RackCorp</h3>
<p><a href="https://www.rackcorp.com/storage/s3storage">RackCorp Object
Storage</a> is an S3 compatible object storage platform from your
friendly cloud provider RackCorp. The service is fast, reliable, well
priced and located in many strategic locations unserviced by others, to
ensure you can maintain data sovereignty.</p>
<p>Before you can use RackCorp Object Storage, you'll need to "<a
href="https://www.rackcorp.com/signup">sign up</a>" for an account on
our "<a href="https://portal.rackcorp.com">portal</a>". Next you can
create an <code>access key</code>, a <code>secret key</code> and
<code>buckets</code>, in your location of choice with ease. These
details are required for the next steps of configuration, when
<code>rclone config</code> asks for your <code>access_key_id</code> and
<code>secret_access_key</code>.</p>
<p>Your config should end up looking a bit like this:</p>
<pre><code>[RCS3-demo-config]
type = s3
provider = RackCorp
env_auth = true
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region = au-nsw
endpoint = s3.rackcorp.com
location_constraint = au-nsw</code></pre>
<h3 id="rclone">Rclone Serve S3</h3>
<p>Rclone can serve any remote over the S3 protocol. For details see the
<a href="https://rclone.org/commands/rclone_serve_s3/">rclone serve
s3</a> documentation.</p>
<p>For example, to serve <code>remote:path</code> over s3, run the
server like this:</p>
<pre><code>rclone serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY remote:path</code></pre>
<p>This will be compatible with an rclone remote which is defined like
this:</p>
<pre><code>[serves3]
type = s3
provider = Rclone
endpoint = http://127.0.0.1:8080/
access_key_id = ACCESS_KEY_ID
secret_access_key = SECRET_ACCESS_KEY
use_multipart_uploads = false</code></pre>
<p>Note that setting <code>use_multipart_uploads = false</code> is to
work around <a
href="https://rclone.org/commands/rclone_serve_s3/#bugs">a bug</a> which
will be fixed in due course.</p>
<h3 id="scaleway">Scaleway</h3>
<p><a href="https://www.scaleway.com/object-storage/">Scaleway</a> The
Object Storage platform allows you to store anything from backups, logs
and web assets to documents and photos. Files can be dropped from the
Scaleway console or transferred through our API and CLI or using any
S3-compatible tool.</p>
<p>Scaleway provides an S3 interface which can be configured for use
with rclone like this:</p>
<pre><code>[scaleway]
type = s3
provider = Scaleway
env_auth = false
endpoint = s3.nl-ams.scw.cloud
access_key_id = SCWXXXXXXXXXXXXXX
secret_access_key = 1111111-2222-3333-44444-55555555555555
region = nl-ams
location_constraint = nl-ams
acl = private
upload_cutoff = 5M
chunk_size = 5M
copy_cutoff = 5M</code></pre>
<p><a href="https://www.scaleway.com/en/glacier-cold-storage/">Scaleway
Glacier</a> is the low-cost S3 Glacier alternative from Scaleway and it
works the same way as on S3 by accepting the "GLACIER"
<code>storage_class</code>. So you can configure your remote with the
<code>storage_class = GLACIER</code> option to upload directly to
Scaleway Glacier. Don't forget that in this state you can't read files
back after, you will need to restore them to "STANDARD" storage_class
first before being able to read them (see "restore" section above)</p>
<h3 id="lyve">Seagate Lyve Cloud</h3>
<p><a
href="https://www.seagate.com/gb/en/services/cloud/storage/">Seagate
Lyve Cloud</a> is an S3 compatible object storage platform from <a
href="https://seagate.com/">Seagate</a> intended for enterprise use.</p>
<p>Here is a config run through for a remote called <code>remote</code>
- you may choose a different name of course. Note that to create an
access key and secret key you will need to create a service account
first.</p>
<pre><code>$ rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote</code></pre>
<p>Choose <code>s3</code> backend</p>
<pre><code>Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage&gt; s3</code></pre>
<p>Choose <code>LyveCloud</code> as S3 provider</p>
<pre><code>Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Seagate Lyve Cloud
   \ (LyveCloud)
[snip]
provider&gt; LyveCloud</code></pre>
<p>Take the default (just press enter) to enter access key and secret in
the config file.</p>
<pre><code>Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt;</code></pre>
<pre><code>AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; XXX</code></pre>
<pre><code>AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; YYY</code></pre>
<p>Leave region blank</p>
<pre><code>Region to connect to.
Leave blank if you are using an S3 clone and you don&#39;t have a region.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Use this if unsure.
 1 | Will use v4 signatures and an empty region.
   \ ()
   / Use this only if v4 signatures don&#39;t work.
 2 | E.g. pre Jewel/v10 CEPH.
   \ (other-v2-signature)
region&gt;</code></pre>
<p>Enter your Lyve Cloud endpoint. This field cannot be kept empty.</p>
<pre><code>Endpoint for Lyve Cloud S3 API.
Required when using an S3 clone.
Please type in your LyveCloud endpoint.
Examples:
- s3.us-west-1.{account_name}.lyve.seagate.com (US West 1 - California)
- s3.eu-west-1.{account_name}.lyve.seagate.com (US West 1 - Ireland)
Enter a value.
endpoint&gt; s3.us-west-1.global.lyve.seagate.com</code></pre>
<p>Leave location constraint blank</p>
<pre><code>Location constraint - must be set to match the Region.
Leave blank if not sure. Used when creating buckets only.
Enter a value. Press Enter to leave empty.
location_constraint&gt;</code></pre>
<p>Choose default ACL (<code>private</code>).</p>
<pre><code>Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
[snip]
acl&gt;</code></pre>
<p>And the config file should end up looking like this:</p>
<pre><code>[remote]
type = s3
provider = LyveCloud
access_key_id = XXX
secret_access_key = YYY
endpoint = s3.us-east-1.lyvecloud.seagate.com</code></pre>
<h3 id="seaweedfs">SeaweedFS</h3>
<p><a href="https://github.com/chrislusf/seaweedfs/">SeaweedFS</a> is a
distributed storage system for blobs, objects, files, and data lake,
with O(1) disk seek and a scalable file metadata store. It has an S3
compatible object storage interface. SeaweedFS can also act as a <a
href="https://github.com/chrislusf/seaweedfs/wiki/Gateway-to-Remote-Object-Storage">gateway
to remote S3 compatible object store</a> to cache data and metadata with
asynchronous write back, for fast local speed and minimize access
cost.</p>
<p>Assuming the SeaweedFS are configured with <code>weed shell</code> as
such:</p>
<pre><code>&gt; s3.bucket.create -name foo
&gt; s3.configure -access_key=any -secret_key=any -buckets=foo -user=me -actions=Read,Write,List,Tagging,Admin -apply
{
  &quot;identities&quot;: [
    {
      &quot;name&quot;: &quot;me&quot;,
      &quot;credentials&quot;: [
        {
          &quot;accessKey&quot;: &quot;any&quot;,
          &quot;secretKey&quot;: &quot;any&quot;
        }
      ],
      &quot;actions&quot;: [
        &quot;Read:foo&quot;,
        &quot;Write:foo&quot;,
        &quot;List:foo&quot;,
        &quot;Tagging:foo&quot;,
        &quot;Admin:foo&quot;
      ]
    }
  ]
}</code></pre>
<p>To use rclone with SeaweedFS, above configuration should end up with
something like this in your config:</p>
<pre><code>[seaweedfs_s3]
type = s3
provider = SeaweedFS
access_key_id = any
secret_access_key = any
endpoint = localhost:8333</code></pre>
<p>So once set up, for example to copy files into a bucket</p>
<pre><code>rclone copy /path/to/files seaweedfs_s3:foo</code></pre>
<h3 id="selectel">Selectel</h3>
<p><a href="https://selectel.ru/services/cloud/storage/">Selectel Cloud
Storage</a> is an S3 compatible storage system which features triple
redundancy storage, automatic scaling, high availability and a
comprehensive IAM system.</p>
<p>Selectel have a section on their website for <a
href="https://docs.selectel.ru/en/cloud/object-storage/tools/rclone/">configuring
rclone</a> which shows how to make the right API keys.</p>
<p>From rclone v1.69 Selectel is a supported operator - please choose
the <code>Selectel</code> provider type.</p>
<p>Note that you should use "vHosted" access for the buckets (which is
the recommended default), not "path style".</p>
<p>You can use <code>rclone config</code> to make a new provider like
this</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n

Enter name for new remote.
name&gt; selectel

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including ..., Selectel, ...
   \ (s3)
[snip]
Storage&gt; s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Selectel Object Storage
   \ (Selectel)
[snip]
provider&gt; Selectel

Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; 1

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; SECRET_ACCESS_KEY

Option region.
Region where your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / St. Petersburg
   \ (ru-1)
region&gt; 1

Option endpoint.
Endpoint for Selectel Object Storage.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Saint Petersburg
   \ (s3.ru-1.storage.selcloud.ru)
endpoint&gt; 1

Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n

Configuration complete.
Options:
- type: s3
- provider: Selectel
- access_key_id: ACCESS_KEY
- secret_access_key: SECRET_ACCESS_KEY
- region: ru-1
- endpoint: s3.ru-1.storage.selcloud.ru
Keep this &quot;selectel&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>And your config should end up looking like this:</p>
<pre><code>[selectel]
type = s3
provider = Selectel
access_key_id = ACCESS_KEY
secret_access_key = SECRET_ACCESS_KEY
region = ru-1
endpoint = s3.ru-1.storage.selcloud.ru</code></pre>
<h3 id="storj">Storj</h3>
<p>Storj is a decentralized cloud storage which can be used through its
native protocol or an S3 compatible gateway.</p>
<p>The S3 compatible gateway is configured using
<code>rclone config</code> with a type of <code>s3</code> and with a
provider name of <code>Storj</code>. Here is an example run of the
configurator.</p>
<pre><code>Type of storage to configure.
Storage&gt; s3
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; 1
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; XXXX (as shown when creating the access grant)
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; XXXX (as shown when creating the access grant)
Option endpoint.
Endpoint of the Shared Gateway.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / EU1 Shared Gateway
   \ (gateway.eu1.storjshare.io)
 2 / US1 Shared Gateway
   \ (gateway.us1.storjshare.io)
 3 / Asia-Pacific Shared Gateway
   \ (gateway.ap1.storjshare.io)
endpoint&gt; 1 (as shown when creating the access grant)
Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n</code></pre>
<p>Note that s3 credentials are generated when you <a
href="https://docs.storj.io/dcs/api-reference/s3-compatible-gateway#usage">create
an access grant</a>.</p>
<h4 id="backend-quirks">Backend quirks</h4>
<ul>
<li><code>--chunk-size</code> is forced to be 64 MiB or greater. This
will use more memory than the default of 5 MiB.</li>
<li>Server side copy is disabled as it isn't currently supported in the
gateway.</li>
<li>GetTier and SetTier are not supported.</li>
</ul>
<h4 id="backend-bugs">Backend bugs</h4>
<p>Due to <a href="https://github.com/storj/gateway-mt/issues/39">issue
#39</a> uploading multipart files via the S3 gateway causes them to lose
their metadata. For rclone's purpose this means that the modification
time is not stored, nor is any MD5SUM (if one is available from the
source).</p>
<p>This has the following consequences:</p>
<ul>
<li>Using <code>rclone rcat</code> will fail as the metadata doesn't
match after upload</li>
<li>Uploading files with <code>rclone mount</code> will fail for the
same reason
<ul>
<li>This can worked around by using <code>--vfs-cache-mode writes</code>
or <code>--vfs-cache-mode full</code> or setting
<code>--s3-upload-cutoff</code> large</li>
</ul></li>
<li>Files uploaded via a multipart upload won't have their modtimes
<ul>
<li>This will mean that <code>rclone sync</code> will likely keep trying
to upload files bigger than <code>--s3-upload-cutoff</code></li>
<li>This can be worked around with <code>--checksum</code> or
<code>--size-only</code> or setting <code>--s3-upload-cutoff</code>
large</li>
<li>The maximum value for <code>--s3-upload-cutoff</code> is 5GiB
though</li>
</ul></li>
</ul>
<p>One general purpose workaround is to set
<code>--s3-upload-cutoff 5G</code>. This means that rclone will upload
files smaller than 5GiB as single parts. Note that this can be set in
the config file with <code>upload_cutoff = 5G</code> or configured in
the advanced settings. If you regularly transfer files larger than 5G
then using <code>--checksum</code> or <code>--size-only</code> in
<code>rclone sync</code> is the recommended workaround.</p>
<h4 id="comparison-with-the-native-protocol">Comparison with the native
protocol</h4>
<p>Use the <a href="/storj">the native protocol</a> to take advantage of
client-side encryption as well as to achieve the best possible download
performance. Uploads will be erasure-coded locally, thus a 1gb upload
will result in 2.68gb of data being uploaded to storage nodes across the
network.</p>
<p>Use this backend and the S3 compatible Hosted Gateway to increase
upload performance and reduce the load on your systems and network.
Uploads will be encrypted and erasure-coded server-side, thus a 1GB
upload will result in only in 1GB of data being uploaded to storage
nodes across the network.</p>
<p>For more detailed comparison please check the documentation of the <a
href="/storj">storj</a> backend.</p>
<h3 id="synology-c2">Synology C2 Object Storage</h3>
<p><a
href="https://c2.synology.com/en-global/object-storage/overview">Synology
C2 Object Storage</a> provides a secure, S3-compatible, and
cost-effective cloud storage solution without API request, download
fees, and deletion penalty.</p>
<p>The S3 compatible gateway is configured using
<code>rclone config</code> with a type of <code>s3</code> and with a
provider name of <code>Synology</code>. Here is an example run of the
configurator.</p>
<p>First run:</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config

n/s/q&gt; n

Enter name for new remote.1
name&gt; syno

Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value

XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ &quot;s3&quot;

Storage&gt; s3

Choose your S3 provider.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 24 / Synology C2 Object Storage
   \ (Synology)

provider&gt; Synology

Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Enter a boolean value (true or false). Press Enter for the default (&quot;false&quot;).
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;

env_auth&gt; 1

AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).

access_key_id&gt; accesskeyid

AWS Secret Access Key (password)
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).

secret_access_key&gt; secretaccesskey

Region where your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Europe Region 1
   \ (eu-001)
 2 / Europe Region 2
   \ (eu-002)
 3 / US Region 1
   \ (us-001)
 4 / US Region 2
   \ (us-002)
 5 / Asia (Taiwan)
   \ (tw-001)

region &gt; 1

Option endpoint.
Endpoint for Synology C2 Object Storage API.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / EU Endpoint 1
   \ (eu-001.s3.synologyc2.net)
 2 / US Endpoint 1
   \ (us-001.s3.synologyc2.net)
 3 / TW Endpoint 1
   \ (tw-001.s3.synologyc2.net)

endpoint&gt; 1

Option location_constraint.
Location constraint - must be set to match the Region.
Leave blank if not sure. Used when creating buckets only.
Enter a value. Press Enter to leave empty.
location_constraint&gt;

Edit advanced config? (y/n)
y) Yes
n) No
y/n&gt; y

Option no_check_bucket.
If set, don&#39;t attempt to check the bucket exists or create it.
This can be useful when trying to minimise the number of transactions
rclone does if you know the bucket exists already.
It can also be needed if the user you are using does not have bucket
creation permissions. Before v1.52.0 this would have passed silently
due to a bug.
Enter a boolean value (true or false). Press Enter for the default (true).

no_check_bucket&gt; true

Configuration complete.
Options:
- type: s3
- provider: Synology
- region: eu-001
- endpoint: eu-001.s3.synologyc2.net
- no_check_bucket: true
Keep this &quot;syno&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote

y/e/d&gt; y</code></pre>
<h3 id="tencent-cos">Tencent COS</h3>
<p><a href="https://intl.cloud.tencent.com/product/cos">Tencent Cloud
Object Storage (COS)</a> is a distributed storage service offered by
Tencent Cloud for unstructured data. It is secure, stable, massive,
convenient, low-delay and low-cost.</p>
<p>To configure access to Tencent COS, follow the steps below:</p>
<ol type="1">
<li>Run <code>rclone config</code> and select <code>n</code> for a new
remote.</li>
</ol>
<pre><code>rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n</code></pre>
<ol start="2" type="1">
<li>Give the name of the configuration. For example, name it 'cos'.</li>
</ol>
<pre><code>name&gt; cos</code></pre>
<ol start="3" type="1">
<li>Select <code>s3</code> storage.</li>
</ol>
<pre><code>Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ &quot;s3&quot;
[snip]
Storage&gt; s3</code></pre>
<ol start="4" type="1">
<li>Select <code>TencentCOS</code> provider.</li>
</ol>
<pre><code>Choose a number from below, or type in your own value
1 / Amazon Web Services (AWS) S3
   \ &quot;AWS&quot;
[snip]
11 / Tencent Cloud Object Storage (COS)
   \ &quot;TencentCOS&quot;
[snip]
provider&gt; TencentCOS</code></pre>
<ol start="5" type="1">
<li>Enter your SecretId and SecretKey of Tencent Cloud.</li>
</ol>
<pre><code>Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Enter a boolean value (true or false). Press Enter for the default (&quot;false&quot;).
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
access_key_id&gt; AKIDxxxxxxxxxx
AWS Secret Access Key (password)
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
secret_access_key&gt; xxxxxxxxxxx</code></pre>
<ol start="6" type="1">
<li>Select endpoint for Tencent COS. This is the standard endpoint for
different region.</li>
</ol>
<pre><code> 1 / Beijing Region.
   \ &quot;cos.ap-beijing.myqcloud.com&quot;
 2 / Nanjing Region.
   \ &quot;cos.ap-nanjing.myqcloud.com&quot;
 3 / Shanghai Region.
   \ &quot;cos.ap-shanghai.myqcloud.com&quot;
 4 / Guangzhou Region.
   \ &quot;cos.ap-guangzhou.myqcloud.com&quot;
[snip]
endpoint&gt; 4</code></pre>
<ol start="7" type="1">
<li>Choose acl and storage class.</li>
</ol>
<pre><code>Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Owner gets Full_CONTROL. No one else has access rights (default).
   \ &quot;default&quot;
[snip]
acl&gt; 1
The storage class to use when storing new objects in Tencent COS.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Default
   \ &quot;&quot;
[snip]
storage_class&gt; 1
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n&gt; n
Remote config
--------------------
[cos]
type = s3
provider = TencentCOS
env_auth = false
access_key_id = xxx
secret_access_key = xxx
endpoint = cos.ap-guangzhou.myqcloud.com
acl = default
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y
Current remotes:

Name                 Type
====                 ====
cos                  s3</code></pre>
<h3 id="wasabi">Wasabi</h3>
<p><a href="https://wasabi.com">Wasabi</a> is a cloud-based object
storage service for a broad range of applications and use cases. Wasabi
is designed for individuals and organizations that require a
high-performance, reliable, and secure data storage infrastructure at
minimal cost.</p>
<p>Wasabi provides an S3 interface which can be configured for use with
rclone like this.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
s) Set configuration password
n/s&gt; n
name&gt; wasabi
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, ArvanCloud, Minio, Liara)
   \ &quot;s3&quot;
[snip]
Storage&gt; s3
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID - leave blank for anonymous access or runtime credentials.
access_key_id&gt; YOURACCESSKEY
AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
secret_access_key&gt; YOURSECRETACCESSKEY
Region to connect to.
Choose a number from below, or type in your own value
   / The default endpoint - a good choice if you are unsure.
 1 | US Region, Northern Virginia, or Pacific Northwest.
   | Leave location constraint empty.
   \ &quot;us-east-1&quot;
[snip]
region&gt; us-east-1
Endpoint for S3 API.
Leave blank if using AWS to use the default endpoint for the region.
Specify if using an S3 clone such as Ceph.
endpoint&gt; s3.wasabisys.com
Location constraint - must be set to match the Region. Used when creating buckets only.
Choose a number from below, or type in your own value
 1 / Empty for US Region, Northern Virginia, or Pacific Northwest.
   \ &quot;&quot;
[snip]
location_constraint&gt;
Canned ACL used when creating buckets and/or storing objects in S3.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Choose a number from below, or type in your own value
 1 / Owner gets FULL_CONTROL. No one else has access rights (default).
   \ &quot;private&quot;
[snip]
acl&gt;
The server-side encryption algorithm used when storing this object in S3.
Choose a number from below, or type in your own value
 1 / None
   \ &quot;&quot;
 2 / AES256
   \ &quot;AES256&quot;
server_side_encryption&gt;
The storage class to use when storing objects in S3.
Choose a number from below, or type in your own value
 1 / Default
   \ &quot;&quot;
 2 / Standard storage class
   \ &quot;STANDARD&quot;
 3 / Reduced redundancy storage class
   \ &quot;REDUCED_REDUNDANCY&quot;
 4 / Standard Infrequent Access storage class
   \ &quot;STANDARD_IA&quot;
storage_class&gt;
Remote config
--------------------
[wasabi]
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region = us-east-1
endpoint = s3.wasabisys.com
location_constraint =
acl =
server_side_encryption =
storage_class =
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This will leave the config file looking like this.</p>
<pre><code>[wasabi]
type = s3
provider = Wasabi
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region =
endpoint = s3.wasabisys.com
location_constraint =
acl =
server_side_encryption =
storage_class =</code></pre>
<h3 id="Zata">Zata Object Storage</h3>
<p><a href="https://zata.ai/">Zata Object Storage</a> provides a secure,
S3-compatible cloud storage solution designed for scalability and
performance, ideal for a variety of data storage needs.</p>
<p>First run:</p>
<pre><code>rclone config</code></pre>
<pre><code>This will guide you through an interactive setup process:

e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; n

Enter name for new remote.
name&gt; my zata storage 

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
 
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
 
Storage&gt; s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 
XX / Zata (S3 compatible Gateway)
   \ (Zata)

provider&gt; Zata

Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt;

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; &quot;your key&quot;

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; &quot;your secret key&quot;

Option region.
Region where you can connect with.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Indore, Madhya Pradesh, India
   \ (us-east-1)
region&gt; 1

Option endpoint.
Endpoint for Zata Object Storage.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / South Asia Endpoint
   \ (idr01.zata.ai)
endpoint&gt; 1

Option location_constraint.
Location constraint - must be set to match the Region.
Leave blank if not sure. Used when creating buckets only.
Enter a value. Press Enter to leave empty.
location_constraint&gt;

Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
   / Owner gets FULL_CONTROL.
 3 | The AllUsers group gets READ and WRITE access.
   | Granting this on a bucket is generally not recommended.
   \ (public-read-write)
   / Owner gets FULL_CONTROL.
 4 | The AuthenticatedUsers group gets READ access.
   \ (authenticated-read)
   / Object owner gets FULL_CONTROL.
 5 | Bucket owner gets READ access.
   | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ (bucket-owner-read)
   / Both the object owner and the bucket owner get FULL_CONTROL over the object.
 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ (bucket-owner-full-control)
acl&gt;

Edit advanced config?
y) Yes
n) No (default)
y/n&gt;

Configuration complete.
Options:
- type: s3
- provider: Zata
- access_key_id: xxx
- secret_access_key: xxx
- region: us-east-1
- endpoint: idr01.zata.ai
Keep this &quot;my zata storage&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt;
</code></pre>
<p>This will leave the config file looking like this.</p>
<pre><code>[my zata storage]
type = s3
provider = Zata
access_key_id = xxx
secret_access_key = xxx
region = us-east-1
endpoint = idr01.zata.ai
</code></pre>
<h2 id="memory">Memory usage</h2>
<p>The most common cause of rclone using lots of memory is a single
directory with millions of files in. Despite s3 not really having the
concepts of directories, rclone does the sync on a directory by
directory basis to be compatible with normal filing systems.</p>
<p>Rclone loads each directory into memory as rclone objects. Each
rclone object takes 0.5k-1k of memory, so approximately 1GB per
1,000,000 files, and the sync for that directory does not begin until it
is entirely loaded in memory. So the sync can take a long time to start
for large directories.</p>
<p>To sync a directory with 100,000,000 files in you would need
approximately 100 GB of memory. At some point the amount of memory
becomes difficult to provide so there is <a
href="https://github.com/rclone/rclone/wiki/Big-syncs-with-millions-of-files">a
workaround for this</a> which involves a bit of scripting.</p>
<p>At some point rclone will gain a sync mode which is effectively this
workaround but built in to rclone.</p>
<h2 id="limitations-6">Limitations</h2>
<p><code>rclone about</code> is not supported by the S3 backend.
Backends without this capability cannot determine free space for an
rclone mount or use policy <code>mfs</code> (most free space) as a
member of an rclone union remote.</p>
<p>See <a href="https://rclone.org/overview/#optional-features">List of
backends that do not support rclone about</a> and <a
href="https://rclone.org/commands/rclone_about/">rclone about</a></p>
<h1 id="backblaze-b2">Backblaze B2</h1>
<p>B2 is <a href="https://www.backblaze.com/cloud-storage">Backblaze's
cloud storage system</a>.</p>
<p>Paths are specified as <code>remote:bucket</code> (or
<code>remote:</code> for the <code>lsd</code> command.) You may put
subdirectories in too, e.g. <code>remote:bucket/path/to/dir</code>.</p>
<h2 id="configuration-3">Configuration</h2>
<p>Here is an example of making a b2 configuration. First run</p>
<div class="sourceCode" id="cb1100"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1100-1"><a href="#cb1100-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process. To
authenticate you will either need your Account ID (a short hex number)
and Master Application Key (a long hex number) OR an Application Key,
which is the recommended method. See below for further details on
generating and using an Application Key.</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
q) Quit config
n/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Backblaze B2
   \ &quot;b2&quot;
[snip]
Storage&gt; b2
Account ID or Application Key ID
account&gt; 123456789abc
Application Key
key&gt; 0123456789abcdef0123456789abcdef0123456789
Endpoint for the service - leave blank normally.
endpoint&gt;
Remote config
Configuration complete.
Options:
- type: b2
- account: 123456789abc
- key: 0123456789abcdef0123456789abcdef0123456789
- endpoint:
Keep this &quot;remote&quot; remote?
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This remote is called <code>remote</code> and can now be used like
this</p>
<p>See all buckets</p>
<div class="sourceCode" id="cb1102"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1102-1"><a href="#cb1102-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsd remote:</span></code></pre></div>
<p>Create a new bucket</p>
<div class="sourceCode" id="cb1103"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1103-1"><a href="#cb1103-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> mkdir remote:bucket</span></code></pre></div>
<p>List the contents of a bucket</p>
<div class="sourceCode" id="cb1104"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1104-1"><a href="#cb1104-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> ls remote:bucket</span></code></pre></div>
<p>Sync <code>/home/local/directory</code> to the remote bucket,
deleting any excess files in the bucket.</p>
<div class="sourceCode" id="cb1105"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1105-1"><a href="#cb1105-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> sync <span class="at">--interactive</span> /home/local/directory remote:bucket</span></code></pre></div>
<h3 id="application-keys">Application Keys</h3>
<p>B2 supports multiple <a
href="https://www.backblaze.com/docs/cloud-storage-application-keys">Application
Keys for different access permission to B2 Buckets</a>.</p>
<p>You can use these with rclone too; you will need to use rclone
version 1.43 or later.</p>
<p>Follow Backblaze's docs to create an Application Key with the
required permission and add the <code>applicationKeyId</code> as the
<code>account</code> and the <code>Application Key</code> itself as the
<code>key</code>.</p>
<p>Note that you must put the <em>applicationKeyId</em> as the
<code>account</code> – you can't use the master Account ID. If you try
then B2 will return 401 errors.</p>
<h3 id="fast-list-1">--fast-list</h3>
<p>This remote supports <code>--fast-list</code> which allows you to use
fewer transactions in exchange for more memory. See the <a
href="https://rclone.org/docs/#fast-list">rclone docs</a> for more
details.</p>
<h3 id="modification-times-2">Modification times</h3>
<p>The modification time is stored as metadata on the object as
<code>X-Bz-Info-src_last_modified_millis</code> as milliseconds since
1970-01-01 in the Backblaze standard. Other tools should be able to use
this as a modified time.</p>
<p>Modified times are used in syncing and are fully supported. Note that
if a modification time needs to be updated on an object then it will
create a new version of the object.</p>
<h3 id="restricted-filename-characters-2">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
restricted characters set</a> the following characters are also
replaced:</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
</tbody>
</table>
<p>Invalid UTF-8 bytes will also be <a
href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they
can't be used in JSON strings.</p>
<p>Note that in 2020-05 Backblaze started allowing  characters in file
names. Rclone hasn't changed its encoding as this could cause syncs to
re-transfer files. If you want rclone not to replace  then see the
<code>--b2-encoding</code> flag below and remove the
<code>BackSlash</code> from the string. This can be set in the
config.</p>
<h3 id="sha1-checksums">SHA1 checksums</h3>
<p>The SHA1 checksums of the files are checked on upload and download
and will be used in the syncing process.</p>
<p>Large files (bigger than the limit in
<code>--b2-upload-cutoff</code>) which are uploaded in chunks will store
their SHA1 on the object as <code>X-Bz-Info-large_file_sha1</code> as
recommended by Backblaze.</p>
<p>For a large file to be uploaded with an SHA1 checksum, the source
needs to support SHA1 checksums. The local disk supports SHA1 checksums
so large file transfers from local disk will have an SHA1. See <a
href="https://rclone.org/overview/#features">the overview</a> for
exactly which remotes support SHA1.</p>
<p>Sources which don't support SHA1, in particular <code>crypt</code>
will upload large files without SHA1 checksums. This may be fixed in the
future (see <a
href="https://github.com/rclone/rclone/issues/1767">#1767</a>).</p>
<p>Files sizes below <code>--b2-upload-cutoff</code> will always have an
SHA1 regardless of the source.</p>
<h3 id="transfers">Transfers</h3>
<p>Backblaze recommends that you do lots of transfers simultaneously for
maximum speed. In tests from my SSD equipped laptop the optimum setting
is about <code>--transfers 32</code> though higher numbers may be used
for a slight speed improvement. The optimum number for you may vary
depending on your hardware, how big the files are, how much you want to
load your computer, etc. The default of <code>--transfers 4</code> is
definitely too low for Backblaze B2 though.</p>
<p>Note that uploading big files (bigger than 200 MiB by default) will
use a 96 MiB RAM buffer by default. There can be at most
<code>--transfers</code> of these in use at any moment, so this sets the
upper limit on the memory used.</p>
<h3 id="versions-1">Versions</h3>
<p>The default setting of B2 is to keep old versions of files. This
means when rclone uploads a new version of a file it creates a <a
href="https://www.backblaze.com/docs/cloud-storage-file-versions">new
version of it</a>. Likewise when you delete a file, the old version will
be marked hidden and still be available.</p>
<p>Whether B2 keeps old versions of files or not can be adjusted on a
per bucket basis using the "Lifecycle settings" on the B2 control panel
or when creating the bucket using the <a
href="#b2-lifecycle">--b2-lifecycle</a> flag or after creation using the
<a href="#lifecycle">rclone backend lifecycle</a> command.</p>
<p>You may opt in to a "hard delete" of files with the
<code>--b2-hard-delete</code> flag which permanently removes files on
deletion instead of hiding them.</p>
<p>Old versions of files, where available, are visible using the
<code>--b2-versions</code> flag.</p>
<p>It is also possible to view a bucket as it was at a certain point in
time, using the <code>--b2-version-at</code> flag. This will show the
file versions as they were at that time, showing files that have been
deleted afterwards, and hiding files that were created since.</p>
<p>If you wish to remove all the old versions, and unfinished large file
uploads, then you can use the <code>rclone cleanup remote:bucket</code>
command which will delete all the old versions of files, leaving the
current ones intact. You can also supply a path and only old versions
under that path will be deleted, e.g.
<code>rclone cleanup remote:bucket/path/to/stuff</code>.</p>
<p>Note that <code>cleanup</code> will remove partially uploaded files
from the bucket if they are more than a day old. If you want more
control over the expiry date then run
<code>rclone backend cleanup b2:bucket -o max-age=1h</code> to remove
all unfinished large file uploads older than one hour, leaving old
versions intact.</p>
<p>If you wish to remove all the old versions, leaving current files and
unfinished large files intact, then you can use the <a
href="#cleanup-hidden"><code>rclone backend cleanup-hidden remote:bucket</code></a>
command. You can also supply a path and only old versions under that
path will be deleted, e.g.
<code>rclone backend cleanup-hidden remote:bucket/path/to/stuff</code>.</p>
<p>When you <code>purge</code> a bucket, the current and the old
versions will be deleted then the bucket will be deleted.</p>
<p>However <code>delete</code> will cause the current versions of the
files to become hidden old versions.</p>
<p>Here is a session showing the listing and retrieval of an old version
followed by a <code>cleanup</code> of the old versions.</p>
<p>Show current version and all the versions with
<code>--b2-versions</code> flag.</p>
<div class="sourceCode" id="cb1106"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1106-1"><a href="#cb1106-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> ls b2:cleanup-test</span>
<span id="cb1106-2"><a href="#cb1106-2" aria-hidden="true" tabindex="-1"></a>        <span class="ex">9</span> one.txt</span>
<span id="cb1106-3"><a href="#cb1106-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1106-4"><a href="#cb1106-4" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> <span class="at">--b2-versions</span> ls b2:cleanup-test</span>
<span id="cb1106-5"><a href="#cb1106-5" aria-hidden="true" tabindex="-1"></a>        <span class="ex">9</span> one.txt</span>
<span id="cb1106-6"><a href="#cb1106-6" aria-hidden="true" tabindex="-1"></a>        <span class="ex">8</span> one-v2016-07-04-141032-000.txt</span>
<span id="cb1106-7"><a href="#cb1106-7" aria-hidden="true" tabindex="-1"></a>       <span class="ex">16</span> one-v2016-07-04-141003-000.txt</span>
<span id="cb1106-8"><a href="#cb1106-8" aria-hidden="true" tabindex="-1"></a>       <span class="ex">15</span> one-v2016-07-02-155621-000.txt</span></code></pre></div>
<p>Retrieve an old version</p>
<div class="sourceCode" id="cb1107"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1107-1"><a href="#cb1107-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> <span class="at">--b2-versions</span> copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp</span>
<span id="cb1107-2"><a href="#cb1107-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1107-3"><a href="#cb1107-3" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ls <span class="at">-l</span> /tmp/one-v2016-07-04-141003-000.txt</span>
<span id="cb1107-4"><a href="#cb1107-4" aria-hidden="true" tabindex="-1"></a><span class="ex">-rw-rw-r--</span> 1 ncw ncw 16 Jul  2 17:46 /tmp/one-v2016-07-04-141003-000.txt</span></code></pre></div>
<p>Clean up all the old versions and show that they've gone.</p>
<div class="sourceCode" id="cb1108"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1108-1"><a href="#cb1108-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> cleanup b2:cleanup-test</span>
<span id="cb1108-2"><a href="#cb1108-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1108-3"><a href="#cb1108-3" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> ls b2:cleanup-test</span>
<span id="cb1108-4"><a href="#cb1108-4" aria-hidden="true" tabindex="-1"></a>        <span class="ex">9</span> one.txt</span>
<span id="cb1108-5"><a href="#cb1108-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1108-6"><a href="#cb1108-6" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> <span class="at">--b2-versions</span> ls b2:cleanup-test</span>
<span id="cb1108-7"><a href="#cb1108-7" aria-hidden="true" tabindex="-1"></a>        <span class="ex">9</span> one.txt</span></code></pre></div>
<h4 id="versions-naming-caveat-1">Versions naming caveat</h4>
<p>When using <code>--b2-versions</code> flag rclone is relying on the
file name to work out whether the objects are versions or not. Versions'
names are created by inserting timestamp between file name and its
extension.</p>
<div class="sourceCode" id="cb1109"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1109-1"><a href="#cb1109-1" aria-hidden="true" tabindex="-1"></a>        <span class="ex">9</span> file.txt</span>
<span id="cb1109-2"><a href="#cb1109-2" aria-hidden="true" tabindex="-1"></a>        <span class="ex">8</span> file-v2023-07-17-161032-000.txt</span>
<span id="cb1109-3"><a href="#cb1109-3" aria-hidden="true" tabindex="-1"></a>       <span class="ex">16</span> file-v2023-06-15-141003-000.txt</span></code></pre></div>
<p>If there are real files present with the same names as versions, then
behaviour of <code>--b2-versions</code> can be unpredictable.</p>
<h3 id="data-usage">Data usage</h3>
<p>It is useful to know how many requests are sent to the server in
different scenarios.</p>
<p>All copy commands send the following 4 requests:</p>
<pre class="text"><code>/b2api/v1/b2_authorize_account
/b2api/v1/b2_create_bucket
/b2api/v1/b2_list_buckets
/b2api/v1/b2_list_file_names</code></pre>
<p>The <code>b2_list_file_names</code> request will be sent once for
every 1k files in the remote path, providing the checksum and
modification time of the listed files. As of version 1.33 issue <a
href="https://github.com/rclone/rclone/issues/818">#818</a> causes extra
requests to be sent when using B2 with Crypt. When a copy operation does
not require any files to be uploaded, no more requests will be sent.</p>
<p>Uploading files that do not require chunking, will send 2 requests
per file upload:</p>
<pre class="text"><code>/b2api/v1/b2_get_upload_url
/b2api/v1/b2_upload_file/</code></pre>
<p>Uploading files requiring chunking, will send 2 requests (one each to
start and finish the upload) and another 2 requests for each chunk:</p>
<pre class="text"><code>/b2api/v1/b2_start_large_file
/b2api/v1/b2_get_upload_part_url
/b2api/v1/b2_upload_part/
/b2api/v1/b2_finish_large_file</code></pre>
<h4 id="versions-2">Versions</h4>
<p>Versions can be viewed with the <code>--b2-versions</code> flag. When
it is set rclone will show and act on older versions of files. For
example</p>
<p>Listing without <code>--b2-versions</code></p>
<div class="sourceCode" id="cb1113"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1113-1"><a href="#cb1113-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> ls b2:cleanup-test</span>
<span id="cb1113-2"><a href="#cb1113-2" aria-hidden="true" tabindex="-1"></a>        <span class="ex">9</span> one.txt</span></code></pre></div>
<p>And with</p>
<div class="sourceCode" id="cb1114"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1114-1"><a href="#cb1114-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone <span class="at">-q</span> <span class="at">--b2-versions</span> ls b2:cleanup-test</span>
<span id="cb1114-2"><a href="#cb1114-2" aria-hidden="true" tabindex="-1"></a>        <span class="ex">9</span> one.txt</span>
<span id="cb1114-3"><a href="#cb1114-3" aria-hidden="true" tabindex="-1"></a>        <span class="ex">8</span> one-v2016-07-04-141032-000.txt</span>
<span id="cb1114-4"><a href="#cb1114-4" aria-hidden="true" tabindex="-1"></a>       <span class="ex">16</span> one-v2016-07-04-141003-000.txt</span>
<span id="cb1114-5"><a href="#cb1114-5" aria-hidden="true" tabindex="-1"></a>       <span class="ex">15</span> one-v2016-07-02-155621-000.txt</span></code></pre></div>
<p>Showing that the current version is unchanged but older versions can
be seen. These have the UTC date that they were uploaded to the server
to the nearest millisecond appended to them.</p>
<p>Note that when using <code>--b2-versions</code> no file write
operations are permitted, so you can't upload files or delete them.</p>
<h3 id="b2-and-rclone-link">B2 and rclone link</h3>
<p>Rclone supports generating file share links for private B2 buckets.
They can either be for a file for example:</p>
<div class="sourceCode" id="cb1115"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1115-1"><a href="#cb1115-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./rclone</span> link B2:bucket/path/to/file.txt</span>
<span id="cb1115-2"><a href="#cb1115-2" aria-hidden="true" tabindex="-1"></a><span class="ex">https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx</span></span></code></pre></div>
<p>or if run on a directory you will get:</p>
<div class="sourceCode" id="cb1116"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1116-1"><a href="#cb1116-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./rclone</span> link B2:bucket/path</span>
<span id="cb1116-2"><a href="#cb1116-2" aria-hidden="true" tabindex="-1"></a><span class="ex">https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx</span></span></code></pre></div>
<p>you can then use the authorization token (the part of the url from
the <code>?Authorization=</code> on) on any file path under that
directory. For example:</p>
<pre class="text"><code>https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx
https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx
https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx
</code></pre>
<h3 id="standard-options-3">Standard options</h3>
<p>Here are the Standard options specific to b2 (Backblaze B2).</p>
<h4 id="b2-account">--b2-account</h4>
<p>Account ID or Application Key ID.</p>
<p>Properties:</p>
<ul>
<li>Config: account</li>
<li>Env Var: RCLONE_B2_ACCOUNT</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="b2-key">--b2-key</h4>
<p>Application Key.</p>
<p>Properties:</p>
<ul>
<li>Config: key</li>
<li>Env Var: RCLONE_B2_KEY</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="b2-hard-delete">--b2-hard-delete</h4>
<p>Permanently delete files on remote removal, otherwise hide files.</p>
<p>Properties:</p>
<ul>
<li>Config: hard_delete</li>
<li>Env Var: RCLONE_B2_HARD_DELETE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h3 id="advanced-options-3">Advanced options</h3>
<p>Here are the Advanced options specific to b2 (Backblaze B2).</p>
<h4 id="b2-endpoint">--b2-endpoint</h4>
<p>Endpoint for the service.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_B2_ENDPOINT</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="b2-test-mode">--b2-test-mode</h4>
<p>A flag string for X-Bz-Test-Mode header for debugging.</p>
<p>This is for debugging purposes only. Setting it to one of the strings
below will cause b2 to return specific errors:</p>
<ul>
<li>"fail_some_uploads"</li>
<li>"expire_some_account_authorization_tokens"</li>
<li>"force_cap_exceeded"</li>
</ul>
<p>These will be set in the "X-Bz-Test-Mode" header which is documented
in the <a
href="https://www.backblaze.com/docs/cloud-storage-integration-checklist">b2
integrations checklist</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: test_mode</li>
<li>Env Var: RCLONE_B2_TEST_MODE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="b2-versions">--b2-versions</h4>
<p>Include old versions in directory listings.</p>
<p>Note that when using this no file write operations are permitted, so
you can't upload files or delete them.</p>
<p>Properties:</p>
<ul>
<li>Config: versions</li>
<li>Env Var: RCLONE_B2_VERSIONS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="b2-version-at">--b2-version-at</h4>
<p>Show file versions as they were at the specified time.</p>
<p>Note that when using this no file write operations are permitted, so
you can't upload files or delete them.</p>
<p>Properties:</p>
<ul>
<li>Config: version_at</li>
<li>Env Var: RCLONE_B2_VERSION_AT</li>
<li>Type: Time</li>
<li>Default: off</li>
</ul>
<h4 id="b2-upload-cutoff">--b2-upload-cutoff</h4>
<p>Cutoff for switching to chunked upload.</p>
<p>Files above this size will be uploaded in chunks of
"--b2-chunk-size".</p>
<p>This value should be set no larger than 4.657 GiB (== 5 GB).</p>
<p>Properties:</p>
<ul>
<li>Config: upload_cutoff</li>
<li>Env Var: RCLONE_B2_UPLOAD_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 200Mi</li>
</ul>
<h4 id="b2-copy-cutoff">--b2-copy-cutoff</h4>
<p>Cutoff for switching to multipart copy.</p>
<p>Any files larger than this that need to be server-side copied will be
copied in chunks of this size.</p>
<p>The minimum is 0 and the maximum is 4.6 GiB.</p>
<p>Properties:</p>
<ul>
<li>Config: copy_cutoff</li>
<li>Env Var: RCLONE_B2_COPY_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 4Gi</li>
</ul>
<h4 id="b2-chunk-size">--b2-chunk-size</h4>
<p>Upload chunk size.</p>
<p>When uploading large files, chunk the file into this size.</p>
<p>Must fit in memory. These chunks are buffered in memory and there
might a maximum of "--transfers" chunks in progress at once.</p>
<p>5,000,000 Bytes is the minimum size.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_B2_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 96Mi</li>
</ul>
<h4 id="b2-upload-concurrency">--b2-upload-concurrency</h4>
<p>Concurrency for multipart uploads.</p>
<p>This is the number of chunks of the same file that are uploaded
concurrently.</p>
<p>Note that chunks are stored in memory and there may be up to
"--transfers" * "--b2-upload-concurrency" chunks stored at once in
memory.</p>
<p>Properties:</p>
<ul>
<li>Config: upload_concurrency</li>
<li>Env Var: RCLONE_B2_UPLOAD_CONCURRENCY</li>
<li>Type: int</li>
<li>Default: 4</li>
</ul>
<h4 id="b2-disable-checksum">--b2-disable-checksum</h4>
<p>Disable checksums for large (&gt; upload cutoff) files.</p>
<p>Normally rclone will calculate the SHA1 checksum of the input before
uploading it so it can add it to metadata on the object. This is great
for data integrity checking but can cause long delays for large files to
start uploading.</p>
<p>Properties:</p>
<ul>
<li>Config: disable_checksum</li>
<li>Env Var: RCLONE_B2_DISABLE_CHECKSUM</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="b2-download-url">--b2-download-url</h4>
<p>Custom endpoint for downloads.</p>
<p>This is usually set to a Cloudflare CDN URL as Backblaze offers free
egress for data downloaded through the Cloudflare network. Rclone works
with private buckets by sending an "Authorization" header. If the custom
endpoint rewrites the requests for authentication, e.g., in Cloudflare
Workers, this header needs to be handled properly. Leave blank if you
want to use the endpoint provided by Backblaze.</p>
<p>The URL provided here SHOULD have the protocol and SHOULD NOT have a
trailing slash or specify the /file/bucket subpath as rclone will
request files with "{download_url}/file/{bucket_name}/{path}".</p>
<p>Example: &gt; https://mysubdomain.mydomain.tld (No trailing "/",
"file" or "bucket")</p>
<p>Properties:</p>
<ul>
<li>Config: download_url</li>
<li>Env Var: RCLONE_B2_DOWNLOAD_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="b2-download-auth-duration">--b2-download-auth-duration</h4>
<p>Time before the public link authorization token will expire in s or
suffix ms|s|m|h|d.</p>
<p>This is used in combination with "rclone link" for making files
accessible to the public and sets the duration before the download
authorization token will expire.</p>
<p>The minimum value is 1 second. The maximum value is one week.</p>
<p>Properties:</p>
<ul>
<li>Config: download_auth_duration</li>
<li>Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION</li>
<li>Type: Duration</li>
<li>Default: 1w</li>
</ul>
<h4 id="b2-memory-pool-flush-time">--b2-memory-pool-flush-time</h4>
<p>How often internal memory buffer pools will be flushed. (no longer
used)</p>
<p>Properties:</p>
<ul>
<li>Config: memory_pool_flush_time</li>
<li>Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME</li>
<li>Type: Duration</li>
<li>Default: 1m0s</li>
</ul>
<h4 id="b2-memory-pool-use-mmap">--b2-memory-pool-use-mmap</h4>
<p>Whether to use mmap buffers in internal memory pool. (no longer
used)</p>
<p>Properties:</p>
<ul>
<li>Config: memory_pool_use_mmap</li>
<li>Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="b2-lifecycle">--b2-lifecycle</h4>
<p>Set the number of days deleted files should be kept when creating a
bucket.</p>
<p>On bucket creation, this parameter is used to create a lifecycle rule
for the entire bucket.</p>
<p>If lifecycle is 0 (the default) it does not create a lifecycle rule
so the default B2 behaviour applies. This is to create versions of files
on delete and overwrite and to keep them indefinitely.</p>
<p>If lifecycle is &gt;0 then it creates a single rule setting the
number of days before a file that is deleted or overwritten is deleted
permanently. This is known as daysFromHidingToDeleting in the b2
docs.</p>
<p>The minimum value for this parameter is 1 day.</p>
<p>You can also enable hard_delete in the config also which will mean
deletions won't cause versions but overwrites will still cause versions
to be made.</p>
<p>See: <a href="#lifecycle">rclone backend lifecycle</a> for setting
lifecycles after bucket creation.</p>
<p>Properties:</p>
<ul>
<li>Config: lifecycle</li>
<li>Env Var: RCLONE_B2_LIFECYCLE</li>
<li>Type: int</li>
<li>Default: 0</li>
</ul>
<h4 id="b2-encoding">--b2-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_B2_ENCODING</li>
<li>Type: Encoding</li>
<li>Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot</li>
</ul>
<h4 id="b2-description">--b2-description</h4>
<p>Description of the remote.</p>
<p>Properties:</p>
<ul>
<li>Config: description</li>
<li>Env Var: RCLONE_B2_DESCRIPTION</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h2 id="backend-commands-1">Backend commands</h2>
<p>Here are the commands specific to the b2 backend.</p>
<p>Run them with</p>
<pre><code>rclone backend COMMAND remote:</code></pre>
<p>The help below will explain what arguments each command takes.</p>
<p>See the <a
href="https://rclone.org/commands/rclone_backend/">backend</a> command
for more info on how to pass options and arguments.</p>
<p>These can be run on a running backend using the rc command <a
href="https://rclone.org/rc/#backend-command">backend/command</a>.</p>
<h3 id="lifecycle">lifecycle</h3>
<p>Read or set the lifecycle for a bucket</p>
<pre><code>rclone backend lifecycle remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command can be used to read or set the lifecycle for a
bucket.</p>
<p>Usage Examples:</p>
<p>To show the current lifecycle rules:</p>
<pre><code>rclone backend lifecycle b2:bucket</code></pre>
<p>This will dump something like this showing the lifecycle rules.</p>
<pre><code>[
    {
        &quot;daysFromHidingToDeleting&quot;: 1,
        &quot;daysFromUploadingToHiding&quot;: null,
        &quot;daysFromStartingToCancelingUnfinishedLargeFiles&quot;: null,
        &quot;fileNamePrefix&quot;: &quot;&quot;
    }
]</code></pre>
<p>If there are no lifecycle rules (the default) then it will just
return [].</p>
<p>To reset the current lifecycle rules:</p>
<pre><code>rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=30
rclone backend lifecycle b2:bucket -o daysFromUploadingToHiding=5 -o daysFromHidingToDeleting=1</code></pre>
<p>This will run and then print the new lifecycle rules as above.</p>
<p>Rclone only lets you set lifecycles for the whole bucket with the
fileNamePrefix = "".</p>
<p>You can't disable versioning with B2. The best you can do is to set
the daysFromHidingToDeleting to 1 day. You can enable hard_delete in the
config also which will mean deletions won't cause versions but
overwrites will still cause versions to be made.</p>
<pre><code>rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=1</code></pre>
<p>See: https://www.backblaze.com/docs/cloud-storage-lifecycle-rules</p>
<p>Options:</p>
<ul>
<li>"daysFromHidingToDeleting": After a file has been hidden for this
many days it is deleted. 0 is off.</li>
<li>"daysFromStartingToCancelingUnfinishedLargeFiles": Cancels any
unfinished large file versions after this many days</li>
<li>"daysFromUploadingToHiding": This many days after uploading a file
is hidden</li>
</ul>
<h3 id="cleanup-3">cleanup</h3>
<p>Remove unfinished large file uploads.</p>
<pre><code>rclone backend cleanup remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command removes unfinished large file uploads of age greater
than max-age, which defaults to 24 hours.</p>
<p>Note that you can use --interactive/-i or --dry-run with this command
to see what it would do.</p>
<pre><code>rclone backend cleanup b2:bucket/path/to/object
rclone backend cleanup -o max-age=7w b2:bucket/path/to/object</code></pre>
<p>Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.</p>
<p>Options:</p>
<ul>
<li>"max-age": Max age of upload to delete</li>
</ul>
<h3 id="cleanup-hidden-1">cleanup-hidden</h3>
<p>Remove old versions of files.</p>
<pre><code>rclone backend cleanup-hidden remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command removes any old hidden versions of files.</p>
<p>Note that you can use --interactive/-i or --dry-run with this command
to see what it would do.</p>
<pre><code>rclone backend cleanup-hidden b2:bucket/path/to/dir</code></pre>
<h2 id="limitations-7">Limitations</h2>
<p><code>rclone about</code> is not supported by the B2 backend.
Backends without this capability cannot determine free space for an
rclone mount or use policy <code>mfs</code> (most free space) as a
member of an rclone union remote.</p>
<p>See <a href="https://rclone.org/overview/#optional-features">List of
backends that do not support rclone about</a> and <a
href="https://rclone.org/commands/rclone_about/">rclone about</a></p>
<h1 id="box">Box</h1>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required, e.g.
<code>remote:directory/subdirectory</code>.</p>
<p>The initial setup for Box involves getting a token from Box which you
can do either in your browser, or with a config.json downloaded from Box
to use JWT authentication. <code>rclone config</code> walks you through
it.</p>
<h2 id="configuration-4">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<div class="sourceCode" id="cb1128"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1128-1"><a href="#cb1128-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>This will guide you through an interactive setup process:</p>
<pre class="text"><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Box
   \ &quot;box&quot;
[snip]
Storage&gt; box
Box App Client Id - leave blank normally.
client_id&gt; 
Box App Client Secret - leave blank normally.
client_secret&gt;
Box App config.json location
Leave blank normally.
Enter a string value. Press Enter for the default (&quot;&quot;).
box_config_file&gt;
Box App Primary Access Token
Leave blank normally.
Enter a string value. Press Enter for the default (&quot;&quot;).
access_token&gt;

Enter a string value. Press Enter for the default (&quot;user&quot;).
Choose a number from below, or type in your own value
 1 / Rclone should act on behalf of a user
   \ &quot;user&quot;
 2 / Rclone should act on behalf of a service account
   \ &quot;enterprise&quot;
box_sub_type&gt;
Remote config
Use web browser to automatically authenticate rclone with remote?
 * Say Y if the machine running rclone has a web browser you can use
 * Say N if running rclone on a (remote) machine without web browser access
If not sure try Y. If Y failed, try N.
y) Yes
n) No
y/n&gt; y
If your browser doesn&#39;t open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXXXXXXXXXXXXXXXXXXXXX
Log in and authorize rclone for access
Waiting for code...
Got code
Configuration complete.
Options:
- type: box
- client_id:
- client_secret:
- token: {&quot;access_token&quot;:&quot;XXX&quot;,&quot;token_type&quot;:&quot;bearer&quot;,&quot;refresh_token&quot;:&quot;XXX&quot;,&quot;expiry&quot;:&quot;XXX&quot;}
Keep this &quot;remote&quot; remote?
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine without an internet-connected
web browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Box. This only runs from the moment it opens
your browser to the moment you get back the verification code. This is
on <code>http://127.0.0.1:53682/</code> and this may require you to
unblock it temporarily if you are running a host firewall.</p>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your Box</p>
<div class="sourceCode" id="cb1130"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1130-1"><a href="#cb1130-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsd remote:</span></code></pre></div>
<p>List all the files in your Box</p>
<div class="sourceCode" id="cb1131"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1131-1"><a href="#cb1131-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> ls remote:</span></code></pre></div>
<p>To copy a local directory to an Box directory called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="using-rclone-with-an-enterprise-account-with-sso">Using rclone
with an Enterprise account with SSO</h3>
<p>If you have an "Enterprise" account type with Box with single sign on
(SSO), you need to create a password to use Box with rclone. This can be
done at your Enterprise Box account by going to Settings, "Account" Tab,
and then set the password in the "Authentication" field.</p>
<p>Once you have done this, you can setup your Enterprise Box account
using the same procedure detailed above in the, using the password you
have just set.</p>
<h3 id="invalid-refresh-token">Invalid refresh token</h3>
<p>According to the <a
href="https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens">box
docs</a>:</p>
<blockquote>
<p>Each refresh_token is valid for one use in 60 days.</p>
</blockquote>
<p>This means that if you</p>
<ul>
<li>Don't use the box remote for 60 days</li>
<li>Copy the config file with a box refresh token in and use it in two
places</li>
<li>Get an error on a token refresh</li>
</ul>
<p>then rclone will return an error which includes the text
<code>Invalid refresh token</code>.</p>
<p>To fix this you will need to use oauth2 again to update the refresh
token. You can use the methods in <a
href="https://rclone.org/remote_setup/">the remote setup docs</a>,
bearing in mind that if you use the copy the config file method, you
should not use that remote on the computer you did the authentication
on.</p>
<p>Here is how to do it.</p>
<div class="sourceCode" id="cb1133"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb1133-1"><a href="#cb1133-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone config</span>
<span id="cb1133-2"><a href="#cb1133-2" aria-hidden="true" tabindex="-1"></a><span class="ex">Current</span> remotes:</span>
<span id="cb1133-3"><a href="#cb1133-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1133-4"><a href="#cb1133-4" aria-hidden="true" tabindex="-1"></a><span class="ex">Name</span>                 Type</span>
<span id="cb1133-5"><a href="#cb1133-5" aria-hidden="true" tabindex="-1"></a><span class="ex">====</span>                 ====</span>
<span id="cb1133-6"><a href="#cb1133-6" aria-hidden="true" tabindex="-1"></a><span class="ex">remote</span>               box</span>
<span id="cb1133-7"><a href="#cb1133-7" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1133-8"><a href="#cb1133-8" aria-hidden="true" tabindex="-1"></a><span class="ex">e</span><span class="er">)</span> <span class="ex">Edit</span> existing remote</span>
<span id="cb1133-9"><a href="#cb1133-9" aria-hidden="true" tabindex="-1"></a><span class="ex">n</span><span class="er">)</span> <span class="ex">New</span> remote</span>
<span id="cb1133-10"><a href="#cb1133-10" aria-hidden="true" tabindex="-1"></a><span class="ex">d</span><span class="er">)</span> <span class="ex">Delete</span> remote</span>
<span id="cb1133-11"><a href="#cb1133-11" aria-hidden="true" tabindex="-1"></a><span class="ex">r</span><span class="er">)</span> <span class="ex">Rename</span> remote</span>
<span id="cb1133-12"><a href="#cb1133-12" aria-hidden="true" tabindex="-1"></a><span class="ex">c</span><span class="er">)</span> <span class="ex">Copy</span> remote</span>
<span id="cb1133-13"><a href="#cb1133-13" aria-hidden="true" tabindex="-1"></a><span class="ex">s</span><span class="er">)</span> <span class="ex">Set</span> configuration password</span>
<span id="cb1133-14"><a href="#cb1133-14" aria-hidden="true" tabindex="-1"></a><span class="ex">q</span><span class="er">)</span> <span class="ex">Quit</span> config</span>
<span id="cb1133-15"><a href="#cb1133-15" aria-hidden="true" tabindex="-1"></a><span class="ex">e/n/d/r/c/s/q</span><span class="op">&gt;</span> e</span>
<span id="cb1133-16"><a href="#cb1133-16" aria-hidden="true" tabindex="-1"></a><span class="ex">Choose</span> a number from below, or type in an existing value</span>
<span id="cb1133-17"><a href="#cb1133-17" aria-hidden="true" tabindex="-1"></a> <span class="ex">1</span> <span class="op">&gt;</span> remote</span>
<span id="cb1133-18"><a href="#cb1133-18" aria-hidden="true" tabindex="-1"></a><span class="ex">remote</span><span class="op">&gt;</span> remote</span>
<span id="cb1133-19"><a href="#cb1133-19" aria-hidden="true" tabindex="-1"></a><span class="ex">Configuration</span> complete.</span>
<span id="cb1133-20"><a href="#cb1133-20" aria-hidden="true" tabindex="-1"></a><span class="ex">Options:</span></span>
<span id="cb1133-21"><a href="#cb1133-21" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> type: box</span>
<span id="cb1133-22"><a href="#cb1133-22" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> token: <span class="dt">{</span><span class="st">&quot;access_token&quot;</span><span class="dt">:</span><span class="st">&quot;XXX&quot;</span><span class="op">,</span><span class="st">&quot;token_type&quot;</span><span class="dt">:</span><span class="st">&quot;bearer&quot;</span><span class="op">,</span><span class="st">&quot;refresh_token&quot;</span><span class="dt">:</span><span class="st">&quot;XXX&quot;</span><span class="op">,</span><span class="st">&quot;expiry&quot;</span><span class="dt">:</span><span class="st">&quot;2017-07-08T23:40:08.059167677+01:00&quot;</span><span class="dt">}</span></span>
<span id="cb1133-23"><a href="#cb1133-23" aria-hidden="true" tabindex="-1"></a><span class="ex">Keep</span> this <span class="st">&quot;remote&quot;</span> remote<span class="pp">?</span></span>
<span id="cb1133-24"><a href="#cb1133-24" aria-hidden="true" tabindex="-1"></a><span class="ex">Edit</span> remote</span>
<span id="cb1133-25"><a href="#cb1133-25" aria-hidden="true" tabindex="-1"></a><span class="ex">Value</span> <span class="st">&quot;client_id&quot;</span> = <span class="st">&quot;&quot;</span></span>
<span id="cb1133-26"><a href="#cb1133-26" aria-hidden="true" tabindex="-1"></a><span class="ex">Edit?</span> <span class="er">(</span><span class="ex">y/n</span><span class="kw">)</span><span class="op">&gt;</span></span>
<span id="cb1133-27"><a href="#cb1133-27" aria-hidden="true" tabindex="-1"></a><span class="ex">y</span><span class="er">)</span> <span class="ex">Yes</span></span>
<span id="cb1133-28"><a href="#cb1133-28" aria-hidden="true" tabindex="-1"></a><span class="ex">n</span><span class="er">)</span> <span class="ex">No</span></span>
<span id="cb1133-29"><a href="#cb1133-29" aria-hidden="true" tabindex="-1"></a><span class="ex">y/n</span><span class="op">&gt;</span> n</span>
<span id="cb1133-30"><a href="#cb1133-30" aria-hidden="true" tabindex="-1"></a><span class="ex">Value</span> <span class="st">&quot;client_secret&quot;</span> = <span class="st">&quot;&quot;</span></span>
<span id="cb1133-31"><a href="#cb1133-31" aria-hidden="true" tabindex="-1"></a><span class="ex">Edit?</span> <span class="er">(</span><span class="ex">y/n</span><span class="kw">)</span><span class="op">&gt;</span></span>
<span id="cb1133-32"><a href="#cb1133-32" aria-hidden="true" tabindex="-1"></a><span class="ex">y</span><span class="er">)</span> <span class="ex">Yes</span></span>
<span id="cb1133-33"><a href="#cb1133-33" aria-hidden="true" tabindex="-1"></a><span class="ex">n</span><span class="er">)</span> <span class="ex">No</span></span>
<span id="cb1133-34"><a href="#cb1133-34" aria-hidden="true" tabindex="-1"></a><span class="ex">y/n</span><span class="op">&gt;</span> n</span>
<span id="cb1133-35"><a href="#cb1133-35" aria-hidden="true" tabindex="-1"></a><span class="ex">Remote</span> config</span>
<span id="cb1133-36"><a href="#cb1133-36" aria-hidden="true" tabindex="-1"></a><span class="ex">Already</span> have a token <span class="at">-</span> refresh<span class="pp">?</span></span>
<span id="cb1133-37"><a href="#cb1133-37" aria-hidden="true" tabindex="-1"></a><span class="ex">y</span><span class="er">)</span> <span class="ex">Yes</span></span>
<span id="cb1133-38"><a href="#cb1133-38" aria-hidden="true" tabindex="-1"></a><span class="ex">n</span><span class="er">)</span> <span class="ex">No</span></span>
<span id="cb1133-39"><a href="#cb1133-39" aria-hidden="tru