Desktop CLI client for Containerum platform
Switch branches/tags
Clone or download
Latest commit e46faf2 Jul 25, 2018

README.md

chkit

Build Status LOC GitHub release License: MIT

Chkit is a desktop CLI client for Containerum.

Prerequisites

  • Containerum
  • Windows/Linux/MacOS
  • Golang >= 1.8

Installation

To get chkit source:

go get -u -v github.com/containerum/chkit

or

# in $GOPATH/src/containerum
git clone https://github.com/containerum/chkit.git

To build chkit from sources:

cd $GOPATH/src/containerum/chkit
make single_release CONTAINERUM_API="https://api.containerum.io"  
# or your Containerum API URL

then extract executable from tar.gz archive in ./build to $GOPATH/bin or another $PATH dir

To delete chkit:

Just delete executable file from your $GOPATH/bin

Configuring chkit

Using chkit with your own Kubernetes cluster

Before using chkit to work with Containerum you have to specify the address of your API. You can do that as follows:

  • run
chkit set api YOUR_API_ADDRESS

or

  • build chkit with env:
export CONTAINERUM_API="YOUR_API_ADDRESS"
make release

Using chkit with Containerum Online

By default chkit connects to Containerum Online platform.

Configuraton and logs

OS Config file path Logs path
Linux ~/.config/containerum/config.toml ~/.config/containerum/support
Windows /Users/$USERNAME/AppData/Local/containerum/config.toml /Users/$USERNAME/AppData/Local/containerum/suppport
Mac OS /Library/Application Support/containerum/config.toml /Library/Logs/containerum

Docs

To learn more about chkit commands, please refer to the Docs section on our website.

Contributions

Please submit all contributions concerning chkit component to this repository. If you want to make contributions to the project, please start by checking the source code at chkit/pkg/cli/. Contributing guidelines are available here.

License

Chkit project is licensed under the terms of the MIT license. Please see LICENSE in this repository for more details.