kennethnym/kport
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README with new features

Browse Source 
- Document SSH config Include support
- Mention improved manual port input UI
- Add examples of include usage with glob patterns
- Explain cycle detection feature

Co-authored-by: Ona <no-reply@ona.com>
This commit is contained in:
Ona
2025-09-26 00:10:42 +00:00
parent 5ebe20a210
commit a332459b92
1 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -5,9 +5,10 @@ A terminal user interface (TUI) application for SSH port forwarding that reads f
## Features ## Features
- **SSH Config Integration**: Automatically reads from `~/.ssh/config` - **SSH Config Integration**: Automatically reads from `~/.ssh/config`
- **Include Support**: Supports SSH config `Include` directive with glob patterns
- **Interactive Host Selection**: Choose from configured SSH hosts using arrow keys - **Interactive Host Selection**: Choose from configured SSH hosts using arrow keys
- **Automatic Port Detection**: Scans remote host for listening ports using `netstat`, `ss`, or `lsof` - **Automatic Port Detection**: Scans remote host for listening ports using `netstat`, `ss`, or `lsof`
- **Manual Port Forwarding**: Option to manually specify remote ports - **Manual Port Forwarding**: Option to manually specify remote ports with improved UI
- **Real-time Port Forwarding**: Creates SSH tunnels similar to VSCode's remote SSH port forwarding - **Real-time Port Forwarding**: Creates SSH tunnels similar to VSCode's remote SSH port forwarding
- **Clean TUI Interface**: Built with Bubble Tea for a smooth terminal experience - **Clean TUI Interface**: Built with Bubble Tea for a smooth terminal experience
@@ -74,8 +75,21 @@ Host dev-box
HostName dev.example.com HostName dev.example.com
User developer User developer
Port 2222 Port 2222
# Include additional config files
Include ~/.ssh/config.d/*
Include ~/.ssh/work-config
``` ```
### Include Support
kport supports the SSH `Include` directive, allowing you to organize your SSH configuration across multiple files:
- **Glob patterns**: `Include ~/.ssh/config.d/*`
- **Specific files**: `Include ~/.ssh/work-config`
- **Relative paths**: `Include config.d/servers`
- **Cycle detection**: Prevents infinite loops from circular includes
## Authentication ## Authentication
The application supports: The application supports: