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
Release history Release notifications | RSS feed
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)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6557b0d82afb26695a753b76a25e631ff6cf662deed683df7a85a329b8e1e79e
|
|
| MD5 |
1f3a269b7772b3795001694dbd9e2729
|
|
| BLAKE2b-256 |
dfce0a102c68c6b463c10c6d10c225516645deb659c0dd53d642c02fd0681386
|
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2a215d8d11580c3b52393f9345fe3766dc6768253c1016953c7a5031c452d11a
|
|
| MD5 |
9fcef0906180699f8b375fe9c977750a
|
|
| BLAKE2b-256 |
7f01c2d626153d76e939a77cac3b6ca1a343a3de0ea9d96a99d5bcc85229423e
|