Skip to main content

LocalSend CLI tool

Project description

LocalSend CLI

A lightweight, modular Python CLI implementation of the LocalSend Protocol (v2). This tool allows you to discover devices, send files, and receive data directly from your terminal, fully compatible with official LocalSend clients.

Features

  • Device Discovery: Scan your local network for active LocalSend instances.
  • File Transfer: Send one or multiple files to any LocalSend-enabled device.
  • Receiver Mode: Start a local server to receive files, folders, or text messages.
  • Self-Signed TLS: Automatic generation of required SSL certificates for secure transfers.

Installation

pip install localsend-cli

Usage

Scan for Devices

Find other LocalSend devices on your network using UDP multicast.

localsend-cli scan

Options:

  • --timeout <seconds>: Duration to listen for responses (default: 5).
  • --json: Output as a stream of JSON objects.
  • --clean: Output only IP addresses.

Send Files

Send files to a specific target IP.

localsend-cli send <device-ip> image.png report.pdf

Options:

  • --port <port>: Target port if different from default (53317). You dont need to change this most of the time.
  • --json: Progress and status in JSON format.

Receive Files

Start a server to wait for incoming transfers.

localsend-cli receive --output ./incoming

Options:

  • --output <dir>: Directory to save received files (default: current directory).
  • --pin <code >: Require a specific PIN from the sender.
  • --json: Event-based JSON output (ready, incoming, saved, etc.).

Credits

Localsend: Website GitHub

Localsend Protocol: https://github.com/localsend/protocol

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

localsend_cli-0.1.1.tar.gz (23.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

localsend_cli-0.1.1-py3-none-any.whl (25.8 kB view details)

Uploaded Python 3

File details

Details for the file localsend_cli-0.1.1.tar.gz.

File metadata

  • Download URL: localsend_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 23.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for localsend_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 37c94ef47aebc30ae26aaea624c3fa4f809e672e66d2d3ea508bd1be2e5d72fc
MD5 44df398fbba2b0e731772580869b6943
BLAKE2b-256 08b2c533c72a2e0ae29cb6ae95e6da463f05b3d83a8ddcdc526ab5de03544e3e

See more details on using hashes here.

File details

Details for the file localsend_cli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: localsend_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 25.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for localsend_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0bd2f9272e9ed0c058a6f1d50248534e2aff72115e52d18fc18dfe4bde99cf6c
MD5 b388c0c702b8d37d4ba50d34019c33de
BLAKE2b-256 69338c8ad2ad7715285e69e28ab39786d10e50a62f76b93e7a58953ca598fef7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page