Nick Craig-WoodVersion v1.63.0e90537b3 years agoHistory
73440 lines · 1.9 MB · Text
RawDownload
.\"t.\" Automatically generated by Pandoc 2.9.2.1.\".TH "rclone" "1" "Jun 30, 2023" "User Manual" "".hy.SH Rclone syncs your files to cloud storage.PP.IP \[bu] 2About rclone.IP \[bu] 2What can rclone do for you?.IP \[bu] 2What features does rclone have?.IP \[bu] 2What providers does rclone support?.IP \[bu] 2Download (https://rclone.org/downloads/).IP \[bu] 2Install (https://rclone.org/install/).IP \[bu] 2Donate. (https://rclone.org/donate/).SS About rclone.PPRclone is a command-line program to manage files on cloud storage.It is a feature-rich alternative to cloud vendors\[aq] web storageinterfaces.Over 40 cloud storage products support rclone including S3 objectstores, business & consumer file storage services, as well as standardtransfer protocols..PPRclone has powerful cloud equivalents to the unix commands rsync, cp,mv, mount, ls, ncdu, tree, rm, and cat.Rclone\[aq]s familiar syntax includes shell pipeline support, and\f[C]--dry-run\f[R] protection.It is used at the command line, in scripts or via its API..PPUsers call rclone \f[I]\[dq]The Swiss army knife of cloudstorage\[dq]\f[R], and \f[I]\[dq]Technology indistinguishable frommagic\[dq]\f[R]..PPRclone really looks after your data.It preserves timestamps and verifies checksums at all times.Transfers over limited bandwidth; intermittent connections, or subjectto quota can be restarted, from the last good file transferred.You can check (https://rclone.org/commands/rclone_check/) the integrityof your files.Where possible, rclone employs server-side transfers to minimise localbandwidth use and transfers from one provider to another without usinglocal disk..PPVirtual backends wrap local and cloud file systems to applyencryption (https://rclone.org/crypt/),compression (https://rclone.org/compress/),chunking (https://rclone.org/chunker/),hashing (https://rclone.org/hasher/) andjoining (https://rclone.org/union/)..PPRclone mounts (https://rclone.org/commands/rclone_mount/) any local,cloud or virtual filesystem as a disk on Windows, macOS, linux andFreeBSD, and also serves these overSFTP (https://rclone.org/commands/rclone_serve_sftp/),HTTP (https://rclone.org/commands/rclone_serve_http/),WebDAV (https://rclone.org/commands/rclone_serve_webdav/),FTP (https://rclone.org/commands/rclone_serve_ftp/) andDLNA (https://rclone.org/commands/rclone_serve_dlna/)..PPRclone is mature, open-source software originally inspired by rsync andwritten in Go (https://golang.org).The friendly support community is familiar with varied use cases.Official Ubuntu, Debian, Fedora, Brew and Chocolatey repos.include rclone.For the latest version downloading fromrclone.org (https://rclone.org/downloads/) is recommended..PPRclone is widely used on Linux, Windows and Mac.Third-party developers create innovative backup, restore, GUI andbusiness process solutions using the rclone command line or API..PPRclone does the heavy lifting of communicating with cloud storage..SS What can rclone do for you?.PPRclone helps you:.IP \[bu] 2Backup (and encrypt) files to cloud storage.IP \[bu] 2Restore (and decrypt) files from cloud storage.IP \[bu] 2Mirror cloud data to other cloud services or locally.IP \[bu] 2Migrate data to the cloud, or between cloud storage vendors.IP \[bu] 2Mount multiple, encrypted, cached or diverse cloud storage as a disk.IP \[bu] 2Analyse and account for data held on cloud storage usinglsf (https://rclone.org/commands/rclone_lsf/),ljson (https://rclone.org/commands/rclone_lsjson/),size (https://rclone.org/commands/rclone_size/),ncdu (https://rclone.org/commands/rclone_ncdu/).IP \[bu] 2Union (https://rclone.org/union/) file systems together to presentmultiple local and/or cloud file systems as one.SS Features.IP \[bu] 2Transfers.RS 2.IP \[bu] 2MD5, SHA1 hashes are checked at all times for file integrity.IP \[bu] 2Timestamps are preserved on files.IP \[bu] 2Operations can be restarted at any time.IP \[bu] 2Can be to and from network, e.g.two different cloud providers.IP \[bu] 2Can use multi-threaded downloads to local disk.RE.IP \[bu] 2Copy (https://rclone.org/commands/rclone_copy/) new or changed files tocloud storage.IP \[bu] 2Sync (https://rclone.org/commands/rclone_sync/) (one way) to make adirectory identical.IP \[bu] 2Move (https://rclone.org/commands/rclone_move/) files to cloud storagedeleting the local after verification.IP \[bu] 2Check (https://rclone.org/commands/rclone_check/) hashes and formissing/extra files.IP \[bu] 2Mount (https://rclone.org/commands/rclone_mount/) your cloud storage asa network disk.IP \[bu] 2Serve (https://rclone.org/commands/rclone_serve/) local or remote filesoverHTTP (https://rclone.org/commands/rclone_serve_http/)/WebDav (https://rclone.org/commands/rclone_serve_webdav/)/FTP (https://rclone.org/commands/rclone_serve_ftp/)/SFTP (https://rclone.org/commands/rclone_serve_sftp/)/DLNA (https://rclone.org/commands/rclone_serve_dlna/).IP \[bu] 2Experimental Web based GUI (https://rclone.org/gui/).SS Supported providers.PP(There are many others, built on standard protocols such as WebDAV orS3, that work out of the box.).IP \[bu] 21Fichier.IP \[bu] 2Akamai Netstorage.IP \[bu] 2Alibaba Cloud (Aliyun) Object Storage System (OSS).IP \[bu] 2Amazon Drive.IP \[bu] 2Amazon S3.IP \[bu] 2Backblaze B2.IP \[bu] 2Box.IP \[bu] 2Ceph.IP \[bu] 2China Mobile Ecloud Elastic Object Storage (EOS).IP \[bu] 2Arvan Cloud Object Storage (AOS).IP \[bu] 2Citrix ShareFile.IP \[bu] 2Cloudflare R2.IP \[bu] 2DigitalOcean Spaces.IP \[bu] 2Digi Storage.IP \[bu] 2Dreamhost.IP \[bu] 2Dropbox.IP \[bu] 2Enterprise File Fabric.IP \[bu] 2Fastmail Files.IP \[bu] 2FTP.IP \[bu] 2Google Cloud Storage.IP \[bu] 2Google Drive.IP \[bu] 2Google Photos.IP \[bu] 2HDFS.IP \[bu] 2Hetzner Storage Box.IP \[bu] 2HiDrive.IP \[bu] 2HTTP.IP \[bu] 2Internet Archive.IP \[bu] 2Jottacloud.IP \[bu] 2IBM COS S3.IP \[bu] 2IDrive e2.IP \[bu] 2IONOS Cloud.IP \[bu] 2Koofr.IP \[bu] 2Liara Object Storage.IP \[bu] 2Mail.ru Cloud.IP \[bu] 2Memset Memstore.IP \[bu] 2Mega.IP \[bu] 2Memory.IP \[bu] 2Microsoft Azure Blob Storage.IP \[bu] 2Microsoft OneDrive.IP \[bu] 2Minio.IP \[bu] 2Nextcloud.IP \[bu] 2OVH.IP \[bu] 2Blomp Cloud Storage.IP \[bu] 2OpenDrive.IP \[bu] 2OpenStack Swift.IP \[bu] 2Oracle Cloud Storage Swift.IP \[bu] 2Oracle Object Storage.IP \[bu] 2ownCloud.IP \[bu] 2pCloud.IP \[bu] 2Petabox.IP \[bu] 2PikPak.IP \[bu] 2premiumize.me.IP \[bu] 2put.io.IP \[bu] 2QingStor.IP \[bu] 2Qiniu Cloud Object Storage (Kodo).IP \[bu] 2Rackspace Cloud Files.IP \[bu] 2rsync.net.IP \[bu] 2Scaleway.IP \[bu] 2Seafile.IP \[bu] 2Seagate Lyve Cloud.IP \[bu] 2SeaweedFS.IP \[bu] 2SFTP.IP \[bu] 2Sia.IP \[bu] 2SMB / CIFS.IP \[bu] 2StackPath.IP \[bu] 2Storj.IP \[bu] 2SugarSync.IP \[bu] 2Tencent Cloud Object Storage (COS).IP \[bu] 2Uptobox.IP \[bu] 2Wasabi.IP \[bu] 2WebDAV.IP \[bu] 2Yandex Disk.IP \[bu] 2Zoho WorkDrive.IP \[bu] 2The local filesystem.SS Virtual providers.PPThese backends adapt or modify other storage providers:.IP \[bu] 2Alias: Rename existing remotes.IP \[bu] 2Cache: Cache remotes (DEPRECATED).IP \[bu] 2Chunker: Split large files.IP \[bu] 2Combine: Combine multiple remotes into a directory tree.IP \[bu] 2Compress: Compress files.IP \[bu] 2Crypt: Encrypt files.IP \[bu] 2Hasher: Hash files.IP \[bu] 2Union: Join multiple remotes to work together.SS Links.IP \[bu] 2Home page (https://rclone.org/).IP \[bu] 2GitHub project page for source and bugtracker (https://github.com/rclone/rclone).IP \[bu] 2Rclone Forum (https://forum.rclone.org).IP \[bu] 2Downloads (https://rclone.org/downloads/).SH Install.PPRclone is a Go program and comes as a single binary file..SS Quickstart.IP \[bu] 2Download (https://rclone.org/downloads/) the relevant binary..IP \[bu] 2Extract the \f[C]rclone\f[R] executable, \f[C]rclone.exe\f[R] onWindows, from the archive..IP \[bu] 2Run \f[C]rclone config\f[R] to setup.See rclone config docs (https://rclone.org/docs/) for more details..IP \[bu] 2Optionally configure automatic execution..PPSee below for some expanded Linux / macOS / Windows instructions..PPSee the usage (https://rclone.org/docs/) docs for how to use rclone, orrun \f[C]rclone -h\f[R]..PPAlready installed rclone can be easily updated to the latest versionusing the rcloneselfupdate (https://rclone.org/commands/rclone_selfupdate/) command..SS Script installation.PPTo install rclone on Linux/macOS/BSD systems, run:.IP.nf\f[C]sudo -v ; curl https://rclone.org/install.sh | sudo bash\f[R].fi.PPFor beta installation, run:.IP.nf\f[C]sudo -v ; curl https://rclone.org/install.sh | sudo bash -s beta\f[R].fi.PPNote that this script checks the version of rclone installed first andwon\[aq]t re-download if not needed..SS Linux installation.SS Precompiled binary.PPFetch and unpack.IP.nf\f[C]curl -O https://downloads.rclone.org/rclone-current-linux-amd64.zipunzip rclone-current-linux-amd64.zipcd rclone-*-linux-amd64\f[R].fi.PPCopy binary file.IP.nf\f[C]sudo cp rclone /usr/bin/sudo chown root:root /usr/bin/rclonesudo chmod 755 /usr/bin/rclone\f[R].fi.PPInstall manpage.IP.nf\f[C]sudo mkdir -p /usr/local/share/man/man1sudo cp rclone.1 /usr/local/share/man/man1/sudo mandb\f[R].fi.PPRun \f[C]rclone config\f[R] to setup.See rclone config docs (https://rclone.org/docs/) for more details..IP.nf\f[C]rclone config\f[R].fi.SS macOS installation.SS Installation with brew.IP.nf\f[C]brew install rclone\f[R].fi.PPNOTE: This version of rclone will not support \f[C]mount\f[R] any more(see #5373 (https://github.com/rclone/rclone/issues/5373)).If mounting is wanted on macOS, either install a precompiled binary orenable the relevant option when installing from source..PPNote that this is a third party installer not controlled by the rclonedevelopers so it may be out of date.Its current version is as below..PP[IMAGE: Homebrewpackage (https://repology.org/badge/version-for-repo/homebrew/rclone.svg)] (https://repology.org/project/rclone/versions).SS Precompiled binary, using curl.PPTo avoid problems with macOS gatekeeper enforcing the binary to besigned and notarized it is enough to download with \f[C]curl\f[R]..PPDownload the latest version of rclone..IP.nf\f[C]cd && curl -O https://downloads.rclone.org/rclone-current-osx-amd64.zip\f[R].fi.PPUnzip the download and cd to the extracted folder..IP.nf\f[C]unzip -a rclone-current-osx-amd64.zip && cd rclone-*-osx-amd64\f[R].fi.PPMove rclone to your $PATH.You will be prompted for your password..IP.nf\f[C]sudo mkdir -p /usr/local/binsudo mv rclone /usr/local/bin/\f[R].fi.PP(the \f[C]mkdir\f[R] command is safe to run, even if the directoryalready exists)..PPRemove the leftover files..IP.nf\f[C]cd .. && rm -rf rclone-*-osx-amd64 rclone-current-osx-amd64.zip\f[R].fi.PPRun \f[C]rclone config\f[R] to setup.See rclone config docs (https://rclone.org/docs/) for more details..IP.nf\f[C]rclone config\f[R].fi.SS Precompiled binary, using a web browser.PPWhen downloading a binary with a web browser, the browser will set themacOS gatekeeper quarantine attribute.Starting from Catalina, when attempting to run \f[C]rclone\f[R], apop-up will appear saying:.IP.nf\f[C]\[dq]rclone\[dq] cannot be opened because the developer cannot be verified.macOS cannot verify that this app is free from malware.\f[R].fi.PPThe simplest fix is to run.IP.nf\f[C]xattr -d com.apple.quarantine rclone\f[R].fi.SS Windows installation.SS Precompiled binary.PPFetch the correct binary for your processor type by clicking on theselinks.If not sure, use the first link.

Lines 1–500 of 73440.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t