Runtime Parameters
In addition to the configuration settings, there are several command-line parameters
that control the runtime behavior of the
tdsync
tool.--connect-timeout
- The timeout, in milliseconds, to wait for a network connection to the server. The
default is
20000
(20 seconds). Set to0
to disable the timeout. --delete-search-index
- Delete search index and reprocess after uploading. (This will only be effective at the project level.)
--dry-run
- List the files to be included or excluded; do not actually sync.
--excludes
- Exclusion patterns. May have any number of values.
--force
- Normally, only files whose contents differ will be uploaded (or, in the case of
--pull
, downloaded). When this is present, all files will be affected, not just those that are different. --help
or-h
- Prints usage information, and performs no syncing.
--http-trace
- Enables verbose printing of HTTP traffic.
--maxchunk-files <count>
- Specifies the maximum number of files to include in each payload sent to the server. The default is 1000 files.
--max-upload-size <bytes>
- Specifies the maximum size zip file to upload. Sync breaks down the upload package into one or more zip archives for transfer to the server. This specifies the maximum size of zip archive to build before starting a new one. Default is 10 megabytes (10000000 bytes). Use -1 to disable upload package splitting.
--metadataBehavior <arg>
- How to handle changed metadata values. Must be one of "skip", "merge", or "replace" (default).
--metadataLoader <className>
- Metadata loader class.
--metadataLoader.<param> <value>
- Pass parameter named
<param>
with value<value>
to metadata loader. --missingFiles <arg>
- Behavior for extra remote files.
<arg>
must be one of "ignore" (the default), "download", or "delete". --missingMetadata <arg>
- How to handle excess metadata keys.
<arg>
must be one of "ignore" or "delete" (default). --no-check-certificate
- If present, then the server's HTTPS certificate will not be validated, allowing the tool to be used with self-signed, expired, or otherwise untrusted certificates. USE WITH CARE.
--password <password>
- Password.
--poll
- By default, watch mode uses Operating System hooks to watch files for changes. This
can fail for certain file system types, such as Windows network drives or other remote
file systems. In such cases,
--poll
instructstdsync
to scan the directories for changes at regular intervals instead of using file system hooks. --poll-interval <ms>
- When
-poll
is specified,<ms>
specifies the poll interval, in milliseconds. --projectFolder <folderPath>
- Folder within the project (specified by
--projectKey
) where to load files. --projectKey <key>
- Project key of project in which to load files.
--pull
- When present, files will be downloaded from the server instead of uploaded from the
local file system. Can be used in conjunction with
--dry-run
and/or--force
. --reprocess
or-r
- Reprocess other affected files after uploading.
--request-timeout <ms>
- The amount of time to wait for a response from the server when sending HTTP requests
before failing with an error. The default is
20000
(20 seconds). Set to0
to disable the timeout. --setup
- Generates a
.tdsyncrc
file using user prompts. --url <url>
- Base URL of the admin web application.
--username <username>
- User name.
--verbose
or-v
- When present, extra, detailed information will be written to the console during syncing.
--version
- Prints version information.
--watch
or-w
- When specified, the
tdsync
process will not exit after syncing, instead watching the folder or folders for changes, and uploading those modified files immediately when they are updated. --watch-only
- The same as
--watch
, but without an initial sync.