Flags Reference

Global flags

Available on all commands (send, receive, version).

Flag	Default	Description
`--server <url>`	`https://api.floe.one`	Signaling server URL. Use `http://localhost:3001` for local testing or your self-hosted server URL.
`--no-relay`	`false`	Disable the TURN relay. Only direct (STUN) connections are attempted. The transfer fails if a direct path cannot be established. Useful for ensuring files never pass through a relay.
`--web <url>`	(auto-detected)	Web app URL included in the browser link printed by `floe send`. Auto-detected from `--server`: the production server defaults to `https://floe.one`, and `localhost:3001` defaults to `http://localhost:3000`.

Specific to the receive command.

Flag	Short	Default	Description
`--output <dir>`	`-o`	`.`	Directory to save received files. Created automatically if it does not exist.
`--yes`	`-y`	`false`	Accept incoming files without the confirmation prompt.

Use a local dev server for both sender and receiver:

floe send photo.jpg --server http://localhost:3001
floe receive olive-tiger-castle --server http://localhost:3001

Disable relay fallback (direct connections only):

floe send photo.jpg --no-relay

Point the browser link at a custom web client:

floe send photo.jpg --server https://api.example.com --web https://app.example.com

Save received files to a specific folder and auto-accept:

floe receive olive-tiger-castle -o ~/Downloads -y

See Against a Self-Hosted Server for more server configuration examples.