Description

Check that files in source and destination paths match

Input

name:type
description
pattern

meta

:map

Groovy Map containing source information e.g. [ id:‘test’ ]

source

:string

File or directory containing source files to compare. This should be a path understood by Rclone, such as a local path or a configured remote path. Examples: data/input, s3:bucket/path, gs:bucket/path, remote:path/to/data.

destination

:string

Directory containing destination files to compare. This should be the fully resolved target path understood by Rclone, such as a local path or a configured remote path. The module does not append sample IDs, basenames, or modify this path internally. Examples: results/output, s3:bucket/output, gs:bucket/output, remote:path/to/output.

rclone_config

:file

Rclone configuration file defining the remotes used by source_path and/or destination_path. Authentication and remote-specific options should be configured in this file where possible.

*.conf

Output

name:type
description
pattern

combined

meta

:map

Groovy Map containing source information e.g. [ id:‘test’ ]

${prefix}.combined.txt

:file

Combined report of matching, missing, differing, and error paths.

*.combined.txt

differ

meta

:map

Groovy Map containing source information e.g. [ id:‘test’ ]

${prefix}.differ.txt

:file

Report of paths present in both source and destination but different.

*.differ.txt

missing_on_dst

meta

:map

Groovy Map containing source information e.g. [ id:‘test’ ]

${prefix}.missing_on_dst.txt

:file

Report of paths present in source but missing from destination.

*.missing_on_dst.txt

missing_on_src

meta

:map

Groovy Map containing source information e.g. [ id:‘test’ ]

${prefix}.missing_on_src.txt

:file

Report of paths present in destination but missing from source.

*.missing_on_src.txt

match

meta

:map

Groovy Map containing source information e.g. [ id:‘test’ ]

${prefix}.match.txt

:file

Report of matching paths.

*.match.txt

error

meta

:map

Groovy Map containing source information e.g. [ id:‘test’ ]

${prefix}.error.txt

:file

Report of paths with read or hash errors.

*.error.txt

exit_code

meta

:map

Groovy Map containing checksum source information e.g. [ id:‘test’ ]

${prefix}.exit_code.txt

:file

File with exit status.

*.exit_code.txt

versions_rclone

${task.process}

:string

The name of the process

rclone

:string

The name of the tool

rclone --version | sed -n '1s/^rclone v//p'

:eval

The expression to obtain the version of the tool

Topics

name:type
description
pattern

versions

${task.process}

:string

The name of the process

rclone

:string

The name of the tool

rclone --version | sed -n '1s/^rclone v//p'

:eval

The expression to obtain the version of the tool

Tools

rclone
MIT

Rclone is a command-line program to manage files on cloud storage.

rclone.org rclone.org/commands/rclone_check https://github.com/rclone/rclone
included in
datasync
maintainer
Github user atrigila
get in touch
Ask a question on Slack Open an issue on GitHub