📖 Table of Contents

• About
• Features
• Installation
• Quick Start
• Usage Guide
• All Commands
• Interactive Mode
• Web Interface
• Settings
• Examples
• Tech Stack
• Project Structure
• Troubleshooting
• Version History
• Developer
• License

📦 About

CodeSun Beam is a powerful, lightweight CLI tool for sharing files instantly over WiFi. No cables, no cloud uploads, no app installations — just open your terminal, select files, and share via QR code or link.

Built with Node.js, it creates a local HTTP server with optional Cloudflare Tunnel for public access. Perfect for quick file transfers between phone, laptop, tablet, or any device with a browser.

Why CodeSun Beam?

• ⚡ Instant — Share files in under 10 seconds
• 📱 No App Needed — Receiver only needs a browser
• 🔒 Secure — Optional token-based access
• 🌍 Public Access — Cloudflare Tunnel for remote sharing
• 🎨 Beautiful UI — Golden-themed web interface
• 🆓 Free & Open Source — MIT License

✨ Features

Core Sharing

| Feature | Description | |---------|-------------| | 📤 File Sharing | Share single or multiple files | | 📦 ZIP Bundle | Multiple files auto-bundled as ZIP | | 📁 Folder ZIP | Compress folders to ZIP before sharing | | 📱 QR Code | Scan QR code to download instantly | | 🌍 Cloudflare Tunnel | Get public URL accessible from anywhere | | ⏰ Auto Expire | Server auto-stops after configurable time | | 🔒 Secure Mode | Token-based access protection | | 📺 Video Streaming | Stream videos with seek support | | 👁️ File Preview | Preview images, text, code, PDFs in browser | | 📊 Live Stats | Real-time download count and uptime |

CLI Experience

| Feature | Description | |---------|-------------| | 🎨 Colored UI | Clean terminal with yellow, green, cyan colors | | 📋 30+ Commands | Full control over every aspect | | 🔄 Interactive Mode | Easy file selection with number keys | | 💾 Persistent Settings | Settings remembered across sessions | | ⌨️ Shortcuts | .. for parent, ~ for home, etc. |

Web Interface

| Feature | Description | |---------|-------------| | 🖼️ Brand Poster | Animated poster with golden glow | | 📋 Copy Button | One-click copy install command | | 📊 Stats Cards | Files, size, downloads at a glance | | 📁 File Cards | Each file with download button | | 👣 Footer | Developer info + links | | 📱 Responsive | Works on mobile, tablet, desktop |

📥 Installation

Prerequisites

• Node.js >= 16.0.0
• npm >= 7.0.0

Install Globally

npm install -g codesunbeam@latest