Difference between revisions of "Software:Rclone"
|Line 136:||Line 136:|
Latest revision as of 07:44, 31 July 2020
|Original author(s)||Nick Craig-Wood|
|Initial release||June 19, 2012|
|Operating system||Linux, Windows, macOS, FreeBSD, NetBSD, OpenBSD, Plan9, Solaris|
|Platform||Intel/AMD-64, Intel/AMD-32, ARM-32, ARM-64, MIPS-Big-Endian, MIPS-Little-Endian|
Rclone is a command line program to manage files on cloud storage. It is promoted as an alternative to individual cloud storage vendors' web interfaces. The rclone website lists fifty supported backends including major S3 services and consumer file sharing platforms.
Users have called Rclone The Swiss Army Knife of cloud storage, and likened it to magic. Whilst rclone is best known for its
rlone sync and
rclone mount commands, it provides a broad suite of file management utilities analogous to those ordinarily used for local disks. These rclone commands can be applied directly to the full range of rclone backends. In many cases they operate on directories, not files.
Rclone is widely used at hpc research sites to transfer large datasets. Examples include the University of Maryland, Iowa State University, University of Utah, National Institutes of Health, Wharton, Yale and Berkeley.
Rclone was promoted to stable version 1.00 in July 2014.
In May 2017 Amazon controversially barred new rclone users from its consumer Amazon Drive data storage product. Amazon Drive had been advertised as offering unlimited storage for £55 per year. Amazon blamed security concerns and also banned other upload services. Amazon's more expensive AWS S3 service continues to support new rclone users.
The original rclone logo was retired to be replaced with the present one in September 2018.
Amazon's AWS April 2020 public sector blog explained how the Fred Hutch Cancer Research Center were using rclone in their Motuz tool to migrate very large biomedical research datasets in and out of AWS S3 object stores.
1Fichier | Alibaba (Aliyun) Object Storage System (OSS) | Amazon Drive (See note) | Amazon S3 | Backblaze B2 | Box | Ceph | Citrix ShareFile | C14 | DigitalOcean Spaces | Dreamhost | Dropbox | FTP | Google Cloud Storage | Google Drive | Google Photos | HTTP | Hubic | Jottacloud | IBM COS S3 | Koofr | Mail.ru Cloud | Memset Memstore | Mega | Memory | Microsoft Azure Blob Storage | Microsoft OneDrive | Minio | Nextcloud | OVH | OpenDrive | OpenStack Swift | Oracle Cloud Storage | ownCloud | pCloud | premiumize.me | put.io | QingStor | Rackspace Cloud Files | rsync.net | Scaleway | Seafile | SFTP | StackPath | SugarSync | Tardigrade | Wasabi | WebDAV | Yandex Disk | The local filesystem
One or more remotes are defined from backends with
rclone config. Rclone can further layer those remotes through virtual, encrypted, chunked, cached, vfs-cached or union backends. Once defined they are referenced by other rclone commands.
Note that remote names are followed by a colon to distinguish them from local drives. For example, a remote example_remote containing a folder or pseudofolder my folder is referred to within a command as
rclone [flags] rclone [command]
about Get quota information from the remote. authorize Remote authorisation. cachestats Print cache stats for a remote cat Concatenates any files and sends them to stdout. check Checks the files in the source and destination match. cleanup Clean up the remote if possible config Enter an interactive configuration session. copy Copy files from source to dest, skipping already copied copyto Copy files from source to dest, skipping already copied copyurl Copy url content to dest. cryptcheck Cryptcheck checks the integrity of a crypted remote. cryptdecode Cryptdecode returns unencrypted file names. dbhashsum Produces a Dropbox hash file for all the objects in the path. dedupe Interactively find duplicate files and delete/rename them. delete Remove the contents of path. deletefile Remove a single file from remote. genautocomplete Output completion script for a given shell. gendocs Output markdown docs for rclone to the directory supplied. hashsum Produces an 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. 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'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. obscure Obscure password for use in the rclone.conf 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 path if empty. rmdirs Remove empty directories under the path. 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. 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.
Rclone can serve a web based graphical interface -
The rclone website lists third party developers that have used rclone within their own applications.
Rclone and rsync
Rsync transfers files between computers it is installed on. It operates at the block level and has a delta algorithm so that it only needs to transfer changes in files. Rclone has a wider range of file management capabilities, and types of backend it can address, but only works at a whole file/object level. Rclone decides which of those whole files to transfer after obtaining a checksum, to compare, from the remote server. In extremis, where checksums are not available, it can be configured to use file size and time.
- "Changelog". https://rclone.org/changelog/.
- "Rclone". https://rclone.org/.
- "Issues with special characters in filenames". June 6, 2020. https://forum.rclone.org/t/issues-with-special-characters-in-filenames/16955/11.
- "Stopping and starting rclone mid transfer". October 11, 2016. https://forum.rclone.org/t/stopping-and-starting-rclone-mid-transfer/60.
- "Is rclone more efficient than an nfs mount". June 10, 2020. https://forum.rclone.org/t/is-rclone-more-efficient-than-an-nfs-mount/16974/6.
- "rclone / rclone". https://github.com/rclone/rclone.
This article is released into the public domain