syq persist
Manage reusable SSH connections and receiving profiles. Start with Use your laptop from a server for setup, or see Persistence details for profiles and limits.
syq persist <COMMAND>
| Command | Purpose |
|---|---|
persist receive | Configure receiving and decide incoming copy or command requests |
persist destinations | Inspect or recover named return destinations |
persist connect | Connect to an SSH server and wait until enabled receiving is ready |
persist on | Enable persistent connections for later syq commands |
persist off | Disable persistence and close its live SSH control connections |
persist status | Show connection readiness and any receiving problem |
Help (also available on subcommands)
| Argument / option | Meaning |
|---|---|
-h, --help | Show common usage and options |
--help-all | Show all options and details |
syq persist receive
Configure receiving and approve its requests. See the three uses of receiving for file copies to your machine, commands on it, and authorizing copies between servers.
syq persist receive <COMMAND>
| Command | Purpose |
|---|---|
persist receive pending | Show incoming copy and command requests awaiting approval on this machine |
persist receive approve | Allow one pending request using the ID from persist receive pending |
persist receive deny | Deny one pending request using the ID from persist receive pending |
persist receive on | Enable or configure a receiving profile (without –name, use the first profile) |
persist receive off | Disable receiving and stop its background connections; keep ordinary persistence |
persist receive remove | Remove a saved receiving profile and stop its connections |
persist receive status | Show receiving settings and background connection state |
persist receive wait | Wait for a connection with a deadline |
syq persist receive pending
--json prints structured requests. --wait waits for a request, up to --timeout seconds (default 30). Use the returned request ID with approve or deny.
syq persist receive pending [OPTIONS]
Options
| Argument / option | Meaning |
|---|---|
--json | See the command description above. |
--wait | Wait for an incoming request, with a deadline |
--timeout <TIMEOUT> | [default: 30] |
syq persist receive approve
ID is a pending request ID from persist receive pending on this machine. Approval applies to that request only.
syq persist receive approve <ID>
Arguments
| Argument / option | Meaning |
|---|---|
<ID> | See the command description above. |
syq persist receive deny
ID is a pending request ID from persist receive pending on this machine.
syq persist receive deny <ID>
Arguments
| Argument / option | Meaning |
|---|---|
<ID> | See the command description above. |
syq persist receive on
Omitted settings keep saved values. New profiles ask for approval with desktop
prompts and use the home directory. Set --root to confine copies to a directory.
Changing settings cancels the profile’s active requests. See
profile settings and
copy limits.
syq persist receive on [OPTIONS]
Options
| Argument / option | Meaning |
|---|---|
--auto-approve-root <AUTO_APPROVE_ROOT> | Automatically approve downloads confined to this directory |
--no-auto-approve-root | Require approval for every download again |
--server <SERVERS> | Limit this profile to these SSH destinations (repeat to allow several) |
--all-servers | Make this profile available through every connected server |
--notify <NOTIFICATIONS> | Show desktop prompts, or use only local pending/approve/deny commands [possible values: desktop, off] |
--name <NAME> | Create or update this named profile; omitted means the first profile |
-C, --cwd <CWD> | Default destination directory; absolute paths and .. may select elsewhere |
--auto-cwd | Choose cwd from root, auto-approve-root, then HOME |
--root <ROOT> | Confinement boundary for every download, even with approval |
--no-root | Remove the hard download boundary |
--max-bytes <MAX_BYTES> | Maximum bytes one transfer may reserve/write (default: 100G) |
--max-entries <MAX_ENTRIES> | Maximum entries one transfer may touch (default: 1000000) |
--max-delete <MAX_DELETE> | Permit pruning up to N entries per transfer (default: 0) |
syq persist receive off
Disable the named profile, or all profiles when --name is omitted. This stops incoming requests while leaving forward SSH persistence available.
syq persist receive off [OPTIONS]
Options
| Argument / option | Meaning |
|---|---|
--name <NAME> | Stop only this profile; without –name, stop all profiles |
syq persist receive remove
NAME identifies the saved profile to remove. Its connections and requests stop. The last profile can be disabled but cannot be removed; server-side name assignments remain until explicitly forgotten.
syq persist receive remove <NAME>
Arguments
| Argument / option | Meaning |
|---|---|
<NAME> | See the command description above. |
syq persist receive status
Show all profiles, or select one with --name. Use --json for structured output.
syq persist receive status [OPTIONS]
Options
| Argument / option | Meaning |
|---|---|
--json | See the command description above. |
--name <NAME> | See the command description above. |
syq persist receive wait
HOST is the SSH server endpoint. Wait for the selected profile, or every enabled profile when --name is omitted. --timeout is in seconds; failure or timeout exits nonzero. This command does not start a connection.
syq persist receive wait [OPTIONS] <HOST>
Arguments
| Argument / option | Meaning |
|---|---|
<HOST> | See the command description above. |
Options
| Argument / option | Meaning |
|---|---|
--name <NAME> | Wait for this profile; otherwise wait for every enabled profile |
--timeout <TIMEOUT> | [default: 30] |
syq persist destinations
syq persist destinations <COMMAND>
| Command | Purpose |
|---|---|
persist destinations list | Print registrations and whether their receiving laptop responds |
persist destinations forget | Remove an offline destination name so another laptop can register it |
persist destinations wait | Wait for a connection with a deadline |
syq persist destinations list
syq persist destinations list
syq persist destinations forget
NAME is an offline receiving name to release before replacing its machine. Forgetting a live connection is refused.
syq persist destinations forget <NAME>
Arguments
| Argument / option | Meaning |
|---|---|
<NAME> | See the command description above. |
syq persist destinations wait
NAME is a receiving name without @. Wait up to --timeout seconds for it to respond; timeout exits nonzero.
syq persist destinations wait [OPTIONS] <NAME>
Arguments
| Argument / option | Meaning |
|---|---|
<NAME> | See the command description above. |
Options
| Argument / option | Meaning |
|---|---|
--timeout <TIMEOUT> | [default: 30] |
syq persist connect
Connect to HOST and wait for receiving to be ready. --timeout applies to
the receiving wait after SSH and helper setup. --syq-path and --no-bootstrap
cannot combine. Use --pscope for an existing ephemeral scope.
syq persist connect [OPTIONS] <HOST>
Arguments
| Argument / option | Meaning |
|---|---|
<HOST> | SSH endpoint ([USER@]HOST[:PORT]); receiving names are not accepted |
Options
| Argument / option | Meaning |
|---|---|
--syq-path <PATH> | Use this remote syq executable instead of installing a matching helper |
--no-bootstrap | Use syq on the remote PATH instead of installing a matching helper |
--timeout <TIMEOUT> | Wait this many seconds for receiving after SSH/helper setup [default: 30] |
--pscope <PATH> | Reuse forward SSH in an existing ephemeral scope, without enabling receiving |
syq persist on
syq persist on [OPTIONS]
Options
| Argument / option | Meaning |
|---|---|
--ephemeral | Create an ephemeral scope and print its path instead of changing the user setting |
syq persist off
syq persist off [OPTIONS]
Options
| Argument / option | Meaning |
|---|---|
--pscope <PATH> | Operate on this ephemeral persistence scope instead of the user setting |
syq persist status
Inspect connections without starting them. --json uses the connection-status contract. --pscope selects an ephemeral scope.
syq persist status [OPTIONS]
Options
| Argument / option | Meaning |
|---|---|
--json | Print structured connection state |
--pscope <PATH> | Inspect this ephemeral persistence scope instead of the user setting |