miniserve CLI
miniserve is an HTTP file server with browser directory listings and optional uploads into selected folders.
- 8,096 ★ on the repository
- Last commit
- MIT
Extended access
Why this level
- The server exposes selected files over the network and can accept writes when uploads are enabled.
Install
Manual install
chmod +x miniserve-linux
./miniserve-linuxFirst README method: download miniserve-linux from Releases first. These commands make it executable and start the server in the current directory.
Access and checks
How we reviewExtended accessThe tool runs code or makes network calls and only reads external data.
- The server exposes selected files over the network and can accept writes when uploads are enabled.
This is third-party code. Review the repository files before installing.
What it does
miniserve is a file-sharing CLI that starts an HTTP server for a selected file or directory. A browser shows its listing or a chosen index page. SPA mode routes unknown paths to the client-side application. Optional settings add authentication, TLS and uploads. An agent can prepare temporary build previews or file sharing with an explicit directory and listening address. The server remains a process to stop afterward.
Who it is for. Prototype developers temporarily previewing a static build or sharing a selected folder over a network.
Good fit when
- You are opening a completed HTML build in a browser over HTTP.
- A colleague downloads one large file from a temporarily shared folder.
- While testing an SPA, you navigate to nested routes.
- Participants upload files from browsers into an agreed, authenticated folder.
Not a fit when
- You need a permanent multi-user document platform.
- The selected folder contains secrets visitors must not access.
- You need application backend code or database queries executed.
Example request
Prepare a loopback-only preview of this static build with uploads disabled. Show the URL and how to stop it.Limitations
Without an explicit bind address, miniserve attempts to listen on all interfaces; use loopback for local previews. Authentication and TLS are separate options, and a random route does not replace access control. Uploads permit writes to selected directories and need suitable temporary-file storage. Symlinks may point beyond the expected folder, so disable following them when they are unnecessary for the share.
How to disable. Stop miniserve to end HTTP access. Uploaded files remain in the selected directories; retain or remove them separately.
FAQ
How do I run the downloaded Linux binary?
Run `chmod +x miniserve-linux`, then `./miniserve-linux`. Check the current directory first because the server will serve its contents.
Can I serve one file?
Yes. Pass a file path instead of a directory. The server address will serve that file.
How do I use an index page?
Set `--index` to the filename. Add the documented `--spa` mode for a client-side SPA.
Can I use HTTPS?
Yes. `--tls-cert` and `--tls-key` take the certificate and key paths. After startup, open the HTTPS address in a browser and verify its certificate chain.
Does the binary need extra dependencies?
Release binaries are self-contained. Cargo builds require Rust and are a separate installation method.
Discussion
No questions or reviews yet.
Related
CLI toolsThe command-line client of the Plik file-sharing service with a built-in MCP server for uploads from an agent editor
1C AI sandbox client-server
1c-ai-sandbox-client-server
A devcontainer plus a Hyper-V VM with a 1C server that isolate an AI agent from the host machine so a wrong command cannot touch real files or drives
Nehemiah gives agents Firecracker Linux microVMs over MCP: launch, run commands, preview URLs, fork and templates.
aeroftp-cli handles FTP, SFTP, S3 and WebDAV through vault profiles so the agent never sees passwords, and its MCP mode opens 78 tools
A WebSSH console for VPS with an MCP server: the agent works across several servers while ACL tokens limit tools and hosts.
A Go CLI that compares a server with its last snapshot, reports only changes that matter and serves them to an agent via MCP
README in short
File listings support name filtering and directory archive downloads. A minimal HTML renderer serves terminal browsers.