Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

These docs describe unreleased changes on master. Read the latest stable documentation.

syq clean-partials

Remove syq partial files below local or SSH directory trees. Stop copies writing into those trees before deleting partials:

syq clean-partials --dry-run -v backup
syq clean-partials backup

See interrupted-copy recovery for which files this removes. Results use the rm record format.

syq clean-partials [OPTIONS] <TREE>...

Sources and selection

Argument / optionMeaning
--on <ENDPOINT>Removal endpoint ([USER@]HOST[:PORT]); omitted means local
-C, --cwd <DIR>Resolve relative trees from DIR at the removal endpoint
--root <DIR>Confine traversal beneath DIR
<TREE>...Directory trees to search

Preview and output

Argument / optionMeaning
-n, --dry-runPreview without changing copy/removal data; remote setup may still cache the helper or install syq; requested results files are still written
-v, --verbose...List removed paths
-q, --quietSuppress non-error messages

Performance tuning

Argument / optionMeaning
--performance-tuning <KEY=VALUE,...>Filesystem removal workers: workers=N

Progress and results

Argument / optionMeaning
--progressShow progress even when stderr is not a terminal
--no-progressNever show the human progress display
--progress-jsonEmit machine-readable progress lines (JSON) on stderr
--results <FILE>Write the machine-readable NDJSON result stream to FILE (created fresh; an existing file is refused)
--results-fd <FD>Write the result stream to an inherited file descriptor the caller opened (e.g. --results-fd 3 3>run.ndjson); must be above 2

SSH and transport

Argument / optionMeaning
--syq-path <PATH>Use this exact syq executable on the remote removal endpoint
--no-bootstrapUse syq on the remote PATH instead of installing a helper

Help and version

Argument / optionMeaning
-h, --helpShow common usage and options
-V, --versionPrint version
--help-allShow all options and details