{"id":13575440,"url":"https://github.com/c-bata/kube-prompt","last_synced_at":"2025-05-15T02:07:27.675Z","repository":{"id":23972450,"uuid":"100288067","full_name":"c-bata/kube-prompt","owner":"c-bata","description":"An interactive kubernetes client featuring auto-complete.","archived":false,"fork":false,"pushed_at":"2024-07-30T13:55:04.000Z","size":232,"stargazers_count":1809,"open_issues_count":29,"forks_count":135,"subscribers_count":21,"default_branch":"main","last_synced_at":"2025-04-11T14:17:04.505Z","etag":null,"topics":["command-line-tool","golang","kubectl","kubernetes","prompt"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/c-bata.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":"2017-08-14T16:32:33.000Z","updated_at":"2025-04-07T08:36:57.000Z","dependencies_parsed_at":"2024-06-18T15:22:47.916Z","dependency_job_id":"4cd9f44f-3df4-447f-87dd-db4bf5f62b2f","html_url":"https://github.com/c-bata/kube-prompt","commit_stats":{"total_commits":206,"total_committers":14,"mean_commits":"14.714285714285714","dds":0.09708737864077666,"last_synced_commit":"8547400009dcb7340f3bbd6428113aa5ccc2c7b7"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c-bata%2Fkube-prompt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c-bata%2Fkube-prompt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c-bata%2Fkube-prompt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c-bata%2Fkube-prompt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/c-bata","download_url":"https://codeload.github.com/c-bata/kube-prompt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254259383,"owners_count":22040820,"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":["command-line-tool","golang","kubectl","kubernetes","prompt"],"created_at":"2024-08-01T15:01:01.074Z","updated_at":"2025-05-15T02:07:27.624Z","avatar_url":"https://github.com/c-bata.png","language":"Go","funding_links":[],"categories":["API/CLI adaptors","Go","kubernetes"],"sub_categories":["[Jenkins](#jenkins)"],"readme":"# kube-prompt\n\n![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)\n![Go Report Card](https://goreportcard.com/badge/github.com/c-bata/kube-prompt)\n\nAn interactive kubernetes client featuring auto-complete using [go-prompt](https://github.com/c-bata/go-prompt).\n\n![demo](https://github.com/c-bata/assets/raw/master/kube-prompt/kube-prompt.gif)\n\nkube-prompt accepts the same commands as the kubectl, except you don't need to provide the `kubectl` prefix.\nSo it doesn't require the additional cost to use this cli.\n\nAnd you can integrate other commands via pipe (`|`).\n\n```\n\u003e\u003e\u003e get pod | grep web\nweb-1144924021-2spbr        1/1     Running     4       25d\nweb-1144924021-5r1fg        1/1     Running     4       25d\nweb-1144924021-pqmfq        1/1     Running     4       25d\n```\n\n## Installation\n\n#### Downloading standalone binary\n\nBinaries are available from [github release](https://github.com/c-bata/kube-prompt/releases).\n\n\u003cdetails\u003e\n\u003csummary\u003emacOS (darwin) - amd64\u003c/summary\u003e\n\n```\nwget https://github.com/c-bata/kube-prompt/releases/download/v1.0.11/kube-prompt_v1.0.11_darwin_amd64.zip\nunzip kube-prompt_v1.0.11_darwin_amd64.zip\nchmod +x kube-prompt\nsudo mv ./kube-prompt /usr/local/bin/kube-prompt\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eLinux - amd64\u003c/summary\u003e\n\n```\nwget https://github.com/c-bata/kube-prompt/releases/download/v1.0.11/kube-prompt_v1.0.11_linux_amd64.zip\nunzip kube-prompt_v1.0.11_linux_amd64.zip\nchmod +x kube-prompt\nsudo mv ./kube-prompt /usr/local/bin/kube-prompt\n```\n\n\u003c/details\u003e\n\n\n\u003cdetails\u003e\n\u003csummary\u003eLinux - i386\u003c/summary\u003e\n\n```\nwget https://github.com/c-bata/kube-prompt/releases/download/v1.0.11/kube-prompt_v1.0.11_linux_386.zip\nunzip kube-prompt_v1.0.11_linux_386.zip\nchmod +x kube-prompt\nsudo mv ./kube-prompt /usr/local/bin/kube-prompt\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eLinux - arm64\u003c/summary\u003e\n\n```\nwget https://github.com/c-bata/kube-prompt/releases/download/v1.0.11/kube-prompt_v1.0.11_linux_arm64.zip\nunzip kube-prompt_v1.0.11_linux_arm64.zip\nchmod +x kube-prompt\nsudo mv ./kube-prompt /usr/local/bin/kube-prompt\n```\n\n\u003c/details\u003e\n\n#### Using Homebrew (macOS)\n\n```console\n$ brew install c-bata/kube-prompt/kube-prompt\n```\n\n#### Arch Linux\n\nAn unofficial [AUR package](https://aur.archlinux.org/packages/kube-prompt) `kube-prompt`\nis available. Install instructions can be found on the [Arch \nwiki](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages).\n\n#### Building from source\n\n```console\n$ GO111MODULE=on go build .\n```\n\nTo create a multi-platform binary, use the cross command via make:\n\n```console\n$ make cross\n```\n\n## Similar projects\n\n* [kube-shell](https://github.com/cloudnativelabs/kube-shell): An integrated shell for working with the Kubernetes written in Python using [python-prompt-toolkit](https://github.com/prompt-toolkit/python-prompt-toolkit).\n\n## Goal\n\nHopefully support following commands enough to operate kubernetes.\n\n* [x] `get`            Display one or many resources\n* [x] `describe`       Show details of a specific resource or group of resources\n* [x] `create`         Create a resource by filename or stdin\n* [x] `replace`        Replace a resource by filename or stdin.\n* [x] `patch`          Update field(s) of a resource using strategic merge patch.\n* [x] `delete`         Delete resources by filenames, stdin, resources and names, or by resources and label selector.\n* [x] `edit`           Edit a resource on the server\n* [x] `apply`          Apply a configuration to a resource by filename or stdin\n* [x] `namespace`      SUPERSEDED: Set and view the current Kubernetes namespace\n* [x] `logs`           Print the logs for a container in a pod.\n* [x] `rolling-update` Perform a rolling update of the given ReplicationController.\n* [x] `scale`          Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.\n* [x] `cordon`         Mark node as unschedulable\n* [x] `drain`          Drain node in preparation for maintenance\n* [x] `uncordon`       Mark node as schedulable\n* [x] `attach`         Attach to a running container.\n* [x] `exec`           Execute a command in a container.\n* [x] `port-forward`   Forward one or more local ports to a pod.\n* [x] `proxy`          Run a proxy to the Kubernetes API server\n* [x] `run`            Run a particular image on the cluster.\n* [x] `expose`         Take a replication controller, service, or pod and expose it as a new Kubernetes Service\n* [x] `autoscale`      Auto-scale a Deployment, ReplicaSet, or ReplicationController\n* [x] `rollout`        rollout manages a deployment\n* [x] `label`          Update the labels on a resource\n* [x] `annotate`       Update the annotations on a resource\n* [x] `config`         config modifies kubeconfig files\n* [x] `cluster-info`   Display cluster info\n* [x] `api-versions`   Print the supported API versions on the server, in the form of \"group/version\".\n* [x] `version`        Print the client and server version information.\n* [x] `explain`        Documentation of resources.\n* [x] `convert`        Convert config files between different API versions\n* [x] `top`            Display Resource (CPU/Memory/Storage) usage\n\n## Author\n\nMasashi Shibata\n\n* Twitter: [@c\\_bata\\_](https://twitter.com/c_bata_/)\n* Github: [@c-bata](https://github.com/c-bata/)\n* Facebook: [Masashi Shibata](https://www.facebook.com/masashi.cbata)\n\n## LICENSE\n\nThis software is licensed under the MIT License (See [LICENSE](./LICENSE)).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fc-bata%2Fkube-prompt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fc-bata%2Fkube-prompt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fc-bata%2Fkube-prompt/lists"}