Skip to content

Guide · Open source

How to use rclone: setup, copy and sync files to cloud storage

Updated · written with AI from the project's own documentation and checked against our catalogue data

Rclone is a command-line program for syncing files and directories to and from many cloud storage providers. The project describes it as "rsync for cloud storage". This guide explains what it is, how to get the source, which providers it supports, and when it is the right tool. It is written for readers who are comfortable in a terminal and want to move or back up files between storage services without writing custom code for each one.

rclonerclone/rclone · ★ 60.7k · MIT

Quick start

  1. 1Decide if rclone fits. Confirm you are comfortable with a command-line tool and need to move files between cloud providers.
  2. 2Get the source. Run git clone https://github.com/rclone/rclone.git or download a release from the project's download page.
  3. 3Read the installation notes. Open the installation page on rclone.org to find build or install steps for your operating system.
  4. 4Set up a remote. Follow the documentation page for your provider to create a named remote with your credentials.
  5. 5Test with a small folder. Run a copy or sync on a small test directory and check the result before using real data.
  6. 6Automate recurring jobs. Once a command works, put it in a script or scheduler to run regular backups or mirrors.

What rclone does

Rclone syncs files and directories to and from different cloud storage providers. The README describes it as "rsync for cloud storage", which is a useful way to think about it if you already know rsync for copying files between machines.

The project is open source under the MIT licence and written in Go.

Which storage providers rclone supports

The README lists a very large set of providers. Examples named in the source include Amazon S3, Google Drive, Dropbox, Backblaze B2, Microsoft OneDrive, Google Cloud Storage, Microsoft Azure Blob Storage, Wasabi, and Swift-based services. Protocol-based targets such as SFTP, FTP, and WebDAV are also listed.

Check the provider list in the README or on the documentation site before you start, because support is listed per provider and some services have their own setup page.

  • Object storage: Amazon S3, Backblaze B2, Wasabi, Google Cloud Storage, Microsoft Azure Blob Storage
  • Consumer drives: Google Drive, Dropbox, Microsoft OneDrive
  • Protocols: SFTP, FTP, WebDAV

Get rclone from the repository

The README gives this command to clone the repository. Downloading a prebuilt release from the project's download page is another route listed in the README links, and the installation page covers platform-specific steps.

The source does not list prerequisites for installing rclone, so check the installation page for what your system needs.

git clone https://github.com/rclone/rclone.git

Configure a remote before your first transfer

Rclone works with named remotes, one per storage account. You set up each remote with its provider's settings, such as credentials or an API key, before you can copy to or from it. The README points to the documentation site for each provider's configuration steps, so read the page for your provider before you run any transfer.

Keep your credentials private. Do not paste them into shared scripts or public repositories.

Copy, move and sync files

Once a remote is configured, rclone commands move data between a local path and a remote, or between two remotes. Use the documentation for the exact subcommands and flags, since the README does not list them. Test with a small folder first so you can see what a sync will change before you run it on important data.

Sync-style commands can delete files on the destination to match the source. Read the documentation for the command you pick before running it against real data.

  • Start with a small test folder
  • Check the documentation for each subcommand's behaviour
  • Run recurring jobs from a script or scheduler once a command works by hand

What people use it for

  • Backing up local files to object storage such as Amazon S3 or Backblaze B2
  • Mirroring files between two cloud providers without writing custom code
  • Moving data from one storage service to another
  • Running scripted, recurring transfers from a server

Frequently asked questions

Is rclone free to use?

Rclone is open source and released under the MIT licence, according to the README. The licence allows use, so check the licence file in the repository for the exact terms.

What is rclone used for?

Rclone syncs files and directories to and from cloud storage providers from the command line. People use it to back up, mirror, or move files between services.

Which cloud services does rclone support?

The README lists a large set of providers, including Amazon S3, Google Drive, Dropbox, Backblaze B2, OneDrive, and Azure Blob Storage, plus SFTP, FTP, and WebDAV.

Is rclone the same as rsync?

The project describes rclone as "rsync for cloud storage", so it works in a similar spirit. Rclone is aimed at cloud providers rather than machine-to-machine copying over SSH.

Is there a graphical version of rclone?

The README describes rclone as a command-line program. If you want a point-and-click desktop sync app, rclone is not the right fit.

How does rclone compare to restic or Syncthing?

Restic, Syncthing, Duplicati, and s3cmd are listed as comparable projects in this analysis. Pick based on whether you need cloud transfer across many providers (rclone), encrypted backups, device-to-device sync, or S3-only commands.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Rclone suits people who are comfortable in a terminal and need one tool to move or back up files across many cloud providers. It is a poor choice if you want a point-and-click sync app or only need one provider's official client, and anyone unwilling to read provider configuration docs will struggle at the first step.

Install options & downloads