Skip to main content
The floe CLI connects to https://api.floe.one by default. You can point it at any Floe signaling server using the --server flag.

​
Usage

Both sender and receiver must use the same server: 
floe send photo.jpg --server https://api.your-domain.com
floe receive olive-tiger-castle --server https://api.your-domain.com
The --server value must be the URL of the signaling server, not the web client.

​
Separating the web client URL

When using --server, the browser link printed by floe send defaults to the same origin as the server. If your web client is hosted at a different URL, override it with --web: 
floe send photo.jpg --server https://api.your-domain.com --web https://app.your-domain.com
This is common when the client and server run on separate subdomains.

​
Local testing

To test against a local instance running on the default ports: 
# Terminal 1 - sender
floe send photo.jpg --server http://localhost:3001

# Terminal 2 - receiver
floe receive olive-tiger-castle --server http://localhost:3001
The browser link will point to http://localhost:3000 automatically when using localhost:3001. See Self-Hosting for instructions on running your own Floe instance.