miniserve: Instantly Serve Files Over HTTP from Your Terminal

TL;DR — Quick Summary

miniserve is a tiny, self-contained HTTP server. Serve any directory over HTTP instantly — with uploads, directory listing, auth, and QR codes — all from one command.

miniserve turns any directory into a web server instantly. One command, no config, beautiful listing.

Installation

# macOS
brew install miniserve

# Arch Linux
sudo pacman -S miniserve

# Cargo
cargo install miniserve

Usage

# Serve current directory
miniserve .
miniserve /path/to/files

# Custom port
miniserve -p 3000 .

# Enable uploads
miniserve --upload-files .
miniserve -u .              # Short flag

# QR code for mobile
miniserve --qrcode .

# Authentication
miniserve --auth user:password .

# Serve a single file
miniserve document.pdf

# Directory listing options
miniserve --title "My Files" .
miniserve --color-scheme monokai .
miniserve --hide-theme-selector .

# HTTPS
miniserve --tls-cert cert.pem --tls-key key.pem .

# Bind to all interfaces (LAN access)
miniserve -i 0.0.0.0 .

# Compress files on the fly
miniserve --compress-response .

# Hide hidden files
miniserve --hidden .

Comparison

Feature	miniserve	python http.server	http-server (Node)	darkhttpd
Uploads	Yes	No	No	No
Auth	Yes	No	No	No
HTTPS	Yes	No	Yes	No
QR code	Yes	No	No	No
Themes	Yes	No	No	No
Speed	Fast	Slow	Medium	Fast

Summary

miniserve serves files via HTTP with zero configuration
File uploads, authentication, HTTPS, QR codes out of the box
Beautiful directory listing with theme support
Single binary, no dependencies — perfect for quick file sharing
Bind to 0.0.0.0 for LAN access, compress responses on the fly

Guide & Instructions

Estimated Time: 2m

Tools Needed:

miniserve
Terminal

Install miniserve

Install with brew install miniserve, pacman -S miniserve, or cargo install miniserve.

Serve current directory

Run miniserve . to serve files on port 8080.

Enable uploads

Run miniserve --upload-files . to allow file uploads.

Show QR code

Run miniserve --qrcode . to display a QR code for easy mobile access.

Add auth

Run miniserve --auth user:pass . for basic authentication.

Frequently Asked Questions

What is miniserve?

miniserve is a zero-config HTTP file server. Run miniserve . in any directory and it's instantly available over HTTP with a beautiful directory listing. Supports file uploads, authentication, TLS, and QR code generation.

How is miniserve different from python -m http.server?

Python's HTTP server is basic. miniserve adds: file uploads, directory listing themes, authentication, TLS/HTTPS, download compression, QR codes for easy mobile access, and much better performance.

Can miniserve accept uploads?

Yes, use miniserve --upload-files . to enable file uploads via the web interface.

Does miniserve support HTTPS?

Yes, use miniserve --tls-cert cert.pem --tls-key key.pem for HTTPS.