rclone/docs/content/commands/rclone_check.md

128 lines
6.1 KiB
Markdown
Raw Normal View History

---
title: "rclone check"
description: "Checks the files in the source and destination match."
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/check/ and as part of making a release run "make commanddocs"
---
# rclone check
Checks the files in the source and destination match.
## Synopsis
2017-03-18 19:16:43 +08:00
Checks the files in the source and destination match. It compares
2022-03-18 20:29:54 +08:00
sizes and hashes (MD5 or SHA1) and logs a report of files that don't
2017-03-18 19:16:43 +08:00
match. It doesn't alter the source or destination.
2022-07-10 01:08:20 +08:00
For the [crypt](/crypt/) remote there is a dedicated command,
[cryptcheck](/commands/rclone_cryptcheck/), that are able to check
2023-03-24 21:31:39 +08:00
the checksums of the encrypted files.
2022-07-10 01:08:20 +08:00
2021-02-02 21:42:35 +08:00
If you supply the `--size-only` flag, it will only compare the sizes not
2017-03-18 19:16:43 +08:00
the hashes as well. Use this for a quick check.
2021-02-02 21:42:35 +08:00
If you supply the `--download` flag, it will download the data from
2017-03-18 19:16:43 +08:00
both remotes and check them against each other on the fly. This can
be useful for remotes that don't support hashes or if you really want
to check all the data.
If you supply the `--checkfile HASH` flag with a valid hash name,
the `source:path` must point to a text file in the SUM format.
2020-09-02 23:59:04 +08:00
If you supply the `--one-way` flag, it will only check that files in
the source match the files in the destination, not the other way
around. This means that extra files in the destination that are not in
the source will not be detected.
2021-02-02 21:42:35 +08:00
The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match`
2020-09-02 23:59:04 +08:00
and `--error` flags write paths, one per line, to the file name (or
stdout if it is `-`) supplied. What they write is described in the
help below. For example `--differ` will write all paths which are
present on both the source and destination but different.
The `--combined` flag will write a file (or stdout) which contains all
file paths with a symbol and then a space and then the path to tell
you what happened to it. These are reminiscent of diff files.
- `= path` means path was found in source and destination and was identical
- `- path` means path was missing on the source, so only in the destination
- `+ path` means path was missing on the destination, so only in the source
- `* path` means path was present in source and destination but different.
- `! path` means there was an error reading or hashing the source or dest.
2018-06-17 01:21:09 +08:00
2023-06-30 21:11:17 +08:00
The default number of parallel checks is 8. See the [--checkers=N](/docs/#checkers-n)
option for more information.
```
rclone check source:path dest:path [flags]
```
## Options
2017-03-18 19:16:43 +08:00
```
-C, --checkfile string Treat source:path as a SUM file with hashes of given type
2020-09-02 23:59:04 +08:00
--combined string Make a combined report of changes to this file
--differ string Report all non-matching files to this file
2021-11-01 23:42:05 +08:00
--download Check by downloading rather than with hash
2020-09-02 23:59:04 +08:00
--error string Report all files with errors (hashing or reading) to this file
-h, --help help for check
--match string Report all matching files to this file
--missing-on-dst string Report all files missing from the destination to this file
--missing-on-src string Report all files missing from the source to this file
--one-way Check one way only, source files must exist on remote
2017-03-18 19:16:43 +08:00
```
2024-09-08 23:21:56 +08:00
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
2023-08-02 17:02:38 +08:00
2024-09-08 23:21:56 +08:00
### Check Options
2023-08-02 17:02:38 +08:00
2024-09-08 23:21:56 +08:00
Flags used for check commands
2023-08-02 17:02:38 +08:00
```
--max-backlog int Maximum number of objects in sync or check backlog (default 10000)
```
2024-09-08 23:21:56 +08:00
### Filter Options
2023-08-02 17:02:38 +08:00
2024-09-08 23:21:56 +08:00
Flags for filtering directory listings
2023-08-02 17:02:38 +08:00
```
--delete-excluded Delete files on dest excluded from sync
--exclude stringArray Exclude files matching pattern
--exclude-from stringArray Read file exclude patterns from file (use - to read from stdin)
--exclude-if-present stringArray Exclude directories if filename is present
--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)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--ignore-case Ignore case in filters (case insensitive)
--include stringArray Include files matching pattern
--include-from stringArray Read file include patterns from file (use - to read from stdin)
--max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--max-depth int If set limits the recursion depth to this (default -1)
--max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
--metadata-exclude stringArray Exclude metadatas matching pattern
--metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin)
--metadata-filter stringArray Add a metadata filtering rule
--metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin)
--metadata-include stringArray Include metadatas matching pattern
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
2024-09-08 23:21:56 +08:00
### Listing Options
2023-08-02 17:02:38 +08:00
2024-09-08 23:21:56 +08:00
Flags for listing directories
2023-08-02 17:02:38 +08:00
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
2024-09-08 23:21:56 +08:00
## See Also
2018-10-15 18:03:08 +08:00
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
2018-03-19 18:06:13 +08:00