kubectl-apidocs

README

kubectl-apidocs

A kubectl plugin for browsing Kubernetes API resource documentation in an interactive tree view.

---

Table of Contents

• Examples
• Installation
  • Using Krew
  • Homebrew installation
  • Manual Installation
• Usage
• Terminal Navigation Guide
• Contributing
• License
• Additional resources

---

Examples

kubectl apidocs interactive demo

Groups and resources are selectable

Navigate using arrow keys or hjkl, and use ENTER to select or ESC to go back

Fields are selectable

Use TAB to toggle focus between the tree view and the details panel; the details panel is scrollable

---

Installation

Using krew

1. Install the Krew plugin manager if you haven’t already.
2. Run the following command:

kubectl krew install apidocs

Homebrew installation

brew tap hashmap-kz/homebrew-tap
brew install kubectl-apidocs

Manual Installation

1. Download the latest binary for your platform from the Releases page.
2. Place the binary in your system's PATH (e.g., /usr/local/bin).

Example installation script for Unix-Based OS (requirements: tar, curl, jq):

(
set -euo pipefail

OS="$(uname | tr '[:upper:]' '[:lower:]')"
ARCH="$(uname -m | sed -e 's/x86_64/amd64/' -e 's/\(arm\)\(64\)\?.*/\1\2/' -e 's/aarch64$/arm64/')"
TAG="$(curl -s https://api.github.com/repos/hashmap-kz/kubectl-apidocs/releases/latest | jq -r .tag_name)"

curl -L "https://github.com/hashmap-kz/kubectl-apidocs/releases/download/${TAG}/kubectl-apidocs_${TAG}_${OS}_${ARCH}.tar.gz" |
tar -xzf - -C /usr/local/bin && \
chmod +x /usr/local/bin/kubectl-apidocs
)

Usage:

kubectl apidocs

---

Terminal Navigation Guide

🖥️ Keyboard Shortcuts

Shortcut	Action
<hjkl>	Navigate (Vim-style)
<ARROWS>	Navigate (Arrow keys)
<ENTER>	Select (group/resource)
<TAB>	Switch focus between tree/details (NOTE: details-view is scrollable)
<ESC>	Step back in navigation
/	Open search mode
<:cmd>	Execute a command
<ctrl-c>	Quit application
<b>	Step back to closest root

---

🚀 Tips for Efficient Navigation

• Use hjkl for fast movement (Vim-style navigation).
• TAB lets you quickly switch between tree-view and details (NOTE: details-view is scrollable).

---

Contributing

We welcome contributions! To contribute: see the Contribution guidelines.

---

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

---

Additional Resources

For more information, visit the project repository.

---