Code Monkey home page Code Monkey logo

kexplain's Introduction

Kexplain

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!

asciicast

Install

  • 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

Usage

# 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 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

kexplain's People

Contributors

tony612 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.