ShareLive SDK

Command-line tool to expose localhost to the internet via secure tunnels.

Requirements

• Node.js 20 or newer
• npm account with publish access

📦 Installation

# Global installation (after publishing to npm)
npm install -g sharelive

# Or use locally
npm link

🚀 Usage

Authentication

# Login to your account
sharelive login

# Logout
sharelive logout

Create Tunnels

# Basic usage (default port 3000)
sharelive

# Specify port
sharelive --port 8080
sharelive -p 8080

# Custom subdomain
sharelive --name myapp
sharelive -n myapp -p 3000

# Verbose logging
sharelive --verbose
sharelive -v

# All options combined
sharelive -p 3000 -n myapp -v

Help

# Show all commands
sharelive --help

# Show version
sharelive --version

⚙️ Configuration

Config stored in ~/.sharelive/config.json:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "email": "[email protected]",
  "serverUrl": "https://tunnel.sharelive.site"
}

🔐 Authentication

Login before creating tunnels:

sharelive login
# Enter your email and password
# Token saved securely (permissions: 0o600)

sharelive -p 3000
# Creates authenticated tunnel
# Shows: 🔐 Authenticated tunnel for [email protected]

📝 Environment Variables

# Optional: override server URL
export SHARELIVE_URL=https://tunnel.sharelive.site

🛠️ Development

# Install dependencies
npm install

# Build TypeScript
npm run build

# Link for local testing
npm link

# Test
sharelive --help

🚀 Publish to npm

# 1. Build the package
npm run build

# 2. Verify what will be published
NPM_CONFIG_CACHE=/tmp/sharelive-npm-cache npm pack --dry-run

# 3. Login to npm
npm login

# 4. Publish
npm publish

If the sharelive package name is already taken on npm, change the package name in package.json to a scoped name such as @your-scope/sharelive and publish again with:

npm publish --access public

🔌 How It Works

1. Connect: SDK opens WebSocket to server
2. Authenticate (optional): Sends JWT token
3. Register: Gets unique subdomain (e.g., abc123.sharelive.site)
4. Forward: Proxies requests from public URL to localhost
5. Respond: Sends localhost response back to browser

🎯 Features

• ✅ Unlimited tunnel time
• ✅ Custom subdomains
• ✅ Request logging
• ✅ Authentication support
• ✅ Works even if port offline
• ✅ Beautiful error pages

📚 Documentation

• Architecture
• Complete Implementation
• Deployment Guide