core

package

Go to main page

Versions in this module

v2

v2.42.0

Jul 22, 2025

v2.41.0

Jun 23, 2025

v2.40.0

Jun 3, 2025

Changes in this version

type BeforeFunc

+ func ExecStoreBeforeCmdWithResulter(metaKey, cmd string, resulter func(any) any) BeforeFunc

type Commands

+ func (c *Commands) MergeAll(cmds ...*Commands)

v2.39.0

Apr 15, 2025

v2.38.0

Mar 26, 2025

v2.37.0

Feb 21, 2025

v2.36.0

Jan 27, 2025

Changes in this version

+ type TestMetadata map[string]interface

+ func (meta TestMetadata) Render(strTpl string) string

v2.35.0

Nov 29, 2024

Changes in this version

type BuildInfo

+ UserAgentPrefix string

v2.34.0

Sep 16, 2024

Changes in this version

+ const PrinterOptJSONPretty

+ const PrinterTypeHuman

+ const PrinterTypeJSON

+ const PrinterTypeTemplate

+ const PrinterTypeWide

+ const PrinterTypeYAML

+ const TestBucketNamePrefix

+ var AllLocalities = "all"

+ var Debug = flag.Bool("debug", os.Getenv("SCW_DEBUG") == "true", "Enable Debug Mode")

+ var DefaultRetryInterval *time.Duration

+ var UpdateCassettes = flag.Bool("cassettes", os.Getenv("CLI_UPDATE_CASSETTES") == "true", "Record Cassettes")

+ var UpdateGoldens = flag.Bool("goldens", os.Getenv("CLI_UPDATE_GOLDENS") == "true", "Record goldens")

+ func ApplyDefaultValues(ctx context.Context, argSpecs ArgSpecs, rawArgs args.RawArgs) args.RawArgs

+ func ArgIsOption(arg string) bool — darwin/amd64, linux/amd64, windows/amd64

+ func AutoCompleteArgValue(ctx context.Context, cmd *Command, argSpec *ArgSpec, argValuePrefix string, ...) []string

+ func AutocompleteGetArg(ctx context.Context, cmd *Command, argSpec *ArgSpec, ...) []string

+ func Bootstrap(config *BootstrapConfig) (exitCode int, result interface{}, err error)

+ func BuildUsageArgs(ctx context.Context, cmd *Command, deprecated bool) string

+ func CreateAndCloseFile(path string) error

+ func ExecCmd(ctx context.Context, cmd *exec.Cmd) (exitCode int, err error)

+ func ExtractAliases(ctx context.Context) *alias.Config

+ func ExtractBetaMode(ctx context.Context) bool

+ func ExtractBinaryName(ctx context.Context) string

+ func ExtractCacheDir(ctx context.Context) string

+ func ExtractCliConfig(ctx context.Context) *cliConfig.Config

+ func ExtractCliConfigPath(ctx context.Context) string

+ func ExtractClient(ctx context.Context) *scw.Client

+ func ExtractConfigPath(ctx context.Context) string

+ func ExtractConfigPathFlag(ctx context.Context) string

+ func ExtractEnv(ctx context.Context, envKey string) string

+ func ExtractHTTPClient(ctx context.Context) *http.Client

+ func ExtractProfileFlag(ctx context.Context) string

+ func ExtractProfileName(ctx context.Context) string

+ func ExtractStdin(ctx context.Context) io.Reader

+ func ExtractUserHomeDir(ctx context.Context) string

+ func GetDocGenContext() context.Context

+ func GetLatestVersionUpdateFilePath(cacheDir string) string

+ func GetOrganizationIDFromContext(ctx context.Context) string

+ func GetProjectIDFromContext(ctx context.Context) string

+ func GetRandomName(prefix string) string

+ func GetValuesForFieldByName(value reflect.Value, parts []string) (values []reflect.Value, err error)

+ func GoldenReplacePatterns(golden string, replacements ...GoldenReplacement) (string, error)

+ func InjectConfig(ctx context.Context, config *scw.Config)

