Skip to content

rclone | Cheatsheet

Rclone is an open source, multi threaded, command line computer program to manage or migrate content on cloud and other high latency storage. Its capabilities include sync, transfer, crypt, cache, union, compress and mount. The rclone website lists supported backends including S3 and Google Drive.

Fastest possible rclone to google drive

rclone copy --transfers=45 --checkers=45 --buffer-size=75M \
    --log-level INFO --log-file=~/logs/rclone/rclone.log   \ 
    --progress-terminal-title  --progress  --stats-one-line \ 
    --create-empty-src-dirs --fast-list \ 
    --max-backlog=999999  --drive-chunk-size=512M  \ 
    /path/ google-drive:/path/on/cloud 

Download from google drive to local path

rclone sync \
    --drive-chunk-size 512M  \
    --transfers=45 --checkers=45 \
    --progress google_drive: /home/<user>/test

Upload from local path to google drive

rclone sync \
    --drive-chunk-size 512M  \
    --transfers=45 --checkers=45  \
    --progress /home/<user>/pictures google_photos:

Download from onedrive to localdrive

rclone sync \
    --drive-chunk-size 512M  \
    --transfers=45 \
  --checkers=45 \
    --progress onedrive: /mnt/usb/cloud/onedrive

Upload from onedrive to localdrive

rclone sync \
    --drive-chunk-size 512M  \
    --transfers=45 \
    --checkers=45 \
    --progress /mnt/usb/cloud/onedrive onedrive:

Mount google photos

rclone mount --allow-non-empty --allow-other --allow-root --daemon \ 
    --file-perms 7777 --dir-perms 7777 --no-seek --vfs-cache-mode off \ 
    google-photos: /mnt/google-photos/

Mount onedrive

rclone mount \
    --allow-non-empty \
    --allow-other \
    --allow-root \
    --daemon \
    --file-perms 7777 \
    --dir-perms 7777 \
    -no-seek \
    --vfs-cache-mode off \
    onedrive: /mnt/cloud/onedrive

Copy a folder to onedrive cloud with 45 transfers in parallel

rclone copy /mnt/onedrive  \
    --fast-list \
    --max-backlog=999999 \
    --drive-chunk-size=512M \
    --transfers=45 \
    --checkers=45  \
    --buffer-size=75M \
    --verbose onedrive:/path/on/cloud

Update to get latest features

rclone selfupdate

Create new configuration

rclone config

Allow mounting over a non-empty directory

rclone mount --allow-non-empty                        

Allow access to other users

rclone mount --allow-other                           

Allow access to root user

rclone mount --allow-root                            

Use asynchronous reads

rclone mount --async-read                             

Time for which file/directory attributes are cached

rclone mount --attr-timeout duration                  

Run mount in background and exit parent process

rclone mount --daemon                                 

Time limit for rclone to respond to kernel

rclone mount --daemon-timeout duration                

Time to wait for ready mount from daemon

rclone mount --daemon-wait duration                   

Debug the FUSE internals - needs -v

rclone mount --debug-fuse                             

Makes kernel enforce access control based on the file mode

rclone mount --default-permissions                   

Set the device name - default is remote:path

rclone mount --devname string                         

Time to cache directory entries for

rclone mount --dir-cache-time duration                

Directory permissions (default 0777)

rclone mount --dir-perms FileMode                    

File permissions (default 0666)

rclone mount --file-perms FileMode                   

Flags or arguments to be passed direct to libfuse/WinFsp

rclone mount --fuse-flag stringArray                 

Override the gid field set by the filesystem

rclone mount --gid uint32                             

The number of bytes that can be prefetched for sequential reads

rclone mount --max-read-ahead SizeSuffix              

Mount as remote network drive, instead of fixed disk drive

rclone mount --network-mode                           

Don't compare checksums on up/download

rclone mount --no-checksum                            

Don't read/write the modification time

rclone mount --no-modtime                             

Don't allow seeking in files

rclone mount --no-seek                                

Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true)

rclone mount --noappledouble                          

Ignore all "*" extended attributes (supported on OSX only)

rclone mount --noapplexattr                           

Option for libfuse/WinFsp

rclone mount --option <stringArray>                     

Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)

rclone mount --poll-interval <duration>                 

Only allow read-only access

rclone mount --read-only                              

Override the uid field set by the filesystem

rclone mount --uid uint32                             

Override the permission bits set by the filesystem

rclone mount --umask int                              

Max age of objects in the cache

rclone mount --vfs-cache-max-age duration             

Max total size of objects in the cache

rclone mount --vfs-cache-max-size SizeSuffix

Cache mode off|minimal|writes|full

rclone mount --vfs-cache-mode CacheMode              

Interval to poll the cache for stale objects

rclone mount --vfs-cache-poll-interval <duration>   

If a file name not found, find a case insensitive match

rclone mount --vfs-case-insensitive                   

Specify the total space of disk (default off)

rclone mount --vfs-disk-space-total-size <SizeSuffix>

Use fast (less accurate) fingerprints for change detection

rclone mount --vfs-fast-fingerprint                   

Extra read ahead over --buffer-size when using cache-mode full

rclone mount --vfs-read-ahead SizeSuffix             

Read the source objects in chunks (default 128MiB)

rclone mount --vfs-read-chunk-size SizeSuffix         

If greater than --vfs-read-chunk-size, double the chunk size after each chunk read

rclone mount --vfs-read-chunk-size-limit SizeSuffix   

Time to wait for in-sequence read before seeking

rclone mount --vfs-read-wait duration                 

Use the rclone size algorithm for Used size

rclone mount --vfs-used-is-size rclone size           

Time to writeback files after last use when using cache

rclone mount --vfs-write-back duration                

Time to wait for in-sequence write before giving error

rclone mount --vfs-write-wait duration                

Set the volume name

rclone mount --volname string                         

Makes kernel buffer writes before sending them to rclone

rclone mount --write-back-cache