Skip to main content
This command is not implemented in v0. Use Ctrl+C on the tunnel process instead.

​
Overview

The close command will gracefully terminate active tunnels. This feature is planned for a future release.

​
Usage

wormkey close [tunnel-id]

​
Current Behavior

In v0, running this command displays: 
$ wormkey close
Close not implemented in v0. Use Ctrl+C on the tunnel process.

​
Current Method: Using Ctrl+C

To close a tunnel in v0, use Ctrl+C in the terminal where the tunnel is running:
$ wormkey http 3000
Wormhole open.
https://abc123.wormkey.run

Press Ctrl+C to close.

^C  # Press Ctrl+C to close
The Ctrl+C signal triggers a graceful shutdown:
  1. Closes the WebSocket connection to the edge server
  2. Stops accepting new requests
  3. Terminates the CLI process
  4. Invalidates the public URL

​
Planned Functionality

In future versions, the close command will:
  • Close specific tunnels - Terminate by tunnel ID or URL
  • Close all tunnels - Shut down all active wormholes
  • Graceful shutdown - Complete in-flight requests before closing
  • Confirmation prompts - Prevent accidental closures
  • Remote closure - Close tunnels from a different terminal or machine

​
Expected Usage Examples

wormkey close abc123

​
Expected Output

$ wormkey close abc123

Closing tunnel abc123...
✓ Tunnel closed successfully

Public URL is now inactive:
  https://abc123.wormkey.run

​
Planned Options

​
tunnel-id
string
The ID or public URL of the tunnel to close. If omitted, closes all active tunnels (with confirmation).
​
--all
boolean
Close all active tunnels without specifying individual IDs
​
--force
boolean
Skip confirmation prompts and force close immediately
​
--wait
boolean
Wait for in-flight requests to complete before closing (graceful shutdown)

​
Alternative: Kill Process

If the tunnel process is unresponsive to Ctrl+C, you can force kill it:

​
Step 1: Find the Process

ps aux | grep wormkey
Output: 
user    12345  0.1  0.5  ... node /usr/local/bin/wormkey http 3000

​
Step 2: Kill the Process

kill 12345
# or force kill if it doesn't respond
kill -9 12345
Using kill -9 forces immediate termination without graceful shutdown. In-flight requests may fail.

​
Managing Background Tunnels

If you run tunnels in the background, you’ll need to track and close them manually:

​
Running in Background

# Start tunnel in background
wormkey http 3000 > tunnel.log 2>&1 &

# Save the process ID
echo $! > tunnel.pid

​
Closing Background Tunnel

# Read the process ID and kill it
kill $(cat tunnel.pid)
rm tunnel.pid

​
Use Cases for Future Implementation

When close is implemented, it will be useful for:

Remote Management

Close tunnels from any terminal

Automation

Script tunnel lifecycle management

Cleanup

Close all tunnels with one command

Graceful Shutdown

Complete requests before closing

​
Graceful vs Force Shutdown

​
Graceful Shutdown (Ctrl+C)

  • Completes current requests
  • Closes WebSocket connection properly
  • Cleans up resources
  • Returns exit code 0

​
Force Shutdown (kill -9)

  • Immediate termination
  • May leave connections open
  • In-flight requests fail
  • Use only when graceful shutdown fails

​
When Tunnels Auto-Close

Tunnels automatically close when:
  • Session expires - Based on --expires duration (default 24h)
  • Process exits - CLI process terminates for any reason
  • Connection lost - Network interruption between CLI and edge
  • Local server down - Target port becomes unreachable
Set appropriate expiry times with --expires to ensure tunnels don’t stay open longer than needed:
wormkey http 3000 --expires 30m  # Auto-closes after 30 minutes

​
See Also

Build docs developers (and LLMs) love

Get started for freeTalk to us