A CLI for managing declarative infrastructure.
Go to file
Pete Birley a1c9e41957 Gerrit: Add .gitreview file
This PS adds a gitreview file for AirshipCTL.

Change-Id: Ib968f07083668591a73858f0b0647ae1d8e3655a
Signed-off-by: Pete Birley <pete@port.direct>
2019-06-25 08:11:57 -05:00
cmd Add kubeadm command 2019-06-13 14:46:07 -05:00
docs Remove argo 2019-06-13 08:12:45 -05:00
pkg Add argo as a subcommand 2019-06-13 08:58:19 -05:00
test Move workflow listing to its own package 2019-05-31 15:57:07 -05:00
tools Enable the linter, and fix uncovered linting issues 2019-05-30 10:02:54 -05:00
.gitignore Remove old .gitignores 2019-06-06 09:30:51 -05:00
.gitreview Gerrit: Add .gitreview file 2019-06-25 08:11:57 -05:00
.travis.yml Add .travis.yml 2019-06-06 09:21:20 -05:00
Dockerfile Update the Dockerfile to account for static builds 2019-05-17 10:19:58 -05:00
Makefile Remove coverage tests 2019-06-06 08:59:59 -05:00
README.md Add detailed documentation on plugins 2019-06-07 11:35:51 -05:00
go.mod Add kubeadm command 2019-06-13 14:46:07 -05:00
go.sum Add kubeadm command 2019-06-13 14:46:07 -05:00
main.go Add a convenience NewAirshipCTLCommand function 2019-06-07 14:06:37 -05:00


Build Status


Custom Plugins Tutorial

This tutorial walks through a very basic plugin for airshipctl. For a more involved example, see Plugin Support

The following steps will get you started with a very rudimentary example plugin for airshipctl. First, create a directory for your project outside of the GOPATH:

mkdir /tmp/example
cd /tmp/example

This project will need to be a go module. You can initialize a module named example with the following:

go mod init example

Note that modules are a relatively new feature added to Go, so you'll need to be running Go1.11 or greater. Also note that most modules will follow a naming schema that matches the remote version control system. A more realistice module name might look something like github.com/ian-howell/exampleplugin.

Next, create a file main.go and populate it with the following:

package main

import (


func main() {
	rootCmd, _, err := cmd.NewRootCmd(os.Stdout)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Failed to create root airshipctl command: %s\n", err.Error())

	exampleCmd := &cobra.Command{
		Use:   "example",
		Short: "an example plugin",
		Run: func(cmd *cobra.Command, args []string) {
			fmt.Fprintln(os.Stdout, "Hello airshipctl!")

	if err := rootCmd.Execute(); err != nil {
		fmt.Fprintf(os.Stderr, "Failure during execution: %s\n", err.Error())

And finally, run the build command to download and compile airshipctl:

go build -o airshipctl

Now that you've built airshipctl, you can access your plugin with the following command:

./airshipctl example

You may have noticed that this example ignores the second return value from cmd.NewRootCmd. This value is a pointer to the AirshipCTLSettings, which contains various configuration details, such as the debug flag and the path to the config file*. A useful paradigm involves embedding this object into a custom ExampleSettings struct. This can be seen in the demo repo.

For a more involved example, see Plugin Support

* Work in progress