tanzu-cli

module

v0.0.17 Latest Latest Go to latest Published: Mar 31, 2023 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

README ¶

Tanzu Core CLI

⚠ NOTE: This repository is still under early development. We plan to make releases available for evaluation in the second quarter of 2023. Please watch this page for further updates.

Overview

The Tanzu Core CLI project provides the core functionality of the Tanzu CLI. The CLI is based on a plugin architecture where CLI command functionality can be delivered through independently developed plugin binaries. To support this architecture, this project provides releases of the core CLI binary that plugins integrate with. Said binary serves the role of

providing discovery, installation and lifecycle management of plugins on the CLI host
providing dispatching of CLI command invocation to a specific plugin
providing authentication with and managing access to endpoints which certain CLI commands will target

Development

Details about how to get started with development for this project can be found in the development guide.

Contributing

Thanks for taking the time to join our community and start contributing! We welcome pull requests. Feel free to dig through the issues and jump in.

Before you begin

Check out the contribution guidelines to learn more about how to contribute.

Directories ¶

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

Path	Synopsis
apis
cli/v1alpha1 Package v1alpha1 contains API Schema definitions for the cli v1alpha1 API group +kubebuilder:object:generate=true +groupName=cli.tanzu.vmware.com	Package v1alpha1 contains API Schema definitions for the cli v1alpha1 API group +kubebuilder:object:generate=true +groupName=cli.tanzu.vmware.com
cmd
plugin/builder
plugin/builder/command Package command provides handling to generate new scaffolding, compile, and publish CLI plugins.	Package command provides handling to generate new scaffolding, compile, and publish CLI plugins.
plugin/builder/command/publish Package publish implements plugin and plugin api publishing related function	Package publish implements plugin and plugin api publishing related function
plugin/builder/fakes Code generated by counterfeiter.	Code generated by counterfeiter.
plugin/builder/helpers Package helpers implements helper function for builder plugin	Package helpers implements helper function for builder plugin
plugin/builder/imgpkg Package imgpkg implements helper function for imgpkg cli	Package imgpkg implements helper function for imgpkg cli
plugin/builder/inventory Package inventory implements inventory specific init and update functionalities	Package inventory implements inventory specific init and update functionalities
plugin/builder/plugin Package plugin implements plugin specific publishing functions	Package plugin implements plugin specific publishing functions
plugin/builder/template Package template provides template for creating new plugins.	Package template provides template for creating new plugins.
plugin/builder/template/plugintemplates Package plugintemplates provides templates for bootstrapping plugins.	Package plugintemplates provides templates for bootstrapping plugins.
plugin/builder/types Package types defines helper structure definitions	Package types defines helper structure definitions
plugin/test
plugin/test/test
tanzu The Tanzu CLI.	The Tanzu CLI.
pkg
artifact Package artifact implements interface to fetch the binary artifacts from different sources	Package artifact implements interface to fetch the binary artifacts from different sources
auth/csp Package csp provides VMware Cloud Services Platform token utilities.	Package csp provides VMware Cloud Services Platform token utilities.
auth/tkg Package tkgauth provides TKG authentication functions.	Package tkgauth provides TKG authentication functions.
auth/utils/kubeconfig Package kubeconfig provides kubeconfig access functions.	Package kubeconfig provides kubeconfig access functions.
auth/utils/net Package net provides helpers to work with network addresses.	Package net provides helpers to work with network addresses.
auth/wcp Package wcp provides helpers to interact with a vSphere Supervisor.	Package wcp provides helpers to interact with a vSphere Supervisor.
buildinfo Package buildinfo holds global vars set at build time to provide information about the build.	Package buildinfo holds global vars set at build time to provide information about the build.
carvelhelpers Package carvelhelpers implements wrapper functions to use carvel tooling	Package carvelhelpers implements wrapper functions to use carvel tooling
catalog Package catalog implements catalog management functions	Package catalog implements catalog management functions
cli Package cli provides libraries for building CLI commands and plugins.	Package cli provides libraries for building CLI commands and plugins.
clientconfighelpers Package clientconfighelpers implements helper function related to client configurations	Package clientconfighelpers implements helper function related to client configurations
cluster Package cluster provides functions to manipulate the package	Package cluster provides functions to manipulate the package
command Package command creates and initializes the tanzu CLI.	Package command creates and initializes the tanzu CLI.
command/templates Package plugintemplates provides templates for CLI doc generation	Package plugintemplates provides templates for CLI doc generation
common Package common defines generic constants and structs	Package common defines generic constants and structs
config Package config provides functions for the tanzu cli configuration	Package config provides functions for the tanzu cli configuration
configpaths Package configpaths provides functions to handle config files	Package configpaths provides functions to handle config files
constants Package constants provides tanzu cli constants.	Package constants provides tanzu cli constants.
cosignhelper Package cosignhelper implements cosign verification functionality using cosign libraries	Package cosignhelper implements cosign verification functionality using cosign libraries
discovery Package discovery is implements discovery interface for plugin discovery Discovery is the interface to fetch the list of available plugins, their supported versions and how to download them either stand-alone or scoped to a server.	Package discovery is implements discovery interface for plugin discovery Discovery is the interface to fetch the list of available plugins, their supported versions and how to download them either stand-alone or scoped to a server.
distribution Package distribution implements plugin distribution interface Distribution is the interface to download a plugin version binary for a given OS and architecture combination.	Package distribution implements plugin distribution interface Distribution is the interface to download a plugin version binary for a given OS and architecture combination.
fakes Code generated by counterfeiter.	Code generated by counterfeiter.
fakes/helper Package helper implements helper functions used for unit tests	Package helper implements helper functions used for unit tests
interfaces Package interfaces is collection of generic interfaces	Package interfaces is collection of generic interfaces
plugininventory Package plugininventory implements an interface to deal with a plugin inventory.	Package plugininventory implements an interface to deal with a plugin inventory.
pluginmanager Package pluginmanager is responsible for plugin discovery and installation	Package pluginmanager is responsible for plugin discovery and installation
pluginsupplier Package pluginsupplier provides installed plugins information	Package pluginsupplier provides installed plugins information
registry Package registry defines a Registry interface and client for working for imkpkg images.	Package registry defines a Registry interface and client for working for imkpkg images.
utils Package utils contains utility functions	Package utils contains utility functions
test
e2e/context Package context provides context command specific E2E test cases	Package context provides context command specific E2E test cases
e2e/framework Package framework defines the integration and end-to-end test case for cli core	Package framework defines the integration and end-to-end test case for cli core
e2e/plugin_lifecycle Package plugin provides plugin command specific E2E test cases	Package plugin provides plugin command specific E2E test cases
e2e/plugins_compatibility Package plugincompatibility provides plugins compatibility E2E test cases	Package plugincompatibility provides plugins compatibility E2E test cases
e2e Module