Documentation

Everything you need to get started with kftray — from installation to advanced configuration.

Getting Started

What kftray is and why it exists.

Get kftray running on macOS, Linux, or Windows.

Create your first port forward in minutes.

Understand the forwarding pipeline.

Service, pod, proxy, and expose modes.

Field reference, defaults, and storage.

TCP and UDP forwarding options.

Route traffic through cluster proxies.

Capture request and response data.

Share configs across teams.

Discover services from annotations.

System tray app with HTTP logging and GitHub sync.

Keyboard-driven, SSH-compatible, lightweight.

Flags, non-interactive mode, scripting, CI/CD.

Environment variables, keyboard shortcuts, debug logging.

Deep dive into components and internals.