CLI
Command reference.
farwing is the free program: a client with no artificial feature locks for SSH copies, plus a small helper started on the remote side. For the full flag list on your install, runfarwing --help and farwing cp --help.
Commands
| Command | Purpose |
|---|
farwing cp | Copy one file. One side is [user@]host:path, or use --ticket. |
farwing bench | Memory-to-memory speed test against a host (no disk). |
farwing daemon | Own the data port so every transfer on this host shares it. |
farwing listen | Lab mode: wait for sessions that use a shared key file (no SSH). |
farwing keygen | Print a new random key for lab mode (64 hex digits). |
farwing serve | Remote helper started by the client over SSH. Not for direct use. |
farwing cp
farwing cp SRC DST
farwing cp --ticket TICKET LOCAL_PATH
| Flag | Meaning |
|---|
--ticket | Transfer ticket from a Farwing Server. |
--ticket-host | Connect somewhere other than the address in the ticket. |
--no-verify | Skip the whole-file BLAKE3 check at the end. |
--fsync | Flush the file to disk before reporting success. |
--no-resume | Start over instead of continuing a partial file. |
--no-retry | Give up after the first failure. |
--retry-max | Tries in all, counting the first one. |
--retry-for | Stop retrying after this long (s/m/h). |
Rate and transport (cp / bench)
| Flag | Default | Meaning |
|---|
-l / --max-rate | 25g | Highest rate (k/m/g suffixes). Required for --policy fixed. |
-m / --min-rate | 0 | Lowest rate for auto / background policies. |
--start-rate | from history | First rate when the transfer starts. |
--policy | auto | auto, fixed, or background. |
--transport | auto | auto (UDP→TCP→SSH), udp, tcp, or ssh. |
--lanes | 4 | Parallel UDP sessions on consecutive ports. |
--streams | 8 | Parallel streams for TCP or SSH carry. |
--port | 47700 | Remote data port (UDP and TCP fallback). |
-q / --quiet | off | No progress line. |
--json | — | Write a summary JSON file. |
--log | — | Rate-control samples (JSON lines every 100 ms). |
SSH options
| Flag | Meaning |
|---|
-P / --ssh-port | SSH port. |
-i / --identity | Private key file. |
-o / --ssh-option | Extra ssh -o option (repeatable). |
--ssh | SSH program (default ssh). |
--remote-path | Path of farwing on the remote host. |
--udp-host | Data host/address if it differs from the SSH host. |
--connect | Lab mode: connect to farwing listen at IP:PORT. |
--key-file | Lab mode shared key (see farwing keygen). |
Examples
farwing cp big.iso user@host:/data/
farwing cp user@host:/data/big.iso .
farwing cp --ticket "$TICKET" ./payload.bin
farwing bench user@host --size 5G
farwing daemon --port 47700