🚀 Qshare

A high-performance CLI tool designed for developers to share local files via public links instantly. Qshare combines secure tunneling with a premium in-browser viewing experience, featuring real-time synchronization (Live Reload) and specialized renderers for modern technical documents.

✨ Key Features

• ⚡ Instant Public Links: Zero-configuration Cloudflare Tunnel to share local files/folders globally.
• 🔄 Live Sync (Hot Reload): In-browser view updates instantly as you save changes in your local editor.
• 📊 Technical Renderers:
  • Mermaid.js: Support for 20+ diagram types (Flowcharts, Sequence, Mindmaps, ERD, etc.).
  • Markdown: GitHub-flavored documentation with Table of Contents auto-generation.
  • JSON: Interactive tree-view with collapsible sections.
  • Multimedia: Native support for PDF preview and Image optimization.
• 🔍 Global Search: Fast full-text search across all shared files in folder mode.
• 🌓 Adaptive Theme: Premium Dark/Light mode synchronization based on system or user preference.
• 📂 File Tree Navigation: Explore complex directory structures through a polished sidebar.

📦 Installation

# Install globally via npm
$ npm install -g qshare-cli

# Or run instantly without installation
$ npx qshare-cli <path>

🕹️ Usage Guide

Basic Command

$ qshare <file_or_directory> [options]

Options

| Flag | Long Form | Description | | :--- | :------------- | :------------------------------------------------ | | -p | --port <num> | Explicitly set a local port (defaults to random). | | -h | --help | Display usage instructions. | | -v | --version | Show current version. |

Examples

# Share a markdown document
$ qshare documentation.md


# Share a markdown document with specific port
$ qshare documentation.md --port 8080

# Share an entire project folder
$ qshare ./src/project

# Render a mermaid diagram flowchart
$ qshare architecture.mmd

📁 Supported Extensions

| Type | Extensions | Rendering Engine | | :---------------- | :------------------------------ | :----------------------- | | Diagrams | .mmd, .mermaid | Mermaid.js v11 | | Documentation | .md, .markdown | Marked.js + Shiki | | Data | .json | Custom Interative Tree | | Documents | .pdf | Native Embed | | Images | .png, .jpg, .svg, .webp | Optimized Browser Native |

📝 License

This project is currently UNLICENSED. All rights reserved by the author.

Developed with ❤️ by Nguyen Duc