@statezero/statezero-tunnel
Version:
Tunnelmole client for StateZero users to create secure tunnels to their local services.
75 lines (47 loc) • 2.14 kB
Markdown
# StateZero Tunnel Client
[](https://github.com/statezero/statezero-tunnel "Go to GitHub repo")
[](https://github.com/statezero/statezero-tunnel)
[](https://github.com/statezero/statezero-tunnel)
A **fork** of [Tunnelmole](https://github.com/robbie-cahill/tunnelmole-client) that provides a simple, project-based CLI tool for creating persistent tunnels to local HTTP(s) servers via subdomains under `tunnels.statezero.dev`. Designed exclusively for use in development workflows with web-only AI code editors like Bolt.new and a local Django backend.
## 🚀 Key Features
* **Persistent subdomains**: Stable `<subdomain>.tunnels.statezero.dev` URLs for each project.
* **Interactive CLI**: Create and select projects directly from your terminal.
* **Lightweight**: Focused on tunneling; no advanced programmatic APIs or self-hosting options.
## 📦 Installation
Requires **Node.js 16.10+**.
**Recommended: Use npx (no installation required)**
```bash
npx @statezero/statezero-tunnel
```
*Project data is automatically saved to your user config directory and persists between runs.*
**Alternative: Install globally**
```bash
npm install -g @statezero/statezero-tunnel
```
## 🛠️ CLI Usage
**List or create projects**
```bash
npx @statezero/statezero-tunnel
```
**Start a tunnel**
```bash
npx @statezero/statezero-tunnel <port>
```
* Example:
```bash
npx @statezero/statezero-tunnel 8000
```
**Sample output:**
```
🚀 Starting tunnel...
🌐 Subdomain: myapp-1a2b3c.tunnels.statezero.dev
Public URL:
https://myapp-1a2b3c.tunnels.statezero.dev ⟶ http://localhost:8000
```
Your tunnel URL will remain consistent across runs for that project.
## 📜 License
MIT © StateZero Inc.