github/rclone
1
Fork 0
mirror of https://github.com/rclone/rclone synced 2024-12-22 13:03:02 +01:00
Code Releases Activity
d45c750f76
rclone/docs/content/commands/rclone.md

238 lines
18 KiB
Markdown
Raw Normal View History

Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
---
Version v1.40
2018-03-19 11:06:13 +01:00
date: 2018-03-19T10:05:30Z
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
title: "rclone"
slug: rclone
url: /commands/rclone/
---
## rclone
Version v1.40
2018-03-19 11:06:13 +01:00
Sync files and directories to and from local and remote object stores - v1.40
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
### Synopsis
Rclone is a command line program to sync files and directories to and
Add ftp.md to docs builder and update docs
2017-06-15 21:12:26 +02:00
from various cloud storage systems and using file transfer services, such as:
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
Version v1.38
2017-09-30 15:19:47 +02:00
* Amazon Drive
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
* Amazon S3
Version v1.38
2017-09-30 15:19:47 +02:00
* Backblaze B2
* Box
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
* Dropbox
Version v1.38
2017-09-30 15:19:47 +02:00
* FTP
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
* Google Cloud Storage
Version v1.38
2017-09-30 15:19:47 +02:00
* Google Drive
* HTTP
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
* Hubic
Version v1.38
2017-09-30 15:19:47 +02:00
* Microsoft Azure Blob Storage
* Microsoft OneDrive
* Openstack Swift / Rackspace cloud files / Memset Memstore
Version v1.39
2017-12-23 14:07:45 +01:00
* pCloud
Version v1.38
2017-09-30 15:19:47 +02:00
* QingStor
Add ftp.md to docs builder and update docs
2017-06-15 21:12:26 +02:00
* SFTP
Version v1.39
2017-12-23 14:07:45 +01:00
* Webdav / Owncloud / Nextcloud
Version v1.38
2017-09-30 15:19:47 +02:00
* Yandex Disk
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
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.
Update urls to https after site move
2017-03-29 11:06:22 +02:00
* https://rclone.org/
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
```
Add ftp.md to docs builder and update docs
2017-06-15 21:12:26 +02:00
rclone [flags]
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
```
### Options
```
Version v1.39
2017-12-23 14:07:45 +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)
--auto-confirm If enabled, do not request console confirmation.
--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)
--b2-chunk-size int Upload chunk size. Must fit in memory. (default 96M)
--b2-hard-delete Permanently delete files on remote removal, otherwise hide files.
--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.
--backup-dir string Make backups into hierarchy based in DIR.
--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)
--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.
--cache-chunk-clean-interval string Interval at which chunk cleanup runs (default "1m")
--cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming
--cache-chunk-path string Directory to cached chunk files (default "/home/ncw/.cache/rclone/cache-backend")
--cache-chunk-size string The size of a chunk (default "5M")
--cache-db-path string Directory to cache DB (default "/home/ncw/.cache/rclone/cache-backend")
--cache-db-purge Purge the cache DB before
Version v1.40
2018-03-19 11:06:13 +01:00
--cache-db-wait-time duration How long to wait for the DB to be available - 0 is unlimited (default 1s)
Version v1.39
2017-12-23 14:07:45 +01:00
--cache-dir string Directory rclone will use for caching. (default "/home/ncw/.cache/rclone")
--cache-info-age string How much time should object info be stored in cache (default "6h")
--cache-read-retries int How many times to retry a read from a cache storage (default 10)
--cache-rps int Limits the number of requests per second to the source FS. -1 disables the rate limiter (default -1)
Version v1.40
2018-03-19 11:06:13 +01:00
--cache-tmp-upload-path string Directory to keep temporary files until they are uploaded to the cloud storage
--cache-tmp-wait-time string How long should files be stored in local cache before being uploaded (default "15m")
Version v1.39
2017-12-23 14:07:45 +01:00
--cache-total-chunk-size string The total size which the chunks can take up from the disk (default "10G")
--cache-workers int How many workers should run in parallel to download chunks (default 4)
--cache-writes Will cache file data on writes through the FS
--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)
-L, --copy-links Follow symlinks and copy the pointed to item.
--cpuprofile string Write cpu profile to file
--crypt-show-mapping For all files listed show how the names encrypt.
--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
--disable string Disable a comma separated list of features. Use help to see a list.
--drive-auth-owner-only Only consider files owned by the authenticated user.
--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")
Version v1.40
2018-03-19 11:06:13 +01:00
--drive-impersonate string Impersonate this user when using a service account.
Version v1.39
2017-12-23 14:07:45 +01:00
--drive-list-chunk int Size of listing chunk 100-1000. 0 to disable. (default 1000)
--drive-shared-with-me Only show files that are shared with me
--drive-skip-gdocs Skip google documents in all listings.
--drive-trashed-only Only show files that are in the trash
--drive-upload-cutoff int Cutoff for switching to chunked upload (default 8M)
Version v1.40
2018-03-19 11:06:13 +01:00
--drive-use-created-date Use created date instead of modified date.
Version v1.39
2017-12-23 14:07:45 +01:00
--drive-use-trash Send files to the trash instead of deleting permanently. (default true)
--dropbox-chunk-size int Upload chunk size. Max 150M. (default 48M)
-n, --dry-run Do a trial run with no permanent changes
Version v1.40
2018-03-19 11:06:13 +01:00
--dump string List of items to dump from: headers,bodies,requests,responses,auth,filters
Version v1.39
2017-12-23 14:07:45 +01:00
--dump-bodies Dump HTTP headers and bodies - may contain sensitive info
Version v1.40
2018-03-19 11:06:13 +01:00
--dump-headers Dump HTTP bodies - may contain sensitive info
Version v1.39
2017-12-23 14:07:45 +01:00
--exclude stringArray Exclude files matching pattern
--exclude-from stringArray Read exclude patterns from file
--exclude-if-present string Exclude directories if filename is present
--fast-list Use recursive list if available. Uses more memory but fewer transactions.
--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
--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).
-h, --help help for rclone
--ignore-checksum Skip post copy check of checksums.
--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
--immutable Do not modify files. Fail if existing files have been modified.
--include stringArray Include files matching pattern
--include-from stringArray Read include patterns from file
--local-no-unicode-normalization Don't apply unicode normalization to paths and filenames
--log-file string Log everything to this file
--log-level string Log level DEBUG|INFO|NOTICE|ERROR (default "NOTICE")
--low-level-retries int Number of low level retries to do. (default 10)
Version v1.40
2018-03-19 11:06:13 +01:00
--max-age duration Don't transfer any file older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--max-delete int When synchronizing, limit the number of deletes (default -1)
Version v1.39
2017-12-23 14:07:45 +01:00
--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
Version v1.40
2018-03-19 11:06:13 +01:00
--min-age duration Don't transfer any file younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
Version v1.39
2017-12-23 14:07:45 +01:00
--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.
Version v1.40
2018-03-19 11:06:13 +01:00
--no-traverse Obsolete - does nothing.
Version v1.39
2017-12-23 14:07:45 +01:00
--no-update-modtime Don't update destination mod-time if files identical.
-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)
-q, --quiet Print as little stuff as possible
Version v1.40
2018-03-19 11:06:13 +01:00
--rc Enable the remote control server.
--rc-addr string IPaddress:Port or :Port to bind server to. (default "localhost:5572")
--rc-cert string SSL PEM key (concatenation of certificate and CA certificate)
--rc-client-ca string Client certificate authority to verify clients with
--rc-htpasswd string htpasswd file - if not provided no authentication is done
--rc-key string SSL PEM Private key
--rc-max-header-bytes int Maximum size of request header (default 4096)
--rc-pass string Password for authentication.
--rc-realm string realm for authentication (default "rclone")
--rc-server-read-timeout duration Timeout for server reading data (default 1h0m0s)
--rc-server-write-timeout duration Timeout for server writing data (default 1h0m0s)
--rc-user string User name for authentication.
Version v1.39
2017-12-23 14:07:45 +01:00
--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)
Version v1.40
2018-03-19 11:06:13 +01:00
--sftp-ask-password Allow asking for SFTP password when needed.
Version v1.39
2017-12-23 14:07:45 +01:00
--size-only Skip based on size only, not mod-time or checksum
--skip-links Don't warn about skipped symlinks.
--stats duration Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s)
Version v1.40
2018-03-19 11:06:13 +01:00
--stats-file-name-length int Max file name length in stats. 0 for no limit (default 40)
Version v1.39
2017-12-23 14:07:45 +01:00
--stats-log-level string Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO")
--stats-unit string Show data rate in stats as either 'bits' or 'bytes'/s (default "bytes")
--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)
--suffix string Suffix for use with --backup-dir.
--swift-chunk-size int Above this size files will be chunked into a _segments container. (default 5G)
--syslog Use Syslog for logging
--syslog-facility string Facility for syslog, eg KERN,USER,... (default "DAEMON")
--timeout duration IO idle timeout (default 5m0s)
--tpslimit float Limit HTTP transactions per second to this.
--tpslimit-burst int Max burst of transactions for --tpslimit. (default 1)
--track-renames When synchronizing, track file renames and do a server side move if possible
--transfers int Number of file transfers to run in parallel. (default 4)
-u, --update Skip files that are newer on the destination.
Version v1.40
2018-03-19 11:06:13 +01:00
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.40")
-v, --verbose count Print lots more stuff (repeat for more)
Version v1.39
2017-12-23 14:07:45 +01:00
-V, --version Print the version number
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
```
### SEE ALSO
Version v1.40
2018-03-19 11:06:13 +01:00
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
* [rclone authorize](/commands/rclone_authorize/) - Remote authorization.
Version v1.39
2017-12-23 14:07:45 +01:00
* [rclone cachestats](/commands/rclone_cachestats/) - Print cache stats for a remote
Version v1.33
2016-08-24 23:58:24 +02:00
* [rclone cat](/commands/rclone_cat/) - Concatenates any files and sends them to stdout.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
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
Version v1.35
2017-01-02 16:30:34 +01:00
* [rclone copyto](/commands/rclone_copyto/) - Copy files from source to dest, skipping already copied
Version v1.37
2017-07-22 19:16:46 +02:00
* [rclone cryptcheck](/commands/rclone_cryptcheck/) - Cryptcheck checks the integrity of a crypted remote.
Version v1.38
2017-09-30 15:19:47 +02:00
* [rclone cryptdecode](/commands/rclone_cryptdecode/) - Cryptdecode returns unencrypted file names.
Version v1.39
2017-12-23 14:07:45 +01:00
* [rclone dbhashsum](/commands/rclone_dbhashsum/) - Produces a Dropbox hash file for all the objects in the path.
* [rclone dedupe](/commands/rclone_dedupe/) - Interactively find duplicate files and delete/rename them.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
* [rclone delete](/commands/rclone_delete/) - Remove the contents of path.
support for zsh auto-completion - #983
2017-08-31 16:52:51 +02:00
* [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
* [rclone gendocs](/commands/rclone_gendocs/) - Output markdown docs for rclone to the directory supplied.
Version v1.34
2016-11-06 11:17:52 +01:00
* [rclone listremotes](/commands/rclone_listremotes/) - List all the remotes in the config file.
Version v1.40
2018-03-19 11:06:13 +01:00
* [rclone ls](/commands/rclone_ls/) - List the objects in the path with size and path.
Typo: the the -> the in docs and comments
2016-12-31 18:20:31 +01:00
* [rclone lsd](/commands/rclone_lsd/) - List all directories/containers/buckets in the path.
Version v1.40
2018-03-19 11:06:13 +01:00
* [rclone lsf](/commands/rclone_lsf/) - List directories and objects in remote:path formatted for parsing
Add ftp.md to docs builder and update docs
2017-06-15 21:12:26 +02:00
* [rclone lsjson](/commands/rclone_lsjson/) - List directories and objects in the path in JSON format.
Version v1.40
2018-03-19 11:06:13 +01:00
* [rclone lsl](/commands/rclone_lsl/) - List the objects in path with modification time, size and path.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
* [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.
Version v1.33
2016-08-24 23:58:24 +02:00
* [rclone mount](/commands/rclone_mount/) - Mount the remote as a mountpoint. **EXPERIMENTAL**
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
* [rclone move](/commands/rclone_move/) - Move files from source to dest.
Version v1.35
2017-01-02 16:30:34 +01:00
* [rclone moveto](/commands/rclone_moveto/) - Move file or directory from source to dest.
Add ftp.md to docs builder and update docs
2017-06-15 21:12:26 +02:00
* [rclone ncdu](/commands/rclone_ncdu/) - Explore a remote with a text based user interface.
Version v1.36
2017-03-18 12:16:43 +01:00
* [rclone obscure](/commands/rclone_obscure/) - Obscure password for use in the rclone.conf
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
* [rclone purge](/commands/rclone_purge/) - Remove the path and all of its contents.
Version v1.40
2018-03-19 11:06:13 +01:00
* [rclone rc](/commands/rclone_rc/) - Run a command against a running rclone.
Version v1.38
2017-09-30 15:19:47 +02:00
* [rclone rcat](/commands/rclone_rcat/) - Copies standard input to file on remote.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
* [rclone rmdir](/commands/rclone_rmdir/) - Remove the path if empty.
DOC: any empty directoryies -> empty directories (fixes #1546)
2017-07-21 19:17:57 +02:00
* [rclone rmdirs](/commands/rclone_rmdirs/) - Remove empty directories under the path.
Version v1.39
2017-12-23 14:07:45 +01:00
* [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
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.
Version v1.39
2017-12-23 14:07:45 +01:00
* [rclone touch](/commands/rclone_touch/) - Create new file or change file modification time.
Version v1.38
2017-09-30 15:19:47 +02:00
* [rclone tree](/commands/rclone_tree/) - List the contents of the remote in a tree like fashion.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 22:36:28 +02:00
* [rclone version](/commands/rclone_version/) - Show the version number.
Version v1.40
2018-03-19 11:06:13 +01:00
###### Auto generated by spf13/cobra on 19-Mar-2018
Copy Permalink