2016-08-04 04:36:28 +08:00
|
|
|
---
|
|
|
|
|
title: "rclone check"
|
2020-05-16 22:11:55 +08:00
|
|
|
description: "Checks the files in the source and destination match."
|
2016-08-04 04:36:28 +08:00
|
|
|
slug: rclone_check
|
|
|
|
|
url: /commands/rclone_check/
|
2020-02-10 20:31:45 +08:00
|
|
|
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/check/ and as part of making a release run "make commanddocs"
|
2016-08-04 04:36:28 +08:00
|
|
|
---
|
2020-05-22 18:17:37 +08:00
|
|
|
# rclone check
|
2016-08-04 04:36:28 +08:00
|
|
|
|
|
|
|
|
Checks the files in the source and destination match.
|
|
|
|
|
|
2020-05-22 18:17:37 +08:00
|
|
|
## Synopsis
|
2016-08-04 04:36:28 +08:00
|
|
|
|
|
|
|
|
|
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.
|
2016-08-04 04:36:28 +08:00
|
|
|
|
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.
|
2016-08-04 04:36:28 +08:00
|
|
|
|
2021-07-07 23:34:16 +08:00
|
|
|
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-03-24 19:35:58 +08:00
|
|
|
The default number of parallel checks is N=8. See the [--checkers=N](/docs/#checkers-n) option
|
|
|
|
|
for more information.
|
2016-08-04 04:36:28 +08:00
|
|
|
|
|
|
|
|
```
|
2017-06-16 03:12:26 +08:00
|
|
|
rclone check source:path dest:path [flags]
|
2016-08-04 04:36:28 +08:00
|
|
|
```
|
|
|
|
|
|
2020-05-22 18:17:37 +08:00
|
|
|
## Options
|
2017-03-18 19:16:43 +08:00
|
|
|
|
|
|
|
|
```
|
2021-07-07 23:34:16 +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
|
|
|
```
|
|
|
|
|
|
2019-06-20 23:18:02 +08:00
|
|
|
See the [global flags page](/flags/) for global options not listed here.
|
|
|
|
|
|
2020-05-22 18:17:37 +08:00
|
|
|
## SEE ALSO
|
2016-08-04 04:36:28 +08:00
|
|
|
|
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
|
|
|
|
