https://github.com/hcavarsan/kftray
๐ฆ โก kubectl port forward manager, with support for UDP and proxy connections through k8s clusters
https://github.com/hcavarsan/kftray
developer-tools devops devops-tools devtools k8s kftray kubectl kubernetes kubernetes-cluster-workload kubernetes-service networking port-forward port-forwarding proxy rust tauri tray typescript vite
Last synced: 7 months ago
JSON representation
๐ฆ โก kubectl port forward manager, with support for UDP and proxy connections through k8s clusters
- Host: GitHub
- URL: https://github.com/hcavarsan/kftray
- Owner: hcavarsan
- License: gpl-3.0
- Created: 2023-11-26T01:02:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-06T05:39:56.000Z (8 months ago)
- Last Synced: 2025-04-06T05:56:51.264Z (8 months ago)
- Topics: developer-tools, devops, devops-tools, devtools, k8s, kftray, kubectl, kubernetes, kubernetes-cluster-workload, kubernetes-service, networking, port-forward, port-forwarding, proxy, rust, tauri, tray, typescript, vite
- Language: Rust
- Homepage: https://kftray.app/
- Size: 17 MB
- Stars: 977
- Watchers: 10
- Forks: 62
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-rust - kftray - A cross-platform system tray app for managing and sharing multiple kubectl port-forward configurations. [](https://github.com/hcavarsan/kftray/actions) (Applications)
- awesome-cloud-native - kftray - Manage and run multiple kubectl port-forward configurations directly in the menu bar, syncing configurations with git repositories. (Developer Workspaces & Productivity)
- awesome-made-by-brazilians - KFtray
- awesome-rust - kftray - A cross-platform system tray app for managing and sharing multiple kubectl port-forward configurations. [](https://github.com/hcavarsan/kftray/actions) (Applications)
- awesome-repositories - hcavarsan/kftray - kubectl port-forward manager and reverse tunnel (ngrok-like) for exposing local services publicly, with TLS termination, HTTP traffic inspection, UDP forwarding, multi-hop proxy routing through k8s (Rust)
- fucking-awesome-rust - kftray - A cross-platform system tray app for managing and sharing multiple kubectl port-forward configurations. [](https://github.com/hcavarsan/kftray/actions) (Applications)
- awesome-tuis - kftui - A TUI to manage multiple kubectl port-forward commands, with support for UDP and K8s proxy. (Table of Contents)
- awesome-cli-apps-in-a-csv - kftray - kubectl port-forward on steroids, manage and share multiple k8s port forwards, with support for UDP, proxy through the k8s cluster, and github state sync. (<a name="networking"></a>Networking)
- awesome-tauri - KFtray - A tray application that manages port forwarding in Kubernetes. (Applications / Developer tools)
- awesome-cli-apps - kftray - kubectl port-forward on steroids, manage and share multiple k8s port forwards, with support for UDP, proxy through the k8s cluster, and github state sync. (<a name="networking"></a>Networking)
README
kftray and kftui are independent, cross-platform applications. They help you set up and manage multiple port-forwarding settings easily. Both apps are part of the same open-source project and aim to make working with Kubernetes easier. kftray has a desktop interface, while kftui has a terminal interface, so you can choose the one that suits you best.
## Why
Both apps were made to fix common problems with Kubernetes port forwarding. The usual kubectl port-forward command can be unreliable. For example, if a pod dies, it needs manual reconnection. It also has trouble setting up many port forwards at once and doesn't support UDP services.
They automatically reconnect to running pods if one fails, also it allow setting up multiple port forwards with one click, and support both TCP and UDP protocols. kftray also has extra features like HTTP logs tracing and GitHub sync to make workflows smoother.
## Overview
For more information about kftray features and components, visit our blog post at [kftray.app/blog/posts/13-kftray-manage-all-k8s-port-forward](https://kftray.app/blog/posts/13-kftray-manage-all-k8s-port-forward). The post provides an overview of functionalities including auto-reconnection, multiple port forward management, TCP/UDP support, HTTP logs tracing and GitHub sync.
## Features
- **Resilient Port Forwarding Connection:** Ensures continuous service even if a pod dies by reconnecting to another running pod automatically.
- **One-Click Multiple Port Forwards:** Allows for the setup of several port forwarding instances simultaneously with a single click.
- **Independent of Kubectl:** Directly interfaces with the Kubernetes API, eliminating the need for `kubectl`.
- **Multi-Protocol Support:** Enables access to internal or external servers through a Proxy Relay server deployed in a Kubernetes cluster, including TCP and UDP port forwarding.
- **HTTP Logs Tracing:** Enable or disable HTTP logs for specific configurations to save the requests and responses in a local log file. _(Currently available only in the kftray desktop app)_ - [Blog Post](https://kftray.app/blog/posts/12-kftray-http-logs-vscode)
- **GitHub Sync:** Keep your configurations saved on GitHub and share or synchronize them in a GitOps style. _(Currently available only in the kftray desktop app)_
- **Auto Import:** Automatically import Kubernetes service configurations based on specific annotations. An example with an explanation can be found in this repo: https://github.com/hcavarsan/kftray-k8s-tf-example
| Feature | kftray (Desktop App) | kftui (Terminal UI) |
|----------------------------------------------|----------------------|---------------------|
| Resilient Port Forwarding Connection | โ๏ธ | โ๏ธ |
| One-Click Multiple Port Forwards | โ๏ธ | โ๏ธ |
| Independent of Kubectl | โ๏ธ | โ๏ธ |
| Multi-Protocol Support (TCP/UDP) | โ๏ธ | โ๏ธ |
| HTTP Logs Tracing | โ๏ธ | โ (Coming Soon) |
| GitHub Sync | โ๏ธ | โ (Coming Soon) |
| Local JSON File Configuration | โ๏ธ | โ๏ธ |
| Auto Import with k8s Annotations | โ๏ธ | โ๏ธ |
## kftray - Desktop App
- [INSTALL.md](https://github.com/hcavarsan/kftray/tree/main/docs/kftray/INSTALL.md)
- [USAGE.md](https://github.com/hcavarsan/kftray/tree/main/docs/kftray/USAGE.md)
- [BUILD.md](https://github.com/hcavarsan/kftray/tree/main/docs/kftray/BUILD.md)
## kftui - Terminal User Interface
- [INSTALL.md](https://github.com/hcavarsan/kftray/tree/main/docs/kftui/INSTALL.md)
- [USAGE.md](https://github.com/hcavarsan/kftray/tree/main/docs/kftui/USAGE.md)
- [BUILD.md](https://github.com/hcavarsan/kftray/tree/main/docs/kftui/BUILD.md)
## kftray server - Proxy Relay Server
- [ARCH.md](https://github.com/hcavarsan/kftray/tree/main/docs/ARCH.md).
## Contributing
- **Pull Requests:** Feel free to create pull requests for bug fixes, new features, or improvements.
- **Issues:** Report bugs, suggest new features, or ask questions.
- **Feedback:** Your feedback helps improve kftray.
## License
kftray is available under the [MIT License](LICENSE.md). See the LICENSE file for full details.
## Star History
## Contributors โจ
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

Henrique Cavarsan
๐ป

Filipe Andujar
๐ป

Ikko Eltociear Ashimine
๐ป

Honsun Zhu
๐ป
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!