Documentation
¶
Index ¶
- Constants
- func AddFlags(cmd *cobra.Command)
- func FlagToEnvVarName(f *pflag.Flag) string
- func NewCmdApply() *cobra.Command
- 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 NewCmdExec() *cobra.Command
- func NewCmdFilter() *cobra.Command
- func NewCmdFindConfigs() *cobra.Command
- func NewCmdFix() *cobra.Command
- func NewCmdGeneratePipeline() *cobra.Command
- func NewCmdInit() *cobra.Command
- func NewCmdInspect() *cobra.Command
- func NewCmdLSP() *cobra.Command
- func NewCmdLint() *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 NewCmdTest() *cobra.Command
- func NewCmdUnset() *cobra.Command
- func NewCmdVerify() *cobra.Command
- func NewCmdVersion() *cobra.Command
- func NewSkaffoldCommand(out, errOut io.Writer) *cobra.Command
- func ResetFlagDefaults(cmd *cobra.Command, flags []*Flag)
- func ShouldSuppressErrorReporting(c *cobra.Command) bool
- type Builder
- type DefaultRepoFn
- type Flag
- type Nillable
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 ¶
AddFlags adds to the command the common flags that are annotated with the command name.
func FlagToEnvVarName ¶
func NewCmdApply ¶
NewCmdApply describes the CLI command to apply manifests to a cluster.
func NewCmdBuild ¶
NewCmdBuild describes the CLI command to build artifacts.
func NewCmdCompletion ¶
NewCmdCompletion returns the cobra command that outputs shell completion code
func NewCmdConfig ¶
func NewCmdCredits ¶
func NewCmdDebug ¶
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 ¶
NewCmdDelete describes the CLI command to delete deployed resources.
func NewCmdDeploy ¶
NewCmdDeploy describes the CLI command to deploy artifacts.
func NewCmdDiagnose ¶
NewCmdDiagnose describes the CLI command to diagnose skaffold.
func NewCmdExec ¶ added in v2.4.0
NewCmdExec describes the CLI command to execute a custom action.
func NewCmdFilter ¶
NewCmdFilter describes the CLI command to filter and transform a set of Kubernetes manifests.
func NewCmdFindConfigs ¶
NewCmdFindConfigs list the skaffold config files in the specified directory.
func NewCmdGeneratePipeline ¶
func NewCmdInit ¶
NewCmdInit describes the CLI command to generate a Skaffold configuration.
func NewCmdInspect ¶
func NewCmdLint ¶
func NewCmdList ¶
func NewCmdOptions ¶
func NewCmdRender ¶
NewCmdRender describes the CLI command to build artifacts render Kubernetes manifests.
func NewCmdSchema ¶
func NewCmdSchemaGet ¶
func NewCmdSchemaList ¶
func NewCmdSurvey ¶
func NewCmdTest ¶
NewCmdTest describes the CLI command to test artifacts.
func NewCmdUnset ¶
func NewCmdVerify ¶
NewCmdVerify describes the CLI command to verify artifacts.
func NewCmdVersion ¶
func ResetFlagDefaults ¶
Types ¶
type Builder ¶
type Builder interface {
WithArgs(cobra.PositionalArgs, func(context.Context, io.Writer, []string) error) *cobra.Command
WithDescription(description string) Builder
WithLongDescription(long string) Builder
WithExample(comment, command string) Builder
WithFlagAdder(adder func(*pflag.FlagSet)) Builder
WithFlags([]*Flag) 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
WithCommands(cmds ...*cobra.Command) *cobra.Command
WithPersistentFlagAdder(adder func(*pflag.FlagSet)) Builder
WithPostRunHook(hook func(error) error) Builder
SuppressErrorReporting() Builder
}
Builder is used to build cobra commands.
type DefaultRepoFn ¶
DefaultRepoFn takes an image tag and returns either a new tag with the default repo prefixed, or the original tag if no default repo is specified.
type Flag ¶
type Flag struct {
Name string
Shorthand string
Usage string
Value interface{}
DefValue interface{}
DefValuePerCommand map[string]interface{}
DeprecatedPerCommand map[string]interface{}
NoOptDefVal string
FlagAddMethod string
Deprecated string
DefinedOn []string
Hidden bool
IsEnum bool
}
Flag defines a Skaffold CLI flag which contains a list of subcommands the flag belongs to in `DefinedOn` field. See https://pkg.go.dev/github.com/spf13/pflag#Flag
Source Files
¶
- apply.go
- build.go
- cmd.go
- commands.go
- completion.go
- config.go
- credits.go
- debug.go
- delete.go
- deploy.go
- dev.go
- diagnose.go
- exec.go
- filter.go
- find_configs.go
- fix.go
- flags.go
- generate_pipeline.go
- init.go
- inspect.go
- inspect_build_env.go
- inspect_config_dependencies.go
- inspect_execution_modes.go
- inspect_job_manifest_paths.go
- inspect_modules.go
- inspect_namespaces.go
- inspect_profiles.go
- inspect_tests.go
- lint.go
- lsp.go
- render.go
- run.go
- runner.go
- schema.go
- survey.go
- test.go
- util.go
- verify.go
- version.go
Directories