KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #ai-agents #dsh-plugin #codex #developer-tools #claude-code #windows #cli #desktop-app #typescript #rust #ai-agent

workslocal

★ 14 Open GitHub ↗

Free, open-source localhost tunneling with catch mode and web inspector. ngrok alternative.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center" style="color: #22d3ee">WorksLocal</h1>
<p align="center">
  <em>Free, open-source localhost tunneling. It works on my local.</em>
</p>

## Quick Start

```bash
npx workslocal http 3000
```

That's it. Your localhost:3000 is now live at `https://xyz.workslocal.exposed`.

## Install

```bash
npm install -g workslocal
```

## Features

### Tunnel any local server
```bash
workslocal http 3000
# ✔ Tunnel is live!
# Public URL: https://myapp.workslocal.exposed
# Inspector:  http://localhost:4040
```

### Catch webhooks without code
```bash
workslocal catch --name stripe
# Paste URL in Stripe dashboard
# All payloads appear in your terminal + inspector
```

### Inspect every request
Open `localhost:4040` — dark/light theme, JSON formatting, copy as cURL, filters.

[screenshot of inspector here]

### Persistent subdomains (free)
```bash
workslocal login          # One-time GitHub auth
workslocal http 3000 --name myapp
# https://myapp.workslocal.exposed — same URL every time
```

### WebSocket passthrough
Socket.io, ws, WebRTC signaling — all work through the tunnel.

## Why WorksLocal?

|  | WorksLocal | ngrok (free) | Cloudflare Tunnel |
|--|-----------|-------------|-------------------|
| **Install** | `npm i -g workslocal` | Download binary + sign up | Install cloudflared + add domain + config |
| **Cost** | Free, no limits | Free — 1 GB/month, 20K requests | Free |
| **Account needed?** | No | Yes | Yes (except quick tunnels) |
| **Custom subdomains** | Free, you pick | Paid only | Bring your own domain |
| **Catch mode** | Yes | — | — |
| **Request inspector** | Yes | yes | — |
| **Open source** | MIT | No | Client only |
| **Interstitial page** | None | Shows warning on free | None |
| **WebSocket** | Yes | Yes | Yes |

> **Honest note:** ngrok's inspector has request replay with modifications — we don't (yet).
> Cloudflare Tunnel offers quick tunnels (`cloudflared tunnel --url`) with no account needed,
> but URLs are random and ephemeral with a 200 concurrent request limit.

## Commands

| Command | Description |
|---------|-------------|
| `workslocal http <port>` | Tunnel localhost to a public URL |
| `workslocal catch` | Capture webhooks (no local server needed) |
| `workslocal login` | Authenticate with GitHub |
| `workslocal logout` | Sign out |
| `workslocal whoami` | Show current user |
| `workslocal list` | List persistent subdomains |

## Options

```
workslocal http <port> [options]
  -n, --name <subdomain>   Custom subdomain
  -d, --domain <domain>    Tunnel domain (default: workslocal.exposed)
  --server <url>           Custom relay server URL
  -v, --verbose            Verbose logging

workslocal catch [options]
  -n, --name <subdomain>   Custom subdomain
  -s, --status <code>      Response status code (default: 200)
  -b, --body <json>        Response body (default: {"ok":true})
```

## How It Works

```
Your machine                  Cloudflare Edge              Internet
┌───────────┐    WebSocket   ┌───────────┐    HTTPS     ┌──────────┐
│ localhost │◄──────────────►│  Worker   │◄────────────►│ Browser  │
│   :3000   │                │ + Durable │              │  / curl  │
│           │                │  Object   │              │          │
└───────────┘                └───────────┘              └──────────┘
     CLI                       $0/month                  Public URL
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

MIT — see [LICENSE](LICENSE).

workslocal

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README