github.com/artpar/rclone@v1.67.3/docs/content/commands/rclone_cryptcheck.md (about)

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