A collection of +180 reusable WebAssembly modules for building composable CI/CD pipelines with FluentCI fluentci.io/modules
modules artifacts rclone COMPONENT.md
5.9 kB · 103 lines
Markdown
at main

rclone component functions #

Requires FluentCI v0.17.3 or newer. The compiler derives native WIT signatures and embedded help from these typed PureScript functions. Optional arguments may be omitted.

run #

Execute arbitrary literal CLI arguments.

Argument Type Required Description
project string no Working directory containing the source checkout; defaults to the current directory. Default: ".".
run-dir string yes Fresh directory for this invocation’s execution report and task logs; must not already exist.
executable string no Native CLI executable name or absolute path; defaults to this operation’s tool.
timeout-ms integer no Maximum task duration in milliseconds; defaults to 900000. Default: 900000.
artifacts array no Output artifacts to collect as NAME=PATH entries; names must be unique.
arguments array yes Literal native CLI argument tokens, passed without shell expansion.

Returns Contract.ExecutionResult.

version #

Print the CLI version.

Argument Type Required Description
project string no Working directory containing the source checkout; defaults to the current directory. Default: ".".
run-dir string yes Fresh directory for this invocation’s execution report and task logs; must not already exist.
executable string no Native CLI executable name or absolute path; defaults to this operation’s tool.
timeout-ms integer no Maximum task duration in milliseconds; defaults to 900000. Default: 900000.
artifacts array no Output artifacts to collect as NAME=PATH entries; names must be unique.

Returns Contract.ExecutionResult.

copy #

copy

Argument Type Required Description
project string no Working directory containing the source checkout; defaults to the current directory. Default: ".".
run-dir string yes Fresh directory for this invocation’s execution report and task logs; must not already exist.
executable string no Native CLI executable name or absolute path; defaults to this operation’s tool.
timeout-ms integer no Maximum task duration in milliseconds; defaults to 900000. Default: 900000.
artifacts array no Output artifacts to collect as NAME=PATH entries; names must be unique.
checksum boolean no Checksum supplied to the rclone copy operation.
immutable boolean no Immutable supplied to the rclone copy operation.
transfers integer no Transfers supplied to the rclone copy operation.
source string yes Source supplied to the rclone copy operation.
destination string yes Destination supplied to the rclone copy operation.

Returns Contract.ExecutionResult.

copyto #

copyto

Argument Type Required Description
project string no Working directory containing the source checkout; defaults to the current directory. Default: ".".
run-dir string yes Fresh directory for this invocation’s execution report and task logs; must not already exist.
executable string no Native CLI executable name or absolute path; defaults to this operation’s tool.
timeout-ms integer no Maximum task duration in milliseconds; defaults to 900000. Default: 900000.
artifacts array no Output artifacts to collect as NAME=PATH entries; names must be unique.
checksum boolean no Checksum supplied to the rclone copyto operation.
immutable boolean no Immutable supplied to the rclone copyto operation.
source string yes Source supplied to the rclone copyto operation.
destination string yes Destination supplied to the rclone copyto operation.

Returns Contract.ExecutionResult.

check #

Verify transferred artifact content against the source.

Argument Type Required Description
project string no Working directory containing the source checkout; defaults to the current directory. Default: ".".
run-dir string yes Fresh directory for this invocation’s execution report and task logs; must not already exist.
executable string no Native CLI executable name or absolute path; defaults to this operation’s tool.
timeout-ms integer no Maximum task duration in milliseconds; defaults to 900000. Default: 900000.
artifacts array no Output artifacts to collect as NAME=PATH entries; names must be unique.
one-way boolean no One Way supplied to the rclone check operation.
source string yes Source supplied to the rclone check operation.
destination string yes Destination supplied to the rclone check operation.

Returns Contract.ExecutionResult.

lsjson #

lsjson

Argument Type Required Description
project string no Working directory containing the source checkout; defaults to the current directory. Default: ".".
run-dir string yes Fresh directory for this invocation’s execution report and task logs; must not already exist.
executable string no Native CLI executable name or absolute path; defaults to this operation’s tool.
timeout-ms integer no Maximum task duration in milliseconds; defaults to 900000. Default: 900000.
artifacts array no Output artifacts to collect as NAME=PATH entries; names must be unique.
recursive boolean no Recursive supplied to the rclone lsjson operation.
path string yes Path supplied to the rclone lsjson operation.

Returns Contract.ExecutionResult.