joecalsend/README.md
2025-08-10 13:35:54 -07:00

3 KiB

JocalSend, a TUI LocalSend implementation

LocalSend is, in its words, "a free, open-source app that allows you to securely share files and messages with nearby devices over your local network without needing an internet connection." It comes in the form a Flutter/Dart cross-platform GUI application that runs on both mobile and desktop devices. Using it on mobile is very nice, but the desktop experience is a bit lacking in zazz.

JocalSend is an implementation of the LocalSend protocol that uses Ratatui to provide an interactive terminal-based application, and is compatible with the official app.

Install with cargo install jocalsend (requires Rust); tested on Linux, it will probably work on Macs but if you're on a Mac, you probably have AirDrop.

Capabilities and screenshots

As with the official app, JocalSend can be used to send and receive files and text from other LocalSend instances on your local subnetwork. Most of the modes have the following keybindings available:

  • M -> go back to the main screen
  • S -> go to the sending screen, defaulting to sending files
  • R -> go to the receiving screen to approve or deny incoming transfers
  • L -> go to the logging screen where you can adjust the log level
  • ESC -> go back to the previous screen
  • Q -> exit the application

Additionally, when in the sending screen, the following are available

  • TAB -> switch between content selection and peer selection
  • P -> switch to peer selection
  • T -> switch to entering text to send
  • F -> switch to selecting files to send (not available when entering text, use ESC to exit text entry)

In addition to the interactive commands, it will also accept commandline arguments to pre-select a file or pre-populate text to send:

$ jocalsend -h
A terminal implementation of the LocalSend protocol

Usage: jocalsend [OPTIONS]

Options:
  -f, --file <FILE>  File to pre-select for sending
  -t, --text <TEXT>  Text string to send
  -h, --help         Print help
  -V, --version      Print version

Sending Files

JocalSend has a file-picking widget for selecting files to send:

![./media/sending_file.png]

but there's no preview available on the receiving side:

![./media/receiving_file_from_jocalsend.png]

Sending text

JocalSend supports entering text directly:

![./media/sending_text.png]

and on the receiving side in the official app, you see

![./media/receiving_text_on_phone.png]

Receiving files

The main screen shows incoming transfer requests:

![./media/main_screen_receiving.png]

hit r to enter the "receiving" screen to approve or deny:

![./media/receiving_file_receiving_screen.png]

Receiving text

If the incoming transfer request is plain text, JocalSend will show a preview in both the main screen and in the receiving screen:

![./media/receiving_text_main_screen.png]

![./media/receiving_text_receive_screen.png]