cmd

Documentation

Overview

Package cmd is home to the full set of ytt's "commands" -- instances of cobra.Command (not to be confused with ./cmd which contains the bootstrapping for executing ytt in various environments).

A cobra.Command is the starting point of execution.

For a list of commands run:

$ ytt help

The default command is "template".

Index

• func NewCmd(o *template.Options) *cobra.Command
• func NewDefaultYttCmd() *cobra.Command
• func NewFmtCmd(o *FmtOptions) *cobra.Command
• func NewVersionCmd(o *VersionOptions) *cobra.Command
• func NewWebsiteCmd(o *WebsiteOptions) *cobra.Command
• func NewYttCmd(o *YttOptions) *cobra.Command
• type FmtOptions
  • func NewFmtOptions() *FmtOptions
  • func (o *FmtOptions) Run() error
• type VersionOptions
  • func NewVersionOptions() *VersionOptions
  • func (o *VersionOptions) Run() error
• type WebsiteOptions
  • func NewWebsiteOptions() *WebsiteOptions
  • func (o *WebsiteOptions) Run() error
  • func (o *WebsiteOptions) Server() *website.Server
• type YttOptions
  • func NewDefaultYttOptions() *YttOptions

Functions

func NewCmd

func NewCmd(o *template.Options) *cobra.Command

NewCmd construct main ytt command. It has been moved out of "template" package so that "template" package does not carry dependency on cobra. This is desirable for users who use ytt as a library.

func NewDefaultYttCmd

func NewDefaultYttCmd() *cobra.Command

func NewFmtCmd

func NewFmtCmd(o *FmtOptions) *cobra.Command

func NewVersionCmd

func NewVersionCmd(o *VersionOptions) *cobra.Command

func NewWebsiteCmd

func NewWebsiteCmd(o *WebsiteOptions) *cobra.Command

func NewYttCmd

func NewYttCmd(o *YttOptions) *cobra.Command

Types

type FmtOptions

type FmtOptions struct {
	Files      []string
	StrictYAML bool
	Debug      bool
}

func NewFmtOptions

func NewFmtOptions() *FmtOptions

func (*FmtOptions) Run

func (o *FmtOptions) Run() error

type VersionOptions

type VersionOptions struct{}

func NewVersionOptions

func NewVersionOptions() *VersionOptions

func (*VersionOptions) Run

func (o *VersionOptions) Run() error

type WebsiteOptions

type WebsiteOptions struct {
	ListenAddr      string
	RedirectToHTTPS bool
	BinaryPath      string
	CheckCookie     bool
}

func NewWebsiteOptions

func NewWebsiteOptions() *WebsiteOptions

func (*WebsiteOptions) Run

func (o *WebsiteOptions) Run() error

func (*WebsiteOptions) Server

func (o *WebsiteOptions) Server() *website.Server

type YttOptions

type YttOptions struct{}

func NewDefaultYttOptions

func NewDefaultYttOptions() *YttOptions