+ func InjectMeta(ctx context.Context, meta *Meta) context.Context

+ func IsNotFoundError(err error) bool

+ func OptionToArgSpecName(option string) string — darwin/amd64, linux/amd64, windows/amd64

+ func ReloadClient(ctx context.Context) error

+ func RunShell(ctx context.Context, printer *Printer, meta *Meta, rootCmd *cobra.Command, ...)

+ func Test(config *TestConfig) func(t *testing.T)

+ func ValidateNoConflict(cmd *Command, rawArgs args.RawArgs) error

+ type AfterCommandCheckFunc func(ctx context.Context)

+ type AfterFunc func(ctx *AfterFuncCtx) error

+ func AfterFuncCombine(afterFuncs ...AfterFunc) AfterFunc

+ func AfterFuncWhenUpdatingCassette(afterFunc AfterFunc) AfterFunc

+ func ExecAfterCmd(cmd string) AfterFunc

+ type AfterFuncCtx struct

+ Client *scw.Client

+ CmdResult interface{}

+ ExecuteCmd func(args []string) interface{}

+ Logger *Logger

+ Meta testMetadata

+ OverrideEnv map[string]string

+ T *testing.T

+ type ArgSpec struct

+ AutoCompleteFunc AutoCompleteArgFunc

+ CanLoadFile bool

+ Default DefaultFunc

+ Deprecated bool

+ EnumValues []string

+ Name string

+ OneOfGroup string

+ Positional bool

+ Required bool

+ Short string

+ ValidateFunc ArgSpecValidateFunc

+ func OrganizationArgSpec() *ArgSpec

+ func OrganizationIDArgSpec() *ArgSpec

+ func ProjectArgSpec() *ArgSpec

+ func ProjectIDArgSpec() *ArgSpec

+ func RegionArgSpec(regions ...scw.Region) *ArgSpec

+ func WaitTimeoutArgSpec(defaultTimeout time.Duration) *ArgSpec

+ func ZoneArgSpec(zones ...scw.Zone) *ArgSpec

+ func (a *ArgSpec) ConflictWith(b *ArgSpec) bool

+ func (a *ArgSpec) IsPartOfMapOrSlice() bool

+ func (a *ArgSpec) Prefix() string

+ type ArgSpecValidateFunc func(argSpec *ArgSpec, value interface{}) error

+ func DefaultArgSpecValidateFunc() ArgSpecValidateFunc

+ func ValidateAccessKey() ArgSpecValidateFunc

+ func ValidateOrganizationID() ArgSpecValidateFunc

+ func ValidateProjectID() ArgSpecValidateFunc

+ func ValidateSecretKey() ArgSpecValidateFunc

+ type ArgSpecs []*ArgSpec

+ func (s *ArgSpecs) AddBefore(name string, argSpec *ArgSpec)

+ func (s *ArgSpecs) DeleteByName(name string)

+ func (s ArgSpecs) GetByName(name string) *ArgSpec

+ func (s ArgSpecs) GetDeprecated(deprecated bool) ArgSpecs

+ func (s ArgSpecs) GetPositionalArg() *ArgSpec

+ type AutoCompleteArgFunc func(ctx context.Context, prefix string, request any) AutocompleteSuggestions

+ func AutocompleteProfileName() AutoCompleteArgFunc

+ type AutoCompleteNode struct

+ ArgSpec *ArgSpec

+ Children map[string]*AutoCompleteNode

+ Command *Command

+ Name string

+ Type AutoCompleteNodeType

+ func BuildAutoCompleteTree(ctx context.Context, commands *Commands) *AutoCompleteNode

+ func NewAutoCompleteArgNode(cmd *Command, argSpec *ArgSpec) *AutoCompleteNode

+ func NewAutoCompleteCommandNode(flags []FlagSpec) *AutoCompleteNode

+ func NewAutoCompleteFlagNode(parent *AutoCompleteNode, flagSpec *FlagSpec) *AutoCompleteNode

