Skip to contents

Binary installation

Install and locate the rclone binary.

install_rclone()
Install the rclone binary

Low-level interface

Run any rclone command directly.

rclone()
Run an rclone command

Remote configuration

Create and manage cloud storage remotes.

rclone_config_create()
Configure an rclone remote
rclone_config_set()
Set individual parameters on an existing remote
rclone_config_show()
Show rclone configuration
rclone_config_delete()
Delete an rclone remote
rclone_listremotes()
List configured remotes

Listing and metadata

List objects and retrieve metadata.

rclone_ls()
List objects in a remote path
rclone_lsd()
List directories in a remote path
rclone_stat()
Get metadata for a single object
rclone_size()
Get total size of a remote path

File transfer

Copy, move, and synchronise files.

rclone_copy()
Copy files between remotes or local paths
rclone_move()
Move files between remotes or local paths
rclone_sync()
Sync a source to a destination
rclone_copyurl()
Copy a URL directly to a remote

File operations

Read, create, and delete files and directories.

rclone_cat()
Output file content to R
rclone_mkdir()
Create a directory or bucket
rclone_rmdir()
Remove an empty directory
rclone_delete()
Delete files at a remote path
rclone_purge()
Remove a path and all its contents

Utilities

Miscellaneous rclone utilities.

rclone_check()
Check whether two remotes are in sync
rclone_link()
Generate a public link for a remote file
rclone_about()
Get quota information for a remote
rclone_version()
Show rclone version information