Major rewrite, automatic path, smaller binary

This commit is contained in:
Caileb 2025-06-19 10:38:25 -05:00
parent af221bedf7
commit 1e3bd82ae7
4 changed files with 414 additions and 586 deletions

View file

@ -6,7 +6,7 @@ A zero-configuration Rust CLI for instantly serving any local directory over HTT
- Zero-configuration: serve the current directory immediately with sensible defaults
- Flexible options to override directory, port, and bind address
- Graceful shutdown on Ctrl+C
- Tiny release binary (<1MB)
- Tiny release binary (~650KB)
## About
`quickstart` takes any local directory and serves it over HTTP ***instantly***, letting you:
@ -36,7 +36,9 @@ By default, this installs to:
- **Windows**: `$env:USERPROFILE\.quickstart\bin` (same as double-click)
### Add to PATH
Ensure your local bin directory is in your PATH:
`quickstart` automatically attempts to add itself to your PATH on first run. If this succeeds, you'll see a confirmation message. **You may need to restart your terminal/IDE** for PATH changes to take effect.
If automatic setup fails, manually ensure your local bin directory is in your PATH:
**Windows (PowerShell)**
```powershell
@ -48,19 +50,22 @@ $env:Path += ";$env:USERPROFILE\.quickstart\bin"
export PATH="$HOME/.quickstart/bin:$PATH"
```
After updating, restart your terminal.
## Usage
```bash
quickstart [OPTIONS]
```
## Examples
Serve the current directory on port 8080:
Serve the current directory on localhost port 8080:
```bash
quickstart
# Serving C:\Users\Caileb\Downloads at http://127.0.0.1:8080
```
Serve the `public` directory on port 3000:
```bash
quickstart -d public -p 3000
```
Serve on all network interfaces (for LAN sharing):
```bash
quickstart -b 0.0.0.0 -p 8080
```