+ func (node *AutoCompleteNode) GetChildMatch(name string) (*AutoCompleteNode, bool)

+ func (node *AutoCompleteNode) GetChildOrCreate(name string, aliases []string, flags []FlagSpec) *AutoCompleteNode

+ type AutoCompleteNodeType uint

+ const AutoCompleteNodeTypeArgument

+ const AutoCompleteNodeTypeCommand

+ const AutoCompleteNodeTypeFlag

+ const AutoCompleteNodeTypeFlagValueConst

+ const AutoCompleteNodeTypeFlagValueVariable

+ type AutocompleteResponse struct

+ Suggestions AutocompleteSuggestions

+ func AutoComplete(ctx context.Context, leftWords []string, wordToComplete string, ...) *AutocompleteResponse

+ type AutocompleteSuggestions []string

+ type BeforeFunc func(ctx *BeforeFuncCtx) error

+ func BeforeFuncCombine(beforeFuncs ...BeforeFunc) BeforeFunc

+ func BeforeFuncOsExec(cmd string, args ...string) BeforeFunc

+ func BeforeFuncStoreInMeta(key string, value interface{}) BeforeFunc

+ func BeforeFuncWhenUpdatingCassette(beforeFunc BeforeFunc) BeforeFunc

+ func ExecBeforeCmd(cmd string) BeforeFunc

+ func ExecBeforeCmdArgs(args []string) BeforeFunc

+ func ExecStoreBeforeCmd(metaKey, cmd string) BeforeFunc

+ type BeforeFuncCtx struct

+ Client *scw.Client

+ ExecuteCmd func(args []string) interface{}

+ Logger *Logger

+ Meta testMetadata

+ OverrideEnv map[string]string

+ T *testing.T

+ type BootstrapConfig struct

+ Args []string

+ BetaMode bool

+ BuildInfo *BuildInfo

+ Client *scw.Client

+ Commands *Commands

+ Ctx context.Context

+ DisableAliases bool

+ DisableTelemetry bool

+ HTTPClient *http.Client

+ Logger *Logger

+ OverrideEnv map[string]string

+ OverrideExec OverrideExecFunc

+ Platform platform.Platform

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ type BuildInfo struct

+ BuildDate string

+ GitBranch string

+ GitCommit string

+ GoArch string

+ GoOS string

+ GoVersion string

+ Version *version.Version

+ func ExtractBuildInfo(ctx context.Context) *BuildInfo

+ func (b *BuildInfo) GetUserAgent() string

+ func (b *BuildInfo) IsRelease() bool

+ func (b *BuildInfo) MarshalJSON() ([]byte, error)

+ func (b *BuildInfo) Tags() map[string]string

+ type CheckFuncCtx struct

+ Client *scw.Client

+ Err error

+ ExitCode int

+ LogBuffer string

+ Logger *Logger

+ Meta testMetadata

+ OverrideEnv map[string]string

+ Result interface{}

+ Stderr []byte

+ Stdout []byte

+ type CliError struct

+ Code int

+ Details string

+ Empty bool

+ Err error

+ Hint string

+ Message string

+ func ArgumentConflictError(arg1 string, arg2 string) *CliError

+ func InvalidAPIURLError(value string) *CliError

+ func InvalidAccessKeyError(value string) *CliError

+ func InvalidOrganizationIDError(value string) *CliError

+ func InvalidProjectIDError(value string) *CliError

+ func InvalidRegionError(value string) *CliError

+ func InvalidSecretKeyError(value string) *CliError

+ func InvalidValueForEnumError(argSpecName string, argSpecEnumValues []string, value string) *CliError

+ func InvalidZoneError(value string) *CliError

+ func MissingRequiredArgumentError(argumentName string) *CliError

+ func WindowIsNotSupportedError() *CliError

+ func (s *CliError) Error() string

+ func (s *CliError) MarshalHuman() (string, error)

+ func (s *CliError) MarshalJSON() ([]byte, error)

+ type Command struct

+ AcceptMultiplePositionalArgs bool

+ Aliases []string

