kubeconfig-manager documentation

kcm is a CLI + TUI for managing local kubeconfig files and kubectl contexts, with tags, destructive-action guardrails, and first-class shell integration.

Table of contents

Guides

• Getting started — install, shell hook, first run
• Shell integration — use, tui, install-shell-hook, optional kubectl alias
• Tags and alerts — how metadata attaches to kubeconfigs
• Destructive-action guard — how kcm kubectl intercepts dangerous verbs
• Helm values-path guard — catch values-file / context mismatches before helm upgrade ruins your day
• Import, split, merge — reorganizing kubeconfig files
• State file — schema, storage location, sync-readiness
• Architecture — package layout and design decisions
• Roadmap — deferred features (helm guard, cloud sync, fish shell)

CLI reference

Auto-generated from the Cobra command tree. Regenerate with go run scripts/gendocs.go.

• kcm — root command
• kcm list
• kcm show
• kcm contexts
• kcm use
• kcm tui
• kcm tag
• kcm alert
• kcm rename
• kcm import
• kcm split
• kcm merge
• kcm kubectl
• kcm install-shell-hook
• kcm uninstall-shell-hook

Man pages

Installable man pages are generated into the man/ directory alongside the markdown (man/kcm.1, man/kcm-list.1, …). After goreleaser publishes a release, these are packaged into the downloadable archives.

Hosting documentation

When you're ready to publish this at a real URL, the recommended framework is MkDocs with the Material theme — it's the de-facto standard for Kubernetes-adjacent CLI tools (Helm, Kustomize, ArgoCD, Velero all use it), builds from the same markdown in docs/, and deploys to GitHub Pages with a single GitHub Action. See roadmap for the concrete migration plan.