spin

README

Spinnaker CLI

This is under active development, and not yet intended for production use.

Edit pipelines, applications & intents.

Development

Fetch the code

go get github.com/spinnaker/spin

Note: If you are using two-factor authentication with ssh keys to authenticate with GitHub, you may need to run the following git command:

git config --global --add url."git@github.com:".insteadOf "https://github.com/"

for the go get command to work properly.

Enter the code's directory

cd $GOPATH/src/github.com/spinnaker/spin

Fetch dependencies and build with with

go get -d -v
go build -v

from the root spin/ directory.

Run using

./spin <cmds> <flags>

Test using

go test -v ./...

from the root spin/ directory.

Configuration

The configuration file for this CLI should live in $HOME/.spin/config. We include a template with all the configuration options in the config/ directory.

Here is also a small example of a configuration file:

# ~/.spin/config

# Example using x509 authentication.
auth:
  enabled: true
  x509:
    keyPath: ~/.spin/keyfile
    certPath: ~/.spin/certfile

Usage

Download the spin binary from a release:

export VERSION=<desired spin version tag> # Select a tag from the released version, e.g. v0.1.0
curl -L https://github.com/spinnaker/spin/releases/download/$VERSION/spin -o spin
chmod +x ./spin
./spin --help