neulab/tldr huggingface dataset:
Choose an authentication method. Enter a string value. Press Enter for the default ("existing"). Choose a number from below, or type in your own value 1 / Use an existing access grant. \ "existing" 2 / Create a new access grant from satellite address, API key, and passphrase. \ "new" provider> new Satellite Address. Custom satellite address should match the format: `<nodeid>@<address>:<port>`. Enter a string value. Press Enter for the default ("us-central-1.tardigrade.io"). Choose a number from below, or type in your own value 1 / US Central 1 \ "us-central-1.tardigrade.io" 2 / Europe West 1 \ "europe-west-1.tardigrade.io" 3 / Asia East 1 \ "asia-east-1.tardigrade.io" satellite_address> 1 API Key. Enter a string value. Press Enter for the default (""). api_key> your-api-key-for-your-tardigrade-project Encryption Passphrase. To access existing objects enter passphrase used for uploading. Enter a string value. Press Enter for the default (""). passphrase> your-human-readable-encryption-passphrase Remote config -------------------- [remote] type = tardigrade satellite_address = 12EayRS2V1kEsWESU9QMRseFhdxYxKicsiFmxrsLZHeLUtdps3S@us-central-1.tardigrade.io:7777 api_key = your-api-key-for-your-tardigrade-project passphrase = your-human-readable-encryption-passphrase access_grant = the-access-grant-generated-from-the-api-key-and-passphrase -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y
Standard options Here are the standard options specific to tardigrade (Tardigrade Decentralized Cloud Storage).
--tardigrade-provider Choose an authentication method.
• Env Var: RCLONE_TARDIGRADE_PROVIDER
• Default: "existing"
• "existing"
• Use an existing access grant.
• "new"
• Create a new access grant from satellite address, API key, and passphrase.
--tardigrade-access-grant Access grant.
• Config: access_grant
• Env Var: RCLONE_TARDIGRADE_ACCESS_GRANT
--tardigrade-satellite-address Satellite address.
Custom satellite address should match the format: <nodeid>@<address>:<port>.
• Config: satellite_address
• Env Var: RCLONE_TARDIGRADE_SATELLITE_ADDRESS
• Default: "us-central-1.tardigrade.io"
• "us-central-1.tardigrade.io"
• US Central 1
• "europe-west-1.tardigrade.io"
• Europe West 1
• "asia-east-1.tardigrade.io"
• Asia East 1
--tardigrade-api-key API key.
• Env Var: RCLONE_TARDIGRADE_API_KEY
--tardigrade-passphrase Encryption passphrase.
To access existing objects enter passphrase used for uploading.
• Config: passphrase
• Env Var: RCLONE_TARDIGRADE_PASSPHRASE
Usage Paths are specified as remote:bucket (or remote: for the lsf command.) You may put subdirectories in too, e.g.  remote:bucket/path/to/dir.
Once configured you can then use rclone like this.
Create a new bucket Use the mkdir command to create new bucket, e.g.  bucket.
List all buckets Use the lsf command to list all buckets.
rclone lsf remote:
Note the colon (:) character at the end of the command line.
Delete a bucket Use the rmdir command to delete an empty bucket.
rclone rmdir remote:bucket
Use the purge command to delete a non-empty bucket with all its content.
rclone purge remote:bucket
Upload objects Use the copy command to upload an object.
rclone copy --progress /home/local/directory/file.ext remote:bucket/path/to/dir/
The --progress flag is for displaying progress information.  Remove it if you don't need this information.
Use a folder in the local path to upload all its objects.
rclone copy --progress /home/local/directory/ remote:bucket/path/to/dir/
Only modified files will be copied.
List objects Use the ls command to list recursively all objects in a bucket.
Add the folder to the remote path to list recursively all objects in this folder.
rclone ls remote:bucket/path/to/dir/
Use the lsf command to list non-recursively all objects in a bucket or a folder.
rclone lsf remote:bucket/path/to/dir/
Download objects Use the copy command to download an object.
rclone copy --progress remote:bucket/path/to/dir/file.ext /home/local/directory/
Use a folder in the remote path to download all its objects.
rclone copy --progress remote:bucket/path/to/dir/ /home/local/directory/
Delete objects Use the deletefile command to delete a single object.
rclone deletefile remote:bucket/path/to/dir/file.ext
Use the delete command to delete all object in a folder.
rclone delete remote:bucket/path/to/dir/
Print the total size of objects Use the size command to print the total size of objects in a bucket or a folder.
rclone size remote:bucket/path/to/dir/
Sync two Locations Use the sync command to sync the source to the destination, changing the destination only, deleting any excess files.
rclone sync -i --progress /home/local/directory/ remote:bucket/path/to/dir/
Since this can cause data loss, test first with the --dry-run flag to see exactly what would be copied and deleted.
The sync can be done also from Tardigrade to the local file system.
rclone sync -i --progress remote:bucket/path/to/dir/ /home/local/directory/
Or between two Tardigrade buckets.
rclone sync -i --progress remote-us:bucket/path/to/dir/ remote-europe:bucket/path/to/dir/
Or even between another cloud storage and Tardigrade.
rclone sync -i --progress s3:bucket/path/to/dir/ tardigrade:bucket/path/to/dir/
Limitations rclone about is not supported by the rclone Tardigrade backend.  Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.
Known issues If you get errors like too many open files this usually happens when the default ulimit for system max open files is exceeded.  Native Storj protocol opens a large number of TCP connections (each of which is counted as an open file).  For a single upload stream you can expect 110 TCP connections to be opened.  For a single download stream you can expect 35.  This batch of connections will be opened for every 64 MiB segment and you should also expect TCP connections to be reused.  If you do many transfers you eventually open a connection to most storage nodes (thousands of nodes).
To fix these, please raise your system limits.  You can do this issuing a ulimit -n 65536 just before you run rclone.  To change the limits more permanently you can add this to your shell startup script, e.g. $HOME/.bashrc, or change the system-wide configuration, usually /etc/sysctl.conf and/or /etc/security/limits.conf, but please refer to your operating system manual.
Uptobox This is a Backend for Uptobox file storage service.  Uptobox is closer to a one-click hoster than a traditional cloud storage provider and therefore not suitable for long term storage.
Configuration To configure an Uptobox backend you'll need your personal api token. You'll find it in your account settings (https://uptobox.com/my_account)
Here is an example of how to make a remote called remote with the default setup.  First run:
Name                 Type ====                 ==== TestUptobox          uptobox
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> n name> uptobox Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [...] 37 / Uptobox \ "uptobox" [...] Storage> uptobox ** See help for uptobox backend at: https://rclone.org/uptobox/ **
Your API Key, get it from https://uptobox.com/my_account Enter a string value. Press Enter for the default (""). api_key> xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Edit advanced config? (y/n) y) Yes n) No (default) y/n> n Remote config -------------------- [uptobox] type = uptobox api_key = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d>
List directories in top level of your Uptobox
List all the files in your Uptobox
To copy a local directory to an Uptobox directory called backup
Modified time and hashes Uptobox supports neither modified times nor checksums.
Character   Value   Replacement ──────────────────────────────── "           0x22         ＂ `           0x41         ｀
Standard options Here are the standard options specific to uptobox (Uptobox).
--uptobox-access-token Your access token.
Get it from https://uptobox.com/my_account.
• Env Var: RCLONE_UPTOBOX_ACCESS_TOKEN
Advanced options Here are the advanced options specific to uptobox (Uptobox).
--uptobox-encoding This sets the encoding for the backend.
• Env Var: RCLONE_UPTOBOX_ENCODING
• Default: Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot
Limitations Uptobox will delete inactive files that have not been accessed in 60 days.
rclone about is not supported by this backend an overview of used space can however been seen in the uptobox web interface.
Union The union remote provides a unification similar to UnionFS using other remotes.
During the initial setup with rclone config you will specify the upstream remotes as a space separated list.  The upstream remotes can either be a local paths or other remotes.
Attribute :ro and :nc can be attach to the end of path to tag the remote as read only or no create, e.g.  remote:directory/subdirectory:ro or remote:directory/subdirectory:nc.
Subfolders can be used in upstream remotes.  Assume a union remote named backup with the remotes mydrive:private/backup.  Invoking rclone mkdir backup:desktop is exactly the same as invoking rclone mkdir mydrive:private/backup/desktop.
There will be no special handling of paths containing ..  segments. Invoking rclone mkdir backup:../desktop is exactly the same as invoking rclone mkdir mydrive:private/backup/../desktop.
Configuration Here is an example of how to make a union called remote for local folders.  First run:
No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Union merges the contents of several remotes \ "union" [snip] Storage> union List of space separated upstreams. Can be 'upstreama:test/dir upstreamb:', '\"upstreama:test/space:ro dir\" upstreamb:', etc. Enter a string value. Press Enter for the default (""). upstreams> remote1:dir1 remote2:dir2 remote3:dir3 Policy to choose upstream on ACTION class. Enter a string value. Press Enter for the default ("epall"). action_policy> Policy to choose upstream on CREATE class. Enter a string value. Press Enter for the default ("epmfs"). create_policy> Policy to choose upstream on SEARCH class. Enter a string value. Press Enter for the default ("ff"). search_policy> Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. Enter a signed integer. Press Enter for the default ("120"). cache_time> Remote config -------------------- [remote] type = union upstreams = remote1:dir1 remote2:dir2 remote3:dir3 -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y Current remotes:
Name                 Type ====                 ==== remote               union
List directories in top level in remote1:dir1, remote2:dir2 and remote3:dir3
List all the files in remote1:dir1, remote2:dir2 and remote3:dir3
Copy another local directory to the union directory called source, which will be placed into remote3:dir3
rclone copy C:\source remote:source
Behavior / Policies The behavior of union backend is inspired by trapexit/mergerfs (https://github.com/trapexit/mergerfs).  All functions are grouped into 3 categories: action, create and search.  These functions and categories can be assigned a policy which dictates what file or directory is chosen when performing that behavior.  Any policy can be assigned to a function or category though some may not be very useful in practice.  For instance: rand (random) may be useful for file creation (create) but could lead to very odd behavior if used for delete if there were more than one copy of the file.
Function / Category classifications Category   Description       Functions ─────────────────────────────────────────────────────────────────────────────── action     Writing           move, rmdir, rmdirs, delete, purge and copy, sync Existing file     (as destination when file exist) create     Create            copy, sync (as destination when file not exist) non-existing file search     Reading and       ls, lsd, lsl, cat, md5sum, sha1sum and copy, sync listing file      (as source) N/A                          size, about
Path Preservation Policies, as described below, are of two basic types.  path preserving and non-path preserving.
All policies which start with ep (epff, eplfs, eplus, epmfs, eprand) are path preserving.  ep stands for existing path.
A path preserving policy will only consider upstreams where the relative path being accessed already exists.
When using non-path preserving policies paths will be created in target upstreams as necessary.
Quota Relevant Policies Some policies rely on quota information.  These policies should be used only if your upstreams support the respective quota fields.
Policy       Required Field ──────────────────────────── lfs, eplfs   Free mfs, epmfs   Free lus, eplus   Used lno, eplno   Objects
To check if your upstream supports the field, run rclone about remote: [flags] and see if the required field exists.
Filters Policies basically search upstream remotes and create a list of files / paths for functions to work on.  The policy is responsible for filtering and sorting.  The policy type defines the sorting but filtering is mostly uniform as described below.
• No search policies filter.
• All action policies will filter out remotes which are tagged as read-only.
• All create policies will filter out remotes which are tagged read-only or no-create.
If all remotes are filtered an error will be returned.
Policy descriptions The policies definition are inspired by trapexit/mergerfs (https://github.com/trapexit/mergerfs) but not exactly the same.  Some policy definition could be different due to the much larger latency of remote file systems.
Policy             Description ────────────────────────────────────────────────────────────────────────── all                Search category: same as epall.  Action category: same as epall.  Create category: act on all upstreams. epall (existing    Search category: Given this order configured, act on path, all)         the first one found where the relative path exists. Action category: apply to all found.  Create category: act on all upstreams where the relative path exists. epff (existing     Act on the first one found, by the time upstreams path, first        reply, where the relative path exists. found) eplfs (existing    Of all the upstreams on which the relative path exists path, least free   choose the one with the least free space. space) eplus (existing    Of all the upstreams on which the relative path exists path, least used   choose the one with the least used space. space) eplno (existing    Of all the upstreams on which the relative path exists path, least        choose the one with the least number of objects. number of objects) epmfs (existing    Of all the upstreams on which the relative path exists path, most free    choose the one with the most free space. space) eprand (existing   Calls epall and then randomizes.  Returns only one path, random)      upstream. ff (first found)   Search category: same as epff.  Action category: same as epff.  Create category: Act on the first one found by the time upstreams reply. lfs (least free    Search category: same as eplfs.  Action category: same space)             as eplfs.  Create category: Pick the upstream with the least available free space. lus (least used    Search category: same as eplus.  Action category: same space)             as eplus.  Create category: Pick the upstream with the least used space. lno (least         Search category: same as eplno.  Action category: same number of          as eplno.  Create category: Pick the upstream with the objects)           least number of objects. mfs (most free     Search category: same as epmfs.  Action category: same space)             as epmfs.  Create category: Pick the upstream with the most available free space. newest             Pick the file / directory with the largest mtime. rand (random)      Calls all and then randomizes.  Returns only one upstream.
Standard options Here are the standard options specific to union (Union merges the contents of several upstream fs).
--union-upstreams List of space separated upstreams.
Can be 'upstreama:test/dir upstreamb:', '"upstreama:test/space:ro dir" upstreamb:', etc.
• Config: upstreams
• Env Var: RCLONE_UNION_UPSTREAMS
--union-action-policy Policy to choose upstream on ACTION category.
• Config: action_policy
• Env Var: RCLONE_UNION_ACTION_POLICY
• Default: "epall"
--union-create-policy Policy to choose upstream on CREATE category.
• Config: create_policy
• Env Var: RCLONE_UNION_CREATE_POLICY
• Default: "epmfs"
--union-search-policy Policy to choose upstream on SEARCH category.
• Config: search_policy
• Env Var: RCLONE_UNION_SEARCH_POLICY
• Default: "ff"
--union-cache-time Cache time of usage and free space (in seconds).
This option is only useful when a path preserving policy is used.
• Config: cache_time
• Env Var: RCLONE_UNION_CACHE_TIME
• Default: 120
WebDAV Paths are specified as remote:path
Configuration To configure the WebDAV remote you will need to have a URL for it, and a username and password.  If you know what kind of system you are connecting to then rclone can enable extra features.
No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Webdav \ "webdav" [snip] Storage> webdav URL of http host to connect to Choose a number from below, or type in your own value 1 / Connect to example.com \ "https://example.com" url> https://example.com/remote.php/webdav/ Name of the Webdav site/service/software you are using Choose a number from below, or type in your own value 1 / Nextcloud \ "nextcloud" 2 / Owncloud \ "owncloud" 3 / Sharepoint Online, authenticated by Microsoft account. \ "sharepoint" 4 / Sharepoint with NTLM authentication. Usually self-hosted or on-premises. \ "sharepoint-ntlm" 5 / Other site/service or software \ "other" vendor> 1 User name user> user Password. y) Yes type in my own password g) Generate random password n) No leave this optional password blank y/g/n> y Enter the password: password: Confirm the password: password: Bearer token instead of user/pass (e.g. a Macaroon) bearer_token> Remote config -------------------- [remote] type = webdav url = https://example.com/remote.php/webdav/ vendor = nextcloud user = user pass = *** ENCRYPTED *** bearer_token = -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
List directories in top level of your WebDAV
List all the files in your WebDAV
To copy a local directory to an WebDAV directory called backup
Modified time and hashes Plain WebDAV does not support modified times.  However when used with Owncloud or Nextcloud rclone will support modified times.
Likewise plain WebDAV does not support hashes, however when used with Owncloud or Nextcloud rclone will support SHA1 and MD5 hashes.  Depending on the exact version of Owncloud or Nextcloud hashes may appear on all objects, or only on objects which had a hash uploaded with them.
Standard options Here are the standard options specific to webdav (Webdav).
--webdav-url URL of http host to connect to.
E.g.  https://example.com.
• Env Var: RCLONE_WEBDAV_URL
--webdav-vendor Name of the Webdav site/service/software you are using.
• Config: vendor
• Env Var: RCLONE_WEBDAV_VENDOR
• "nextcloud"
• "owncloud"
• Owncloud
• "sharepoint"
• Sharepoint Online, authenticated by Microsoft account
• "sharepoint-ntlm"
• Sharepoint with NTLM authentication, usually self-hosted or on-premises
• "other"
• Other site/service or software
--webdav-user User name.
In case NTLM authentication is used, the username should be in the format 'Domain'.
• Env Var: RCLONE_WEBDAV_USER
--webdav-pass Password.
• Env Var: RCLONE_WEBDAV_PASS
--webdav-bearer-token Bearer token instead of user/pass (e.g.  a Macaroon).
• Config: bearer_token
• Env Var: RCLONE_WEBDAV_BEARER_TOKEN
Advanced options Here are the advanced options specific to webdav (Webdav).
--webdav-bearer-token-command Command to run to get a bearer token.
• Config: bearer_token_command
• Env Var: RCLONE_WEBDAV_BEARER_TOKEN_COMMAND
--webdav-encoding This sets the encoding for the backend.
Default encoding is Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8 for sharepoint-ntlm or identity otherwise.
• Env Var: RCLONE_WEBDAV_ENCODING
--webdav-headers Set HTTP headers for all transactions.
Use this to set additional HTTP headers for all transactions
• Env Var: RCLONE_WEBDAV_HEADERS
Provider notes See below for notes on specific providers.
Owncloud Click on the settings cog in the bottom right of the page and this will show the WebDAV URL that rclone needs in the config step.  It will look something like https://example.com/remote.php/webdav/.
Owncloud supports modified times using the X-OC-Mtime header.
Nextcloud This is configured in an identical way to Owncloud.  Note that Nextcloud initially did not support streaming of files (rcat) whereas Owncloud did, but this (https://github.com/nextcloud/nextcloud-snap/issues/365) seems to be fixed as of 2020-11-27 (tested with rclone v1.53.1 and Nextcloud Server v19).
Sharepoint Online Rclone can be used with Sharepoint provided by OneDrive for Business or Office365 Education Accounts.  This feature is only needed for a few of these Accounts, mostly Office365 Education ones.  These accounts are sometimes not verified by the domain owner github#1975 (https://github.com/rclone/rclone/issues/1975)
This means that these accounts can't be added using the official API (other Accounts should work with the "onedrive" option).  However, it is possible to access them using webdav.
To use a sharepoint remote with rclone, add it like this: First, you need to get your remote's URL:
• Go here (https://onedrive.live.com/about/en-us/signin/) to open your OneDrive or to sign in
• Now take a look at your address bar, the URL should look like this: https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/_layouts/15/onedrive.aspx
You'll only need this URL up to the email address.  After that, you'll most likely want to add "/Documents".  That subdirectory contains the actual data stored on your OneDrive.
Add the remote to rclone like this: Configure the url as https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/Documents and use your normal account email and password for user and pass.  If you have 2FA enabled, you have to generate an app password.  Set the vendor to sharepoint.
Your config file should look like this:
[sharepoint] type = webdav url = https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/Documents vendor = sharepoint user = YourEmailAddress pass = encryptedpassword
Sharepoint with NTLM Authentication Use this option in case your (hosted) Sharepoint is not tied to OneDrive accounts and uses NTLM authentication.
To get the url configuration, similarly to the above, first navigate to the desired directory in your browser to get the URL, then strip everything after the name of the opened directory.
Example: If the URL is: https://example.sharepoint.com/sites/12345/Documents/Forms/AllItems.aspx
The configuration to use would be: https://example.sharepoint.com/sites/12345/Documents
Set the vendor to sharepoint-ntlm.
NTLM uses domain and user name combination for authentication, set user to DOMAIN\username.
[sharepoint] type = webdav url = https://[YOUR-DOMAIN]/some-path-to/Documents vendor = sharepoint-ntlm user = DOMAIN\user pass = encryptedpassword
Required Flags for SharePoint As SharePoint does some special things with uploaded documents, you won't be able to use the documents size or the documents hash to compare if a file has been changed since the upload / which file is newer.
For Rclone calls copying files (especially Office files such as .docx, .xlsx, etc.) from/to SharePoint (like copy, sync, etc.), you should append these flags to ensure Rclone uses the "Last Modified" datetime property to compare your documents:
--ignore-size --ignore-checksum --update
dCache dCache is a storage system that supports many protocols and authentication/authorisation schemes.  For WebDAV clients, it allows users to authenticate with username and password (BASIC), X.509, Kerberos, and various bearer tokens, including Macaroons (https://www.dcache.org/manuals/workshop-2017-05-29-Umea/000-Final/anupam_macaroons_v02.pdf) and OpenID-Connect (https://en.wikipedia.org/wiki/OpenID_Connect) access tokens.
Configure as normal using the other type.  Don't enter a username or password, instead enter your Macaroon as the bearer_token.
The config will end up looking something like this.
[dcache] type = webdav url = https://dcache... vendor = other user = pass = bearer_token = your-macaroon
There is a script (https://github.com/sara- nl/GridScripts/blob/master/get-macaroon) that obtains a Macaroon from a dCache WebDAV endpoint, and creates an rclone config file.
Macaroons may also be obtained from the dCacheView web-browser/JavaScript client that comes with dCache.
OpenID-Connect dCache also supports authenticating with OpenID-Connect access tokens. OpenID-Connect is a protocol (based on OAuth 2.0) that allows services to identify users who have authenticated with some central service.
Support for OpenID-Connect in rclone is currently achieved using another software package called oidc-agent (https://github.com/indigo-dc/oidc- agent).  This is a command-line tool that facilitates obtaining an access token.  Once installed and configured, an access token is obtained by running the oidc-token command.  The following example shows a (shortened) access token obtained from the XDC OIDC Provider.
paul@celebrimbor:~$ oidc-token XDC eyJraWQ[...]QFXDt0 paul@celebrimbor:~$
Note Before the oidc-token command will work, the refresh token must be loaded into the oidc agent.  This is done with the oidc-add command (e.g., oidc-add XDC).  This is typically done once per login session. Full details on this and how to register oidc-agent with your OIDC Provider are provided in the oidc-agent documentation (https://indigo- dc.gitbooks.io/oidc-agent/).
The rclone bearer_token_command configuration option is used to fetch the access token from oidc-agent.
Configure as a normal WebDAV endpoint, using the 'other' vendor, leaving the username and password empty.  When prompted, choose to edit the advanced config and enter the command to get a bearer token (e.g., oidc-agent XDC).
The following example config shows a WebDAV endpoint that uses oidc-agent to supply an access token from the XDC OIDC Provider.
[dcache] type = webdav url = https://dcache.example.org/ vendor = other bearer_token_command = oidc-token XDC
Yandex Disk Yandex Disk (https://disk.yandex.com) is a cloud storage solution created by Yandex (https://yandex.com).
Configuration Here is an example of making a yandex configuration.  First run
No remotes found - make a new one n) New remote s) Set configuration password n/s> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Yandex Disk \ "yandex" [snip] Storage> yandex Yandex Client Id - leave blank normally. client_id> Yandex Client Secret - leave blank normally. client_secret> Remote config Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] client_id = client_secret = token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","token_type":"OAuth","expiry":"2016-12-29T12:27:11.362788025Z"} -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
Note that rclone runs a webserver on your local machine to collect the token as returned from Yandex Disk.  This only runs from the moment it opens your browser to the moment you get back the verification code. This is on http://127.0.0.1:53682/ and this it may require you to unblock it temporarily if you are running a host firewall.
Yandex paths may be as deep as required, e.g. remote:directory/subdirectory.
Modified time Modified times are supported and are stored accurate to 1 ns in custom metadata called rclone_modified in RFC3339 with nanoseconds format.
MD5 checksums MD5 checksums are natively supported by Yandex Disk.
Emptying Trash If you wish to empty your trash you can use the rclone cleanup remote: command which will permanently delete all your trashed files.  This command does not take any path arguments.
Restricted filename characters The default restricted characters set (https://rclone.org/overview/#restricted-characters) are replaced.
Standard options Here are the standard options specific to yandex (Yandex Disk).
--yandex-client-id OAuth Client Id.
• Env Var: RCLONE_YANDEX_CLIENT_ID
--yandex-client-secret OAuth Client Secret.
• Env Var: RCLONE_YANDEX_CLIENT_SECRET
Advanced options Here are the advanced options specific to yandex (Yandex Disk).
--yandex-token OAuth Access Token as a JSON blob.
• Env Var: RCLONE_YANDEX_TOKEN
--yandex-auth-url Auth server URL.
• Env Var: RCLONE_YANDEX_AUTH_URL
--yandex-token-url Token server url.
• Env Var: RCLONE_YANDEX_TOKEN_URL
--yandex-encoding This sets the encoding for the backend.
• Env Var: RCLONE_YANDEX_ENCODING
Limitations When uploading very large files (bigger than about 5 GiB) you will need to increase the --timeout parameter.  This is because Yandex pauses (perhaps to calculate the MD5SUM for the entire file) before returning confirmation that the file has been uploaded.  The default handling of timeouts in rclone is to assume a 5 minute pause is an error and close the connection - you'll see net/http: timeout awaiting response headers errors in the logs if this is happening.  Setting the timeout to twice the max size of file in GiB should be enough, so if you want to upload a 30 GiB file set a timeout of 2 * 30 = 60m, that is --timeout 60m.
Having a Yandex Mail account is mandatory to use the Yandex.Disk subscription.  Token generation will work without a mail account, but Rclone won't be able to complete any actions.
[403 - DiskUnsupportedUserAccountTypeError] User account type is not supported.
Zoho Workdrive Zoho WorkDrive (https://www.zoho.com/workdrive/) is a cloud storage solution created by Zoho (https://zoho.com).
Configuration Here is an example of making a zoho configuration.  First run
No remotes found - make a new one n) New remote s) Set configuration password n/s> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / Zoho \ "zoho" [snip] Storage> zoho ** See help for zoho backend at: https://rclone.org/zoho/ **
OAuth Client Id Leave blank normally. Enter a string value. Press Enter for the default (""). client_id> OAuth Client Secret Leave blank normally. Enter a string value. Press Enter for the default (""). client_secret> Edit advanced config? (y/n) y) Yes n) No (default) y/n> n Remote config Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine y) Yes (default) n) No y/n> If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=LVn0IHzxej1ZkmQw31d0wQ Log in and authorize rclone for access Waiting for code... Got code Choose a number from below, or type in your own value 1 / MyTeam \ "4u28602177065ff22426787a6745dba8954eb" Enter a Team ID> 1 Choose a number from below, or type in your own value 1 / General \ "4u2869d2aa6fca04f4f2f896b6539243b85b1" Enter a Workspace ID> 1 -------------------- [remote] type = zoho token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","token_type":"Zoho-oauthtoken","refresh_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","expiry":"2020-10-12T00:54:52.370275223+02:00"} root_folder_id = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d>
Rclone runs a webserver on your local computer to collect the authorization token from Zoho Workdrive.  This is only from the moment your browser is opened until the token is returned.  The webserver runs on http://127.0.0.1:53682/.  If local port 53682 is protected by a firewall you may need to temporarily unblock the firewall to complete authorization.
Zoho paths may be as deep as required, eg remote:directory/subdirectory.
Modified time Modified times are currently not supported for Zoho Workdrive
Checksums No checksums are supported.
Usage information To view your current quota you can use the rclone about remote: command which will display your current usage.
Restricted filename characters Only control characters and invalid UTF-8 are replaced.  In addition most Unicode full-width characters are not supported at all and will be removed from filenames during upload.
Standard options Here are the standard options specific to zoho (Zoho).
--zoho-client-id OAuth Client Id.
• Env Var: RCLONE_ZOHO_CLIENT_ID
--zoho-client-secret OAuth Client Secret.
• Env Var: RCLONE_ZOHO_CLIENT_SECRET
--zoho-region Zoho region to connect to.
You'll have to use the region your organization is registered in.  If not sure use the same top level domain as you connect to in your browser.
• Env Var: RCLONE_ZOHO_REGION
• "com"
• United states / Global
• Europe
• "in"
• India
• "com.au"
• Australia
Advanced options Here are the advanced options specific to zoho (Zoho).
--zoho-token OAuth Access Token as a JSON blob.
• Env Var: RCLONE_ZOHO_TOKEN
--zoho-auth-url Auth server URL.
• Env Var: RCLONE_ZOHO_AUTH_URL
--zoho-token-url Token server url.
• Env Var: RCLONE_ZOHO_TOKEN_URL
--zoho-encoding This sets the encoding for the backend.
• Env Var: RCLONE_ZOHO_ENCODING
• Default: Del,Ctl,InvalidUtf8
Local Filesystem Local paths are specified as normal filesystem paths, e.g. /path/to/wherever, so
rclone sync -i /home/source /tmp/destination
Will sync /home/source to /tmp/destination.
Configuration For consistencies sake one can also configure a remote of type local in the config file, and access the local filesystem using rclone remote paths, e.g.  remote:path/to/wherever, but it is probably easier not to.
Modified time Rclone reads and writes the modified time using an accuracy determined by the OS.  Typically this is 1ns on Linux, 10 ns on Windows and 1 Second on OS X.
Filenames Filenames should be encoded in UTF-8 on disk.  This is the normal case for Windows and OS X.
There is a bit more uncertainty in the Linux world, but new distributions will have UTF-8 encoded files names.  If you are using an old Linux filesystem with non UTF-8 file names (e.g.  latin1) then you can use the convmv tool to convert the filesystem to UTF-8.  This tool is available in most distributions' package managers.
If an invalid (non-UTF8) filename is read, the invalid characters will be replaced with a quoted representation of the invalid bytes.  The name gro\xdf will be transferred as gro‛DF.  rclone will emit a debug message in this case (use -v to see), e.g.
Local file system at .: Replacing invalid UTF-8 characters in "gro\xdf"
Restricted characters With the local backend, restrictions on the characters that are usable in file or directory names depend on the operating system.  To check what rclone will replace by default on your system, run rclone help flags local-encoding.
On non Windows platforms the following characters are replaced when handling file names.
When running on Windows the following characters are replaced.  This list is based on the Windows file naming conventions (https://docs.microsoft.com/de-de/windows/desktop/FileIO/naming-a- file#naming-conventions).
Character   Value   Replacement ──────────────────────────────── NUL         0x00         ␀ SOH         0x01         ␁ STX         0x02         ␂ ETX         0x03         ␃ EOT         0x04         ␄ ENQ         0x05         ␅ ACK         0x06         ␆ BEL         0x07         ␇ BS          0x08         ␈ HT          0x09         ␉ LF          0x0A         ␊ VT          0x0B         ␋ FF          0x0C         ␌ CR          0x0D         ␍ SO          0x0E         ␎ SI          0x0F         ␏ DLE         0x10         ␐ DC1         0x11         ␑ DC2         0x12         ␒ DC3         0x13         ␓ DC4         0x14         ␔ NAK         0x15         ␕ SYN         0x16         ␖ ETB         0x17         ␗ CAN         0x18         ␘ EM          0x19         ␙ SUB         0x1A         ␚ ESC         0x1B         ␛ FS          0x1C         ␜ GS          0x1D         ␝ RS          0x1E         ␞ US          0x1F         ␟ /           0x2F         ／ "           0x22         ＂ *           0x2A         ＊ :           0x3A         ： <           0x3C         ＜ >           0x3E         ＞ ?           0x3F         ？ \           0x5C         ＼ |           0x7C         ｜
File names on Windows can also not end with the following characters. These only get replaced if they are the last character in the name:
Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can't be converted to UTF-16.
Paths on Windows On Windows there are many ways of specifying a path to a file system resource.  Local paths can be absolute, like C:\path\to\wherever, or relative, like ..\wherever.  Network paths in UNC format, \\server\share, are also supported.  Path separator can be either \ (as in C:\path\to\wherever) or / (as in C:/path/to/wherever).  Length of these paths are limited to 259 characters for files and 247 characters for directories, but there is an alternative extended-length path format increasing the limit to (approximately) 32,767 characters.  This format requires absolute paths and the use of prefix \\?\, e.g. \\?\D:\some\very\long\path.  For convenience rclone will automatically convert regular paths into the corresponding extended-length paths, so in most cases you do not have to worry about this (read more below).
Note that Windows supports using the same prefix \\?\ to specify path to volumes identified by their GUID, e.g. \\?\Volume{b75e2c83-0000-0000-0000-602f00000000}\some\path.  This is not supported in rclone, due to an issue (https://github.com/golang/go/issues/39785) in go.
Long paths Rclone handles long paths automatically, by converting all paths to extended-length path format (https://docs.microsoft.com/en- us/windows/win32/fileio/maximum-file-path-limitation), which allows paths up to 32,767 characters.
This conversion will ensure paths are absolute and prefix them with the \\?\.  This is why you will see that your paths, for instance .\files is shown as path \\?\C:\files in the output, and \\server\share as \\?\UNC\server\share.
However, in rare cases this may cause problems with buggy file system drivers like EncFS (https://github.com/rclone/rclone/issues/261).  To disable UNC conversion globally, add this to your .rclone.conf file:
[local] nounc = true
If you want to selectively disable UNC, you can add it to a separate entry like this:
[nounc] type = local nounc = true
And use rclone like this:
rclone copy c:\src nounc:z:\dst
This will use UNC paths on c:\src but not on z:\dst.  Of course this will cause problems if the absolute path length of a file exceeds 259 characters on z, so only use this option if you have to.
Symlinks / Junction points Normally rclone will ignore symlinks or junction points (which behave like symlinks under Windows).
If you supply --copy-links or -L then rclone will follow the symlink and copy the pointed to file or directory.  Note that this flag is incompatible with --links / -l.
This flag applies to all commands.
For example, supposing you have a directory structure like this
$ tree /tmp/a /tmp/a ├── b -> ../b ├── expected -> ../expected ├── one └── two └── three
Then you can see the difference with and without the flag like this
$ rclone ls /tmp/a 6 one 6 two/three
$ rclone -L ls /tmp/a 4174 expected 6 one 6 two/three 6 b/two 6 b/one
--links, -l Normally rclone will ignore symlinks or junction points (which behave like symlinks under Windows).
If you supply this flag then rclone will copy symbolic links from the local storage, and store them as text files, with a '.rclonelink' suffix in the remote storage.
The text file will contain the target of the symbolic link (see example).
$ tree /tmp/a /tmp/a ├── file1 -> ./file4 └── file2 -> /home/user/file3
Copying the entire directory with '-l'
$ rclone copyto -l /tmp/a/file1 remote:/tmp/a/
The remote files are created with a '.rclonelink' suffix
$ rclone ls remote:/tmp/a 5 file1.rclonelink 14 file2.rclonelink
The remote files will contain the target of the symbolic links
$ rclone cat remote:/tmp/a/file1.rclonelink ./file4
$ rclone cat remote:/tmp/a/file2.rclonelink /home/user/file3
Copying them back with '-l'
$ rclone copyto -l remote:/tmp/a/ /tmp/b/
$ tree /tmp/b /tmp/b ├── file1 -> ./file4 └── file2 -> /home/user/file3
However, if copied back without '-l'
$ rclone copyto remote:/tmp/a/ /tmp/b/
$ tree /tmp/b /tmp/b ├── file1.rclonelink └── file2.rclonelink
Note that this flag is incompatible with -copy-links / -L.
Restricting filesystems with --one-file-system Normally rclone will recurse through filesystems as mounted.
However if you set --one-file-system or -x this tells rclone to stay in the filesystem specified by the root and not to recurse into different file systems.
For example if you have a directory hierarchy like this
root ├── disk1     - disk1 mounted on the root │   └── file3 - stored on disk1 ├── disk2     - disk2 mounted on the root │   └── file4 - stored on disk12 ├── file1     - stored on the root disk └── file2     - stored on the root disk
Using rclone --one-file-system copy root remote: will only copy file1 and file2.  Eg
$ rclone -q --one-file-system ls root 0 file1 0 file2
$ rclone -q ls root 0 disk1/file3 0 disk2/file4 0 file1 0 file2
NB Rclone (like most unix tools such as du, rsync and tar) treats a bind mount to the same device as being on the same filesystem.
NB This flag is only available on Unix based systems.  On systems where it isn't supported (e.g.  Windows) it will be ignored.
Advanced options Here are the advanced options specific to local (Local Disk).
--local-nounc Disable UNC (long path names) conversion on Windows.
• Config: nounc
• Env Var: RCLONE_LOCAL_NOUNC
• Disables long file names.
--copy-links / -L Follow symlinks and copy the pointed to item.
• Config: copy_links
• Env Var: RCLONE_LOCAL_COPY_LINKS
--links / -l Translate symlinks to/from regular files with a '.rclonelink' extension.
• Config: links
• Env Var: RCLONE_LOCAL_LINKS
--skip-links Don't warn about skipped symlinks.
This flag disables warning messages on skipped symlinks or junction points, as you explicitly acknowledge that they should be skipped.
• Env Var: RCLONE_LOCAL_SKIP_LINKS
--local-zero-size-links Assume the Stat size of links is zero (and read them instead) (deprecated).
Rclone used to use the Stat size of links as the link size, but this fails in quite a few places:
• On some virtual filesystems (such ash LucidLink)
• Android
So rclone now always reads the link.
• Config: zero_size_links
• Env Var: RCLONE_LOCAL_ZERO_SIZE_LINKS
--local-unicode-normalization Apply unicode NFC normalization to paths and filenames.
This flag can be used to normalize file names into unicode NFC form that are read from the local filesystem.
Rclone does not normally touch the encoding of file names it reads from the file system.
This can be useful when using macOS as it normally provides decomposed (NFD) unicode which in some language (eg Korean) doesn't display properly on some OSes.
Note that rclone compares filenames with unicode normalization in the sync routine so this flag shouldn't normally be used.
• Config: unicode_normalization
• Env Var: RCLONE_LOCAL_UNICODE_NORMALIZATION
--local-no-check-updated Don't check to see if the files change during upload.
Normally rclone checks the size and modification time of files as they are being uploaded and aborts with a message which starts "can't copy - source file is being updated" if the file changes during upload.
However on some file systems this modification time check may fail (e.g. Glusterfs #2206 (https://github.com/rclone/rclone/issues/2206)) so this check can be disabled with this flag.
If this flag is set, rclone will use its best efforts to transfer a file which is being updated.  If the file is only having things appended to it (e.g.  a log) then rclone will transfer the log file with the size it had the first time rclone saw it.
If the file is being modified throughout (not just appended to) then the transfer may fail with a hash check failure.
In detail, once the file has had stat() called on it for the first time we:
• Only transfer the size that stat gave
• Only checksum the size that stat gave
• Don't update the stat info for the file
• Config: no_check_updated
• Env Var: RCLONE_LOCAL_NO_CHECK_UPDATED
--one-file-system / -x Don't cross filesystem boundaries (unix/macOS only).
• Config: one_file_system
• Env Var: RCLONE_LOCAL_ONE_FILE_SYSTEM
--local-case-sensitive Force the filesystem to report itself as case sensitive.
Normally the local backend declares itself as case insensitive on Windows/macOS and case sensitive for everything else.  Use this flag to override the default choice.
• Config: case_sensitive
• Env Var: RCLONE_LOCAL_CASE_SENSITIVE
--local-case-insensitive Force the filesystem to report itself as case insensitive.
• Config: case_insensitive
• Env Var: RCLONE_LOCAL_CASE_INSENSITIVE
--local-no-preallocate Disable preallocation of disk space for transferred files.
Preallocation of disk space helps prevent filesystem fragmentation. However, some virtual filesystem layers (such as Google Drive File Stream) may incorrectly set the actual file size equal to the preallocated space, causing checksum and file size checks to fail.  Use this flag to disable preallocation.
• Config: no_preallocate
• Env Var: RCLONE_LOCAL_NO_PREALLOCATE
--local-no-sparse Disable sparse files for multi-thread downloads.
On Windows platforms rclone will make sparse files when doing multi-thread downloads.  This avoids long pauses on large files where the OS zeros the file.  However sparse files may be undesirable as they cause disk fragmentation and can be slow to work with.
• Config: no_sparse
• Env Var: RCLONE_LOCAL_NO_SPARSE
--local-no-set-modtime Disable setting modtime.
Normally rclone updates modification time of files after they are done uploading.  This can cause permissions issues on Linux platforms when the user rclone is running as does not own the file uploaded, such as when copying to a CIFS mount owned by another user.  If this option is enabled, rclone will no longer update the modtime after copying a file.
• Config: no_set_modtime
• Env Var: RCLONE_LOCAL_NO_SET_MODTIME
--local-encoding This sets the encoding for the backend.
• Env Var: RCLONE_LOCAL_ENCODING
• Default: Slash,Dot
Backend commands Here are the commands specific to the local backend.
noop A null operation for testing backend commands
rclone backend noop remote: [options] [<arguments>+]
This is a test command which has some options you can try to change the output.
• "echo": echo the input arguments
• "error": return an error based on option value
Changelog v1.57.0 - 2021-11-01 See commits (https://github.com/rclone/rclone/compare/v1.56.0...v1.57.0)
• New backends
• Sia: for Sia decentralized cloud (Ian Levesque, Matthew Sevey, Ivan Andreev)
• Hasher: caches hashes and enable hashes for backends that don't support them (Ivan Andreev)
• New commands
• lsjson --stat: to get info about a single file/dir and operations/stat api (Nick Craig-Wood)
• config paths: show configured paths (albertony)
• New Features
• about: Make human-readable output more consistent with other commands (albertony)
• Use go1.17 for building and make go1.14 the minimum supported (Nick Craig-Wood)
• Update Go to 1.16 and NDK to 22b for Android builds (x0b)
• config
• Support hyphen in remote name from environment variable (albertony)
• Make temporary directory user-configurable (albertony)
• Convert --cache-dir value to an absolute path (albertony)
• Do not override MIME types from OS defaults (albertony)
• docs
• Toc styling and header levels cleanup (albertony)
• Extend documentation on valid remote names (albertony)