cmd

Documentation

Index

• Constants
• type CLI
  • func NewCLI(outStream io.Writer, errStream io.Writer) *CLI
  • func (cli *CLI) Run(args []string) int
• type Options

Constants

const (
	ExitCodeOK    int = 0
	ExitCodeError int = 1 + iota
	ExitCodeIssuesFound
)

Exit codes are int values that represent an exit code for a particular error.

Types

type CLI

type CLI struct {
	// contains filtered or unexported fields
}

CLI is the command line object

func NewCLI

func NewCLI(outStream io.Writer, errStream io.Writer) *CLI

NewCLI returns new CLI initialized by input streams

func (*CLI) Run

func (cli *CLI) Run(args []string) int

Run invokes the CLI with the given arguments.

type Options

type Options struct {
	Version       bool     `short:"v" long:"version" description:"Print TFLint version"`
	Langserver    bool     `long:"langserver" description:"Start language server"`
	Format        string   `short:"f" long:"format" description:"Output format" choice:"default" choice:"json" choice:"checkstyle" default:"default"`
	Config        string   `short:"c" long:"config" description:"Config file name" value-name:"FILE" default:".tflint.hcl"`
	IgnoreModules []string `long:"ignore-module" description:"Ignore module sources" value-name:"SOURCE"`
	EnableRules   []string `long:"enable-rule" description:"Enable rules from the command line" value-name:"RULE_NAME"`
	DisableRules  []string `long:"disable-rule" description:"Disable rules from the command line" value-name:"RULE_NAME"`
	Varfiles      []string `long:"var-file" description:"Terraform variable file name" value-name:"FILE"`
	Variables     []string `long:"var" description:"Set a Terraform variable" value-name:"'foo=bar'"`
	Module        bool     `long:"module" description:"Inspect modules"`
	Deep          bool     `long:"deep" description:"Enable deep check mode"`
	AwsAccessKey  string   `long:"aws-access-key" description:"AWS access key used in deep check mode" value-name:"ACCESS_KEY"`
	AwsSecretKey  string   `long:"aws-secret-key" description:"AWS secret key used in deep check mode" value-name:"SECRET_KEY"`
	AwsProfile    string   `long:"aws-profile" description:"AWS shared credential profile name used in deep check mode" value-name:"PROFILE"`
	AwsCredsFile  string   `long:"aws-creds-file" description:"AWS shared credentials file path used in deep checking" value-name:"FILE"`
	AwsRegion     string   `long:"aws-region" description:"AWS region used in deep check mode" value-name:"REGION"`
	Force         bool     `long:"force" description:"Return zero exit status even if issues found"`
	NoColor       bool     `long:"no-color" description:"Disable colorized output"`
}

Options is an option specified by arguments.