Skip to main content

CLI File transfer tool over local network

Project description

๐Ÿš€ ByteBeam

ByteBeam is a lightweight, blazing-fast CLI tool for transferring files over a local network. Whether you're on the same Wi-Fi or LAN, ByteBeam lets you send and receive files securely, without needing the internet or third-party tools.


๐Ÿ”ง Features

  • โšก Fast local transfers โ€” no cloud, just pure LAN speed
  • ๐Ÿ” Secure token-based access control
  • ๐Ÿง  Can block unnecessary connections for persistent settings
  • ๐Ÿง Linux-first philosophy, perfect for terminal lovers

๐Ÿ“ฆ Installation

๐Ÿ“ Using .deb (Debian-based distros)

sudo dpkg -i bytebeam_1.0.0-1_amd64.deb
๐Ÿงช From Source

Clone the repo and install dependencies (if any):

git clone https://github.com/yourusername/bytebeam.git
cd bytebeam
python3 -m venv venv
source venv/bin/activate
pip install .

๐Ÿ–ฅ๏ธ Usage
๐Ÿ“ค Sending a file

bytebeam --send file.txt --port 5000 --token 1234

๐Ÿ“ฅ Receiving a file

bytebeam --receive --port 5000 --token 1234

โš™๏ธ Setting configuration

bytebeam-config --default-port 5000 --default-token 1234

๐Ÿ”‘ Command Line Options
Option	Description
--send / -s	Path to file to send
--receive / -r	Receive mode
--host / -H	IP address to bind (default: 0.0.0.0)
--port / -p	Port to listen/send on (required)
--token / -t	Authentication token for secure transfer
๐Ÿ“‚ Configuration

ByteBeam supports persistent settings using a config file. This is managed by the bytebeam-config command. Config values are stored in:

~/.config/bytebeam/config.json

๐Ÿงช Testing

Run the test suite using pytest:

pytest tests/

๐Ÿ“ Project Structure

bytebeam/
โ”œโ”€โ”€ bytebeam/
โ”‚   โ”œโ”€โ”€ cli.py           # CLI entry points
โ”‚   โ”œโ”€โ”€ transfer.py      # Core file transfer logic
โ”‚   โ”œโ”€โ”€ utils.py         # Utility functions
โ”‚   โ””โ”€โ”€ __init__.py
โ”œโ”€โ”€ tests/               # Test cases
โ”‚   โ””โ”€โ”€ ...
โ”œโ”€โ”€ requirements.txt
โ”œโ”€โ”€ README.md
โ””โ”€โ”€ setup.py

๐Ÿ™‹ Author

    Dipanshu Tiwari
    ๐Ÿ“ง dipanshutiwari115@gmail.com

๐Ÿชช License

This project is licensed under the MIT License.
Feel free to use, modify, and distribute.
๐ŸŒ Coming Soon

    GUI interface

    QR Code-based file sharing

    Cross-platform support (Windows/macOS)

Made with ๐Ÿ’ป and โ˜• in Linux.

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

bytebeam-0.1.0.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

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

bytebeam-0.1.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file bytebeam-0.1.0.tar.gz.

File metadata

  • Download URL: bytebeam-0.1.0.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for bytebeam-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6557b0d82afb26695a753b76a25e631ff6cf662deed683df7a85a329b8e1e79e
MD5 1f3a269b7772b3795001694dbd9e2729
BLAKE2b-256 dfce0a102c68c6b463c10c6d10c225516645deb659c0dd53d642c02fd0681386

See more details on using hashes here.

File details

Details for the file bytebeam-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: bytebeam-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for bytebeam-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a215d8d11580c3b52393f9345fe3766dc6768253c1016953c7a5031c452d11a
MD5 9fcef0906180699f8b375fe9c977750a
BLAKE2b-256 7f01c2d626153d76e939a77cac3b6ca1a343a3de0ea9d96a99d5bcc85229423e

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