package
2.37.0
Repository: https://github.com/scaleway/scaleway-cli.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

AfterFuncCombine combines multiple after functions into one.
No description provided by the author
ApplyDefaultValues will hydrate args with default values.
ArgIsOption returns if an argument is an option.
No description provided by the author
AutoComplete process a command line and returns autocompletion suggestions.
AutoCompleteArgValue returns suggestions for a (argument name, argument value prefix) pair.
AutocompleteGetArg tries to complete an argument by using the list verb if it exists for the same resource It will search for the same field in the response of the list Field name will be stripped of the resource name (ex: cluster-id -> id).
No description provided by the author
BeforeFuncCombine combines multiple before functions into one.
No description provided by the author
No description provided by the author
No description provided by the author
Bootstrap is the main entry point.
BuildAutoCompleteTree builds the autocomplete tree from the commands, subcommands and arguments.
BuildUsageArgs builds usage args string.
CombineCommandInterceptor will combine one or more CommandInterceptor.
CreateAndCloseFile creates a file and closes it.
DefaultArgSpecValidateFunc validates a value passed for an ArgSpec Uses ArgSpec.EnumValues.
DefaultCommandValidateFunc is the default validation function for commands.
No description provided by the author
ExecAfterCmd executes the given before command.
ExecBeforeCmd executes the given before command.
ExecBeforeCmdArgs executes the given command before command.
No description provided by the author
ExecStoreBeforeCmd executes the given before command and register the result in the context Meta at metaKey.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetDocGenContext returns a minimal context that can be used by scw-doc-gen.
No description provided by the author
No description provided by the author
No description provided by the author
GetRandomName returns a random name prefixed for the CLI.
GetValuesForFieldByName recursively search for fields in a cmdArgs' value and returns its values if they exist.
GoldenReplacePatterns replace the list of patterns with their given replacement.
injectSDKConfig add config to a Meta context.
InjectMeta creates a new ctx based on the given one with injected meta and returns it.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewAutoCompleteArgNode creates a new node corresponding to a command argument.
NewAutoCompleteCommandNode creates a new node corresponding to a command or subcommand.
NewAutoCompleteFlagNode returns a node representing a Flag.
No description provided by the author
No description provided by the author
No description provided by the author
NewPrinter returns an initialized formatter corresponding to a given FormatterType.
No description provided by the author
OptionToArgSpecName convert option to arg spec name from additional-volumes.0=hello to additional-volumes.{index} also with multiple indexes pools.0.kubelet-args.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RunShell will run an interactive shell that runs cobra commands.
Run a CLI integration test.
TestCheckCombine combines multiple check functions into one.
TestCheckError asserts error.
TestCheckExitCode assert exitCode.
TestCheckGolden assert stderr and stdout using golden.
TestCheckGoldenAndReplacePatterns assert stderr and stdout using golden, golden are matched against given regex and edited with replacements.
TestCheckS3Golden assert stderr and stdout using golden, and omits the random suffix in the bucket name.
TestCheckStdout asserts stdout using string.
ValidateAccessKey validates an access key ID.
No description provided by the author
ValidateOrganizationID validates a non-required organization ID.
ValidateProjectID validates a non-required project ID.
ValidateSecretKey validates a secret key ID.
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Option to enable pretty output on json printer.
PrinterTypeHuman defines a human readable formatted formatter.
PrinterTypeJSON defines a JSON formatter.
PrinterTypeTemplate defines a go template to use to format output.
PrinterTypeWide defines a human-readable formatted formatter without shrinking.
PrinterTypeYAML defines a YAML formatter.
No description provided by the author

# Variables

No description provided by the author
Debug set the log level to LogLevelDebug.
DefaultRetryInterval is used across all wait functions in the CLI In particular it is very handy to define this RetryInterval at 0 second while running cassette in testing because they will be executed without waiting.
UpdateCassettes will update all cassettes of a given test.
UpdateGoldens will update all the golden files of a given test.

# Structs

No description provided by the author
No description provided by the author
AutoCompleteNode is a node in the AutoComplete Tree.
AutocompleteResponse contains the autocomplete suggestions.
No description provided by the author
No description provided by the author
No description provided by the author
CheckFuncCtx contain the result of a command execution.
CliError is an all-in-one error structure that can be used in commands to return useful errors to the user.
Command represent a CLI command.
Commands represent a list of CLI commands, with a index to allow searching.
No description provided by the author
Example represents an example for the usage of a CLI command.
No description provided by the author
No description provided by the author
GoldenReplacement describe patterns to be replaced in goldens.
No description provided by the author
Meta store globally available variables like sdk client or global Flags.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TestConfig contain configuration that can be used with the Test function.
View hydrates human.MarshalOpt.
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
ArgSpecValidateFunc validates one argument of a command.
AutoCompleteArgFunc is the function called to complete arguments values.
No description provided by the author
AutocompleteSuggestions is a list of words to be set to the shell as autocomplete suggestions.
No description provided by the author
CommandInterceptor allow to intercept and manipulate a runner arguments and return value.
CommandPreValidateFunc allows to manipulate args before validation.
CommandRunner returns the command response or an error.
CommandValidateFunc validates en entire command.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Type defines an formatter format.
This type can be return by a command that need to output specific content on stdout directly.
TestCheck is a function that perform assertion on a CheckFuncCtx.
TestMetadata contains arbitrary data that can be passed along a test lifecycle.
WaitFunc returns the updated response (respI if unchanged) or an error.