<h1 align="center"><img src="https://github.com/user-attachments/assets/f28e04e0-0610-412c-9c58-fa53706a9c91"> kubectl.nvim</h1> <a href="https://nvim.io/"> <img src="https://img.shields.io/static/v1?style=flat-square&label=neovim&message=v0.11%2b&logo=neovim&color=414b32"> </a> <img src="https://img.shields.io/github/languages/code-size/Ramilito/kubectl.nvim?style=flat-square"> <a href="https://github.com/Ramilito/kubectl.nvim/blob/main/LICENSE"> <img src="https://img.shields.io/github/license/Ramilito/kubectl.nvim?style=flat-square"> </a> <img src="https://img.shields.io/github/check-runs/Ramilito/kubectl.nvim/main"> <a href="https://github.com/Ramilito/kubectl.nvim/releases/latest"> <img src="https://img.shields.io/github/v/release/Ramilito/kubectl.nvim"> </a>

Processes kubectl outputs to enable vim-like navigation in a buffer for your cluster.

kubectl-nvim-light

✨ Features

<details> <summary>Navigate your cluster in a buffer, using hierarchy where possible (backspace for up, enter for down) e.g. root -> deployment -> pod -> container </summary> <img src="https://github.com/user-attachments/assets/2243c9d8-0808-4734-92aa-7612496c920b" width="700px"> </details> <details> <summary>Colored output and smart highlighting</summary> <img src="https://github.com/user-attachments/assets/f42fa62c-0ddc-4733-9a83-b9d55b4745a1" width="700px"> </details> <details> <summary>Floating windows for contextual stuff such as logs, description, containers..</summary> <img src="https://github.com/user-attachments/assets/899cb923-e038-4822-890b-d88466797d52" width="700px"> </details> <details> <summary>Completion</summary> <img src="https://github.com/user-attachments/assets/f6d5d38a-2b1d-4262-9c15-0587277e2b7a" width="700px"> </details> <details> <summary>Commands: <code>:Kubectl</code>, <code>:Kubens</code>, <code>:Kubectx</code></summary> Run kubectl commands directly or open interactive views. All commands support tab completion. <pre> :Kubectl get endpoints -- Run kubectl and show output in split :Kubectl view [resource] -- Open interactive view for any resource :Kubectl top -- Open top dashboard :Kubectl diff [path] -- Diff resources :Kubens [namespace] -- Switch or select namespace :Kubectx [context] -- Switch or select context</pre> <img src="https://github.com/user-attachments/assets/3162ef16-4730-472b-95f8-4bdc2948647f" width="700px"> </details> <details> <summary>Change context using cmd <code>:Kubectx context-name</code> or the context view</summary> <img src="https://github.com/user-attachments/assets/bca7c827-4207-47d2-b828-5dc6caab005a" width="700px"> </details> <details> <summary>Exec into containers</summary> In the pod view, select a pod by pressing <code><cr></code> and then again <code><cr></code> on the container you want to exec into <img src="https://github.com/user-attachments/assets/ffb9cfb1-8e75-4917-88f5-477a443669a9" width="700px"> </details> <details> <summary>Sort by headers</summary> By moving the cursor to anywhere in a column and pressing <code>gs</code> <img src="https://github.com/user-attachments/assets/918038d4-60ed-4d7a-a20d-8d9e57fd1be9" width="700px"> </details> <details> <summary>Tail logs</summary> <img src="https://github.com/user-attachments/assets/8a1f59fb-59f2-4093-a479-8900940edfc9" width="700px"> </details> <details> <summary>Diff view: <code>:Kubectl diff (path)</code></summary> <img src="https://github.com/user-attachments/assets/52662db4-698b-4059-a5a2-2c9ddfe8d146" width="700px"> </details> <details> <summary>Port forward</summary> <img src="https://github.com/user-attachments/assets/9dec1bb8-b65c-4b5a-a8fe-4ca26c93ab43" width="700px"> </details> <details> <summary>Aliases (fallback view)</summary> A fallback view that directs custom resources and has basic functionality such desc, edit, del <img src="https://github.com/user-attachments/assets/6d5bbb82-bc42-4ab4-9f9d-a40b1e7f0286" width="700px"> </details> <details> <summary>Overview</summary> <img src="https://github.com/user-attachments/assets/cb1f46be-fcc0-4a6d-9d1e-ffcd5bdb32b3" width="700px"> </details> <details> <summary>Picker for recent items</summary> <img src="https://github.com/user-attachments/assets/fb519986-4d6e-437d-8fda-bd14199a71f2" width="700px"> </details> <details> <summary>Lineage</summary> A plugin similar to <a href="https://github.com/tohjustin/kube-lineage/tree/master">kube-lineage</a> ⚠️ This is a beta feature and not all bugs are sorted out <img src="https://github.com/user-attachments/assets/6c170724-d86d-46a7-af98-2862c45bcd01" width="700px"> </details>

⚡️ Required Dependencies

neovim >= 0.10

⚡️ Optional Dependencies

kubediff or DirDiff (If you want to use the diff feature)
Helm (for helm view)

📦 Installation

Install the plugin with your preferred package manager:

lazy.nvim

return {
  {
    "ramilito/kubectl.nvim",
    -- use a release tag to download pre-built binaries
    version = "2.*",
    -- OR build from source, requires nightly: https://rust-lang.github.io/rustup/concepts/channels.html#working-with-nightly-rust
    -- build = 'make build',
    -- OR if you use nix, build from source with:
    -- build = 'nix run .#build-plugin',
    dependencies = "saghen/blink.download",
    config = function()
      require("kubectl").setup()
    end,
  },
}

