Documentation
Install kftray or kftui and set up Kubernetes port forwards, HTTP logs and proxies.
Getting Started
Introduction
Choose between the desktop and terminal apps.
Install
Install on macOS, Linux or Windows.
Quick Start
Create your first port forward.
How It Works
Follow traffic from your machine to the cluster.
Features
Workload Types
Choose service, pod, proxy or expose mode.
Configuration
Check config fields, defaults and storage paths.
Port Forwarding
Set up TCP and UDP forwards.
Proxy Forwarding
Reach remote services through your cluster.
HTTP Logging
Record HTTP requests and responses.
GitHub Sync
Share configs through a GitHub repository.
Auto Import
Import services with Kubernetes annotations.
MCP Server
Let external clients manage port forwards through kftray.
Interfaces
GUI
Manage forwards from the system tray.
TUI
Manage forwards with a keyboard, including over SSH.
CLI
Run forwards from scripts and CI jobs.
Resources
CLI Reference
Look up flags, environment variables and keyboard shortcuts.
Architecture
Read about components, shared state and security.
Relay Server
Configure the in-cluster TCP and UDP relay.
Development
Set up tools, run checks and troubleshoot local development.
Build from Source
Build the desktop or terminal app.
Contributing
Report bugs and submit changes.
Security
Report vulnerabilities and verify releases.
Linux Packaging
Validate and publish distribution packages.
Code of Conduct
Read the community standards and reporting process.