2016-08-03 22:36:28 +02:00
---
2017-09-30 16:22:00 +02:00
date: 2017-09-30T14:21:35+01:00
2016-08-03 22:36:28 +02:00
title: "rclone"
slug: rclone
url: /commands/rclone/
---
## rclone
2017-09-30 16:22:00 +02:00
Sync files and directories to and from local and remote object stores - v1.38
2016-08-03 22:36:28 +02:00
### Synopsis
Rclone is a command line program to sync files and directories to and
2017-06-15 21:12:26 +02:00
from various cloud storage systems and using file transfer services, such as:
2016-08-03 22:36:28 +02:00
2017-09-30 15:19:47 +02:00
* Amazon Drive
2016-08-03 22:36:28 +02:00
* Amazon S3
2017-09-30 15:19:47 +02:00
* Backblaze B2
* Box
2016-08-03 22:36:28 +02:00
* Dropbox
2017-09-30 15:19:47 +02:00
* FTP
2016-08-03 22:36:28 +02:00
* Google Cloud Storage
2017-09-30 15:19:47 +02:00
* Google Drive
* HTTP
2016-08-03 22:36:28 +02:00
* Hubic
2017-09-30 15:19:47 +02:00
* Microsoft Azure Blob Storage
* Microsoft OneDrive
* Openstack Swift / Rackspace cloud files / Memset Memstore
* QingStor
2017-06-15 21:12:26 +02:00
* SFTP
2017-09-30 15:19:47 +02:00
* Yandex Disk
2016-08-03 22:36:28 +02:00
* The local filesystem
Features
* MD5/SHA1 hashes checked at all times for file integrity
* Timestamps preserved on files
* Partial syncs supported on a whole file basis
* Copy mode to just copy new/changed files
* Sync (one way) mode to make a directory identical
* Check mode to check for file hash equality
* Can sync to and from network, eg two different cloud accounts
See the home page for installation, usage, documentation, changelog
and configuration walkthroughs.
2017-03-29 11:06:22 +02:00
* https://rclone.org/
2016-08-03 22:36:28 +02:00
```
2017-06-15 21:12:26 +02:00
rclone [flags]
2016-08-03 22:36:28 +02:00
```
### Options
```
2016-11-06 11:17:52 +01:00
--acd-templink-threshold int Files >= this size will be downloaded via their tempLink. (default 9G)
--acd-upload-wait-per-gb duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s)
--ask-password Allow prompt for password for encrypted configuration. (default true)
2017-09-30 15:19:47 +02:00
--azureblob-chunk-size int Upload chunk size. Must fit in memory. (default 4M)
--azureblob-upload-cutoff int Cutoff for switching to chunked upload (default 256M)
2016-11-06 11:17:52 +01:00
--b2-chunk-size int Upload chunk size. Must fit in memory. (default 96M)
2017-09-30 15:19:47 +02:00
--b2-hard-delete Permanently delete files on remote removal, otherwise hide files.
2016-11-06 11:17:52 +01:00
--b2-test-mode string A flag string for X-Bz-Test-Mode header.
--b2-upload-cutoff int Cutoff for switching to chunked upload (default 190.735M)
--b2-versions Include old versions in directory listings.
2017-03-18 12:16:43 +01:00
--backup-dir string Make backups into hierarchy based in DIR.
2017-09-30 15:19:47 +02:00
--bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name.
--box-upload-cutoff int Cutoff for switching to multipart upload (default 50M)
2017-03-18 12:16:43 +01:00
--buffer-size int Buffer size when copying files. (default 16M)
--bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable.
2016-11-06 11:17:52 +01:00
--checkers int Number of checkers to run in parallel. (default 8)
-c, --checksum Skip based on checksum & size, not mod-time & size
--config string Config file. (default "/home/ncw/.rclone.conf")
--contimeout duration Connect timeout (default 1m0s)
2017-03-18 12:16:43 +01:00
-L, --copy-links Follow symlinks and copy the pointed to item.
2016-11-06 11:17:52 +01:00
--cpuprofile string Write cpu profile to file
2017-03-18 12:16:43 +01:00
--crypt-show-mapping For all files listed show how the names encrypt.
2016-11-06 11:17:52 +01:00
--delete-after When synchronizing, delete files on destination after transfering
--delete-before When synchronizing, delete files on destination before transfering
--delete-during When synchronizing, delete files during transfer (default)
--delete-excluded Delete files on dest excluded from sync
2017-09-30 15:19:47 +02:00
--disable string Disable a comma separated list of features. Use help to see a list.
2017-07-22 19:16:46 +02:00
--drive-auth-owner-only Only consider files owned by the authenticated user.
2016-11-06 11:17:52 +01:00
--drive-chunk-size int Upload chunk size. Must a power of 2 >= 256k. (default 8M)
--drive-formats string Comma separated list of preferred formats for downloading Google docs. (default "docx,xlsx,pptx,svg")
2017-03-18 12:16:43 +01:00
--drive-list-chunk int Size of listing chunk 100-1000. 0 to disable. (default 1000)
2017-06-15 21:12:26 +02:00
--drive-shared-with-me Only show files that are shared with me
2017-03-18 12:16:43 +01:00
--drive-skip-gdocs Skip google documents in all listings.
2017-07-22 19:16:46 +02:00
--drive-trashed-only Only show files that are in the trash
2016-11-06 11:17:52 +01:00
--drive-upload-cutoff int Cutoff for switching to chunked upload (default 8M)
2017-09-30 15:19:47 +02:00
--drive-use-trash Send files to the trash instead of deleting permanently. (default true)
2016-11-06 11:17:52 +01:00
--dropbox-chunk-size int Upload chunk size. Max 150M. (default 128M)
-n, --dry-run Do a trial run with no permanent changes
--dump-auth Dump HTTP headers with auth info
--dump-bodies Dump HTTP headers and bodies - may contain sensitive info
--dump-filters Dump the filters to the output
--dump-headers Dump HTTP headers - may contain sensitive info
2017-01-02 16:30:34 +01:00
--exclude stringArray Exclude files matching pattern
--exclude-from stringArray Read exclude patterns from file
2017-06-15 21:12:26 +02:00
--fast-list Use recursive list if available. Uses more memory but fewer transactions.
2017-01-02 16:30:34 +01:00
--files-from stringArray Read list of source-file names from file
-f, --filter stringArray Add a file-filtering rule
--filter-from stringArray Read filtering patterns from a file
2017-07-22 19:16:46 +02:00
--gcs-location string Default location for buckets (us|eu|asia|us-central1|us-east1|us-east4|us-west1|asia-east1|asia-noetheast1|asia-southeast1|australia-southeast1|europe-west1|europe-west2).
--gcs-storage-class string Default storage class for buckets (MULTI_REGIONAL|REGIONAL|STANDARD|NEARLINE|COLDLINE|DURABLE_REDUCED_AVAILABILITY).
2017-09-30 15:19:47 +02:00
-h, --help help for rclone
2017-03-18 12:16:43 +01:00
--ignore-checksum Skip post copy check of checksums.
2016-11-06 11:17:52 +01:00
--ignore-existing Skip all files that exist on destination
--ignore-size Ignore size when skipping use mod-time or checksum.
-I, --ignore-times Don't skip files that match size and time - transfer all files
2017-09-30 15:19:47 +02:00
--immutable Do not modify files. Fail if existing files have been modified.
2017-01-02 16:30:34 +01:00
--include stringArray Include files matching pattern
--include-from stringArray Read include patterns from file
2017-06-15 21:12:26 +02:00
--local-no-unicode-normalization Don't apply unicode normalization to paths and filenames
2016-11-06 11:17:52 +01:00
--log-file string Log everything to this file
2017-07-22 19:16:46 +02:00
--log-level string Log level DEBUG|INFO|NOTICE|ERROR (default "NOTICE")
2016-11-06 11:17:52 +01:00
--low-level-retries int Number of low level retries to do. (default 10)
--max-age string Don't transfer any file older than this in s or suffix ms|s|m|h|d|w|M|y
--max-depth int If set limits the recursion depth to this. (default -1)
--max-size int Don't transfer any file larger than this in k or suffix b|k|M|G (default off)
--memprofile string Write memory profile to file
--min-age string Don't transfer any file younger than this in s or suffix ms|s|m|h|d|w|M|y
--min-size int Don't transfer any file smaller than this in k or suffix b|k|M|G (default off)
--modify-window duration Max time diff to be considered the same (default 1ns)
--no-check-certificate Do not verify the server SSL certificate. Insecure.
--no-gzip-encoding Don't set Accept-Encoding: gzip.
--no-traverse Don't traverse destination file system on copy.
--no-update-modtime Don't update destination mod-time if files identical.
2017-06-15 21:12:26 +02:00
--old-sync-method Deprecated - use --fast-list instead
2016-11-06 11:17:52 +01:00
-x, --one-file-system Don't cross filesystem boundaries.
--onedrive-chunk-size int Above this size files will be chunked - must be multiple of 320k. (default 10M)
--onedrive-upload-cutoff int Cutoff for switching to chunked upload - must be < = 100MB (default 10M)
-q, --quiet Print as little stuff as possible
--retries int Retry operations this many times if they fail (default 3)
--s3-acl string Canned ACL used when creating buckets and/or storing objects in S3
--s3-storage-class string Storage class to use when uploading S3 objects (STANDARD|REDUCED_REDUNDANCY|STANDARD_IA)
--size-only Skip based on size only, not mod-time or checksum
2017-09-30 15:19:47 +02:00
--skip-links Don't warn about skipped symlinks.
2017-01-02 16:30:34 +01:00
--stats duration Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s)
2017-07-22 19:16:46 +02:00
--stats-log-level string Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO")
2017-01-02 16:30:34 +01:00
--stats-unit string Show data rate in stats as either 'bits' or 'bytes'/s (default "bytes")
2017-09-30 15:19:47 +02:00
--streaming-upload-cutoff int Cutoff for switching to chunked upload if file size is unknown. Upload starts after reaching cutoff or when file ends. (default 100k)
2017-03-18 12:16:43 +01:00
--suffix string Suffix for use with --backup-dir.
2016-11-06 11:17:52 +01:00
--swift-chunk-size int Above this size files will be chunked into a _segments container. (default 5G)
2017-03-18 12:16:43 +01:00
--syslog Use Syslog for logging
--syslog-facility string Facility for syslog, eg KERN,USER,... (default "DAEMON")
2016-11-06 11:17:52 +01:00
--timeout duration IO idle timeout (default 5m0s)
2017-07-22 19:16:46 +02:00
--tpslimit float Limit HTTP transactions per second to this.
--tpslimit-burst int Max burst of transactions for --tpslimit. (default 1)
2017-03-18 12:16:43 +01:00
--track-renames When synchronizing, track file renames and do a server side move if possible
2016-11-06 11:17:52 +01:00
--transfers int Number of file transfers to run in parallel. (default 4)
-u, --update Skip files that are newer on the destination.
2017-09-30 16:22:00 +02:00
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.38")
2017-03-18 12:16:43 +01:00
-v, --verbose count[=-1] Print lots more stuff (repeat for more)
2016-11-06 11:17:52 +01:00
-V, --version Print the version number
2016-08-03 22:36:28 +02:00
```
### SEE ALSO
* [rclone authorize ](/commands/rclone_authorize/ ) - Remote authorization.
2016-08-24 23:58:24 +02:00
* [rclone cat ](/commands/rclone_cat/ ) - Concatenates any files and sends them to stdout.
2016-08-03 22:36:28 +02:00
* [rclone check ](/commands/rclone_check/ ) - Checks the files in the source and destination match.
* [rclone cleanup ](/commands/rclone_cleanup/ ) - Clean up the remote if possible
* [rclone config ](/commands/rclone_config/ ) - Enter an interactive configuration session.
* [rclone copy ](/commands/rclone_copy/ ) - Copy files from source to dest, skipping already copied
2017-01-02 16:30:34 +01:00
* [rclone copyto ](/commands/rclone_copyto/ ) - Copy files from source to dest, skipping already copied
2017-07-22 19:16:46 +02:00
* [rclone cryptcheck ](/commands/rclone_cryptcheck/ ) - Cryptcheck checks the integrity of a crypted remote.
2017-09-30 15:19:47 +02:00
* [rclone cryptdecode ](/commands/rclone_cryptdecode/ ) - Cryptdecode returns unencrypted file names.
2017-06-15 21:12:26 +02:00
* [rclone dbhashsum ](/commands/rclone_dbhashsum/ ) - Produces a Dropbbox hash file for all the objects in the path.
2016-08-03 22:36:28 +02:00
* [rclone dedupe ](/commands/rclone_dedupe/ ) - Interactively find duplicate files delete/rename them.
* [rclone delete ](/commands/rclone_delete/ ) - Remove the contents of path.
2017-08-31 16:52:51 +02:00
* [rclone genautocomplete ](/commands/rclone_genautocomplete/ ) - Output completion script for a given shell.
2016-08-03 22:36:28 +02:00
* [rclone gendocs ](/commands/rclone_gendocs/ ) - Output markdown docs for rclone to the directory supplied.
2016-11-06 11:17:52 +01:00
* [rclone listremotes ](/commands/rclone_listremotes/ ) - List all the remotes in the config file.
2016-12-31 18:20:31 +01:00
* [rclone ls ](/commands/rclone_ls/ ) - List all the objects in the path with size and path.
* [rclone lsd ](/commands/rclone_lsd/ ) - List all directories/containers/buckets in the path.
2017-06-15 21:12:26 +02:00
* [rclone lsjson ](/commands/rclone_lsjson/ ) - List directories and objects in the path in JSON format.
2016-08-03 22:36:28 +02:00
* [rclone lsl ](/commands/rclone_lsl/ ) - List all the objects path with modification time, size and path.
* [rclone md5sum ](/commands/rclone_md5sum/ ) - Produces an md5sum file for all the objects in the path.
* [rclone mkdir ](/commands/rclone_mkdir/ ) - Make the path if it doesn't already exist.
2016-08-24 23:58:24 +02:00
* [rclone mount ](/commands/rclone_mount/ ) - Mount the remote as a mountpoint. **EXPERIMENTAL**
2016-08-03 22:36:28 +02:00
* [rclone move ](/commands/rclone_move/ ) - Move files from source to dest.
2017-01-02 16:30:34 +01:00
* [rclone moveto ](/commands/rclone_moveto/ ) - Move file or directory from source to dest.
2017-06-15 21:12:26 +02:00
* [rclone ncdu ](/commands/rclone_ncdu/ ) - Explore a remote with a text based user interface.
2017-03-18 12:16:43 +01:00
* [rclone obscure ](/commands/rclone_obscure/ ) - Obscure password for use in the rclone.conf
2016-08-03 22:36:28 +02:00
* [rclone purge ](/commands/rclone_purge/ ) - Remove the path and all of its contents.
2017-09-30 15:19:47 +02:00
* [rclone rcat ](/commands/rclone_rcat/ ) - Copies standard input to file on remote.
2016-08-03 22:36:28 +02:00
* [rclone rmdir ](/commands/rclone_rmdir/ ) - Remove the path if empty.
2017-07-21 19:17:57 +02:00
* [rclone rmdirs ](/commands/rclone_rmdirs/ ) - Remove empty directories under the path.
2016-08-03 22:36:28 +02:00
* [rclone sha1sum ](/commands/rclone_sha1sum/ ) - Produces an sha1sum file for all the objects in the path.
* [rclone size ](/commands/rclone_size/ ) - Prints the total size and number of objects in remote:path.
* [rclone sync ](/commands/rclone_sync/ ) - Make source and dest identical, modifying destination only.
2017-09-30 15:19:47 +02:00
* [rclone tree ](/commands/rclone_tree/ ) - List the contents of the remote in a tree like fashion.
2016-08-03 22:36:28 +02:00
* [rclone version ](/commands/rclone_version/ ) - Show the version number.
2017-09-30 15:19:47 +02:00
###### Auto generated by spf13/cobra on 30-Sep-2017