port-key VS Code Extension

Share your local development server with the world using custom subdomains!

Features

• 🚀 Instant Setup: Configure your API key and start sharing ports in seconds
• 🌐 Auto-generated Subdomains: Secure, unique subdomains for every tunnel
• 🔌 Multi-Port Support: Share multiple local ports simultaneously
• 📊 Real-time Status: See your active tunnel URLs in the status bar and sidebar
• 🔒 Secure: Uses WebSocket connections with API key authentication
• 📈 Analytics: Track requests and bandwidth in the web dashboard

Installation

1. Install the extension from the VS Code marketplace
2. Get your API key from port-key
3. Run the command: port-key: Configure API Key
4. Paste your API key

Usage

Start a Tunnel

1. Open Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
2. Run: port-key: Start Tunnel
3. Enter the local port to share (e.g., 3000)
4. Your app is now live at a custom subdomain!

Stop a Tunnel

• Run: port-key: Stop Tunnel
• Select the tunnel you want to stop from the list
• Or use the "Stop" button in the port-key sidebar

Status Bar & Sidebar

The status bar shows the number of active tunnels. Click it to open the sidebar. The sidebar allows you to:

• View all active tunnels
• Copy tunnel URLs
• Stop specific tunnels
• Quickly start new tunnels

Commands

• port-key: Configure API Key - Set up your API key
• port-key: Start Tunnel - Start sharing a local port
• port-key: Stop Tunnel - Stop the active tunnel
• port-key: Open Dashboard - View analytics and manage API keys

Configuration

Settings

• port-key.apiKey - Your port-key API key
• port-key.dashboardUrl - Dashboard URL (default: https://port-key.dev)

Requirements

• Active port-key account
• Valid API key from the dashboard
• Access to the port-key server

Support

For issues and feature requests, please visit our port-key.

License

MIT