flags

package
v1.7.0-beta.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 23, 2026 License: MPL-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Add 

func Add(cmd *cobra.Command, defs ...Flag)

Add registers the given flag definitions on the command's local flags.

func AddPersistent 

func AddPersistent(cmd *cobra.Command, defs ...Flag)

AddPersistent registers the given flag definitions on the command's persistent flags (inherited by subcommands).

func BindEnv 

func BindEnv(fs *pflag.FlagSet, flagName string)

BindEnv wires the canonical DEVSY_* env var into a cobra flag. Call it immediately after the flag's *Var registration. If the env var is set, the value is applied to the flag (Changed=true, satisfying MarkFlagRequired) and the usage string advertises the env var.

Failure modes are loud by design:

  • panics if the flag is not registered (programmer bug at startup);
  • log.Fatalf if the env value is rejected by the flag's type (operator bug; e.g. DEVSY_DEBUG=garbage on a bool flag). This matches the contract of the prior inheritFlagsFromEnvironment loop so misconfigured env vars are never silently ignored.

func EnvName 

func EnvName(flagName string) string

EnvName returns the canonical env var name for a flag under the uniform rule: 

config.EnvPrefix + uppercase(flagName) with "-" replaced by "_"

Example: "agent-url" -> "DEVSY_AGENT_URL".

func RegisterDevContainerModifierFlags 

func RegisterDevContainerModifierFlags(fs *flag.FlagSet, opts DevContainerModifierFlags)

Types

type BoolFlag 

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

BoolFlag defines a bool flag.

func Bool 

func Bool(dest *bool, name string, def bool, usage string) *BoolFlag

Bool binds a bool flag to dest.

func (*BoolFlag) Hidden 

func (f *BoolFlag) Hidden() *BoolFlag

Hidden marks the flag hidden from help output.

func (*BoolFlag) Shorthand 

func (f *BoolFlag) Shorthand(s string) *BoolFlag

Shorthand sets a single-letter shorthand.

type DevContainerModifierFlags 

type DevContainerModifierFlags struct {
	Image               *string
	Features            *string
	UserEnvProbe        *string
	IDLabels            *[]string
	ContainerDataFolder *string
}

type DurationFlag 

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

DurationFlag defines a time.Duration flag.

func Duration 

func Duration(dest *time.Duration, name string, def time.Duration, usage string) *DurationFlag

Duration binds a time.Duration flag to dest.

func (*DurationFlag) Hidden 

func (f *DurationFlag) Hidden() *DurationFlag

Hidden marks the flag hidden from help output.

type Flag 

type Flag interface {
	// contains filtered or unexported methods
}

type Int64Flag 

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

Int64Flag defines an int64 flag.

func Int64 

func Int64(dest *int64, name string, def int64, usage string) *Int64Flag

Int64 binds an int64 flag to dest.

func (*Int64Flag) Hidden 

func (f *Int64Flag) Hidden() *Int64Flag

Hidden marks the flag hidden from help output.

type IntFlag 

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

IntFlag defines an int flag.

func Int 

func Int(dest *int, name string, def int, usage string) *IntFlag

Int binds an int flag to dest.

func (*IntFlag) Hidden 

func (f *IntFlag) Hidden() *IntFlag

Hidden marks the flag hidden from help output.

type StringArrayFlag 

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

StringArrayFlag defines a repeatable string array flag.

func StringArray 

func StringArray(dest *[]string, name string, def []string, usage string) *StringArrayFlag

StringArray binds a repeatable string array flag.

func (*StringArrayFlag) Hidden 

func (f *StringArrayFlag) Hidden() *StringArrayFlag

Hidden marks the flag hidden from help output.

func (*StringArrayFlag) Shorthand 

func (f *StringArrayFlag) Shorthand(s string) *StringArrayFlag

Shorthand sets a single-letter shorthand.

type StringFlag 

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

StringFlag defines a string flag.

func String 

func String(dest *string, name, def, usage string) *StringFlag

String binds a string flag to dest.

func (*StringFlag) Hidden 

func (f *StringFlag) Hidden() *StringFlag

Hidden marks the flag hidden from help output.

func (*StringFlag) Shorthand 

func (f *StringFlag) Shorthand(s string) *StringFlag

Shorthand sets a single-letter shorthand (e.g. "L" for -L).

type StringSliceFlag 

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

StringSliceFlag defines a comma-separated / repeatable string slice flag.

func StringSlice 

func StringSlice(dest *[]string, name string, def []string, usage string) *StringSliceFlag

StringSlice binds a comma-separated string slice flag to dest.

func (*StringSliceFlag) Hidden 

func (f *StringSliceFlag) Hidden() *StringSliceFlag

Hidden marks the flag hidden from help output.

func (*StringSliceFlag) Shorthand 

func (f *StringSliceFlag) Shorthand(s string) *StringSliceFlag

Shorthand sets a single-letter shorthand.

type ValueFlag 

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

ValueFlag defines a flag backed by a custom pflag.Value implementation.

func Value 

func Value(value flag.Value, name, usage string) *ValueFlag

Value binds a custom pflag.Value flag.

func (*ValueFlag) Hidden 

func (f *ValueFlag) Hidden() *ValueFlag

Hidden marks the flag hidden from help output.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.