QuickServeCLI (qserve)

Instant Zero-Conf HTTP Server for your Terminal.

qserve turns any directory into a web server in seconds, with a beautiful CLI authentication, automatic port selection, and optional public tunneling.

Why QuickServeCLI?

Serving files locally usually requires remembering long commands (python -m http.server), dealing with port conflicts, or configuring heavy tools. QuickServeCLI removes friction: one alias (qserve), zero config, and it just works. It handles the details so you can focus on your code.

Features

• ⚡ Instant: Up and running in < 100ms.
• 🔌 Smart Ports: Automatically finds open ports if 8000 is busy.
• 🌍 Public Access: Expose to the world via ngrok with a single flag.
• 📱 QR Code: Generate terminal QR codes for testing on mobile.
• 🎨 Beautiful UI: Minimalist, noise-free, and informative.

Example Output

⚡ QuickServeCLI v1.0.0
────────────────────────────────────────
Serving        : /home/user/projects/website
Local          : http://localhost:8000
Network        : http://192.168.1.15:8000
Public         : https://random-name.ngrok-free.app  <-- (Optional)

ℹ Press Ctrl+C to stop

Installation

Linux / macOS

./scripts/init.sh

Creates a virtual environment, installs dependencies, and adds the qserve alias to your shell profile.

Windows (PowerShell)

./scripts/init.ps1

Sets up the environment and adds a permanent qserve function to your PowerShell profile.

Usage

Serve current directory:

qserve

Serve a specific folder:

qserve ./dist

Specify a port:

qserve --port 8080

(If busy, it will ask to try the next one)

Auto-select available port:

qserve --port auto

Generate QR Code for mobile:

qserve --qr

Expose to the internet (Public + QR):

qserve --public --qr

Public Access (ngrok)

You can use --public to get a real https:// URL accessible from anywhere.

• This requires ngrok to be installed and configured on your system.
• If ngrok is missing, qserve will not crash; it will simply serve locally and inform you.
• Uses your local ngrok agent transparently.

Stopping the Server

Simply press Ctrl+C in your terminal. The server will shut down gracefully, and any active tunnels will be closed.

Design Philosophy

• Fast: No startup lag.
• Zero-config: Sensible defaults for everything.
• No Lock-in: Uses standard HTTP protocols.
• Clean: Output is for humans, not logs.