Documentation
¶
Index ¶
- Constants
- func AddFlags(cmd *cobra.Command)
- func FlagToEnvVarName(f *pflag.Flag) string
- func NewCmdBuild() *cobra.Command
- func NewCmdCompletion() *cobra.Command
- func NewCmdConfig() *cobra.Command
- func NewCmdCredits() *cobra.Command
- func NewCmdDebug() *cobra.Command
- func NewCmdDelete() *cobra.Command
- func NewCmdDeploy() *cobra.Command
- func NewCmdDev() *cobra.Command
- func NewCmdDiagnose() *cobra.Command
- func NewCmdFilter() *cobra.Command
- func NewCmdFindConfigs() *cobra.Command
- func NewCmdFix() *cobra.Command
- func NewCmdGeneratePipeline() *cobra.Command
- func NewCmdInit() *cobra.Command
- func NewCmdList() *cobra.Command
- func NewCmdOptions() *cobra.Command
- func NewCmdRender() *cobra.Command
- func NewCmdRun() *cobra.Command
- func NewCmdSchema() *cobra.Command
- func NewCmdSchemaGet() *cobra.Command
- func NewCmdSchemaList() *cobra.Command
- func NewCmdSet() *cobra.Command
- func NewCmdSurvey() *cobra.Command
- func NewCmdUnset() *cobra.Command
- func NewCmdVersion() *cobra.Command
- func NewSkaffoldCommand(out, err io.Writer) *cobra.Command
- type Builder
- type Flag
Constants ¶
const (
HouseKeepingMessagesAllowedAnnotation = "skaffold_annotation_housekeeping_allowed"
)
Annotation for commands that should allow post execution housekeeping messages like updates and surveys
Variables ¶
This section is empty.
Functions ¶
func AddFlags ¶ added in v0.30.0
AddFlags adds to the command the common flags that are annotated with the command name.
func FlagToEnvVarName ¶ added in v0.20.0
func NewCmdBuild ¶ added in v0.6.0
NewCmdBuild describes the CLI command to build artifacts.
func NewCmdCompletion ¶ added in v0.4.0
NewCmdCompletion returns the cobra command that outputs shell completion code
func NewCmdConfig ¶ added in v0.13.0
func NewCmdCredits ¶ added in v1.0.0
func NewCmdDebug ¶ added in v0.26.0
NewCmdDebug describes the CLI command to run a pipeline in debug mode. Unlike `dev`, `debug` defaults `auto-build` and `auto-deploy` to `false`.
func NewCmdDelete ¶ added in v0.7.0
NewCmdDelete describes the CLI command to delete deployed resources.
func NewCmdDeploy ¶ added in v0.7.0
NewCmdDeploy describes the CLI command to deploy artifacts.
func NewCmdDiagnose ¶ added in v0.16.0
NewCmdDiagnose describes the CLI command to diagnose skaffold.
func NewCmdFilter ¶ added in v1.7.1
NewCmdFilter describes the CLI command to filter and transform a set of Kubernetes manifests.
func NewCmdFindConfigs ¶ added in v0.32.0
NewCmdFindConfigs list the skaffold config files in the specified directory.
func NewCmdGeneratePipeline ¶ added in v0.36.0
func NewCmdInit ¶ added in v0.14.0
NewCmdInit describes the CLI command to generate a Skaffold configuration.
func NewCmdList ¶ added in v0.31.0
func NewCmdOptions ¶ added in v0.34.0
func NewCmdRender ¶ added in v0.39.0
NewCmdRender describes the CLI command to build artifacts render Kubernetes manifests.
func NewCmdSchema ¶ added in v1.1.0
func NewCmdSchemaGet ¶ added in v1.1.0
func NewCmdSchemaList ¶ added in v1.1.0
func NewCmdSurvey ¶ added in v1.7.1
func NewCmdUnset ¶ added in v0.31.0
func NewCmdVersion ¶
Types ¶
type Builder ¶ added in v0.31.0
type Builder interface {
WithDescription(description string) Builder
WithLongDescription(long string) Builder
WithExample(comment, command string) Builder
WithFlags(adder func(*pflag.FlagSet)) Builder
WithHouseKeepingMessages() Builder
WithCommonFlags() Builder
Hidden() Builder
ExactArgs(argCount int, action func(context.Context, io.Writer, []string) error) *cobra.Command
NoArgs(action func(context.Context, io.Writer) error) *cobra.Command
}
Builder is used to build cobra commands.
type Flag ¶ added in v0.30.0
type Flag struct {
Name string
Shorthand string
Usage string
Value interface{}
DefValue interface{}
DefValuePerCommand map[string]interface{}
FlagAddMethod string
DefinedOn []string
Hidden bool
// contains filtered or unexported fields
}
Flag defines a Skaffold CLI flag which contains a list of subcommands the flag belongs to in `DefinedOn` field.