Tanzu Core CLI

Overview

The Tanzu CLI provides integrated and unified command-line access to a broad array of products and solutions in the VMware Tanzu portfolio. 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

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

To facilitate plugin development, the Core CLI also provides

1. the ability to scaffold new plugin projects and plugin commands themselves.
2. the capability to build, test, and publish the plugins being developed.

Installation

For information on how to install the CLI, see the Installation Guide

Documentation

To get a quick start on how to use Tanzu CLI, visit the Quick Start guide or visit the Full Documentation for more details.

For users of previous version of the CLI, see this section of the Quick Start guide for changes to be aware of.

Plugin Development

To learn more about how to develop a Tanzu CLI plugin, see the Tanzu plugin development guide.

Testing

Plugin developers can use the End-to-End test framework to implement tests for the functionality of their plugins under a Tanzu CLI installation. More details found in the End-to-End framework and test case implementation. Currently, CLI E2E framework does not support backward compatibility.

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.
• Check out the document here about the project's support process.

Development

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

Testing

Unit and Integration tests implementation is part of CLI Core development. CLI core does have end-to-end test case implementation. More details found in the End-to-End framework and test case implementation.