Command reference
Look up commands and options below. For copy examples, start with Copy files.
The advanced option groups have separate references:
- Performance tuning: workers, request sizes, and copy methods.
- Resource limits: bandwidth and concurrency ceilings.
- Integrity checking: comparisons and checksums.
Angle brackets mark values you supply; square brackets mark optional arguments,
and ... allows repetition.
syq
syq <COMMAND> [OPTIONS]
syq --self-update
| Command | Purpose |
|---|---|
cp | Copy files and directories, optionally removing destination-only files |
exec | Run a command on a named receiving machine after local approval |
rm | Remove selected files and directory trees |
clean-partials | Delete syq partial files in directory trees |
map | Print source-to-destination mappings as NDJSON |
rsync | Copy using rsync-compatible syntax |
persist | Manage persistent connections, receiving, and return destinations |
completion | Generate shell completion and manage cached endpoint suggestions |
tuning-cache | Inspect and clear local transfer tuning history |
receiver | Manage manual receiver enrollment and recovery |
help | Show help for any command or nested command |
Options
| Argument / option | Meaning |
|---|---|
--self-update | Install the newest signed release (standalone installs); Homebrew: brew upgrade syq |
Help and version
| Argument / option | Meaning |
|---|---|
-h, --help | Show common usage and options |
--help-all | Show all options and details |
-V, --version | Print version |
syq –self-update
Update a standalone installation. For Homebrew and source installations, see installation updates.
syq --self-update
Options
| Argument / option | Meaning |
|---|---|
--self-update | Update the executable registered by the standalone installer |
Help and version
| Argument / option | Meaning |
|---|---|
-h, --help | Show common usage and options |
--help-all | Show all options and details |
syq help
syq help [COMMAND...] [--help-all]
Show common help for a command or nested command, such as syq help persist receive on. Add --help-all for its complete help. With no command, show the
root help. A trailing --help or -h selects common help.
Build identity
syq --build-identity prints the executable’s build identity. See development builds.