alaminopu/kctl

A CLI wrapper for making kubernetes commands much easier

kctl

A CLI wrapper for making kubernetes commands much easier

Usage

$ kctl --help
USAGE:
    kctl [OPTIONS] <command> [ARGS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -n, --namespace <namespace>    Specify the namespace to work on [default: default]

ARGS:
    <command>    Input command you want to run! [possible values: pod, svc, deploy, log, exec, forward, set-
                 namespace]
    <app>        Get specific app pods
    <port>       Get port number for port forwarding

Demo

Usage Docs

Installation

Homebrew

brew tap alaminopu/kctl https://github.com/alaminopu/kctl.git  
brew install kctl

Manual

Before building the tool, install rust and cargo

On Linux and macOS systems, this is done as follows:

curl https://sh.rustup.rs -sSf | sh

Then run

cargo build --release 

You will find the binary in /target folder

Update permission

chmod a+x kctl

Move the binary to /usr/local/bin to make it executable from any terminal window

mov kctl /usr/local/bin

Contributing

• Fork the repo
• Create an issue in the issue section
• Write code and commit changes
• Send an PR to the master branch

Authors

• Md. Al-Amin alaminopu
• Arvind Thangamani dnivra26

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

kctl's Issues

Add Integration tests

https://mattgathu.github.io/testing-rust-cli-apps/
https://crates.io/crates/assert_cmd

Separate each command in different files

Currently, main.rs is too big. We should create an individual file for each command.

Handle exit codes properly

Failed commands should have an non-zero exit code.
In our case
kctl gives an exit code of 1.
while
kctl log gives an exit code of 0. (command fails because app name is not specified)

Decouple clap from the core logic

Right now the core logic has clap tightly coupled with it. Planning to move it out and make the core logic independent of clap

Support setting namespace on the fly

Currently, the namespace is defined as hard coded .

Planning to set the namespace with a command

kctl set-namespace -n <namespace>

Example:

kctl set-namespace -n food

Save namespace value in the config ~/.kctlconf

Read the namespace value from config ~/.kctlconf

Add Brew support for easier installation

Brew supports third party taps. https://docs.brew.sh/Taps