+ AllowAnonymousClient bool

+ ArgSpecs ArgSpecs

+ ArgsType reflect.Type

+ Deprecated bool

+ DisableAfterChecks bool

+ DisableTelemetry bool

+ Examples []*Example

+ Groups []string

+ Hidden bool

+ Interceptor CommandInterceptor

+ Long string

+ Namespace string

+ PreValidateFunc CommandPreValidateFunc

+ Resource string

+ Run CommandRunner

+ SeeAlsos []*SeeAlso

+ Short string

+ ValidateFunc CommandValidateFunc

+ Verb string

+ View *View

+ WaitFunc WaitFunc

+ WaitUsage string

+ WebURL string

+ func (c *Command) AddInterceptors(interceptors ...CommandInterceptor)

+ func (c *Command) Copy() *Command

+ func (c *Command) GetCommandLine(binaryName string) string

+ func (c *Command) GetUsage(binaryName string, commands *Commands) string

+ func (c *Command) MatchAlias(alias alias.Alias) bool

+ func (c *Command) Override(builder func(command *Command) *Command)

+ type CommandInterceptor func(ctx context.Context, argsI interface{}, runner CommandRunner) (interface{}, error)

+ func CombineCommandInterceptor(interceptors ...CommandInterceptor) CommandInterceptor

+ type CommandPreValidateFunc func(ctx context.Context, argsI interface{}) error

+ type CommandRunner func(ctx context.Context, argsI interface{}) (interface{}, error)

+ type CommandValidateFunc func(ctx context.Context, cmd *Command, cmdArgs interface{}, rawArgs args.RawArgs) error

+ func DefaultCommandValidateFunc() CommandValidateFunc

+ type Commands struct

+ func ExtractCommands(ctx context.Context) *Commands

+ func NewCommands(cmds ...*Command) *Commands

+ func NewCommandsMerge(cmdsList ...*Commands) *Commands

+ func (c *Commands) Add(cmd *Command)

+ func (c *Commands) AliasIsValidCommandChild(command *Command, alias alias.Alias) bool

+ func (c *Commands) Copy() *Commands

+ func (c *Commands) Find(path ...string) *Command

+ func (c *Commands) GetAll() []*Command

+ func (c *Commands) GetSortedCommand() []*Command

+ func (c *Commands) HasSubCommands(cmd *Command) bool

+ func (c *Commands) Merge(cmds *Commands)

+ func (c *Commands) MustFind(path ...string) *Command

+ func (c *Commands) Remove(namespace, verb string)

+ func (c *Commands) RemoveResource(namespace, resource string)

+ type Completer struct — darwin/amd64, linux/amd64, windows/amd64

+ func NewShellCompleter(ctx context.Context) *Completer

+ func (c *Completer) Complete(d prompt.Document) []prompt.Suggest

+ type DefaultFunc func(ctx context.Context) (value string, doc string)

+ func DefaultValueSetter(defaultValue string) DefaultFunc

+ func RandomValueGenerator(prefix string) DefaultFunc

+ type Example struct

+ ArgsJSON string

+ Raw string

+ Short string

+ func (e *Example) GetCommandLine(binaryName string, cmd *Command) string

+ type ExecFuncCtx struct

+ Client *scw.Client

+ Meta testMetadata

+ T *testing.T

+ type FlagSpec struct

+ EnumValues []string

+ HasVariableValue bool

+ Name string

+ type GoldenReplacement struct

+ OptionalMatch bool

+ Pattern *regexp.Regexp

+ Replacement string

+ type Logger struct

+ func ExtractLogger(ctx context.Context) *Logger

+ func (l *Logger) Debug(args ...interface{})

+ func (l *Logger) Debugf(format string, args ...interface{})

+ func (l *Logger) Error(args ...interface{})

+ func (l *Logger) Errorf(format string, args ...interface{})

+ func (l *Logger) Info(args ...interface{})

+ func (l *Logger) Infof(format string, args ...interface{})

+ func (l *Logger) ShouldLog(level logger.LogLevel) bool

