A kubectl plugin for browsing Kubernetes API resource documentation in an interactive tree view.
Use TAB to toggle focus between the tree view and the details panel; the details panel is scrollable
- Install the Krew plugin manager if you haven’t already.
- Run the following command:
kubectl krew install apidocsbrew tap hashmap-kz/homebrew-tap
brew install kubectl-apidocs- Download the latest binary for your platform from the Releases page.
- Place the binary in your system's
PATH(e.g.,/usr/local/bin).
(
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
)kubectl apidocs| 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 |
- Use
hjklfor fast movement (Vim-style navigation). TABlets you quickly switch between tree-view and details (NOTE: details-view is scrollable).
We welcome contributions! To contribute: see the Contribution guidelines.
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
For more information, visit the project repository.