Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/c-bata/kube-prompt
An interactive kubernetes client featuring auto-complete.
https://github.com/c-bata/kube-prompt
command-line-tool golang kubectl kubernetes prompt
Last synced: 28 days ago
JSON representation
An interactive kubernetes client featuring auto-complete.
- Host: GitHub
- URL: https://github.com/c-bata/kube-prompt
- Owner: c-bata
- License: mit
- Created: 2017-08-14T16:32:33.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-07-30T13:55:04.000Z (3 months ago)
- Last Synced: 2024-10-01T15:02:55.059Z (about 1 month ago)
- Topics: command-line-tool, golang, kubectl, kubernetes, prompt
- Language: Go
- Homepage:
- Size: 227 KB
- Stars: 1,787
- Watchers: 22
- Forks: 134
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kube-prompt
An interactive kubernetes client featuring auto-complete using [go-prompt](https://github.com/c-bata/go-prompt).
kube-prompt accepts the same commands as the kubectl, except you don't need to provide the `kubectl` prefix.
So it doesn't require the additional cost to use this cli.
And you can integrate other commands via pipe (`|`).
```
>>> get pod | grep web
web-1144924021-2spbr 1/1 Running 4 25d
web-1144924021-5r1fg 1/1 Running 4 25d
web-1144924021-pqmfq 1/1 Running 4 25d
```
## Installation
#### Downloading standalone binary
Binaries are available from [github release](https://github.com/c-bata/kube-prompt/releases).
macOS (darwin) - amd64
```
wget https://github.com/c-bata/kube-prompt/releases/download/v1.0.11/kube-prompt_v1.0.11_darwin_amd64.zip
unzip kube-prompt_v1.0.11_darwin_amd64.zip
chmod +x kube-prompt
sudo mv ./kube-prompt /usr/local/bin/kube-prompt
```
Linux - amd64
```
wget https://github.com/c-bata/kube-prompt/releases/download/v1.0.11/kube-prompt_v1.0.11_linux_amd64.zip
unzip kube-prompt_v1.0.11_linux_amd64.zip
chmod +x kube-prompt
sudo mv ./kube-prompt /usr/local/bin/kube-prompt
```
Linux - i386
```
wget https://github.com/c-bata/kube-prompt/releases/download/v1.0.11/kube-prompt_v1.0.11_linux_386.zip
unzip kube-prompt_v1.0.11_linux_386.zip
chmod +x kube-prompt
sudo mv ./kube-prompt /usr/local/bin/kube-prompt
```
Linux - arm64
```
wget https://github.com/c-bata/kube-prompt/releases/download/v1.0.11/kube-prompt_v1.0.11_linux_arm64.zip
unzip kube-prompt_v1.0.11_linux_arm64.zip
chmod +x kube-prompt
sudo mv ./kube-prompt /usr/local/bin/kube-prompt
```
#### Using Homebrew (macOS)
```console
$ brew install c-bata/kube-prompt/kube-prompt
```
#### Arch Linux
An unofficial [AUR package](https://aur.archlinux.org/packages/kube-prompt) `kube-prompt`
is available. Install instructions can be found on the [Arch
wiki](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages).
#### Building from source
```console
$ GO111MODULE=on go build .
```
To create a multi-platform binary, use the cross command via make:
```console
$ make cross
```
## Similar projects
* [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).
## Goal
Hopefully support following commands enough to operate kubernetes.
* [x] `get` Display one or many resources
* [x] `describe` Show details of a specific resource or group of resources
* [x] `create` Create a resource by filename or stdin
* [x] `replace` Replace a resource by filename or stdin.
* [x] `patch` Update field(s) of a resource using strategic merge patch.
* [x] `delete` Delete resources by filenames, stdin, resources and names, or by resources and label selector.
* [x] `edit` Edit a resource on the server
* [x] `apply` Apply a configuration to a resource by filename or stdin
* [x] `namespace` SUPERSEDED: Set and view the current Kubernetes namespace
* [x] `logs` Print the logs for a container in a pod.
* [x] `rolling-update` Perform a rolling update of the given ReplicationController.
* [x] `scale` Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.
* [x] `cordon` Mark node as unschedulable
* [x] `drain` Drain node in preparation for maintenance
* [x] `uncordon` Mark node as schedulable
* [x] `attach` Attach to a running container.
* [x] `exec` Execute a command in a container.
* [x] `port-forward` Forward one or more local ports to a pod.
* [x] `proxy` Run a proxy to the Kubernetes API server
* [x] `run` Run a particular image on the cluster.
* [x] `expose` Take a replication controller, service, or pod and expose it as a new Kubernetes Service
* [x] `autoscale` Auto-scale a Deployment, ReplicaSet, or ReplicationController
* [x] `rollout` rollout manages a deployment
* [x] `label` Update the labels on a resource
* [x] `annotate` Update the annotations on a resource
* [x] `config` config modifies kubeconfig files
* [x] `cluster-info` Display cluster info
* [x] `api-versions` Print the supported API versions on the server, in the form of "group/version".
* [x] `version` Print the client and server version information.
* [x] `explain` Documentation of resources.
* [x] `convert` Convert config files between different API versions
* [x] `top` Display Resource (CPU/Memory/Storage) usage
## Author
Masashi Shibata
* Twitter: [@c\_bata\_](https://twitter.com/c_bata_/)
* Github: [@c-bata](https://github.com/c-bata/)
* Facebook: [Masashi Shibata](https://www.facebook.com/masashi.cbata)
## LICENSE
This software is licensed under the MIT License (See [LICENSE](./LICENSE)).