{"id":16767171,"url":"https://github.com/tony612/kexplain","last_synced_at":"2025-04-10T19:13:00.741Z","repository":{"id":144914391,"uuid":"439025212","full_name":"tony612/kexplain","owner":"tony612","description":"Kexplain is an interactive kubectl explain","archived":false,"fork":false,"pushed_at":"2023-10-23T14:44:17.000Z","size":109,"stargazers_count":12,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-24T16:55:12.106Z","etag":null,"topics":["cli","documentation","go","golang","k8s","kubectl","kubectl-plugins","kubernetes","terminal"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tony612.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-16T14:48:13.000Z","updated_at":"2025-01-21T06:14:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"cbaf9a61-bc54-41a6-9c11-dfeb1fed6706","html_url":"https://github.com/tony612/kexplain","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tony612%2Fkexplain","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tony612%2Fkexplain/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tony612%2Fkexplain/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tony612%2Fkexplain/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tony612","download_url":"https://codeload.github.com/tony612/kexplain/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248280134,"owners_count":21077410,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","documentation","go","golang","k8s","kubectl","kubectl-plugins","kubernetes","terminal"],"created_at":"2024-10-13T06:08:35.000Z","updated_at":"2025-04-10T19:13:00.722Z","avatar_url":"https://github.com/tony612.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kexplain\n\nKexplain is an interactive `kubectl explain`. It supports viewing the resource documentation\nlike `less` and jumping around between documentation of fields.\n\nWhen kube config doesn't exist or k8s API is not available, a static API document from\n[GitHub](https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/openapi-spec/swagger.json) will be used.\nSo you can use `kexplain` without k8s clusters!\n\n[![asciicast](https://asciinema.org/a/492648.svg)](https://asciinema.org/a/492648)\n\n## Install\n\n* Pre-compiled binaries are available in the [release](https://github.com/tony612/kexplain/releases) page\n\n* Docker\n\n```\ndocker run --rm -it tony612/kexplain pod.spec\n```\n\n* Building from source code\n\n```\nmake build\ncp _out/kexplain /YOUR/PATH\n\n# or docker\nmake docker-build\n```\n\n## Usage\n\n```\n# Get the documentation of the resource and its fields\nkexplain pod\n\n# Get the documentation of a specific field of a resource\nkexplain pod.spec.containers\n```\n\nThen move around. See Key bindings.\n\n## Key bindings\n\n| Key |      Action     |\n| --- | ----------------- |\n| \u003ckbd\u003ej\u003c/kbd\u003e / \u003ckbd\u003eCtrl-n\u003c/kbd\u003e / \u003ckbd\u003e↓\u003c/kbd\u003e | Move one line down  |\n| \u003ckbd\u003ek\u003c/kbd\u003e / \u003ckbd\u003eCtrl-p\u003c/kbd\u003e/ \u003ckbd\u003e↑\u003c/kbd\u003e   | Move one line up  |\n| \u003ckbd\u003eTab\u003c/kbd\u003e       | Select next field |\n| \u003ckbd\u003eShift\u003c/kbd\u003e+\u003ckbd\u003eTab\u003c/kbd\u003e | Select previous field |\n| \u003ckbd\u003eAlt-]\u003c/kbd\u003e / \u003ckbd\u003eAlt\u003c/kbd\u003e+\u003ckbd\u003e→\u003c/kbd\u003e / \u003ckbd\u003eEnter\u003c/kbd\u003e  | Go to the documentation of the selected field |\n| \u003ckbd\u003eAlt-[\u003c/kbd\u003e / \u003ckbd\u003eAlt\u003c/kbd\u003e+\u003ckbd\u003e←\u003c/kbd\u003e    | Go back to the previous documentation |\n| \u003ckbd\u003eCtrl-f\u003c/kbd\u003e | Move one page down  |\n| \u003ckbd\u003eCtrl-b\u003c/kbd\u003e | Move one page up  |\n| \u003ckbd\u003eg\u003c/kbd\u003e      | Move to the head  |\n| \u003ckbd\u003eG\u003c/kbd\u003e      | Move to the bottom  |\n| \u003ckbd\u003e/\u003c/kbd\u003e, type `word`, \u003ckbd\u003eEnter\u003c/kbd\u003e    | Search `word`  |\n| \u003ckbd\u003en\u003c/kbd\u003e      | Repeat previous search  |\n| \u003ckbd\u003eN\u003c/kbd\u003e      | Repeat previous search in reverse direction.  |\n| \u003ckbd\u003eq\u003c/kbd\u003e / \u003ckbd\u003eQ\u003c/kbd\u003e  | Quit  |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftony612%2Fkexplain","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftony612%2Fkexplain","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftony612%2Fkexplain/lists"}