webserve 1.3.0

A lightweight web server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

<div align="center">

# webserve

**Static file server for local development** — SPA fallback, optional live reload, configurable host and port.

[Rust](https://www.rust-lang.org/) · [Actix Web](https://actix.rs/) · [Tokio](https://tokio.rs/)

[![GitHub stars](https://img.shields.io/github/stars/marcuwynu23/webserve?style=flat&logo=github)](https://github.com/marcuwynu23/webserve/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/marcuwynu23/webserve?style=flat&logo=github)](https://github.com/marcuwynu23/webserve/network/members)
[![GitHub issues](https://img.shields.io/github/issues/marcuwynu23/webserve?style=flat&logo=github)](https://github.com/marcuwynu23/webserve/issues)
[![License](https://img.shields.io/github/license/marcuwynu23/webserve?style=flat)](LICENSE)
[![Crates.io](https://img.shields.io/crates/v/webserve.svg)](https://crates.io/crates/webserve)

[**Repository**](https://github.com/marcuwynu23/webserve) · [**Issues**](https://github.com/marcuwynu23/webserve/issues) · [**Pull requests**](https://github.com/marcuwynu23/webserve/pulls)

</div>

---

## Features

| Capability | Description |
|------------|-------------|
| Static hosting | Serve any folder; directory listing when no `index.html` is present |
| Directory listing UI | Full-width layout, breadcrumbs, folders first then files; name, size, modified; light/dark theme with icon toggle (persisted) |
| SPA mode | `--spa` — unknown paths serve `index.html` (client-side routing) |
| Live reload | `--watch` — filesystem watcher + injected reload script for HTML |
| Open browser | `--open` — after bind, open default browser (uses `127.0.0.1` when host is `0.0.0.0`) |
| URL normalization | Collapses `//` and `.` segments; directory URLs get a trailing `/` redirect (disable with `--no-redirect-dir-slash`) |
| Binding | Configurable `--host` and `--port` (defaults: `127.0.0.1`, `8080`); if port is in use, tries next port until one is free |

---

## Requirements

- **Rust** (stable), e.g. via [rustup](https://rustup.rs/)

---

## Installation

**From a clone**

```bash
git clone https://github.com/marcuwynu23/webserve.git
cd webserve
cargo build --release
```

Binary: `target/release/webserve` (or `webserve.exe` on Windows).

**Install into Cargo bin path**

```bash
cargo install --path .
```

**Install from registry***

```bash
cargo install webserve
```

---

## Usage

```bash
webserve [OPTIONS]
```

Run `webserve --help` for the full option list.

### Options

| Option | Short | Description | Default |
|--------|-------|-------------|---------|
| `--dir` | `-d` | Root directory to serve | Current working directory |
| `--port` | `-p` | TCP port | `8080` |
| `--host` | `-h` | Bind address | `127.0.0.1` |
| `--spa` | — | SPA fallback to `index.html` | off |
| `--watch` | `-w` | Watch files and reload browsers | off |
| `--open` | — | Open default browser to server URL | off |
| `--no-redirect-dir-slash` | — | Don’t redirect `/dir` → `/dir/` | off (redirect on) |

### Examples

Serve the current directory:

```bash
webserve
```

Serve a production build with SPA and reload (typical for Vite/React/Vue `dist`):

```bash
webserve --dir ./dist --spa --watch
```

Open the site in the browser after start:

```bash
webserve --open --port 8080
```

Listen on all interfaces (e.g. phone on same LAN):

```bash
webserve --host 0.0.0.0 --port 3000 --dir ./public
```

---

## Development

```bash
cargo build
cargo test
```

**Git hooks (tag + version check):** use the repo’s hooks directory (native `core.hooksPath`):

```bash
git config core.hooksPath .githooks
```

Hooks are **off by default** so `git push` isn’t delayed. Optional tag check: `WEBSERVE_HOOK_VERSION_CHECK=1 git push origin v1.2.1` — see [`.githooks/README.md`](.githooks/README.md).

---

## License

MIT © [Mark Wayne Menorca](mailto:marcuwynu23@gmail.com)