LinuxCommandLibrary

rclone

Synchronize files to and from cloud storage

TLDR

Launch an interactive menu to setup rclone

$ rclone config
copy

List contents of a directory on an rclone remote
$ rclone lsf [remote_name]:[path/to/directory]
copy

Copy a file or directory from the local machine to the remote destination
$ rclone copy [path/to/source_file_or_directory] [remote_name]:[path/to/directory]
copy

Copy files changed within the past 24 hours to a remote from the local machine, asking the user to confirm each file
$ rclone copy [[-i|--interactive]] --max-age 24h [remote_name]:[path/to/directory] [path/to/local_directory]
copy

Mirror a specific file or directory (Note: Unlike copy, sync removes files from the remote if it does not exist locally)
$ rclone sync [path/to/file_or_directory] [remote_name]:[path/to/directory]
copy

Delete a remote file or directory (Note: --dry-run means test, remove it from the command to actually delete)
$ rclone [[-n|--dry-run]] delete [remote_name]:[path/to/file_or_directory]
copy

Mount rclone remote (experimental)
$ rclone mount [remote_name]:[path/to/directory] [path/to/mount_point]
copy

Unmount rclone remote if fails (experimental)
$ fusermount [[-u|--update]] [path/to/mount_point]
copy

SYNOPSIS

rclone command [flags]

PARAMETERS

config file
    Path to the rclone configuration file. By default it is located in ~/.config/rclone/rclone.conf

copy
    Copy files from source to dest, skipping already copied

sync
    Make source and dest identical, modifying destination only.

move
    Move files from source to dest, deleting from source after copy.

delete
    Remove files from dest which are not in source.

ls
    List files in a remote.

lsd
    List all directories/containers/buckets in the object storage to the path.

mkdir
    Make a directory or container.

rmdir
    Remove an empty directory or container.

mount
    Mount the remote as a file system.

--transfers int
    Number of file transfers to run in parallel. (default 4)

--checkers int
    Number of checkers to run in parallel. (default 8)

--dry-run
    Do all actions without actually doing them

DESCRIPTION

rclone is a command-line program to manage files on cloud storage. It is a feature-rich alternative to cloud vendors' web interfaces. rclone supports over 70 cloud storage products including S3 object stores, business & consumer file storage services, as well as standard transfer protocols.

It features include: MD5/SHA-1 hashes checked at all times for file integrity; Timestamps preserved on files; Partial syncs supported on whole files; Copy new or changed files; Sync (one way) to make a directory identical; Check to check for file hash integrity; Can mount any of rclone's cloud storage as a disk on Windows, macOS and Linux; Serve files from cloud storage over HTTP, FTP, SFTP or DLNA; Union multiple cloud storage providers into one.

REMOTES

rclone uses the concept of 'remotes' to define cloud storage locations. Each remote is named and configured to connect to a specific cloud storage provider or protocol. Remotes can be local filesystem or other cloud locations.

CONFIGURATION

rclone requires configuration before it can be used with most cloud storage providers. The 'rclone config' command is used to create and manage remotes.

PATHS

rclone uses paths to specify files and directories on remotes. Paths take the form 'remote:path/to/file' or 'remote:/path/to/file'. The remote name is separated from the path by a colon.

SEE ALSO

rsync(1), cp(1)

Copied to clipboard