github.com/rclone/rclone@v1.66.1-0.20240517100346-7b89735ae726/docs/content/commands/rclone_check.md (about)

     1  ---
     2  title: "rclone check"
     3  description: "Checks the files in the source and destination match."
     4  slug: rclone_check
     5  url: /commands/rclone_check/
     6  groups: Filter,Listing,Check
     7  # autogenerated - DO NOT EDIT, instead edit the source code in cmd/check/ and as part of making a release run "make commanddocs"
     8  ---
     9  # rclone check
    10  
    11  Checks the files in the source and destination match.
    12  
    13  ## Synopsis
    14  
    15  
    16  Checks the files in the source and destination match.  It compares
    17  sizes and hashes (MD5 or SHA1) and logs a report of files that don't
    18  match.  It doesn't alter the source or destination.
    19  
    20  For the [crypt](/crypt/) remote there is a dedicated command,
    21  [cryptcheck](/commands/rclone_cryptcheck/), that are able to check
    22  the checksums of the encrypted files.
    23  
    24  If you supply the `--size-only` flag, it will only compare the sizes not
    25  the hashes as well.  Use this for a quick check.
    26  
    27  If you supply the `--download` flag, it will download the data from
    28  both remotes and check them against each other on the fly.  This can
    29  be useful for remotes that don't support hashes or if you really want
    30  to check all the data.
    31  
    32  If you supply the `--checkfile HASH` flag with a valid hash name,
    33  the `source:path` must point to a text file in the SUM format.
    34  
    35  If you supply the `--one-way` flag, it will only check that files in
    36  the source match the files in the destination, not the other way
    37  around. This means that extra files in the destination that are not in
    38  the source will not be detected.
    39  
    40  The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match`
    41  and `--error` flags write paths, one per line, to the file name (or
    42  stdout if it is `-`) supplied. What they write is described in the
    43  help below. For example `--differ` will write all paths which are
    44  present on both the source and destination but different.
    45  
    46  The `--combined` flag will write a file (or stdout) which contains all
    47  file paths with a symbol and then a space and then the path to tell
    48  you what happened to it. These are reminiscent of diff files.
    49  
    50  - `= path` means path was found in source and destination and was identical
    51  - `- path` means path was missing on the source, so only in the destination
    52  - `+ path` means path was missing on the destination, so only in the source
    53  - `* path` means path was present in source and destination but different.
    54  - `! path` means there was an error reading or hashing the source or dest.
    55  
    56  The default number of parallel checks is 8. See the [--checkers=N](/docs/#checkers-n)
    57  option for more information.
    58  
    59  
    60  ```
    61  rclone check source:path dest:path [flags]
    62  ```
    63  
    64  ## Options
    65  
    66  ```
    67    -C, --checkfile string        Treat source:path as a SUM file with hashes of given type
    68        --combined string         Make a combined report of changes to this file
    69        --differ string           Report all non-matching files to this file
    70        --download                Check by downloading rather than with hash
    71        --error string            Report all files with errors (hashing or reading) to this file
    72    -h, --help                    help for check
    73        --match string            Report all matching files to this file
    74        --missing-on-dst string   Report all files missing from the destination to this file
    75        --missing-on-src string   Report all files missing from the source to this file
    76        --one-way                 Check one way only, source files must exist on remote
    77  ```
    78  
    79  
    80  ## Check Options
    81  
    82  Flags used for `rclone check`.
    83  
    84  ```
    85        --max-backlog int   Maximum number of objects in sync or check backlog (default 10000)
    86  ```
    87  
    88  ## Filter Options
    89  
    90  Flags for filtering directory listings.
    91  
    92  ```
    93        --delete-excluded                     Delete files on dest excluded from sync
    94        --exclude stringArray                 Exclude files matching pattern
    95        --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
    96        --exclude-if-present stringArray      Exclude directories if filename is present
    97        --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
    98        --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
    99    -f, --filter stringArray                  Add a file filtering rule
   100        --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
   101        --ignore-case                         Ignore case in filters (case insensitive)
   102        --include stringArray                 Include files matching pattern
   103        --include-from stringArray            Read file include patterns from file (use - to read from stdin)
   104        --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
   105        --max-depth int                       If set limits the recursion depth to this (default -1)
   106        --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
   107        --metadata-exclude stringArray        Exclude metadatas matching pattern
   108        --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
   109        --metadata-filter stringArray         Add a metadata filtering rule
   110        --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
   111        --metadata-include stringArray        Include metadatas matching pattern
   112        --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
   113        --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
   114        --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
   115  ```
   116  
   117  ## Listing Options
   118  
   119  Flags for listing directories.
   120  
   121  ```
   122        --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
   123        --fast-list           Use recursive list if available; uses more memory but fewer transactions
   124  ```
   125  
   126  See the [global flags page](/flags/) for global options not listed here.
   127  
   128  # SEE ALSO
   129  
   130  * [rclone](/commands/rclone/)	 - Show help for rclone commands, flags and backends.
   131