Skip to main content
This command is not implemented in v0.

​
Overview

The status command will display information about active tunnels, including connection status, traffic statistics, and session details. This feature is planned for a future release.

​
Usage

wormkey status

​
Current Behavior

In v0, running this command displays: 
$ wormkey status
Status not implemented in v0.

​
Planned Functionality

In future versions, the status command will show:
  • Active tunnels - List of all running wormholes
  • Connection status - Health and connectivity information
  • Traffic statistics - Request counts, bandwidth usage
  • Session details - Expiry time, authentication status
  • Public URLs - Accessible endpoints

​
Expected Output

$ wormkey status

Active Tunnels:

┌─────────────────────────────────────────────────────┐
│ Tunnel 1                                            │
├─────────────────────────────────────────────────────┤
│ Local Port:    3000                                 │
│ Public URL:    https://abc123.wormkey.run           │
│ Status:        Connected                            │
│ Uptime:        2h 34m                               │
│ Requests:      1,234                                │
│ Auth:          Enabled                              │
│ Expires:       in 21h 26m                           │
└─────────────────────────────────────────────────────┘

┌─────────────────────────────────────────────────────┐
│ Tunnel 2                                            │
├─────────────────────────────────────────────────────┤
│ Local Port:    8080                                 │
│ Public URL:    https://xyz789.wormkey.run           │
│ Status:        Connected                            │
│ Uptime:        45m                                  │
│ Requests:      89                                   │
│ Auth:          Disabled                             │
│ Expires:       in 23h 15m                           │
└─────────────────────────────────────────────────────┘

Total active tunnels: 2

​
Planned Options

​
--json
boolean
Output status information in JSON format for scripting and automation
​
--watch
boolean
Continuously monitor and update status in real-time
​
--verbose
boolean
Show detailed connection and traffic information

​
JSON Output Example

{
  "tunnels": [
    {
      "id": "abc123",
      "localPort": 3000,
      "publicUrl": "https://abc123.wormkey.run",
      "status": "connected",
      "uptime": 9240,
      "requests": 1234,
      "auth": true,
      "expiresIn": 77160
    }
  ],
  "total": 1
}

​
Current Workarounds

In v0, you can check tunnel status by looking at the CLI output when you start a tunnel:
$ wormkey http 3000
Control plane: https://wormkey-control-plane.onrender.com
Edge tunnel: wss://t.wormkey.run/tunnel

Wormhole open.
https://abc123.wormkey.run
The tunnel is active as long as the process is running. Press Ctrl+C to close it.

​
Checking If a Tunnel is Active

​
Method 1: Process Listing

Check if a wormkey process is running: 
ps aux | grep wormkey

​
Method 2: Test the Public URL

Visit or curl the public URL provided when you started the tunnel: 
curl https://abc123.wormkey.run

​
Method 3: Check Local Port

Verify your local service is running: 
lsof -i :3000
# or
netstat -an | grep 3000

​
Use Cases

When implemented, status will be useful for:

Monitoring

Track tunnel health and uptime

Debugging

Identify connection issues

Analytics

Review traffic and usage patterns

Management

Manage multiple active tunnels

​
See Also

Build docs developers (and LLMs) love

Get started for freeTalk to us