package
1.4.0-pre-alpha-2
Repository: https://github.com/vmware-tanzu/tanzu-framework.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
Package component defines components that can be made use of in plugins.

# Functions

AppendClientMetadata adds client metadata.
ApplyDefaultConfig applies default configurations to plugin descriptor.
AskForConfirmation is used to prompt the user to confirm or deny a choice.
BinFromPluginName return a plugin binary name from its name.
BinTestFromPluginName return a plugin binary name from its name.
BuildArch returns compile time build arch or locates it.
Clean deletes all plugins and tests.
CleanCatalogCache cleans the catalog cache.
DeletePlugin deletes a plugin.
DeprecateCommand marks the command as deprecated and adds deprecation message.
DeprecateCommandWithAlternative marks the commands as deprecated and adds deprecation message with an alternative.
DeprecateFlag marks the flag as deprecated and hidden with a deprecation message.
DeprecateFlagWithAlternative marks the flag as deprecated and hidden with deprecation message recommending an alternative flag to use.
DescribePlugin describes a plugin.
DescribeTestPlugin describes a test plugin.
EnsureDistro ensures that all the distro plugins are installed.
EnsureTest ensures the right version of the test is present for the plugin.
EnsureTests ensures the plugin tests are installed.
FilterVersions returns the list of valid versions depending on whether unstable versions are requested or not.
GetCmd returns a cobra command for the plugin.
HasPluginUpdate tells whether the plugin descriptor has an update available in the given repository.
HasPluginUpdateIn checks if the plugin has an update in any of the given repositories.
HasUpdate tells whether the core plugin has an update.
InitializePlugin initializes the plugin configuration.
InstallAllMulti installs all the plugins at the latest version in all the given repositories.
InstallAllPlugins plugins with the given version finder.
InstallPlugin installs a plugin from the given repository.
InstallTest installs the test for the given plugin name.
IsDistributionSatisfied tells if a distribution is satisfied by the plugin list.
ListPlugins returns the available plugins.
ListTestPlugins returns the available test plugins.
LoadRepositories loads the repositories from the config file along with the known repositories.
LoadVersionSelector will return the correct VersionSelector for a VersionSelectorLevel.
MakeArtifactName returns an artifact name for a plugin name.
MakeTestArtifactName returns a test artifact name for a plugin name.
NewCatalog creates an instance of Catalog.
NewDefaultRepository returns the default repository.
NewGCPBucketRepository returns a new GCP bucket repository.
NewLocalRepository returns a new local repository.
NewMainUsage creates an instance of Usage.
NewMultiRepo returns a new multirepo.
NewRunner creates an instance of Runner.
NewTestFor creates a plugin descriptor for a test plugin.
ParsePluginDescriptor parses a plugin descriptor in yaml.
PluginNameFromBin returns a plugin name from the binary name.
PluginNameFromTestBin returns a plugin name from the test binary name.
ReadPluginStateFromPath read states from a path on disk.
SelectVersionAlpha specifically returns only -alpha tagged releases.
SelectVersionAny returns the latest version from a list of versions including prereleases.
SelectVersionExperimental includes all prerelease tagged plugin versions, minus +build versions.
SelectVersionStable returns the latest stable version from a list of versions.
TestCmd returns a cobra command for the plugin.
Update the core CLI.
UpgradePlugin upgrades a plugin from the given repository.
ValidatePlugin validates the plugin descriptor.
WithClientMetadata is an option to append CLI client metadata.
WithDistro sets the distro that should be installed with the CLI.
WithGCPBucket sets the gcp bucket to use for the artifact repository.
WithGCPRootPath sets the gcp bucket root path to use for the artifact repository.
WithName sets the name.
WithPluginRoot sets the root which directory plugins live in.
WithVersionSelector sets the version finder.

# Constants

AllPlugins is the keyword for all plugins.
ArtifactNamePrefix is the prefix for tanzu artifact names.
BinNamePrefix is the prefix for tanzu plugin binary names.
ClientName of the CLI.
CoreName is the name of the core binary.
DarwinAMD64 arch.
DarwinARM64 arch.
DefaultArtifactsDirectory is the root artifacts directory.
DefaultManifestQueryTimeout is max time to wait for querying for a plugin manifest.
EnvPluginStateKey is the environment key that contains the path to the plugin state file.
Linux386 arch.
LinuxAMD64 arch.
LinuxARM64 arch.
ManifestFileName is the file name for the manifest.
Name of the CLI.
PluginFileName is the file name for the plugin descriptor.
SubCmdTemplate is the template for plugin commands.
TestBinNamePrefix is the prefix for tanzu plugin binary names.
Win386 arch.
WinAMD64 arch.

# Variables

BuildDate is the date the CLI was built.
BuildSHA is the git sha the CLI was built with.
BuildVersion is the version the CLI was built with.
CoreDescriptor is the core descriptor.
CorePlugin is the core plugin.
DefaultDistro is the core set of plugins that should be included with the CLI.
DefaultLocalRepository is the default local repository.
DefaultPluginRoot is the default plugin root.
DefaultVersionSelector is the default version selector.
SubCmdUsageFunc is the usage func for a plugin.
TemplateFuncs are the template usage funcs.
VersionLatest is the latest version.

# Structs

GCPBucketRepository is a artifact repository utilizing a GCP bucket.
LocalRepository is a artifact repository utilizing a local host os.
MainUsage create the main usage display for tanzu cli.
Manifest is stored in the repository which gives an inventory of the artifacts.
MultiRepo is a multiple.
Plugin is an installable CLI plugin.
PluginState is state that will be passed to plugins.
Runner is a plugin runner.

# Interfaces

Repository is a remote repository containing plugin artifacts.

# Type aliases

Arch represents a system architecture.
CmdMap is the map of command groups to plugins.
Option is a filesystem store option.
VersionSelector returns a version from a set of versions.