extern/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2024-11-27 10:54:56 +01:00
Code Issues Packages Projects Releases Wiki Activity
655d63b4fd
rclone/docs/content/flags.md

672 lines
65 KiB
Markdown
Raw Normal View History

docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
---
title: "Global Flags"
description: "Rclone Global Flags"
---
# Global Flags
Version v1.49.0
2019-08-26 16:25:20 +02:00
This describes the global flags available to every rclone command
split into two groups, non backend and backend flags.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
## Non Backend Flags
These flags are available for every command.
```
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--ask-password Allow prompt for password for encrypted configuration (default true)
--auto-confirm If enabled, do not request console confirmation
--backup-dir string Make backups into hierarchy based in DIR
--bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name
--buffer-size SizeSuffix In memory buffer size when reading files for each --transfer (default 16Mi)
--bwlimit BwTimetable Bandwidth limit in KiB/s, or use suffix B|K|M|G|T|P or a full timetable
--bwlimit-file BwTimetable Bandwidth limit per file in KiB/s, or use suffix B|K|M|G|T|P or a full timetable
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--ca-cert string CA certificate used to verify servers
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--cache-dir string Directory rclone will use for caching (default "$HOME/.cache/rclone")
--check-first Do all the checks before starting transfers
--checkers int Number of checkers to run in parallel (default 8)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
-c, --checksum Skip based on checksum (if available) & size, not mod-time & size
--client-cert string Client SSL certificate (PEM) for mutual TLS auth
--client-key string Client SSL private key (PEM) for mutual TLS auth
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--compare-dest stringArray Include additional comma separated server-side paths during comparison
--config string Config file (default "$HOME/.config/rclone/rclone.conf")
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--contimeout duration Connect timeout (default 1m0s)
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--copy-dest stringArray Implies --compare-dest but also copies files from paths into destination
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--cpuprofile string Write cpu profile to file
docs: new flags
2020-05-17 18:54:52 +02:00
--cutoff-mode string Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default "HARD")
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--delete-after When synchronizing, delete files on destination after transferring (default)
--delete-before When synchronizing, delete files on destination before transferring
--delete-during When synchronizing, delete files during transfer
--delete-excluded Delete files on dest excluded from sync
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--disable string Disable a comma separated list of features (use --disable help to see a list)
Version v1.59.0
2022-07-09 19:08:20 +02:00
--disable-http-keep-alives Disable HTTP keep-alives and use each connection once.
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--disable-http2 Disable HTTP/2 in the global transport
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
-n, --dry-run Do a trial run with no permanent changes
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--dscp string Set DSCP value to connections, value or name, e.g. CS1, LE, DF, AF21
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--dump DumpFlags List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles
--dump-bodies Dump HTTP headers and bodies - may contain sensitive info
--dump-headers Dump HTTP headers - may contain sensitive info
docs: new flags
2020-05-17 18:54:52 +02:00
--error-on-no-transfer Sets exit code 9 if no files are transferred, useful in scripts
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--exclude stringArray Exclude files matching pattern
docs: new flags
2020-05-17 18:54:52 +02:00
--exclude-from stringArray Read exclude patterns from file (use - to read from stdin)
filter: allow multiple --exclude-if-present flags - fixes #6219
2022-06-08 09:29:01 +02:00
--exclude-if-present stringArray Exclude directories if filename is present
Version v1.51.0
2020-02-01 11:31:42 +01:00
--expect-continue-timeout duration Timeout when using expect / 100-continue in HTTP (default 1s)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--fast-list Use recursive list if available; uses more memory but fewer transactions
docs: new flags
2020-05-17 18:54:52 +02:00
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
-f, --filter stringArray Add a file-filtering rule
docs: new flags
2020-05-17 18:54:52 +02:00
--filter-from stringArray Read filtering patterns from a file (use - to read from stdin)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--fs-cache-expire-duration duration Cache remotes for this long (0 to disable caching) (default 5m0s)
--fs-cache-expire-interval duration Interval to check for expired remotes (default 1m0s)
docs: new flags
2020-05-17 18:54:52 +02:00
--header stringArray Set HTTP header for all transactions
--header-download stringArray Set HTTP header for download transactions
--header-upload stringArray Set HTTP header for upload transactions
Version v1.57.0
2021-11-01 16:42:05 +01:00
--human-readable Print numbers in a human-readable format, sizes with suffix Ki|Mi|Gi|Ti|Pi
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--ignore-case Ignore case in filters (case insensitive)
--ignore-case-sync Ignore case when synchronizing
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--ignore-checksum Skip post copy check of checksums
Version v1.57.0
2021-11-01 16:42:05 +01:00
--ignore-errors Delete even if there are I/O errors
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--ignore-existing Skip all files that exist on destination
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--ignore-size Ignore size when skipping use mod-time or checksum
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
-I, --ignore-times Don't skip files that match size and time - transfer all files
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--immutable Do not modify files, fail if existing files have been modified
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--include stringArray Include files matching pattern
docs: new flags
2020-05-17 18:54:52 +02:00
--include-from stringArray Read include patterns from file (use - to read from stdin)
Version v1.53.0
2020-09-02 17:59:04 +02:00
-i, --interactive Enable interactive mode
lib/kv: add key-value database api #5587 Add bolt-based key-value database support. Quick API description: https://github.com/rclone/rclone/pull/5587#issuecomment-942174768
2021-10-12 13:57:54 +02:00
--kv-lock-time duration Maximum time to keep key-value database locked by process (default 1s)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--log-file string Log everything to this file
--log-format string Comma separated list of log format options (default "date,time")
--log-level string Log level DEBUG|INFO|NOTICE|ERROR (default "NOTICE")
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--log-systemd Activate systemd integration for the logger
--low-level-retries int Number of low level retries to do (default 10)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--max-backlog int Maximum number of objects in sync or check backlog (default 10000)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--max-delete int When synchronizing, limit the number of deletes (default -1)
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--max-depth int If set limits the recursion depth to this (default -1)
--max-duration duration Maximum duration rclone will transfer data for
Use binary prefixes for size and rate units Includes adding support for additional size input suffix Mi and MiB, treated equivalent to M. Extends binary suffix output with letter i, e.g. Ki and Mi. Centralizes creation of bit/byte unit strings.
2021-03-02 20:11:57 +01:00
--max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--max-stats-groups int Maximum number of stats groups to keep in memory, on max oldest is discarded (default 1000)
--max-transfer SizeSuffix Maximum size of data to transfer (default off)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--memprofile string Write memory profile to file
Version v1.59.0
2022-07-09 19:08:20 +02:00
-M, --metadata If set, preserve metadata when copying objects
--metadata-set stringArray Add metadata key=value when uploading
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
Use binary prefixes for size and rate units Includes adding support for additional size input suffix Mi and MiB, treated equivalent to M. Extends binary suffix output with letter i, e.g. Ki and Mi. Centralizes creation of bit/byte unit strings.
2021-03-02 20:11:57 +01:00
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--modify-window duration Max time diff to be considered the same (default 1ns)
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 250Mi)
--multi-thread-streams int Max number of streams to use for multi-thread downloads (default 4)
--no-check-certificate Do not verify the server SSL certificate (insecure)
--no-check-dest Don't check the destination, copy regardless
--no-console Hide console window (supported on Windows only)
--no-gzip-encoding Don't set Accept-Encoding: gzip
--no-traverse Don't traverse destination file system on copy
--no-unicode-normalization Don't normalize unicode characters in filenames
--no-update-modtime Don't update destination mod-time if files identical
docs: spelling: e.g. Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-13 23:49:58 +02:00
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--password-command SpaceSepList Command for supplying password for encrypted configuration
-P, --progress Show progress during transfer
--progress-terminal-title Show progress on the terminal title (requires -P/--progress)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
-q, --quiet Print as little stuff as possible
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--rc Enable the remote control server
--rc-addr string IPaddress:Port or :Port to bind server to (default "localhost:5572")
--rc-allow-origin string Set the allowed origin for CORS
--rc-baseurl string Prefix for URLs - leave blank for root
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--rc-cert string SSL PEM key (concatenation of certificate and CA certificate)
--rc-client-ca string Client certificate authority to verify clients with
docs: new flags
2020-05-17 18:54:52 +02:00
--rc-enable-metrics Enable prometheus metrics on /metrics
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--rc-files string Path to local files to serve on the HTTP server
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--rc-htpasswd string htpasswd file - if not provided no authentication is done
docs: capitalization of flag usage strings
2021-12-30 13:27:03 +01:00
--rc-job-expire-duration duration Expire finished async jobs older than this value (default 1m0s)
--rc-job-expire-interval duration Interval to check for expired async jobs (default 10s)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--rc-key string SSL PEM Private key
--rc-max-header-bytes int Maximum size of request header (default 4096)
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--rc-no-auth Don't require auth for certain methods
--rc-pass string Password for authentication
docs: capitalization of flag usage strings
2021-12-30 13:27:03 +01:00
--rc-realm string Realm for authentication (default "rclone")
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--rc-serve Enable the serving of remote objects
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--rc-server-read-timeout duration Timeout for server reading data (default 1h0m0s)
--rc-server-write-timeout duration Timeout for server writing data (default 1h0m0s)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--rc-template string User-specified template
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--rc-user string User name for authentication
--rc-web-fetch-url string URL to fetch the releases for webgui (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest")
Version v1.49.0
2019-08-26 16:25:20 +02:00
--rc-web-gui Launch WebGUI on localhost
rcd: move webgui apart; option to disable browser Fix #3601, #3785
2020-01-12 10:12:04 +01:00
--rc-web-gui-force-update Force update to latest version of web gui
Version v1.51.0
2020-02-01 11:31:42 +01:00
--rc-web-gui-no-open-browser Don't open the browser automatically
--rc-web-gui-update Check and update to latest version of web gui
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--refresh-times Refresh the modtime of remote files
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--retries int Retry operations this many times if they fail (default 3)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--retries-sleep duration Interval between retrying operations if they fail, e.g. 500ms, 60s, 5m (0 to disable)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--size-only Skip based on size only, not mod-time or checksum
Version v1.57.0
2021-11-01 16:42:05 +01:00
--stats duration Interval between printing stats, e.g. 500ms, 60s, 5m (0 to disable) (default 1m0s)
--stats-file-name-length int Max file name length in stats (0 for no limit) (default 45)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--stats-log-level string Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO")
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--stats-one-line Make the stats fit on one line
--stats-one-line-date Enable --stats-one-line and add current date/time prefix
--stats-one-line-date-format string Enable --stats-one-line-date and use custom formatted date: Enclose date string in double quotes ("), see https://golang.org/pkg/time/#Time.Format
make commanddocs for v1.56 (#5383)
2021-06-08 17:57:04 +02:00
--stats-unit string Show data rate in stats as either 'bits' or 'bytes' per second (default "bytes")
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki)
--suffix string Suffix to add to changed files
--suffix-keep-extension Preserve the extension when using --suffix
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--syslog Use Syslog for logging
docs: spelling: e.g. Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-13 23:49:58 +02:00
--syslog-facility string Facility for syslog, e.g. KERN,USER,... (default "DAEMON")
Version v1.57.0
2021-11-01 16:42:05 +01:00
--temp-dir string Directory rclone will use for temporary files (default "/tmp")
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--timeout duration IO idle timeout (default 5m0s)
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
docs: spelling: server-side Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-13 23:43:40 +02:00
--track-renames When synchronizing, track file renames and do a server-side move if possible
Version v1.53.0
2020-09-02 17:59:04 +02:00
--track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash")
docs: punctuation cleanup See #5538
2021-08-16 11:30:01 +02:00
--transfers int Number of file transfers to run in parallel (default 4)
-u, --update Skip files that are newer on the destination
--use-cookies Enable session cookiejar
--use-json-log Use json log format
--use-mmap Use mmap allocator (see docs)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--use-server-modtime Use server modified time instead of object metadata
Version v1.59.0
2022-07-09 19:08:20 +02:00
--user-agent string Set the user-agent to a specified string (default "rclone/v1.59.0")
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
-v, --verbose count Print lots more stuff (repeat for more)
```
## Backend Flags
These flags are available for every command. They control the backends
and may be set in the config file.
```
Version v1.57.0
2021-11-01 16:42:05 +01:00
--acd-auth-url string Auth server URL
--acd-client-id string OAuth Client Id
--acd-client-secret string OAuth Client Secret
Version v1.58.0
2022-03-18 13:29:54 +01:00
--acd-encoding MultiEncoder The encoding for the backend (default Slash,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink (default 9Gi)
--acd-token string OAuth Access Token as a JSON blob
--acd-token-url string Token server url
--acd-upload-wait-per-gb Duration Additional time per GiB to wait after a failed complete upload to see if it appears (default 3m0s)
--alias-remote string Remote or path to alias
--azureblob-access-tier string Access tier of blob: hot, cool or archive
--azureblob-account string Storage Account Name
--azureblob-archive-tier-delete Delete archive tier blobs before overwriting
Version v1.58.0
2022-03-18 13:29:54 +01:00
--azureblob-chunk-size SizeSuffix Upload chunk size (default 4Mi)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--azureblob-disable-checksum Don't store MD5 checksum with object metadata
Version v1.58.0
2022-03-18 13:29:54 +01:00
--azureblob-encoding MultiEncoder The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--azureblob-endpoint string Endpoint for the service
--azureblob-key string Storage Account Key
--azureblob-list-chunk int Size of blob list (default 5000)
--azureblob-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed (default 1m0s)
--azureblob-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool
--azureblob-msi-client-id string Object ID of the user-assigned MSI to use, if any
--azureblob-msi-mi-res-id string Azure resource ID of the user-assigned MSI to use, if any
--azureblob-msi-object-id string Object ID of the user-assigned MSI to use, if any
--azureblob-no-head-object If set, do not do HEAD before GET when getting objects
--azureblob-public-access string Public access level of a container: blob or container
--azureblob-sas-url string SAS URL for container level access only
--azureblob-service-principal-file string Path to file containing credentials for use with a service principal
Version v1.58.0
2022-03-18 13:29:54 +01:00
--azureblob-upload-concurrency int Concurrency for multipart uploads (default 16)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--azureblob-upload-cutoff string Cutoff for switching to chunked upload (<= 256 MiB) (deprecated)
--azureblob-use-emulator Uses local storage emulator if provided as 'true'
--azureblob-use-msi Use a managed service identity to authenticate (only works in Azure)
--b2-account string Account ID or Application Key ID
--b2-chunk-size SizeSuffix Upload chunk size (default 96Mi)
--b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4Gi)
--b2-disable-checksum Disable checksums for large (> upload cutoff) files
--b2-download-auth-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d (default 1w)
--b2-download-url string Custom endpoint for downloads
Version v1.58.0
2022-03-18 13:29:54 +01:00
--b2-encoding MultiEncoder The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--b2-endpoint string Endpoint for the service
--b2-hard-delete Permanently delete files on remote removal, otherwise hide files
--b2-key string Application Key
--b2-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed (default 1m0s)
--b2-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool
--b2-test-mode string A flag string for X-Bz-Test-Mode header for debugging
--b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
Version v1.59.0
2022-07-09 19:08:20 +02:00
--b2-version-at Time Show file versions as they were at the specified time (default off)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--b2-versions Include old versions in directory listings
--box-access-token string Box App Primary Access Token
--box-auth-url string Auth server URL
--box-box-config-file string Box App config.json location
--box-box-sub-type string (default "user")
--box-client-id string OAuth Client Id
--box-client-secret string OAuth Client Secret
--box-commit-retries int Max number of times to try committing a multipart file (default 100)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--box-encoding MultiEncoder The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--box-list-chunk int Size of listing chunk 1-1000 (default 1000)
--box-owned-by string Only show items owned by the login (email address) passed in
--box-root-folder-id string Fill in for rclone to use a non root folder as its starting point
--box-token string OAuth Access Token as a JSON blob
--box-token-url string Token server url
--box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50 MiB) (default 50Mi)
--cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage (default 1m0s)
--cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming
--cache-chunk-path string Directory to cache chunk files (default "$HOME/.cache/rclone/cache-backend")
--cache-chunk-size SizeSuffix The size of a chunk (partial file data) (default 5Mi)
--cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk (default 10Gi)
--cache-db-path string Directory to store file structure metadata DB (default "$HOME/.cache/rclone/cache-backend")
--cache-db-purge Clear all the cached data for this remote on start
--cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s)
--cache-info-age Duration How long to cache file structure information (directory listings, file size, times, etc.) (default 6h0m0s)
--cache-plex-insecure string Skip all certificate verification when connecting to the Plex server
--cache-plex-password string The password of the Plex user (obscured)
--cache-plex-url string The URL of the Plex server
--cache-plex-username string The username of the Plex user
--cache-read-retries int How many times to retry a read from a cache storage (default 10)
--cache-remote string Remote to cache
--cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1)
--cache-tmp-upload-path string Directory to keep temporary files until they are uploaded
--cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s)
--cache-workers int How many workers should run in parallel to download chunks (default 4)
--cache-writes Cache file data on writes through the FS
--chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks (default 2Gi)
--chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks
--chunker-hash-type string Choose how chunker handles hash sums (default "md5")
--chunker-remote string Remote to chunk/unchunk
Version v1.59.0
2022-07-09 19:08:20 +02:00
--combine-upstreams SpaceSepList Upstreams for combining
Version v1.57.0
2021-11-01 16:42:05 +01:00
--compress-level int GZIP compression level (-2 to 9) (default -1)
--compress-mode string Compression mode (default "gzip")
--compress-ram-cache-limit SizeSuffix Some remotes don't allow the upload of files with unknown size (default 20Mi)
--compress-remote string Remote to compress
-L, --copy-links Follow symlinks and copy the pointed to item
--crypt-directory-name-encryption Option to either encrypt directory names or leave them intact (default true)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--crypt-filename-encoding string How to encode the encrypted filename to text string (default "base32")
Version v1.57.0
2021-11-01 16:42:05 +01:00
--crypt-filename-encryption string How to encrypt the filenames (default "standard")
--crypt-no-data-encryption Option to either encrypt file data or leave it unencrypted
--crypt-password string Password or pass phrase for encryption (obscured)
--crypt-password2 string Password or pass phrase for salt (obscured)
--crypt-remote string Remote to encrypt/decrypt
--crypt-server-side-across-configs Allow server-side operations (e.g. copy) to work across different crypt configs
--crypt-show-mapping For all files listed show how the names encrypt
--drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded
--drive-allow-import-name-change Allow the filetype to change when uploading Google docs
--drive-auth-owner-only Only consider files owned by the authenticated user
--drive-auth-url string Auth server URL
--drive-chunk-size SizeSuffix Upload chunk size (default 8Mi)
--drive-client-id string Google Application Client Id
--drive-client-secret string OAuth Client Secret
Version v1.58.0
2022-03-18 13:29:54 +01:00
--drive-copy-shortcut-content Server side copy contents of shortcuts instead of the shortcut
Version v1.57.0
2021-11-01 16:42:05 +01:00
--drive-disable-http2 Disable drive using http2 (default true)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--drive-encoding MultiEncoder The encoding for the backend (default InvalidUtf8)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--drive-export-formats string Comma separated list of preferred formats for downloading Google docs (default "docx,xlsx,pptx,svg")
--drive-formats string Deprecated: See export_formats
--drive-impersonate string Impersonate this user when using a service account
--drive-import-formats string Comma separated list of preferred formats for uploading Google docs
--drive-keep-revision-forever Keep new head revision of each file forever
--drive-list-chunk int Size of listing chunk 100-1000, 0 to disable (default 1000)
--drive-pacer-burst int Number of API calls to allow without sleeping (default 100)
--drive-pacer-min-sleep Duration Minimum time to sleep between API calls (default 100ms)
Version v1.59.0
2022-07-09 19:08:20 +02:00
--drive-resource-key string Resource key for accessing a link-shared file
Version v1.57.0
2021-11-01 16:42:05 +01:00
--drive-root-folder-id string ID of the root folder
--drive-scope string Scope that rclone should use when requesting access from drive
--drive-server-side-across-configs Allow server-side operations (e.g. copy) to work across different drive configs
--drive-service-account-credentials string Service Account Credentials JSON blob
--drive-service-account-file string Service Account Credentials JSON file path
--drive-shared-with-me Only show files that are shared with me
--drive-size-as-quota Show sizes as storage quota usage, not actual size
--drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and videos only
Version v1.58.0
2022-03-18 13:29:54 +01:00
--drive-skip-dangling-shortcuts If set skip dangling shortcut files
Version v1.57.0
2021-11-01 16:42:05 +01:00
--drive-skip-gdocs Skip google documents in all listings
--drive-skip-shortcuts If set skip shortcut files
--drive-starred-only Only show files that are starred
--drive-stop-on-download-limit Make download limit errors be fatal
--drive-stop-on-upload-limit Make upload limit errors be fatal
--drive-team-drive string ID of the Shared Drive (Team Drive)
--drive-token string OAuth Access Token as a JSON blob
--drive-token-url string Token server url
--drive-trashed-only Only show files that are in the trash
--drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8Mi)
--drive-use-created-date Use file created date instead of modified date
--drive-use-shared-date Use date file was shared instead of modified date
--drive-use-trash Send files to the trash instead of deleting permanently (default true)
--drive-v2-download-min-size SizeSuffix If Object's are greater, use drive v2 API to download (default off)
--dropbox-auth-url string Auth server URL
all: fix spelling across the project * abcdefghijklmnopqrstuvwxyz * accounting * additional * allowed * almost * already * appropriately * arise * bandwidth * behave * bidirectional * brackets * cached * characters * cloud * committing * concatenating * configured * constructs * current * cutoff * deferred * different * directory * disposition * dropbox * either way * error * excess * experiments * explicitly * externally * files * github * gzipped * hierarchies * huffman * hyphen * implicitly * independent * insensitive * integrity * libraries * literally * metadata * mimics * missing * modification * multipart * multiple * nightmare * nonexistent * number * obscure * ourselves * overridden * potatoes * preexisting * priority * received * remote * replacement * represents * reproducibility * response * satisfies * sensitive * separately * separator * specifying * string * successful * synchronization * syncing * šenfeld * take * temporarily * testcontents * that * the * themselves * throttling * timeout * transaction * transferred * unnecessary * using * webbrowser * which * with * workspace Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2022-08-14 04:56:32 +02:00
--dropbox-batch-commit-timeout Duration Max time to wait for a batch to finish committing (default 10m0s)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--dropbox-batch-mode string Upload file batching sync|async|off (default "sync")
--dropbox-batch-size int Max number of files in upload batch
--dropbox-batch-timeout Duration Max time to allow an idle upload batch before uploading (default 0s)
--dropbox-chunk-size SizeSuffix Upload chunk size (< 150Mi) (default 48Mi)
--dropbox-client-id string OAuth Client Id
--dropbox-client-secret string OAuth Client Secret
Version v1.58.0
2022-03-18 13:29:54 +01:00
--dropbox-encoding MultiEncoder The encoding for the backend (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--dropbox-impersonate string Impersonate this user when using a business account
--dropbox-shared-files Instructs rclone to work on individual shared files
--dropbox-shared-folders Instructs rclone to work on shared folders
--dropbox-token string OAuth Access Token as a JSON blob
--dropbox-token-url string Token server url
--fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl
Version v1.58.0
2022-03-18 13:29:54 +01:00
--fichier-encoding MultiEncoder The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--fichier-file-password string If you want to download a shared file that is password protected, add this parameter (obscured)
--fichier-folder-password string If you want to list the files in a shared folder that is password protected, add this parameter (obscured)
--fichier-shared-folder string If you want to download a shared folder, add this parameter
Version v1.58.0
2022-03-18 13:29:54 +01:00
--filefabric-encoding MultiEncoder The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--filefabric-permanent-token string Permanent Authentication Token
--filefabric-root-folder-id string ID of the root folder
--filefabric-token string Session Token
--filefabric-token-expiry string Token expiry time
--filefabric-url string URL of the Enterprise File Fabric to connect to
--filefabric-version string Version read from the file fabric
Version v1.58.0
2022-03-18 13:29:54 +01:00
--ftp-ask-password Allow asking for FTP password when needed
Version v1.57.0
2021-11-01 16:42:05 +01:00
--ftp-close-timeout Duration Maximum time to wait for a response to close (default 1m0s)
--ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited
--ftp-disable-epsv Disable using EPSV even if server advertises support
--ftp-disable-mlsd Disable using MLSD even if server advertises support
--ftp-disable-tls13 Disable TLS 1.3 (workaround for FTP servers with buggy TLS)
Version v1.59.0
2022-07-09 19:08:20 +02:00
--ftp-disable-utf8 Disable using UTF-8 even if server advertises support
Version v1.58.0
2022-03-18 13:29:54 +01:00
--ftp-encoding MultiEncoder The encoding for the backend (default Slash,Del,Ctl,RightSpace,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--ftp-explicit-tls Use Explicit FTPS (FTP over TLS)
--ftp-host string FTP host to connect to
--ftp-idle-timeout Duration Max time before closing idle connections (default 1m0s)
--ftp-no-check-certificate Do not verify the TLS certificate of the server
--ftp-pass string FTP password (obscured)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--ftp-port int FTP port number (default 21)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--ftp-shut-timeout Duration Maximum time to wait for data connection closing status (default 1m0s)
--ftp-tls Use Implicit FTPS (FTP over TLS)
--ftp-tls-cache-size int Size of TLS session cache for all control and data connections (default 32)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--ftp-user string FTP username (default "$USER")
Version v1.57.0
2021-11-01 16:42:05 +01:00
--ftp-writing-mdtm Use MDTM to set modification time (VsFtpd quirk)
--gcs-anonymous Access public buckets and objects without credentials
--gcs-auth-url string Auth server URL
--gcs-bucket-acl string Access Control List for new buckets
--gcs-bucket-policy-only Access checks should use bucket-level IAM policies
--gcs-client-id string OAuth Client Id
--gcs-client-secret string OAuth Client Secret
Version v1.59.0
2022-07-09 19:08:20 +02:00
--gcs-decompress If set this will decompress gzip encoded objects
Version v1.58.0
2022-03-18 13:29:54 +01:00
--gcs-encoding MultiEncoder The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--gcs-location string Location for the newly created buckets
Version v1.59.0
2022-07-09 19:08:20 +02:00
--gcs-no-check-bucket If set, don't attempt to check the bucket exists or create it
Version v1.57.0
2021-11-01 16:42:05 +01:00
--gcs-object-acl string Access Control List for new objects
--gcs-project-number string Project number
--gcs-service-account-file string Service Account Credentials JSON file path
--gcs-storage-class string The storage class to use when storing objects in Google Cloud Storage
--gcs-token string OAuth Access Token as a JSON blob
--gcs-token-url string Token server url
--gphotos-auth-url string Auth server URL
--gphotos-client-id string OAuth Client Id
--gphotos-client-secret string OAuth Client Secret
Version v1.58.0
2022-03-18 13:29:54 +01:00
--gphotos-encoding MultiEncoder The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--gphotos-include-archived Also view and download archived media
--gphotos-read-only Set to make the Google Photos backend read only
--gphotos-read-size Set to read the size of media items
--gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000)
--gphotos-token string OAuth Access Token as a JSON blob
--gphotos-token-url string Token server url
--hasher-auto-size SizeSuffix Auto-update checksum for files smaller than this size (disabled by default)
--hasher-hashes CommaSepList Comma separated list of supported checksum types (default md5,sha1)
--hasher-max-age Duration Maximum time to keep checksums in cache (0 = no cache, off = cache forever) (default off)
--hasher-remote string Remote to cache checksums for (e.g. myRemote:path)
--hdfs-data-transfer-protection string Kerberos data transfer protection: authentication|integrity|privacy
Version v1.58.0
2022-03-18 13:29:54 +01:00
--hdfs-encoding MultiEncoder The encoding for the backend (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--hdfs-namenode string Hadoop name node and port
--hdfs-service-principal-name string Kerberos service principal name for the namenode
--hdfs-username string Hadoop user name
Version v1.59.0
2022-07-09 19:08:20 +02:00
--hidrive-auth-url string Auth server URL
--hidrive-chunk-size SizeSuffix Chunksize for chunked uploads (default 48Mi)
--hidrive-client-id string OAuth Client Id
--hidrive-client-secret string OAuth Client Secret
--hidrive-disable-fetching-member-count Do not fetch number of objects in directories unless it is absolutely necessary
--hidrive-encoding MultiEncoder The encoding for the backend (default Slash,Dot)
--hidrive-endpoint string Endpoint for the service (default "https://api.hidrive.strato.com/2.1")
--hidrive-root-prefix string The root/parent folder for all paths (default "/")
--hidrive-scope-access string Access permissions that rclone should use when requesting access from HiDrive (default "rw")
--hidrive-scope-role string User-level that rclone should use when requesting access from HiDrive (default "user")
--hidrive-token string OAuth Access Token as a JSON blob
--hidrive-token-url string Token server url
--hidrive-upload-concurrency int Concurrency for chunked uploads (default 4)
--hidrive-upload-cutoff SizeSuffix Cutoff/Threshold for chunked uploads (default 96Mi)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--http-headers CommaSepList Set HTTP headers for all transactions
Version v1.58.0
2022-03-18 13:29:54 +01:00
--http-no-head Don't use HEAD requests
Version v1.57.0
2021-11-01 16:42:05 +01:00
--http-no-slash Set this if the site doesn't end directories with /
Version v1.59.0
2022-07-09 19:08:20 +02:00
--http-url string URL of HTTP host to connect to
Version v1.57.0
2021-11-01 16:42:05 +01:00
--hubic-auth-url string Auth server URL
--hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container (default 5Gi)
--hubic-client-id string OAuth Client Id
--hubic-client-secret string OAuth Client Secret
Version v1.58.0
2022-03-18 13:29:54 +01:00
--hubic-encoding MultiEncoder The encoding for the backend (default Slash,InvalidUtf8)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--hubic-no-chunk Don't chunk files during streaming upload
--hubic-token string OAuth Access Token as a JSON blob
--hubic-token-url string Token server url
Version v1.59.0
2022-07-09 19:08:20 +02:00
--internetarchive-access-key-id string IAS3 Access Key
--internetarchive-disable-checksum Don't ask the server to test against MD5 checksum calculated by rclone (default true)
--internetarchive-encoding MultiEncoder The encoding for the backend (default Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot)
--internetarchive-endpoint string IAS3 Endpoint (default "https://s3.us.archive.org")
--internetarchive-front-endpoint string Host of InternetArchive Frontend (default "https://archive.org")
--internetarchive-secret-access-key string IAS3 Secret Key (password)
--internetarchive-wait-archive Duration Timeout for waiting the server's processing tasks (specifically archive and book_op) to finish (default 0s)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--jottacloud-encoding MultiEncoder The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--jottacloud-hard-delete Delete files permanently rather than putting them into the trash
--jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required (default 10Mi)
--jottacloud-no-versions Avoid server side versioning by deleting files and recreating files instead of overwriting them
--jottacloud-trashed-only Only show files that are in the trash
--jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's (default 10Mi)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--koofr-encoding MultiEncoder The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--koofr-endpoint string The Koofr API endpoint to use
Version v1.57.0
2021-11-01 16:42:05 +01:00
--koofr-mountid string Mount ID of the mount to use
Version v1.58.0
2022-03-18 13:29:54 +01:00
--koofr-password string Your password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured)
--koofr-provider string Choose your storage provider
Version v1.57.0
2021-11-01 16:42:05 +01:00
--koofr-setmtime Does the backend support setting modification time (default true)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--koofr-user string Your user name
Version v1.57.0
2021-11-01 16:42:05 +01:00
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
--local-case-insensitive Force the filesystem to report itself as case insensitive
--local-case-sensitive Force the filesystem to report itself as case sensitive
Version v1.58.0
2022-03-18 13:29:54 +01:00
--local-encoding MultiEncoder The encoding for the backend (default Slash,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--local-no-check-updated Don't check to see if the files change during upload
--local-no-preallocate Disable preallocation of disk space for transferred files
--local-no-set-modtime Disable setting modtime
--local-no-sparse Disable sparse files for multi-thread downloads
Version v1.59.0
2022-07-09 19:08:20 +02:00
--local-nounc Disable UNC (long path names) conversion on Windows
Version v1.57.0
2021-11-01 16:42:05 +01:00
--local-unicode-normalization Apply unicode NFC normalization to paths and filenames
--local-zero-size-links Assume the Stat size of links is zero (and read them instead) (deprecated)
--mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--mailru-encoding MultiEncoder The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--mailru-pass string Password (obscured)
--mailru-speedup-enable Skip full upload if there is another file with same data hash (default true)
--mailru-speedup-file-patterns string Comma separated list of file name patterns eligible for speedup (put by hash) (default "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf")
--mailru-speedup-max-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3Gi)
--mailru-speedup-max-memory SizeSuffix Files larger than the size given below will always be hashed on disk (default 32Mi)
--mailru-user string User name (usually email)
--mega-debug Output more debug from Mega
Version v1.58.0
2022-03-18 13:29:54 +01:00
--mega-encoding MultiEncoder The encoding for the backend (default Slash,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--mega-hard-delete Delete files permanently rather than putting them into the trash
--mega-pass string Password (obscured)
--mega-user string User name
Version v1.58.0
2022-03-18 13:29:54 +01:00
--netstorage-account string Set the NetStorage account name
--netstorage-host string Domain+path of NetStorage host to connect to
--netstorage-protocol string Select between HTTP or HTTPS protocol (default "https")
--netstorage-secret string Set the NetStorage account secret/G2O key for authentication (obscured)
Version v1.57.0
2021-11-01 16:42:05 +01:00
-x, --one-file-system Don't cross filesystem boundaries (unix/macOS only)
Version v1.59.0
2022-07-09 19:08:20 +02:00
--onedrive-access-scopes SpaceSepList Set scopes to be requested by rclone (default Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--onedrive-auth-url string Auth server URL
--onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes) (default 10Mi)
--onedrive-client-id string OAuth Client Id
--onedrive-client-secret string OAuth Client Secret
--onedrive-drive-id string The ID of the drive to use
--onedrive-drive-type string The type of the drive (personal | business | documentLibrary)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--onedrive-encoding MultiEncoder The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--onedrive-expose-onenote-files Set to make OneNote files show up in directory listings
--onedrive-link-password string Set the password for links created by the link command
--onedrive-link-scope string Set the scope of the links created by the link command (default "anonymous")
--onedrive-link-type string Set the type of the links created by the link command (default "view")
--onedrive-list-chunk int Size of listing chunk (default 1000)
--onedrive-no-versions Remove all versions on modifying operations
--onedrive-region string Choose national cloud region for OneDrive (default "global")
Version v1.58.0
2022-03-18 13:29:54 +01:00
--onedrive-root-folder-id string ID of the root folder
Version v1.57.0
2021-11-01 16:42:05 +01:00
--onedrive-server-side-across-configs Allow server-side operations (e.g. copy) to work across different onedrive configs
--onedrive-token string OAuth Access Token as a JSON blob
--onedrive-token-url string Token server url
--opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size (default 10Mi)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--opendrive-encoding MultiEncoder The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--opendrive-password string Password (obscured)
--opendrive-username string Username
--pcloud-auth-url string Auth server URL
--pcloud-client-id string OAuth Client Id
--pcloud-client-secret string OAuth Client Secret
Version v1.58.0
2022-03-18 13:29:54 +01:00
--pcloud-encoding MultiEncoder The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--pcloud-hostname string Hostname to connect to (default "api.pcloud.com")
Version v1.59.0
2022-07-09 19:08:20 +02:00
--pcloud-password string Your pcloud password (obscured)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--pcloud-root-folder-id string Fill in for rclone to use a non root folder as its starting point (default "d0")
--pcloud-token string OAuth Access Token as a JSON blob
--pcloud-token-url string Token server url
Version v1.59.0
2022-07-09 19:08:20 +02:00
--pcloud-username string Your pcloud username
Version v1.58.0
2022-03-18 13:29:54 +01:00
--premiumizeme-encoding MultiEncoder The encoding for the backend (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--putio-encoding MultiEncoder The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--qingstor-access-key-id string QingStor Access Key ID
--qingstor-chunk-size SizeSuffix Chunk size to use for uploading (default 4Mi)
--qingstor-connection-retries int Number of connection retries (default 3)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--qingstor-encoding MultiEncoder The encoding for the backend (default Slash,Ctl,InvalidUtf8)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--qingstor-endpoint string Enter an endpoint URL to connection QingStor API
--qingstor-env-auth Get QingStor credentials from runtime
--qingstor-secret-access-key string QingStor Secret Access Key (password)
--qingstor-upload-concurrency int Concurrency for multipart uploads (default 1)
--qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
--qingstor-zone string Zone to connect to
--s3-access-key-id string AWS Access Key ID
--s3-acl string Canned ACL used when creating buckets and storing or copying objects
--s3-bucket-acl string Canned ACL used when creating buckets
--s3-chunk-size SizeSuffix Chunk size to use for uploading (default 5Mi)
--s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
--s3-disable-checksum Don't store MD5 checksum with object metadata
--s3-disable-http2 Disable usage of http2 for S3 backends
--s3-download-url string Custom endpoint for downloads
Version v1.58.0
2022-03-18 13:29:54 +01:00
--s3-encoding MultiEncoder The encoding for the backend (default Slash,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--s3-endpoint string Endpoint for S3 API
--s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars)
--s3-force-path-style If true use path style access if false use virtual hosted style (default true)
--s3-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery
--s3-list-chunk int Size of listing chunk (response list for each ListObject S3 request) (default 1000)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--s3-list-url-encode Tristate Whether to url encode listings: true/false/unset (default unset)
--s3-list-version int Version of ListObjects to use: 1,2 or 0 for auto
Version v1.57.0
2021-11-01 16:42:05 +01:00
--s3-location-constraint string Location constraint - must be set to match the Region
--s3-max-upload-parts int Maximum number of parts in a multipart upload (default 10000)
--s3-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed (default 1m0s)
--s3-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool
--s3-no-check-bucket If set, don't attempt to check the bucket exists or create it
--s3-no-head If set, don't HEAD uploaded objects to check integrity
--s3-no-head-object If set, do not do HEAD before GET when getting objects
--s3-profile string Profile to use in the shared credentials file
--s3-provider string Choose your S3 provider
--s3-region string Region to connect to
--s3-requester-pays Enables requester pays option when interacting with S3 bucket
--s3-secret-access-key string AWS Secret Access Key (password)
--s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3
--s3-session-token string An AWS session token
--s3-shared-credentials-file string Path to the shared credentials file
--s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3
--s3-sse-customer-key string If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data
--s3-sse-customer-key-md5 string If using SSE-C you may provide the secret encryption key MD5 checksum (optional)
--s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key
--s3-storage-class string The storage class to use when storing new objects in S3
--s3-upload-concurrency int Concurrency for multipart uploads (default 4)
--s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
--s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint
Version v1.58.0
2022-03-18 13:29:54 +01:00
--s3-use-multipart-etag Tristate Whether to use ETag in multipart uploads for verification (default unset)
Version v1.59.0
2022-07-09 19:08:20 +02:00
--s3-use-presigned-request Whether to use a presigned request or PutObject for single part uploads
Version v1.57.0
2021-11-01 16:42:05 +01:00
--s3-v2-auth If true use v2 authentication
--seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled)
--seafile-create-library Should rclone create a library if it doesn't exist
Version v1.58.0
2022-03-18 13:29:54 +01:00
--seafile-encoding MultiEncoder The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--seafile-library string Name of the library
--seafile-library-key string Library password (for encrypted libraries only) (obscured)
--seafile-pass string Password (obscured)
--seafile-url string URL of seafile host to connect to
--seafile-user string User name (usually email address)
--sftp-ask-password Allow asking for SFTP password when needed
Version v1.59.0
2022-07-09 19:08:20 +02:00
--sftp-chunk-size SizeSuffix Upload and download chunk size (default 32Ki)
--sftp-concurrency int The maximum number of outstanding requests for one file (default 64)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--sftp-disable-concurrent-reads If set don't use concurrent reads
--sftp-disable-concurrent-writes If set don't use concurrent writes
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available
--sftp-host string SSH host to connect to
--sftp-idle-timeout Duration Max time before closing idle connections (default 1m0s)
--sftp-key-file string Path to PEM-encoded private key file
--sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file (obscured)
--sftp-key-pem string Raw PEM-encoded private key
--sftp-key-use-agent When set forces the usage of the ssh-agent
--sftp-known-hosts-file string Optional path to known_hosts file
--sftp-md5sum-command string The command used to read md5 hashes
--sftp-pass string SSH password, leave blank to use ssh-agent (obscured)
Version v1.59.0
2022-07-09 19:08:20 +02:00
--sftp-path-override string Override path used by SSH shell commands
Version v1.58.0
2022-03-18 13:29:54 +01:00
--sftp-port int SSH port number (default 22)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--sftp-pubkey-file string Optional path to public key file
--sftp-server-command string Specifies the path or command to run a sftp server on the remote host
Version v1.59.0
2022-07-09 19:08:20 +02:00
--sftp-set-env SpaceSepList Environment variables to pass to sftp and commands
Version v1.57.0
2021-11-01 16:42:05 +01:00
--sftp-set-modtime Set the modified time on the remote if set (default true)
--sftp-sha1sum-command string The command used to read sha1 hashes
Version v1.59.0
2022-07-09 19:08:20 +02:00
--sftp-shell-type string The type of SSH shell on remote server, if any
Version v1.57.0
2021-11-01 16:42:05 +01:00
--sftp-skip-links Set to skip any symlinks and any other non regular files
--sftp-subsystem string Specifies the SSH2 subsystem on the remote host (default "sftp")
--sftp-use-fstat If set use fstat instead of stat
--sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods
Version v1.58.0
2022-03-18 13:29:54 +01:00
--sftp-user string SSH username (default "$USER")
Version v1.57.0
2021-11-01 16:42:05 +01:00
--sharefile-chunk-size SizeSuffix Upload chunk size (default 64Mi)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--sharefile-encoding MultiEncoder The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--sharefile-endpoint string Endpoint for API calls
--sharefile-root-folder-id string ID of the root folder
--sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 128Mi)
--sia-api-password string Sia Daemon API Password (obscured)
--sia-api-url string Sia daemon API URL, like http://sia.daemon.host:9980 (default "http://127.0.0.1:9980")
Version v1.58.0
2022-03-18 13:29:54 +01:00
--sia-encoding MultiEncoder The encoding for the backend (default Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--sia-user-agent string Siad User Agent (default "Sia-Agent")
--skip-links Don't warn about skipped symlinks
Version v1.58.0
2022-03-18 13:29:54 +01:00
--storj-access-grant string Access grant
--storj-api-key string API key
--storj-passphrase string Encryption passphrase
--storj-provider string Choose an authentication method (default "existing")
--storj-satellite-address string Satellite address (default "us-central-1.storj.io")
Version v1.57.0
2021-11-01 16:42:05 +01:00
--sugarsync-access-key-id string Sugarsync Access Key ID
--sugarsync-app-id string Sugarsync App ID
--sugarsync-authorization string Sugarsync authorization
--sugarsync-authorization-expiry string Sugarsync authorization expiry
--sugarsync-deleted-id string Sugarsync deleted folder id
Version v1.58.0
2022-03-18 13:29:54 +01:00
--sugarsync-encoding MultiEncoder The encoding for the backend (default Slash,Ctl,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--sugarsync-hard-delete Permanently delete files if true
--sugarsync-private-access-key string Sugarsync Private Access Key
--sugarsync-refresh-token string Sugarsync refresh token
--sugarsync-root-id string Sugarsync root id
--sugarsync-user string Sugarsync user
--swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID)
--swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME)
--swift-application-credential-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET)
--swift-auth string Authentication URL for server (OS_AUTH_URL)
--swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN)
--swift-auth-version int AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION)
--swift-chunk-size SizeSuffix Above this size files will be chunked into a _segments container (default 5Gi)
--swift-domain string User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)
Version v1.58.0
2022-03-18 13:29:54 +01:00
--swift-encoding MultiEncoder The encoding for the backend (default Slash,InvalidUtf8)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--swift-endpoint-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public")
--swift-env-auth Get swift credentials from environment variables in standard OpenStack form
--swift-key string API key or password (OS_PASSWORD)
--swift-leave-parts-on-error If true avoid calling abort upload on a failure
--swift-no-chunk Don't chunk files during streaming upload
--swift-region string Region name - optional (OS_REGION_NAME)
--swift-storage-policy string The storage policy to use when creating a new container
--swift-storage-url string Storage URL - optional (OS_STORAGE_URL)
--swift-tenant string Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME)
--swift-tenant-domain string Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME)
--swift-tenant-id string Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID)
--swift-user string User name to log in (OS_USERNAME)
--swift-user-id string User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID)
--union-action-policy string Policy to choose upstream on ACTION category (default "epall")
--union-cache-time int Cache time of usage and free space (in seconds) (default 120)
--union-create-policy string Policy to choose upstream on CREATE category (default "epmfs")
Version v1.59.0
2022-07-09 19:08:20 +02:00
--union-min-free-space SizeSuffix Minimum viable free space for lfs/eplfs policies (default 1Gi)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--union-search-policy string Policy to choose upstream on SEARCH category (default "ff")
--union-upstreams string List of space separated upstreams
--uptobox-access-token string Your access token
Version v1.58.0
2022-03-18 13:29:54 +01:00
--uptobox-encoding MultiEncoder The encoding for the backend (default Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--webdav-bearer-token string Bearer token instead of user/pass (e.g. a Macaroon)
--webdav-bearer-token-command string Command to run to get a bearer token
Version v1.58.0
2022-03-18 13:29:54 +01:00
--webdav-encoding string The encoding for the backend
Version v1.57.0
2021-11-01 16:42:05 +01:00
--webdav-headers CommaSepList Set HTTP headers for all transactions
--webdav-pass string Password (obscured)
--webdav-url string URL of http host to connect to
--webdav-user string User name
Version v1.59.0
2022-07-09 19:08:20 +02:00
--webdav-vendor string Name of the WebDAV site/service/software you are using
Version v1.57.0
2021-11-01 16:42:05 +01:00
--yandex-auth-url string Auth server URL
--yandex-client-id string OAuth Client Id
--yandex-client-secret string OAuth Client Secret
Version v1.58.0
2022-03-18 13:29:54 +01:00
--yandex-encoding MultiEncoder The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
--yandex-hard-delete Delete files permanently rather than putting them into the trash
Version v1.57.0
2021-11-01 16:42:05 +01:00
--yandex-token string OAuth Access Token as a JSON blob
--yandex-token-url string Token server url
--zoho-auth-url string Auth server URL
--zoho-client-id string OAuth Client Id
--zoho-client-secret string OAuth Client Secret
Version v1.58.0
2022-03-18 13:29:54 +01:00
--zoho-encoding MultiEncoder The encoding for the backend (default Del,Ctl,InvalidUtf8)
Version v1.57.0
2021-11-01 16:42:05 +01:00
--zoho-region string Zoho region to connect to
--zoho-token string OAuth Access Token as a JSON blob
--zoho-token-url string Token server url
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
```
Reference in New Issue Copy Permalink