Kexplain is an interactive kubectl explain. It supports viewing the resource documentation
like less and jumping around between documentation of fields.
When kube config doesn't exist or k8s API is not available, a static API document from
GitHub will be used.
So you can use kexplain without k8s clusters!
-
Pre-compiled binaries are available in the release page
-
Docker
docker run --rm -it tony612/kexplain pod.spec
- Building from source code
make build
cp _out/kexplain /YOUR/PATH
# or docker
make docker-build
# Get the documentation of the resource and its fields
kexplain pod
# Get the documentation of a specific field of a resource
kexplain pod.spec.containers
Then move around. See Key bindings.
| Key | Action |
|---|---|
| j / Ctrl-n / ↓ | Move one line down |
| k / Ctrl-p/ ↑ | Move one line up |
| Tab | Select next field |
| Shift+Tab | Select previous field |
| Alt-] / Alt+→ / Enter | Go to the documentation of the selected field |
| Alt-[ / Alt+← | Go back to the previous documentation |
| Ctrl-f | Move one page down |
| Ctrl-b | Move one page up |
| g | Move to the head |
| G | Move to the bottom |
/, type word, Enter |
Search word |
| n | Repeat previous search |
| N | Repeat previous search in reverse direction. |
| q / Q | Quit |