jayjay
/
k9s
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs

mine
derailed 2020-05-23 11:42:10 -06:00
parent 46c2f31249
commit 01cdc5b86e
2 changed files with 42 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -3,7 +3,7 @@ PACKAGE := github.com/derailed/$(NAME)
GIT := $(shell git rev-parse --short HEAD)
SOURCE_DATE_EPOCH ?= $(shell date +%s)
DATE := $(shell date -u -d @${SOURCE_DATE_EPOCH} +%FT%T%Z)
VERSION ?= v0.19.1
VERSION ?= v0.19.7
IMG_NAME := derailed/k9s
IMAGE := ${IMG_NAME}:${VERSION}

31
README.md
View File

@ -63,21 +63,24 @@ K9s is available on Linux, macOS and Windows platforms.
scoop install k9s
```
* Building from source
K9s was built using go 1.13 or above. In order to build K9 from source you must:
1. Clone the repo
2. Add the following command in your go.mod file
```text
replace (
github.com/derailed/k9s => MY_K9S_CLONED_GIT_REPO
)
```
3. Build and run the executable
* Via a GO install
```shell
go run main.go
# NOTE: The dev version will be in effect!
go get -u github.com/derailed/k9s
```
---
## Building From Source
K9s is currently using go v1.14 or above. In order to build K9 from source you must:
1. Clone the repo
2. Build and run the executable
```shell
make build && ./k9s
```
---
@ -159,7 +162,7 @@ k9s -l debug
K9s uses aliases to navigate most K8s resources.
| Action | Command | Comment |
|---------------------------------------------------------------|-----------------------|-------------------------------------------------------------|
|---------------------------------------------------------------|-------------------------------|------------------------------------------------------------------------|
| Show active keyboard mnemonics and help | `?` | |
| Show all available resource alias | `ctrl-a` | |
| To bail out of K9s | `:q`, `ctrl-c` | |