# tty-web
Web-based terminal emulator. Opens a real PTY in the browser over WebSocket.
## Features
- Real PTY with full job control, signals, and terminal capabilities
- Persistent sessions — reconnect without losing state
- Scrollback replay (configurable, 256 KiB default)
- Session sharing — multiple clients on one session
- View mode — read-only observers with automatic window size sync
- Lightweight binary WebSocket protocol
- Single static binary (frontend embedded via `rust-embed`)
- Multi-arch Docker images (`amd64` / `arm64`) — minimal scratch and playground variants
## Quick start
```bash
tty-web --address 127.0.0.1 --port 9090 --shell /bin/zsh
```
Or with Docker:
```bash
docker run --rm -p 9090:9090 ghcr.io/alviner/tty-web:playground
```
The default `latest` tag is a minimal scratch image for `COPY --from`:
```dockerfile
COPY --from=ghcr.io/alviner/tty-web:latest /tty-web /usr/local/bin/tty-web
```
## Documentation
Full documentation is available at **[alviner.github.io/tty-web](https://alviner.github.io/tty-web)**.
## Build
```bash
make build # debug
make release # release
make docker # docker playground image
```
### Local Docker build (macOS)
Building Docker images on macOS requires cross-compilation to Linux.
Install [zig](https://ziglang.org/) and [cargo-zigbuild](https://github.com/rust-cross/cargo-zigbuild):
```bash
brew install zig
cargo install cargo-zigbuild
rustup target add aarch64-unknown-linux-musl # Apple Silicon
rustup target add x86_64-unknown-linux-musl # Intel
```
Then `make docker` will cross-compile and build the image automatically.
## License
[MIT](LICENSE)