ClientOptions (transfer settings)

Every client object exposes an Options field that controls transfer behaviour, versioning, on-the-fly encryption, and connection timeout. All settings are optional (the defaults are sensible for most use cases).

cli.Options.<field> = <value>;

---

Transfer behaviour

Field	Type	Default	Description
StopOnTransferError	bool	false	Abort the entire batch on the first transfer failure. When false, the client continues and reports the overall result.
DownloadPolicy	int	NeverOverwrite	What to do when a local file with the same name already exists. Use the transfer-policy constants.
UploadPolicy	int	NeverOverwrite	What to do when a remote file with the same name already exists. Same constants as DownloadPolicy.
OnDownloadGrantTo	string	""	POSIX username to chown every downloaded file to. Effective only on Linux when ss-wrk runs as root.
AdjustTimeOnDownload	bool	true	Set the downloaded file's modification time to match the remote file's mtime.
AdjustTimeOnUpload	bool	true	Set the remote file's modification time to match the local file's mtime.
DownloadWithTempName	bool	false	Download to <filename>.tempfile, rename to the final name only on successful completion. Prevents readers from seeing partial files.
UploadWithTempName	bool	false	Upload as <filename>.tempfile, rename to the final name only on successful completion.
DeleteSourceAfterDownload	bool	false	Delete the remote file after a successful download (effectively a remote → local move).
DeleteSourceAfterUpload	bool	false	Delete the local file after a successful upload (effectively a local → remote move).

---

Versioning

When versioning is enabled, the existing file is moved to a .ver/ subdirectory before it is overwritten, keeping a configurable number of historical copies.

Field	Type	Default	Description
VersionedDownload	bool	false	Move an existing local file to a .ver/ subdirectory before overwriting it.
VersionedUpload	bool	false	Move an existing remote file to a .ver/ subdirectory before overwriting it.
VersionsToKeepLocal	int	3	Maximum number of versions to retain in the local .ver/ directory. Older copies are pruned automatically.
VersionsToKeepRemote	int	3	Maximum number of versions to retain in the remote .ver/ directory.

---

On-The-Fly Encryption (OTFE)

OTFE encrypts files transparently during upload and decrypts them during download. Encryption and decryption happen in memory, the remote side only ever stores the ciphertext, while the local side always sees plaintext.

Field	Type	Default	Description
OTFE	bool	false	Enable OTFE for all upload and download operations.
OTFEAlgorithm	int	OTFEAlgoAES256GCM	Encryption algorithm. Use the OTFE constants.
OTFEKey	string	""	Passphrase / key material. For AES-256-GCM, fed into PBKDF2-SHA256 to derive a 32-byte key. For OpenPGP, used as the symmetric passphrase (RFC 4880 S2K).

TIP

Avoid storing encryption keys directly in scripts. Use GetSecret to fetch the key at runtime:

cli.Options.OTFE         = true;
cli.Options.OTFEAlgorithm = OTFEAlgoAES256GCM;
cli.Options.OTFEKey      = GetSecret("transfer-encryption-key");

See the Secrets page for how to define secrets in the Admin UI, and the GetSecret reference for usage details.

---

Connection

Field	Type	Default	Description
ConnectTimeoutSeconds	int	30	TCP dial timeout in seconds. 0 means no timeout. Not used by the object-storage clients (S3, Azure, GCS), which manage their own connection timeouts internally via their SDK HTTP clients.