An open API service indexing awesome lists of open source software.

https://github.com/pumpkinseed/kcs

Command-line tool collects set of example usages of kubectl, searchable
https://github.com/pumpkinseed/kcs

cli-tool devops-tools kubectl kubernetes

Last synced: 5 months ago
JSON representation

Command-line tool collects set of example usages of kubectl, searchable

Awesome Lists containing this project

README

          

# kcs - kubectl Cheatsheet CLI

Command-line tool collects set of example usages of kubectl

### Features

- Searchable
- Easy to read
- Verbose mode for description

### Installation

Requirement:
- Golang 1.13

```
git clone git@github.com:PumpkinSeed/kcs.git && cd kcs
make install
```

### Usage

```
$ kcs help
NAME:
kcs - Searchable kubectl cheatsheet CLI tool

COMMANDS:
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--verbose, -v Set verbose mode (default: false)
--search value, -s value Set search query
--category value Set a certain category
--command value Set a certain command
--help, -h show help (default: false)
```

```
$ kcs # prints everything out
$ kcs -v # add description to the commands
$ kcs --category config # prints out the config realted commands
$ kcs --category config --command view # prints out the config's view command
$ kcs --search services # search in the whole content and prints everything satisfied the search term
```

**Usage**

![Usage](assets/usage.gif)

**Usage of search**

![Search Usage](assets/search-usage.gif)