update README & docs (#977)

sunny0826 · Jun 12, 2024 · d92ee47 · d92ee47
1 parent 0ab23a3
commit d92ee47
Show file tree

Hide file tree

Showing 35 changed files with 49 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6065/badge)](https://bestpractices.coreinfrastructure.org/projects/6065)
 [![All Contributors](https://img.shields.io/github/all-contributors/sunny0826/kubecm?color=ee8449&style=flat-square)](#contributors)
 
-![demo](docs/static/Interaction.gif)
+![demo](docs/static/interaction-lates.gif)
 
 ## 🚀 Install
 
@@ -48,8 +48,7 @@ For full documentation, please visit the KubeCM website: [https://kubecm.cloud](
 
 ## 🎬 Demo 
 
-[![asciicast](https://asciinema.org/a/389595.svg)](https://asciinema.org/a/389595)
-
+[![asciicast](https://asciinema.org/a/663642.svg)](https://asciinema.org/a/663642)
 
 ## 🤝 Contribute
 

diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -8,5 +8,5 @@
 ![GitHub](https://img.shields.io/github/license/sunny0826/kubecm.svg?style=flat-square&logo=apache)
 [![GitHub release](https://img.shields.io/github/release/sunny0826/kubecm?style=flat-square&logo=github)](https://github.com/sunny0826/kubecm/releases)
 
-[GitHub](https://github.com/sunny0826/kubecm)
-[Get Started](en-us/README)
+[👨‍💻 GitHub](https://github.com/sunny0826/kubecm)
+[🚀 Get Started](en-us/introduction)
diff --git a/docs/_navbar.md b/docs/_navbar.md
@@ -1,4 +1,2 @@
-- [Home](/)
-- Language
-  - [中文](/zh-cn/)
-  - [English](/en-us/)
+- [🏡 Home](/)
+- [💫 Contribute](/en-us/contribute.md)
diff --git a/docs/en-us/README.md b/docs/en-us/README.md
@@ -56,7 +56,7 @@ Use "kubecm [command] --help" for more information about a command.
 
 ## Demo
 
-<script id="asciicast-389595" src="https://asciinema.org/a/389595.js" async></script>
+<script src="https://asciinema.org/a/vL1vJZA1KeeFka9C0Wx3SSWto.js" id="asciicast-vL1vJZA1KeeFka9C0Wx3SSWto" async="true"></script>
 
 ## Install
 Using [Krew](https://krew.sigs.k8s.io/):

diff --git a/docs/en-us/cli/kubecm.md b/docs/en-us/cli/kubecm.md
@@ -22,6 +22,7 @@ KubeConfig Manager.
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -h, --help            help for kubecm
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update

diff --git a/docs/en-us/cli/kubecm_add.md b/docs/en-us/cli/kubecm_add.md
@@ -50,6 +50,7 @@ cat /etc/kubernetes/admin.conf | kubecm add -f -
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_add_docs.md b/docs/en-us/cli/kubecm_add_docs.md
@@ -32,6 +32,7 @@ kubecm add docs
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
   -c, --cover           overwrite local kubeconfig files
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_alias.md b/docs/en-us/cli/kubecm_alias.md
@@ -32,6 +32,7 @@ $ kubecm alias -o bash
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_alias_docs.md b/docs/en-us/cli/kubecm_alias_docs.md
@@ -31,6 +31,7 @@ kubecm add docs
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_clear.md b/docs/en-us/cli/kubecm_clear.md
@@ -14,7 +14,7 @@ kubecm clear
 
 ```
 
-# Clear lapsed context, cluster and user (default is /Users/I576375/.kube/config)
+# Clear lapsed context, cluster and user (default is /Users/guoxudong/.kube/config)
 kubecm clear
 # Customised clear lapsed files
 kubecm clear config.yaml test.yaml
@@ -31,6 +31,7 @@ kubecm clear config.yaml test.yaml
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_clear_docs.md b/docs/en-us/cli/kubecm_clear_docs.md
@@ -31,6 +31,7 @@ kubecm add docs
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_cloud.md b/docs/en-us/cli/kubecm_cloud.md
@@ -19,6 +19,7 @@ Manage kubeconfig from cloud
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_cloud_add.md b/docs/en-us/cli/kubecm_cloud_add.md
@@ -61,6 +61,7 @@ kubecm cloud add --provider alibabacloud --cluster_id=xxxxxx
 ```
       --cluster_id string   kubernetes cluster id
       --config string       path of kubeconfig (default "$HOME/.kube/config")
+      --create              Create a new kubeconfig file if not exists
   -m, --mac-notify          enable to display Mac notification banner
       --provider string     public cloud
       --region_id string    cloud region id

diff --git a/docs/en-us/cli/kubecm_cloud_docs.md b/docs/en-us/cli/kubecm_cloud_docs.md
@@ -32,6 +32,7 @@ kubecm add docs
 ```
       --cluster_id string   kubernetes cluster id
       --config string       path of kubeconfig (default "$HOME/.kube/config")
+      --create              Create a new kubeconfig file if not exists
   -m, --mac-notify          enable to display Mac notification banner
       --provider string     public cloud
       --region_id string    cloud region id

diff --git a/docs/en-us/cli/kubecm_cloud_list.md b/docs/en-us/cli/kubecm_cloud_list.md
@@ -46,6 +46,7 @@ kubecm cloud list --provider alibabacloud --cluster_id=xxxxxx
 ```
       --cluster_id string   kubernetes cluster id
       --config string       path of kubeconfig (default "$HOME/.kube/config")
+      --create              Create a new kubeconfig file if not exists
   -m, --mac-notify          enable to display Mac notification banner
       --provider string     public cloud
       --region_id string    cloud region id

diff --git a/docs/en-us/cli/kubecm_create.md b/docs/en-us/cli/kubecm_create.md
@@ -39,6 +39,7 @@ kubecm create --user test --namespace default --cluster-role view --context-name
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_delete.md b/docs/en-us/cli/kubecm_delete.md
@@ -33,6 +33,7 @@ kubecm delete my-context1 my-context2
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_delete_docs.md b/docs/en-us/cli/kubecm_delete_docs.md
@@ -31,6 +31,7 @@ kubecm add docs
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_docs.md b/docs/en-us/cli/kubecm_docs.md
@@ -31,6 +31,7 @@ kubecm add docs
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_export.md b/docs/en-us/cli/kubecm_export.md
@@ -32,6 +32,7 @@ kubecm export -f myconfig.yaml my-context1 my-context2
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_export_docs.md b/docs/en-us/cli/kubecm_export_docs.md
@@ -31,6 +31,7 @@ kubecm add docs
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_list.md b/docs/en-us/cli/kubecm_list.md
@@ -21,6 +21,8 @@ kubecm ls
 kubecm l
 # Filter out keywords(Multi-keyword support)
 kubecm ls kind k3s
+# Useful environment variables
+KUBECM_DISABLE_K8S_MORE_INFO: it will disable the k8s more info in the output
 
 ```
 
@@ -34,6 +36,7 @@ kubecm ls kind k3s
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_list_docs.md b/docs/en-us/cli/kubecm_list_docs.md
@@ -31,6 +31,7 @@ kubecm add docs
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_merge.md b/docs/en-us/cli/kubecm_merge.md
@@ -49,6 +49,7 @@ kubecm merge test.yaml --context context1,context2
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_merge_docs.md b/docs/en-us/cli/kubecm_merge_docs.md
@@ -31,6 +31,7 @@ kubecm add docs
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_rename.md b/docs/en-us/cli/kubecm_rename.md
@@ -29,6 +29,7 @@ kubecm rename
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_rename_docs.md b/docs/en-us/cli/kubecm_rename_docs.md
@@ -31,6 +31,7 @@ kubecm add docs
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_switch.md b/docs/en-us/cli/kubecm_switch.md
@@ -33,6 +33,7 @@ kubecm switch dev
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_switch_docs.md b/docs/en-us/cli/kubecm_switch_docs.md
@@ -31,6 +31,7 @@ kubecm add docs
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/cli/kubecm_version.md b/docs/en-us/cli/kubecm_version.md
@@ -20,6 +20,7 @@ kubecm version [flags]
 
 ```
       --config string   path of kubeconfig (default "$HOME/.kube/config")
+      --create          Create a new kubeconfig file if not exists
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

diff --git a/docs/en-us/install.md b/docs/en-us/install.md
@@ -4,6 +4,9 @@ Multiple installation paths are available.
 
 #### ** Krew **
 
+[![homebrew downloads](https://img.shields.io/homebrew/installs/dy/kubecm?style=for-the-badge&logo=homebrew&label=homebrew)](https://formulae.brew.sh/formula/kubecm)
+[![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/sunny0826/kubecm/total?style=for-the-badge&logo=github&label=github%20download)](https://github.com/sunny0826/kubecm/releases)
+
 Using [Krew](https://krew.sigs.k8s.io/):
 
 ```bash

diff --git a/docs/en-us/introduction.md b/docs/en-us/introduction.md
@@ -4,23 +4,15 @@ It also supports kubeconfig management from cloud.
 
 ## Quick start
 
-### Install
+![demo](../static/interaction-lates.gif)
 
-Using [Krew](https://krew.sigs.k8s.io/):
+### 💫 Highlights
 
-```bash
-kubectl krew install kc
-```
-
-Using Homebrew:
-
-```bash
-brew install kubecm
-```
-
-Source binary:
-
-[Download the binary](https://github.com/sunny0826/kubecm/releases)
+- **Context Management**: Switch between Kubernetes **clusters** and **namespaces** in a single command.
+- **Merge-Kubeconfig**: Merge multiple kubeconfig files into one.
+- **Interactive Mode**: Interactively select the context you want to switch to.
+- **Multi-Platform**: Support Linux, macOS, and Windows.
+- **Auto-Completion**: Support auto-completion for Bash, Zsh, and Fish.
 
 ### Add kubeconfig
 
@@ -57,10 +49,11 @@ kubecm ns
 # change to namespace of kube-system
 kubecm ns kube-system
 ```
-![ns](../../static/ns.gif)
+![ns](../../static/ns-lates.gif)
+
 
 ### Interactive operation
 
-<script id="asciicast-389595" src="https://asciinema.org/a/389595.js" async></script>
+<script src="https://asciinema.org/a/vL1vJZA1KeeFka9C0Wx3SSWto.js" id="asciicast-vL1vJZA1KeeFka9C0Wx3SSWto" async="true"></script>
 
 more commands, please see [CLI References](./cli/kubecm_add.md)
diff --git a/docs/static/interaction-lates.gif b/docs/static/interaction-lates.gif
diff --git a/docs/static/lates.gif b/docs/static/lates.gif
diff --git a/docs/static/ns-lates.gif b/docs/static/ns-lates.gif