cmd

Documentation

Index

• Constants
• type REPLCmd
  • func (c *REPLCmd) Execute(args []string) error
• type RunCmd
  • func (c *RunCmd) Execute(args []string) error
• type VersionCmd
  • func (c *VersionCmd) Execute(args []string) error

Constants

const (
	REPLCmdShortDescription = "Run as interactive shell."
	REPLCmdLongDescription  = REPLCmdShortDescription + "\n\n" +
		"The REPL shell provides the same capabilities as the regular `run`\n" +
		"command."
)

Command descriptions used in the flags.Parser.AddCommand.

const (
	RunCmdShortDescription = "Run parses, resolves, and executes a Starlark file."
	RunCmdLongDescription  = RunCmdShortDescription + "\n\n" +
		"When a provider is instantiated is automatically installed, at the \n" +
		"default location (~/.terraform.d/plugins), this can be overrided \n" +
		"using the flag `--plugin-dir=<PATH>`. \n\n" +
		"The Starlark file can be \"transpiled\" to a HCL file using the flag \n" +
		"`--to-hcl=<FILE>`. This file can be used directly with Terraform init \n" +
		"and plan commands.\n"
)

Command descriptions used in the flags.Parser.AddCommand.

const (
	VersionCmdShortDescription = "Version prints information about this binary."
	VersionCmdLongDescription  = VersionCmdShortDescription + "\n\n" +
		"Includes build information about AsCode like version and build\n" +
		"date but also versions from the Go runtime and other dependencies."
)

Command descriptions used in the flags.Parser.AddCommand.

Types

type REPLCmd

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

REPLCmd implements the command `repl`.

func (*REPLCmd) Execute

func (c *REPLCmd) Execute(args []string) error

Execute honors the flags.Commander interface.

type RunCmd

type RunCmd struct {
	ToHCL          string `long:"to-hcl" description:"dumps resources to a hcl file"`
	PrintHCL       bool   `long:"print-hcl" description:"prints resources to a hcl file"`
	NoValidate     bool   `long:"no-validate" description:"skips the validation of the resources"`
	PositionalArgs struct {
		File string `positional-arg-name:"file" description:"starlark source file"`
	} `positional-args:"true" required:"1"`
	// contains filtered or unexported fields
}

RunCmd implements the command `run`.

func (*RunCmd) Execute

func (c *RunCmd) Execute(args []string) error

Execute honors the flags.Commander interface.

type VersionCmd

type VersionCmd struct{}

VersionCmd implements the command `version`.

func (*VersionCmd) Execute

func (c *VersionCmd) Execute(args []string) error

Execute honors the flags.Commander interface.