These docs describe unreleased changes on master. Read the latest stable documentation.
Remove local files, remote filesystem entries, or S3 objects.
See Remove files for selection rules and
S3 removal for versioned objects.
syq rm --src-dir old-output --dry-run -v
For scripting, see environment variables
and removal results.
syq rm [OPTIONS] PATH...
syq rm [OPTIONS] --srcs-in DIR
| 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-versions | Permanently 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 |
--follow | Like –follow-src; also follow symlinks in the –results path |
--follow-src | Follow 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-run | Preview 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, --quiet | Suppress non-error messages |
| Argument / option | Meaning |
|---|
--performance-tuning <KEY=VALUE,...> | Filesystem removal workers: workers=N |
| Argument / option | Meaning |
|---|
--progress | Show progress even when stderr is not a terminal |
--no-progress | Never show the human progress display |
--progress-json | Emit 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 |
| Argument / option | Meaning |
|---|
--syq-path <PATH> | Use this exact syq executable on the remote removal endpoint |
--no-bootstrap | Use 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 |
|---|
-h, --help | Show common usage and options |
-V, --version | Print version |
--help-all | Show all options and details |