Documentation v0.7.1 (latest) v0.7.0 v0.6.0 v0.5.2 v0.5.1 v0.5.0 v0.4.1 v0.4.0 v0.3.2 v0.3.1 v0.3.0 v0.2.0 master — unreleased Choose a version: v0.7.1 (latest) · v0.7.0 · v0.6.0 · v0.5.2 · v0.5.1 · v0.5.0 · v0.4.1 · v0.4.0 · v0.3.2 · v0.3.1 · v0.3.0 · v0.2.0 · master — unreleased Remove local files, remote filesystem entries, or S3 objects.
See Remove files for selection rules and
Versions and deletion for versioned objects.
syq rm --src-dir old-output --dry-run -v
For scripting, see environment variables
and Removal records .
syq rm [OPTIONS] PATH...
syq rm [OPTIONS] --srcs-in DIR
Argument / option Meaning
--auth-from <@NAME>Request storage authorization from a connected receiving machine --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 --pscope <PATH>Use an ephemeral SSH persistence scope created by syq persist on --ephemeral
Argument / option Meaning
--s3-endpoint <URL>S3 API endpoint URL (also AWS_ENDPOINT_URL_S3 or AWS_ENDPOINT_URL) --s3-region <REGION>S3 signing region, used as given (otherwise syq asks AWS where the bucket is) --s3-profile <NAME>AWS shared configuration/credentials profile --s3-header <NAME: VALUE>Add a header before signing every S3 request (repeatable; S3-to-S3 metadata/tag overrides are refused) --s3-all-versionsPermanently remove all selected S3 object versions and delete markers --s3-version-id <ID>Permanently remove one version or delete marker of one exact S3 key
Argument / option Meaning
--on <ENDPOINT>Removal endpoint ([USER@]HOST[:PORT] or s3://BUCKET); omitted means local -C, --cwd <DIR>Resolve relative selectors from DIR at the removal endpoint --root <DIR>Confine resolution and removal beneath DIR --followLike –follow-src; also follow symlinks in the –results path --follow-srcFollow symlinks in –cwd, –root, and selector parent directories; always unlink a final selected symlink --src <PATH>Select a non-directory object; attach =PATH when it begins with - (repeatable) --srcs-in <DIR>Recursively select a directory’s contents, keeping the directory; attach =DIR when it begins with - (repeatable) --src-non-dir <PATH>Select a non-directory object; attach =PATH when it begins with - (repeatable) --src-dir <DIR>Select a directory tree; attach =DIR when it begins with - (repeatable) --src-non-dirs <PATH>...Select several non-directory objects --src-dirs <DIR>...Select several directory trees --srcs <PATH>...Select several non-directory objects [PATH]...Selected objects (shorthand for –src)
Argument / option Meaning
-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
Argument / option Meaning
--performance-tuning <KEY=VALUE,...>Filesystem removal workers: workers=N
Argument / option Meaning
--progressShow progress even when stderr is not a terminal --no-progressNever show the human progress display --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
Argument / option Meaning
-h, --helpShow common usage and options -V, --versionPrint version --help-allShow all options and details
Named paths, --src, and --src-non-dir require non-directories. Use
--src-dir to require a directory and remove it recursively, or --srcs-in
to remove its contents while keeping the directory. These directory selectors
reject a final symlink even when following is enabled. All selections are
checked before deletion begins. Filters are not supported.