Skip to content

ravindrayadav26/share-it

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

share-it CLI 🚀

NPM Version

A simple, modern, and beautiful command-line tool to instantly share files and folders among your devices locally.

Features ✨

  • Instant Web UI: Serves a clean, modern web interface to browse, view, download, and upload files.
  • QR Code Access: Automatically generates a QR code in the terminal for instant access from mobile devices.
  • Recursive Navigation: Easily browse through subdirectories.
  • Multi-File Uploads: Upload multiple files at once with a UI progress bar.
  • Efficient Streaming: Handles large file downloads and video/audio streaming efficiently using Node.js streams.
  • Responsive Design: The web UI works great on both desktop and mobile.

Installation 📦

To use share-it on any computer, install it globally using npm (or your favorite package manager):

npm install -g @ryadav26/share-it

Usage 🧑‍💻

The simplest way to use share-it is to navigate to the directory you want to share and run the command.

Serve the current directory on the default port (8520):

cd /path/to/your/files
share-it

Serve a specific directory on a custom port:

share-it /path/to/your/files --port 3000

Once the server is running, open the provided URL in your browser or scan the QR code with your phone.