Development site, not the published docs. This build is 0.8.0-dev.

Getting started

Install, then copy.

Farwing is free for any use, including commercial use. There is no limit on how many copies run at once. Without a license file, copies on one machine share 1 Gbit/s in total, even if --max-rate asks for more. A licensed Farwing Server at the far end sets its own speed. See free limits. Two commands get you a first copy on a machine you can reach with SSH. Prefer a window to a terminal? See Farwing Desktop.

1. Install

Linux and macOS (save, then run with bash — Ubuntu’s sh cannot run this script):

curl -fsSL -o farwing-install.sh https://farwing.io/install.sh
bash ./farwing-install.sh

Windows (PowerShell):

Invoke-WebRequest -UseBasicParsing https://farwing.io/install.ps1 -OutFile farwing-install.ps1
powershell -File .\farwing-install.ps1

Installers and checksums are on farwing.io/download.

2. First copy

One side is a local path; the other is user@host:path. The client starts a short-lived helper on the remote host over SSH, then moves the bytes on the data port (default 47700). 

farwing cp big.iso user@host:/data/

Pull the other way the same way:

farwing cp user@host:/data/big.iso .
Firewall: open UDP/TCP 47700 on the receiving host (or whichever side runs the remote helper). SSH alone is not enough for full speed.

3. Path test (optional)

Memory-to-memory, like iperf3 — useful before you blame the disk: 

farwing bench user@host --size 5G

Ticket copy (Farwing Server)

When a Farwing Server issues a transfer ticket, you do not need SSH to that host. Install the client, then: 

farwing cp --ticket 'TICKET_STRING' .

With an upload ticket for a folder, . sends everything in the current folder, and you can name any files and folders instead. With a download ticket, . saves the file in the current folder. See the CLI reference for the details. Override the host in the ticket with --ticket-host when you reach the server through a tunnel.

Farwing Desktop (no terminal)

Farwing Desktop is the app for people who send and receive files with a Farwing Server and do not want a terminal. When someone clicks Open in Farwing Desktop in the Farwing Server portal, the app opens and runs the transfer in its own window, with pause, resume and a check of every file. The Farwing Server's license sets the speed, so a free Farwing Desktop is never the limit.

  1. Download the installer for Windows, macOS or Linux from farwing.io/download.
  2. Install it: run the .exe on Windows, drag the app from the .dmg into Applications on macOS, or install the .deb (sudo apt install ./farwing-desktop-linux-amd64.deb) or make the AppImage executable (chmod +x) on Linux. The download page lists what to click if Windows or macOS asks before the first start.
  3. Start it once. From then on, Farwing links from the browser open it. The first time, the browser asks whether to open Farwing Desktop: allow it.

If the portal says Farwing Desktop did not open, install it, start it once, and click Try again. The browser download and the farwing cp --ticket command stay available beside it.

Next

Farwing docs · farwing.io