Last modified April 4, 2017

gsctl Reference

Command Reference

  • create: Create things
    • cluster: Create a new cluster (Details)
    • keypair: Create and download new key pair
    • kubeconfig: Create/download new key pair and update kubectl configuration
  • delete: Delete things
    • cluster: Delete cluster (Details)
  • info: Print some information
  • list: List things, like organizations, clusters, key pairs
  • login: Sign in as a user
  • logout: Sign the current user out
  • ping: Check API connection
  • version: Print version number

Check gsctl <command> --help for details.

Installing and Updating

gsctl comes as a self-contained binary for Mac, Linux, and Windows. Below you find installation instructions for different platforms. If you want to build gsctl from source, find everything you need in its GitHub repository.

The current gsctl version is 0.4.0. Find details in the release notes.

Homebrew provides the most convenient way to install gsctl and keep it up to date. To install, use this command:

brew tap giantswarm/giantswarm
brew install gsctl

For updating:

brew upgrade gsctl

Execute the commands below to install the latest released version. The same commands work for upgrading from a previously installed version.

curl -O http://downloads.giantswarm.io/gsctl/0.4.0/gsctl-0.4.0-darwin-amd64.tar.gz
tar xzf gsctl-0.4.0-darwin-amd64.tar.gz
sudo cp gsctl-0.4.0-darwin-amd64/gsctl /usr/local/bin/

Execute the commands below to install the latest released version. The same commands work for upgrading from a previously installed version.

curl -O http://downloads.giantswarm.io/gsctl/0.4.0/gsctl-0.4.0-linux-amd64.tar.gz
tar xzf gsctl-0.4.0-linux-amd64.tar.gz
sudo cp gsctl-0.4.0-linux-amd64/gsctl /usr/local/bin/
  • Download the 64 bit or 32 bit version of gsctl for Windows
  • Copy the contained gsctl.exe to a convenient location that's in your %PATH%, or add the gsctl.exe location to your %PATH%

Configuration

gsctl keeps it’s own settings under $HOME/.gsctl/config.yaml. Note that manual changes to this file will likely be overwritten.

Additionally, the following environment variables can be used:

  • GSCTL_DISABLE_COLORS: When this variable is set to any non-empty string, all terminal output will be monochrome.
  • GSCTL_DISABLE_CMDLINE_TRACKING: When this variable is set to any non-empty string, command lines won’t be submitted to the API. Otherwise command lines are submitted to learn about the tool’s usage and find ways to improve.

Known Bugs and Limitations

  • gsctl#7: No colored output on Windows
  • Not all API responses (error cases) are handled properly. If you experience a “Unknown Status code” or similar error message, please report this in an issue. Thanks!
  • Check our issues for more

Changelog

You’ll find info on changes in the release description.

Feedback

We welcome your feedback on gsctl. If you feel like sharing openly, use the GitHub repository and create an issue, so other users can participate. Otherwise please use the common Giant Swarm support channels.