Rclone Commands

This is an index of all commands in rclone. Run rclone command --help to see the help for that command.

CommandDescription
rcloneShow help for rclone commands, flags and backends.
rclone aboutGet quota information from the remote.
rclone authorizeRemote authorization.
rclone backendRun a backend-specific command.
rclone bisyncPerform bidirectional synchronization between two paths.
rclone catConcatenates any files and sends them to stdout.
rclone checkChecks the files in the source and destination match.
rclone checksumChecks the files in the destination against a SUM file.
rclone cleanupClean up the remote if possible.
rclone completionOutput completion script for a given shell.
rclone completion bashOutput bash completion script for rclone.
rclone completion fishOutput fish completion script for rclone.
rclone completion powershellOutput powershell completion script for rclone.
rclone completion zshOutput zsh completion script for rclone.
rclone configEnter an interactive configuration session.
rclone config createCreate a new remote with name, type and options.
rclone config deleteDelete an existing remote.
rclone config disconnectDisconnects user from remote
rclone config dumpDump the config file as JSON.
rclone config editEnter an interactive configuration session.
rclone config encryptionset, remove and check the encryption for the config file
rclone config encryption checkCheck that the config file is encrypted
rclone config encryption removeRemove the config file encryption password
rclone config encryption setSet or change the config file encryption password
rclone config fileShow path of configuration file in use.
rclone config passwordUpdate password in an existing remote.
rclone config pathsShow paths used for configuration, cache, temp etc.
rclone config providersList in JSON format all the providers and options.
rclone config reconnectRe-authenticates user with remote.
rclone config redactedPrint redacted (decrypted) config file, or the redacted config for a single remote.
rclone config showPrint (decrypted) config file, or the config for a single remote.
rclone config touchEnsure configuration file exists.
rclone config updateUpdate options in an existing remote.
rclone config userinfoPrints info about logged in user of remote.
rclone copyCopy files from source to dest, skipping identical files.
rclone copytoCopy files from source to dest, skipping identical files.
rclone copyurlCopy the contents of the URL supplied content to dest:path.
rclone cryptcheckCryptcheck checks the integrity of an encrypted remote.
rclone cryptdecodeCryptdecode returns unencrypted file names.
rclone dedupeInteractively find duplicate filenames and delete/rename them.
rclone deleteRemove the files in path.
rclone deletefileRemove a single file from remote.
rclone gendocsOutput markdown docs for rclone to the directory supplied.
rclone gitannexSpeaks with git-annex over stdin/stdout.
rclone hashsumProduces a hashsum file for all the objects in the path.
rclone linkGenerate public link to file/folder.
rclone listremotesList all the remotes in the config file and defined in environment variables.
rclone lsList the objects in the path with size and path.
rclone lsdList all directories/containers/buckets in the path.
rclone lsfList directories and objects in remote:path formatted for parsing.
rclone lsjsonList directories and objects in the path in JSON format.
rclone lslList the objects in path with modification time, size and path.
rclone md5sumProduces an md5sum file for all the objects in the path.
rclone mkdirMake the path if it doesn’t already exist.
rclone mountMount the remote as file system on a mountpoint.
rclone moveMove files from source to dest.
rclone movetoMove file or directory from source to dest.
rclone ncduExplore a remote with a text based user interface.
rclone nfsmountMount the remote as file system on a mountpoint.
rclone obscureObscure password for use in the rclone config file.
rclone purgeRemove the path and all of its contents.
rclone rcRun a command against a running rclone.
rclone rcatCopies standard input to file on remote.
rclone rcdRun rclone listening to remote control commands only.
rclone rmdirRemove the empty directory at path.
rclone rmdirsRemove empty directories under the path.
rclone selfupdateUpdate the rclone binary.
rclone serveServe a remote over a protocol.
rclone serve dlnaServe remote:path over DLNA
rclone serve dockerServe any remote on docker’s volume plugin API.
rclone serve ftpServe remote:path over FTP.
rclone serve httpServe the remote over HTTP.
rclone serve nfsServe the remote as an NFS mount
rclone serve resticServe the remote for restic’s REST API.
rclone serve s3Serve remote:path over s3.
rclone serve sftpServe the remote over SFTP.
rclone serve webdavServe remote:path over WebDAV.
rclone settierChanges storage class/tier of objects in remote.
rclone sha1sumProduces an sha1sum file for all the objects in the path.
rclone sizePrints the total size and number of objects in remote:path.
rclone syncMake source and dest identical, modifying destination only.
rclone testRun a test command
rclone test changenotifyLog any change notify requests for the remote passed in.
rclone test histogramMakes a histogram of file name characters.
rclone test infoDiscovers file name or other limitations for paths.
rclone test makefileMake files with random contents of the size given
rclone test makefilesMake a random file hierarchy in a directory
rclone test memoryLoad all the objects at remote:path into memory and report memory stats.
rclone touchCreate new file or change file modification time.
rclone treeList the contents of the remote in a tree like fashion.
rclone versionShow the version number.