cmd

Documentation

Overview

Example (Diff)

package main

import (
	"os"

	"github.com/aws-cloudformation/rain/cmd"
)

func main() {
	os.Args = []string{
		os.Args[0],
		"diff",
		"../examples/success.template",
		"../examples/failure.template",
	}

	cmd.Execute()
}

Output:

(>) Description: This template fails
(-) Parameters: {...}
(|) Resources:
(|)   Bucket1:
(-)     Properties: {...}
(+)   Bucket2:
(+)     Properties:
(+)       BucketName: !Ref Bucket1
(+)     Type: "AWS::S3::Bucket"

Example (Tree)

package main

import (
	"os"

	"github.com/aws-cloudformation/rain/cmd"
)

func main() {
	os.Args = []string{
		os.Args[0],
		"tree",
		"../examples/success.template",
	}

	cmd.Execute()
}

Output:

Resources:
  Bucket1:
    DependsOn:
      Parameters:
        - BucketName

Index

• Variables
• func Execute()

Examples

• Package (Diff)
• Package (Tree)

Variables

var Root = &cobra.Command{
	Use:  "rain",
	Long: "Rain is a development workflow tool for working with AWS CloudFormation.",
}

Root represents the base command when called without any subcommands

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the Root.