localsend/localsend

Homepage • Discord • GitHub • Codeberg

English (Default) • 中文

LocalSend is 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.

• About
• Sponsors
• Screenshots
• Download
• How It Works
• Dependency Hierarchy
• Getting Started
• Command Line Interface
• Contributing
  • Translation
  • Bug Fixes and Improvements
• Troubleshooting
• Building
  • Android
  • iOS
  • macOS
  • Windows
  • Linux

LocalSend is a cross-platform app that enables secure communication between devices using a REST API and HTTPS encryption. Unlike other messaging apps that rely on external servers, LocalSend doesn't require an internet connection or third-party servers, making it a fast and reliable solution for local communication.

This project is tested with BrowserStack

Supported by TestMu AI

It is recommended to download the app either from an app store or from a package manager because the app does not have an auto-update.

Read more about distribution channels.

Windows binaries are signed. Read more about the Code signing policy.

Compatibility

In most cases, LocalSend should work out of the box. However, if you are having trouble sending or receiving files, you may need to configure your firewall to allow LocalSend to communicate over your local network.

On Linux, for example with ufw: sudo ufw allow 53317. With firewalld: sudo firewall-cmd --permanent --add-port=53317/tcp, sudo firewall-cmd --permanent --add-port=53317/udp, then sudo firewall-cmd --reload.

Also make sure to disable AP isolation on your router. It should be usually disabled by default but some routers may have it enabled (especially guest networks). See troubleshooting for more information.

Portable Mode

(Introduced in v1.13.0)

Create a file named settings.json located in the same directory as the executable. This file can be empty. The app will use this file to store settings instead of the default location.

Start hidden

(Updated in v1.15.0)

To start the app hidden (only in tray), use the --hidden flag (example: localsend_app.exe --hidden).

On v1.14.0 and earlier, the app starts hidden if autostart flag is set, and the hidden setting is enabled.

LocalSend uses a secure communication protocol that allows devices to communicate with each other using a REST API. All data is sent securely over HTTPS, and the TLS/SSL certificate is generated on the fly on each device, ensuring maximum security.

For more information on the LocalSend Protocol, see the documentation.

To compile LocalSend from the source code, follow these steps:

1. Install Flutter directly or using fvm (see version required)
2. Install Rust
3. Clone the LocalSend repository
4. Run cd app to enter the app directory
5. Run flutter pub get to download dependencies
6. Run flutter run to start the app

The LocalSend CLI is a terminal client built on LocalSend Protocol v2. Run localsend-cli --help to see every available option and hotkey.

Use the send command with one or more files, directories, or a mixture of both:

localsend-cli send report.pdf photo.jpg ./project-backup

The command opens the discovered-device list; select the destination interactively and press Enter to start the transfer.

To select the destination without an interactive device list, pass its exact alias or IP address:

localsend-cli send --to "Cute Tomato" report.pdf
localsend-cli send --to 192.168.27.26 report.pdf

An alias must uniquely identify a discovered device. An IP address is probed directly over HTTPS on LocalSend's default port (53317).

To send a text message instead of files, use --text together with --to. Pass - to read the text from stdin:

localsend-cli send --to "Cute Tomato" --text "https://localsend.org"
echo "Hello" | localsend-cli send --to "Cute Tomato" --text -

A single trailing line break is dropped from stdin. Text longer than 64 KB is sent as a .txt file instead. Stdin must be UTF-8 and at most 16 MB; send other data as a file.

Directories are collected recursively. Their selected root names and nested paths are preserved on the receiver. Empty directories are not sent because LocalSend transfers file entries rather than directory entries.

We welcome contributions from anyone interested in helping improve LocalSend. If you'd like to contribute, there are a few ways to get involved:

You can help translate LocalSend into other languages. We use the Weblate platform to manage translations.

Alternatively, you can also contribute by forking this repository and adding translations manually.

The translations are located in the app/assets/i18n directory. Edit the _missing_translations_<locale>.json or strings_<locale>.i18n.json file to add or update translations.

Take note: Fields decorated with @ are not meant to be translated; they are not used in the app in any way, being merely informative text about the file or to give context to the translator.

• Bug Fixes: If you find a bug, please create a pull request with a clear description of the issue and how to fix it.
• Improvements: Have an idea for how to improve LocalSend? Please create an issue first to discuss why the improvement is needed.

For more information, see the contributing guide.

These commands are intended for maintainers only. Make sure to run them from the app directory.

Traditional APK

flutter build apk

AppBundle for Google Play

flutter build appbundle

flutter build ipa

flutter build macos

Traditional

flutter build windows

Local MSIX App

flutter pub run msix:create

Store ready

flutter pub run msix:create --store

Traditional

flutter build linux

AppImage

appimage-builder --recipe AppImageBuilder.yml

Snap

Instructions in localsend/snap/README.md