⌨️ Keymaps

We expose open, close and toggle to bind against:

Toggle

vim.keymap.set(
  "n",
  "<leader>k",
  '<cmd>lua require("kubectl").toggle({ tab: boolean })<cr>',
  { noremap = true, silent = true }
)

Override existing

local group = vim.api.nvim_create_augroup("kubectl_mappings", { clear = true })
vim.api.nvim_create_autocmd("FileType", {
  group = group,
  pattern = "k8s_*",
  callback = function(ev)
    local k = vim.keymap
    local opts = { buffer = ev.buf }

    k.set("n", "<C-e>", "<Plug>(kubectl.picker_view)", opts)
  end,
})

Delete existing

local group = vim.api.nvim_create_augroup("kubectl_mappings", { clear = true })
vim.api.nvim_create_autocmd("FileType", {
  group = group,
  pattern = "k8s_*",
  callback = function(ev)
    local k = vim.keymap
    local opts = { buffer = ev.buf }

    pcall(k.del, "n", 1, opts)
    pcall(k.del, "n", 2, opts)
    pcall(k.del, "n", 3, opts)
    pcall(k.del, "n", 5, opts)
    pcall(k.del, "n", 6, opts)
  end,
})

Default Mappings

You can override the plugin's keymaps using the <Plug> mappings:

<details><summary>Default Mappings</summary>

-- default mappings
local group = vim.api.nvim_create_augroup("kubectl_mappings", { clear = true })
vim.api.nvim_create_autocmd("FileType", {
  group = group,
  pattern = "k8s_*",
  callback = function(ev)
    local k = vim.keymap.set
    local opts = { buffer = ev.buf }

    -- Global
    k("n", "g?", "<Plug>(kubectl.help)", opts) -- Help float
    k("n", "gr", "<Plug>(kubectl.refresh)", opts) -- Refresh view
    k("n", "gs", "<Plug>(kubectl.sort)", opts) -- Sort by column
    k("n", "gD", "<Plug>(kubectl.delete)", opts) -- Delete resource
    k("n", "gd", "<Plug>(kubectl.describe)", opts) -- Describe resource
    k("n", "gy", "<Plug>(kubectl.yaml)", opts) -- View yaml
    k("n", "ge", "<Plug>(kubectl.edit)", opts) -- Edit resource
    k("n", "<C-l>", "<Plug>(kubectl.filter_label)", opts) -- Filter labels
    k("n", "<BS>", "<Plug>(kubectl.go_up)", opts) -- Go back to previous view
    k("v", "<C-f>", "<Plug>(kubectl.filter_term)", opts) -- Filter selected text
    k("n", "<CR>", "<Plug>(kubectl.select)", opts) -- Resource select action (different on each view)
    k("n", "<Tab>", "<Plug>(kubectl.tab)", opts) -- Select resource
    k("n", "<S-Tab>", "<Plug>(kubectl.clear_selection)", opts) -- Clear selection
    k("n", "", "<Plug>(kubectl.quit)", opts) -- Close view (when applicable)
    k("n", "gk", "<Plug>(kubectl.kill)", opts) -- Pod/portforward kill
    k("n", "<M-h>", "<Plug>(kubectl.toggle_headers)", opts) -- Toggle headers
    k("n", "<f4>", "<Plug>(kubectl.toggle_fullscreen)", opts) -- Toggle fullscreen

    -- Views
    k("n", "<C-p>", "<Plug>(kubectl.picker_view)", opts) -- Picker view
    k("n", "<C-a>", "<Plug>(kubectl.alias_view)", opts) -- Aliases view
    k("n", "<C-x>", "<Plug>(kubectl.contexts_view)", opts) -- Contexts view
    k("n", "<C-f>", "<Plug>(kubectl.filter_view)", opts) -- Filter view
    k("n", "<C-n>", "<Plug>(kubectl.namespace_view)", opts) -- Namespaces view
    k("n", "gP", "<Plug>(kubectl.portforwards_view)", opts) -- Portforwards view

    -- views
    k("n", "1", "<Plug>(kubectl.view_deployments)", opts) -- Deployments view
    k("n", "2", "<Plug>(kubectl.view_pods)", opts) -- Pods view
    k("n", "3", "<Plug>(kubectl.view_configmaps)", opts) -- ConfigMaps view
    k("n", "4", "<Plug>(kubectl.view_secrets)", opts) -- Secrets view
    k("n", "5", "<Plug>(kubectl.view_services)", opts) -- Services view
    k("n", "6", "<Plug>(kubectl.view_ingresses)", opts) -- Ingresses view
    k("n", "", "<Plug>(kubectl.view_api_resources)", opts) -- API-Resources view
    k("n", "", "<Plug>(kubectl.view_clusterrolebinding)", opts) -- ClusterRoleBindings view
    k("n", "", "<Plug>(kubectl.view_crds)", opts) -- CRDs view
    k("n", "", "<Plug>(kubectl.view_cronjobs)", opts) -- CronJobs view
    k("n", "", "<Plug>(kubectl.view_daemonsets)", opts) -- DaemonSets view
    k("n", "", "<Plug>(kubectl.view_events)", opts) -- Events view
    k("n", "", "<Plug>(k

Kubectl.nvim

Install / Use

README