derailed/k9s

Maintainer? Show your league in your README

Card: your league's emblem, from Copper to Legendary

[![bestofgithub](https://bestofgithub.dev/badge/derailed/k9s.svg?style=card)](https://bestofgithub.dev/repo/derailed/k9s)

Flat: fits beside your other badges

[![bestofgithub](https://bestofgithub.dev/badge/derailed/k9s.svg)](https://bestofgithub.dev/repo/derailed/k9s)

Loading README…

k9s	k8s client
>= v0.27.0	1.26.1
v0.26.7 - v0.26.6	1.25.3
v0.26.5 - v0.26.4	1.25.1
v0.26.3 - v0.26.1	1.24.3
v0.26.0 - v0.25.19	1.24.2
v0.25.18 - v0.25.3	1.22.3
v0.25.2 - v0.25.0	1.22.0
<= v0.24	1.21.3

Action	Command	Comment
Show active keyboard mnemonics and help	`?`
Show all available resource alias	`ctrl-a`
To bail out of K9s	`:quit`, `:q`, `ctrl-c`
To go up/back to the previous view	`esc`	If you have crumbs on, this will go to the previous one
View a Kubernetes resource using singular/plural or short-name	`:`pod⏎	accepts singular, plural, short-name or alias ie pod or pods
View a Kubernetes resource in a given namespace	`:`pod ns-x⏎
View filtered pods (New v0.30.0!)	`:`pod /fred⏎	View all pods filtered by fred
View labeled pods (New v0.30.0!)	`:`pod app=fred,env=dev⏎	View all pods with labels matching app=fred and env=dev
View pods in a given context (New v0.30.0!)	`:`pod @ctx1⏎	View all pods in context ctx1. Switches out your current k9s context!
Filter out a resource view given a filter	`/`filter⏎	Regex2 supported ie `fred
Inverse regex filter	`/`! filter⏎	Keep everything that doesn't match.
Filter resource view by labels	`/`-l label-selector⏎
Fuzzy find a resource given a filter	`/`-f filter⏎
Bails out of view/command/filter mode	`<esc>`
To view and switch to another Kubernetes context (Pod view)	`:`ctx⏎
To view and switch directly to another Kubernetes context (Last used view)	`:`ctx context-name⏎
To view and switch to another Kubernetes namespace	`:`ns⏎
To switch back to the last active command (like how "cd -" works)	`-`	Navigation that adds breadcrumbs to the bottom are not commands
To go back and forward through the command history	back: `[`, forward: `]`	Same as above
To view all saved resources	`:`screendump or sd⏎
To delete a resource (TAB and ENTER to confirm)	`ctrl-d`
To kill a resource (no confirmation dialog, equivalent to kubectl delete --now)	`ctrl-k`
Launch pulses view	`:`pulses or pu⏎
Launch XRay view	`:`xray RESOURCE [NAMESPACE]⏎	RESOURCE can be one of po, svc, dp, rs, sts, ds, NAMESPACE is optional
Launch Popeye view	`:`popeye or pop⏎	See popeye
Mark resource	`space`
Mark range of resources	`ctrl-space`
Clear all marks	`ctrl-\`
Save resources to file	`ctrl-s`
Toggle faults/error display	`ctrl-z`
Toggle wide columns	`ctrl-w`
Toggle header	`ctrl-e`
Toggle breadcrumbs	`ctrl-g`
Move selected column left	`shift-left arrow`
Move selected column right	`shift-right arrow`
Sort by selected column	`shift-o`
Sort by Name	`shift-n`
Sort by Age	`shift-a`
Sort by Namespace	`shift-p`	Only when viewing all namespaces
Sort by Status	`shift-s`
Copy resource name	`c`
Copy namespace	`n`
View YAML	`y`
View logs	`l`	Resource specific
View previous logs	`p`	Resource specific
Shell into container	`s`	Pods only
Attach to container	`a`	Pods only
Describe resource	`d`
Edit resource	`e`	Not available in read-only mode
Show port-forwards	`f`	Pods/Services/Containers
Port forward	`shift-f`	Pods/Services/Containers
Warp to namespace	`w`	When namespace column is available
Jump to owner	`shift-j`	When resource has an owner
Use/switch namespace	`u`	Namespace view
UsedBy (show resources using this)	`u`	ServiceAccounts/PVCs/Secrets/ConfigMaps
Benchmark (run/stop)	`b`	Services/Port-forwards
Toggle text wrap	`w`	Log view
Toggle timestamp	`t`	Log view
Toggle fullscreen	`f`	Log/YAML/Details view
Refresh/reload view	`ctrl-r`
Trigger (CronJob)	`t`	CronJob view
Cordon/Uncordon node	`u`	Node view
Drain node	`r`	Node view
Restart resource	`r`	Deployments/DaemonSets/StatefulSets
Rollback resource	`ctrl-l`	ReplicaSets
View ReplicaSets	`z`	Deployment view

Type	Description	UI Element
`string`	Free-form text input	Text field
`number`	Numeric input (integers and floats)	Text field with numeric validation
`bool`	Boolean toggle	Checkbox
`dropdown`	Selection from predefined options	Dropdown menu

K9s - Kubernetes CLI To Manage Your Clusters In Style!

Note...

Screenshots

Demo Videos/Recordings

Documentation

Slack Channel

Installation

Building From Source

Running with Docker

Running the official Docker image

Building your own Docker image

Building a multi-platform image

PreFlight Checks

K8S Compatibility Matrix

The Command Line

Logs And Debug Logs

View K9s logs

Start K9s in debug mode

Customize logs destination

Key Bindings

K9s Configuration

Popeye Configuration

Node Shell

Customizing the Shell Pod

Command Aliases

HotKey Support

Port Forwarding over websockets

FastForwards

Example

Custom Views

Resource Jumps

Configuration Format

Configuration Fields

Template Syntax

Examples

Jump between custom operator resources

Jump from ArgoCD Application to Deployments

Jump from Karpenter NodePool to Nodes

How It Works

Plugins

Plugin Inputs

Plugin Examples

Benchmark Your Applications

K9s RBAC FU

Cluster RBAC scope

Namespace RBAC scope

Skins

Contributors

Known Issues

ATTA Girls/Boys!

Meet The Core Team!

Contributions Guideline