instatunnel/README.md

Expose your localhost to the internet instantly - the ngrok alternative that's 40% cheaper with superior UX

# InstaTunnel

InstaTunnel is a fast, reliable, and developer-friendly tunneling service that makes your localhost accessible from anywhere on the internet. Built as the **professional ngrok alternative** that's **40% cheaper** with a more generous free tier.

## 🚀 Features

- **🎯 Zero Configuration**: Just run `instatunnel` or `it` - auto-detects your running app
- **⚡ Lightning Fast**: Tunnel setup in under 2 seconds
- **🔗 Custom Subdomains**: Get memorable URLs like `myapp.instatunnel.my` (free!)
- **🔄 Multiple Tunnels**: Run 3 simultaneous tunnels on free tier
- **📊 Built-in Analytics**: Real-time request tracking and visitor stats
- **⏰ Extended Sessions**: 24+ hour sessions (vs 2 hours on ngrok free)
- **🔒 Security Features**: Password protection, basic auth, HTTPS by default
- **📱 Mobile Testing**: Built-in QR code generation
- **🏢 Custom Domains**: Use your own domain (Pro tier)
- **👥 Team Features**: Share tunnels with your team

## ⚡ Quick Start

### Install CLI
```bash
# Install globally via NPM (recommended)
npm install -g instatunnel

# Verify installation
instatunnel --version
```

### Start Tunneling (Zero Config!)
```bash
# Auto-detect and expose your app instantly (easiest!)
instatunnel
# 🔍 Auto-detected service on port 3000
# ✅ Tunnel created: https://abc123.instatunnel.my

# Ultra-short alias (even faster)
it
# 🔍 Auto-detected service on port 3000
# ✅ Tunnel created: https://def456.instatunnel.my

# Specify port manually if needed
instatunnel 3000

# Use custom subdomain (free tier!)
instatunnel 3000 --subdomain myapp
# ✅ Tunnel created: https://myapp.instatunnel.my
```

### Advanced Features
```bash
# Password protect your tunnel
instatunnel 3000 --password secret123

# Generate QR code for mobile testing
instatunnel 3000 --qr

# Multiple tunnels simultaneously
instatunnel 3000 --subdomain frontend &
instatunnel 8000 --subdomain api &

# Framework-specific shortcuts
instatunnel --react    # Auto-detects React dev server
instatunnel --next     # Auto-detects Next.js
instatunnel --laravel  # Auto-detects Laravel
```

## 📋 Common Usage Patterns

```bash
# Frontend Development
instatunnel --react     # Auto-detect React (port 3000)
instatunnel --next      # Auto-detect Next.js (port 3000)
instatunnel 5173        # Vite dev server

# API Development  
instatunnel --laravel   # Auto-detect Laravel (port 8000)
instatunnel 8000        # Express/Node.js API
instatunnel 4000        # Custom API port

# Full-Stack Development
instatunnel 3000 -s frontend
instatunnel 8000 -s api
instatunnel 5432 -s database

# Quick Sharing & Mobile Testing
it                      # Auto-detect and share instantly
instatunnel --qr        # Auto-detect with QR code for mobile
instatunnel -s demo     # Auto-detect with memorable name
```

## 🛠 Management Commands

```bash
# List active tunnels
instatunnel --list

# Stop specific tunnel
instatunnel --kill myapp

# View live request logs
instatunnel --logs

# Check usage statistics
instatunnel --stats

# Generate sharing templates
instatunnel --share

# Get help
instatunnel --help
```

## 💰 Pricing & Plans

### Free Tier (Perfect for Development)
- ✅ 3 simultaneous tunnels
- ✅ 24+ hour sessions 
- ✅ Custom subdomains
- ✅ Basic analytics
- ✅ Password protection
- ✅ QR code generation

### Pro Tier ($5/month) - 40% cheaper than ngrok Pro
- ✅ Unlimited tunnels
- ✅ Custom domains
- ✅ Advanced analytics
- ✅ Team collaboration
- ✅ Priority support

[View full pricing →](https://instatunnel.my/pricing)

## 🏗 Why InstaTunnel vs ngrok?

| Feature | InstaTunnel Free | ngrok Free | InstaTunnel Pro | ngrok Pro |
|---------|------------------|------------|-----------------|-----------|
| **Price** | Free | Free | **$5/month** | $8/month |
| **Sessions** | **24+ hours** | 2 hours | Unlimited | Unlimited |
| **Tunnels** | **3 simultaneous** | 1 | Unlimited | Unlimited |
| **Subdomains** | ✅ **Custom** | ❌ Random only | ✅ Custom | ✅ Custom |
| **Setup Time** | **< 30 seconds** | ~1 minute | **< 30 seconds** | ~1 minute |

## 🌐 Links

- **Website**: [instatunnel.my](https://instatunnel.my)
- **Dashboard**: [dashboard.instatunnel.my](https://dashboard.instatunnel.my)
- **Documentation**: [instatunnel.my/docs](https://instatunnel.my/docs)
- **Status Page**: [status.instatunnel.my](https://status.instatunnel.my)

## 🚀 Get Started Now

```bash
npm install -g instatunnel
instatunnel
```

That's it! Your local app is now live on the internet. 🎉

---

Made with ❤️ for developers worldwide. [Start your free account →](https://dashboard.instatunnel.my)