Docs · Documentation
Documentation
Learn Kubyl
Everything about the native Kubernetes client: getting it running, connecting clusters, working with resources and configuring it to your taste.
Install Kubyl
Homebrew, apt, dnf, pacman, direct downloads or build from source.
Quick start
Connect a cluster, open a pod list and tail logs in five minutes.
Command palette
The six prefixes that get you anywhere.
Settings
Every key in settings.json with its default.
Getting started
- Introduction
What Kubyl is, what it covers and how these docs are organised.
- Installation
Install Kubyl with Homebrew, apt, dnf, pacman, a release download or from source.
- Quick start
Connect your first cluster and find your way around in five minutes.
Clusters
- Clusters and kubeconfigs
How Kubyl finds kubeconfigs, groups contexts and shows connection state.
- Authentication
Client certificates, tokens, exec plugins, OIDC and OpenShift OAuth.
- Kubeconfig editor
Create, edit, test and import kubeconfigs without leaving Kubyl.
- Production and read-only
Guard rails for clusters you can't afford to break.
Using Kubyl
- The interface
Title bar, sidebar, tabs, docks and status bar.
- Command palette
Six prefixes that get you anywhere in the cluster.
- Resource lists
Live tables, filter syntax, sorting, the details panel and actions.
- YAML editor
Schema-aware editing, diff against live, dry run and server-side apply.
- Logs
Follow logs from pods, workloads and services with search and level filters.
- Terminal
Exec shells, attach, debug containers and node shells in a real terminal.
- Port-forwarding
Forward ports from pods, services and workloads and keep them alive.
- Pod file browser
Two-pane file manager between your machine and a container.
- Overview and metrics
Cluster and namespace dashboards, events and CPU/memory metrics.
Integrations
- Alerts
Alertmanager alerts, silences and Prometheus rules per cluster or across all clusters.
- Network flows
Live flows and topology from Cilium Hubble, Calico Whisker or NetObserv.
- Service web views
Open Grafana, Prometheus and other in-cluster web UIs inside Kubyl.
- Operators and Helm
OperatorHub, OLM operators, Helm releases and OLM v1 extensions.
- Cluster updates
Update paths, pre-flight checks and upgrades for OpenShift and managed clusters.
- Argo CD
Applications, resource trees, diff, sync, history and rollback.
Reference
- Settings
Every key in settings.json with its default, and how the file behaves.
- Keyboard shortcuts
The complete default keymap and the k9s preset.
- Coming from k9s
Map your k9s habits to Kubyl.
- Files and environment
Where Kubyl stores configuration, state, logs and secrets, and the environment variables it reads.
- Updates and privacy
How Kubyl updates itself, what it connects to and what it stores.
- Known limitations
What isn't finished or isn't there yet.