+ func (l *Logger) Warning(args ...interface{})

+ func (l *Logger) Warningf(format string, args ...interface{})

+ type Meta struct

+ BetaMode bool

+ BinaryName string

+ BuildInfo *BuildInfo

+ CliConfig *cliConfig.Config

+ Client *scw.Client

+ Commands *Commands

+ ConfigPathFlag string

+ Logger *Logger

+ OverrideEnv map[string]string

+ OverrideExec OverrideExecFunc

+ Platform platform.Platform

+ ProfileFlag string

+ type MultiResults []interface

+ func (mr MultiResults) MarshalHuman() (string, error)

+ type OneOfGroupManager struct

+ Groups map[string][]string

+ RequiredGroups map[string]bool

+ func NewOneOfGroupManager(cmd *Command) *OneOfGroupManager

+ func (m *OneOfGroupManager) ValidateRequiredOneOfGroups(rawArgs args.RawArgs, cmdArgs interface{}) error

+ func (m *OneOfGroupManager) ValidateUniqueOneOfGroups(rawArgs args.RawArgs, cmdArgs interface{}) error

+ type OverrideExecFunc func(cmd *exec.Cmd) (exitCode int, err error)

+ type OverrideExecTestFunc func(ctx *ExecFuncCtx, cmd *exec.Cmd) (exitCode int, err error)

+ func OverrideExecSimple(cmdStr string, exitCode int) OverrideExecTestFunc

+ type Printer struct

+ func NewPrinter(config *PrinterConfig) (*Printer, error)

+ func (p *Printer) Print(data interface{}, opt *human.MarshalOpt) error

+ type PrinterConfig struct

+ OutputFlag string

+ Stderr io.Writer

+ Stdout io.Writer

+ type PrinterType string

+ func (p PrinterType) String() string

+ type RawResult []byte

+ type SeeAlso struct

+ Command string

+ Short string

+ type ShellSuggestion struct — darwin/amd64, linux/amd64, windows/amd64

+ Arg *ArgSpec

+ Cmd *Command

+ Text string

+ type SocketPassthroughTransport struct

+ func (r *SocketPassthroughTransport) RoundTrip(request *http.Request) (*http.Response, error)

+ type SuccessResult struct

+ Details string

+ Empty bool

+ Message string

+ Resource string

+ TargetResource any

+ Verb string

+ func (s *SuccessResult) MarshalHuman() (string, error)

+ func (s *SuccessResult) MarshalJSON() ([]byte, error)

+ type TestCheck func(t *testing.T, ctx *CheckFuncCtx)

+ func TestCheckCombine(checks ...TestCheck) TestCheck

+ func TestCheckError(err error) TestCheck

+ func TestCheckExitCode(expectedCode int) TestCheck

+ func TestCheckGolden() TestCheck

+ func TestCheckGoldenAndReplacePatterns(replacements ...GoldenReplacement) TestCheck

+ func TestCheckS3Golden() TestCheck

+ func TestCheckStdout(stdout string) TestCheck

+ type TestConfig struct

+ AfterFunc AfterFunc

+ Args []string

+ BeforeFunc BeforeFunc

+ BuildInfo *BuildInfo

+ Check TestCheck

+ Client *scw.Client

+ Cmd string

+ Commands *Commands

+ Ctx context.Context

+ DefaultRegion scw.Region

+ DefaultZone scw.Zone

+ DisableParallel bool

+ EnableAliases bool

+ OverrideEnv map[string]string

+ OverrideExec OverrideExecTestFunc

+ PromptResponseMocks []string

+ Stdin io.Reader

+ TmpHomeDir bool

+ UseE2EClient bool

+ type View struct

+ Fields []*ViewField

+ Sections []*ViewSection

+ Title string

+ type ViewField struct

+ FieldName string

+ Label string

+ type ViewSection struct

+ FieldName string

+ HideIfEmpty bool

+ Title string

+ type WaitFunc func(ctx context.Context, argsI, respI interface{}) (interface{}, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL