Skip to content

Commit c172492

Browse files
authored
Update README.md
1 parent 10feacc commit c172492

File tree

1 file changed

+11
-57
lines changed

1 file changed

+11
-57
lines changed

README.md

+11-57
Original file line numberDiff line numberDiff line change
@@ -2,71 +2,25 @@
22

33
[![.github/workflows/test.yaml](https://github.com/keisku/kubectl-explore/actions/workflows/test.yaml/badge.svg)](https://github.com/keisku/kubectl-explore/actions/workflows/test.yaml)
44

5-
Fuzzy-find the field to explain from all API resources.
6-
75
![demo](./demo.gif)
86

9-
### See also
10-
11-
- [kubectl explore, a better kubectl explain](https://keisku.medium.com/kubectl-explore-a-better-kubectl-explain-46a939fafe3a)
12-
- [kubectl explain にあいまい検索(fuzzy-find)機能を追加したプラグイン kubectl-explore を作った](https://zenn.dev/kskumgk63/articles/d52be6c4a31bbb)
13-
14-
## Motivation
7+
## What’s lacking in the original `kubectl-explain`?
158

16-
- `kubectl explain` needs knowing in advance the resources name/fields.
17-
- `kubectl explain` needs typing the accurate path to the resource name/field, which is a tedious and typo-prone.
18-
19-
## Usage
20-
21-
```
22-
Fuzzy-find the field to explain from all API resources.
9+
- `kubectl explain` requires knowing in advance the resource name/fields.
10+
- `kubectl explain` requires typing the accurate path to the resource name/field, which is a tedious and typo-prone.
2311

24-
Usage:
25-
kubectl explore [resource|regex] [flags]
12+
## Example Usage
2613

27-
Examples:
28-
29-
# Fuzzy-find the field to explain from all API resources.
14+
```bash
15+
# Fuzzy-find a resource, then a field to explain
3016
kubectl explore
3117

32-
# Fuzzy-find the field to explain from pod.
18+
# Fuzzy-find from all fields of a specific resource.
3319
kubectl explore pod
20+
kubectl explore sts
3421

35-
# Fuzzy-find the field to explain from fields matching the regex.
36-
kubectl explore pod.*node
37-
kubectl explore spec.*containers
38-
kubectl explore lifecycle
22+
# Fuzzy-find from fields that a given regex matches.
3923
kubectl explore sts.*Account
40-
41-
# Fuzzy-find the field to explain from all API resources in the selected cluster.
42-
kubectl explore --context=onecontext
43-
44-
45-
Flags:
46-
--api-version string Get different explanations for particular API version (API group/version)
47-
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
48-
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
49-
--as-uid string UID to impersonate for the operation.
50-
--cache-dir string Default cache directory (default "/root/.kube/cache")
51-
--certificate-authority string Path to a cert file for the certificate authority
52-
--client-certificate string Path to a client certificate file for TLS
53-
--client-key string Path to a client key file for TLS
54-
--cluster string The name of the kubeconfig cluster to use
55-
--context string The name of the kubeconfig context to use
56-
--disable-compression If true, opt-out of response compression for all requests to the server
57-
--disable-print-path Disable printing the path to explain
58-
-h, --help help for kubectl
59-
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
60-
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
61-
--match-server-version Require server version to match client version
62-
-n, --namespace string If present, the namespace scope for this CLI request
63-
--password string Password for basic authentication to the API server
64-
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
65-
-s, --server string The address and port of the Kubernetes API server
66-
--tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
67-
--token string Bearer token for authentication to the API server
68-
--user string The name of the kubeconfig user to use
69-
--username string Username for basic authentication to the API server
7024
```
7125

7226
## Installation
@@ -93,7 +47,7 @@ nix-env -iA nixpkgs.kubectl-explore
9347

9448
Download the binary from [GitHub Releases](https://github.com/keisku/kubectl-explore/releases) and drop it in your `$PATH`.
9549

96-
```shell
50+
```bash
9751
# Other available architectures are linux_arm64, darwin_amd64, darwin_arm64, windows_amd64.
9852
export ARCH=linux_amd64
9953
# Check the latest version, https://github.com/keisku/kubectl-explore/releases/latest
@@ -103,7 +57,7 @@ wget -O- "https://github.com/keisku/kubectl-explore/releases/download/${VERSION}
10357

10458
From source.
10559

106-
```shell
60+
```bash
10761
go install github.com/keisku/kubectl-explore@latest
10862
sudo mv $GOPATH/bin/kubectl-explore /usr/local/bin
10963
```

0 commit comments

Comments
 (0)