Main Window¶
The StormTunnel main window is where you manage all your tunnels.
Window Layout¶
The window has three main areas:
| Area | Purpose |
|---|---|
| Sidebar (left) | List of all your tunnels |
| Detail View (right) | Information about selected tunnel |
| Toolbar (top) | Quick actions and settings |
Sidebar - Tunnel List¶
The sidebar shows all your tunnels with their current status.
Status Indicators¶
| Color | Meaning |
|---|---|
| 🟢 Green | Connected |
| ⚫ Gray | Disconnected |
| 🟡 Yellow | Connecting |
| 🔴 Red | Error |
Quick Actions¶
- Click a tunnel to see its details
- Double-click to connect/disconnect
- Right-click for more options (edit, duplicate, delete)
Search and Filtering¶
The sidebar includes a powerful search feature to quickly find tunnels in large lists.
What Search Covers¶
Search filters tunnels in real-time based on:
| Field | Search Scope |
|---|---|
| Tunnel Name | Full tunnel name (e.g., "dev-postgres") |
| Remote Host | Server hostname (SSH) or AWS remote host |
| SSH User | SSH username (e.g., "ec2-user") |
| Instance ID | AWS Instance ID (for AWS Session Manager) |
| Local Port | Local port number (e.g., "5432") |
| Remote Port | Remote port number (e.g., "5432") |
How to Use Search¶
- Click the search field at the top of the sidebar
- Type your search query - results update instantly as you type
- Browse filtered list - only matching tunnels are shown
- Select a tunnel - click or use keyboard to select
- Clear search - press Esc or delete text to see all tunnels
Search Behavior¶
- Case-insensitive: Search ignores letter case
- Partial matches: Matches anywhere in the field
- Real-time filtering: List updates immediately as you type
- Multi-field search: Searches all fields simultaneously
Search Tips¶
| Tip | Example |
|---|---|
| Find by port | Type "5432" to find PostgreSQL tunnels |
| Find by environment | Type "dev" to find all dev tunnels |
| Find by user | Type "ubuntu" to find user-specific |
| Find by service type | Type "redis" for cache tunnels |
| Find AWS instances | Type "i-012" to find specific EC2 |
Keyboard Shortcut
Press Cmd+F to instantly focus the search field from anywhere in the main window.
Search Performance
Search is optimized for performance even with hundreds of tunnels. Results appear instantly without delays.
Detail View¶
When you select a tunnel, the detail view shows:
- Status - Connected/disconnected and duration
- Connection info - Host, ports, SSH user
- SSH Command - The underlying command (useful for debugging)
- Actions - Edit, connect, delete buttons
Dashboard¶
When no tunnel is selected, you see the dashboard with:
- Total number of tunnels
- How many are connected
- Recent connection activity
Toolbar¶
Quick access buttons at the top:
| Button | Action | Shortcut |
|---|---|---|
| + | Create new tunnel | Cmd+N |
| Settings | Open preferences | Cmd+, |
Tunnel Management¶
Duplicate Tunnel¶
Create a copy of an existing tunnel:
- Keyboard: Cmd+D
- Right-click: Select "Duplicate" from context menu
- Menu: Edit → Duplicate
- Behavior: Creates copy with "(Copy)" appended to name
- Security: Password is NOT copied (must re-enter)
Quick Setup
Use duplicate when you need multiple similar tunnels with slightly different settings (e.g., same server but different ports). Save time by duplicating and editing instead of creating from scratch.
Menus¶
File Menu¶
| Item | Action | Shortcut |
|---|---|---|
| New Tunnel | Create tunnel | Cmd+N |
| Import | Import from file | Cmd+I |
| Export | Export to file | Cmd+E |
Edit Menu¶
| Item | Action | Shortcut |
|---|---|---|
| Copy | Copy SSH command | Cmd+C |
| Duplicate | Copy tunnel | Cmd+D |
| Delete | Remove tunnel | Cmd+Del |
View Menu¶
| Item | Action | Shortcut |
|---|---|---|
| Toggle Sidebar | Show/hide sidebar | Cmd+\ |
| Connection History | Open history | Cmd+H |
Keyboard Shortcuts¶
Navigation¶
| Action | Shortcut |
|---|---|
| Move up/down | Up / Down |
| Select tunnel | Enter |
| Connect/disconnect | Space |
| Search | Cmd+F |
Actions¶
| Action | Shortcut |
|---|---|
| New tunnel | Cmd+N |
| Settings | Cmd+, |
| Edit tunnel | Cmd+E |
| Delete tunnel | Cmd+Del |
| Copy command | Cmd+C |
See Keyboard Shortcuts for the complete list.
Tips¶
Resize the Sidebar¶
Drag the divider between sidebar and detail view to adjust widths.
Use the Menu Bar¶
Enable Show in Menu Bar in Settings → General for quick access without opening the main window.
Copy SSH Commands¶
Select a tunnel and press Cmd+C to copy the SSH command. Useful for:
- Debugging connection issues
- Sharing setup with colleagues
- Running manually in Terminal
Right-Click for Options¶
Right-click any tunnel for quick access to:
- Edit
- Duplicate
- Connect/Disconnect
- Copy Command
- Delete
Related¶
- Common Workflows - Daily tasks
- Search & Navigation - Finding tunnels
- Keyboard Shortcuts - All shortcuts