This section provides useful information about developing or building the tanzu-cli project.
default target to update dependencies, build test, and lint the CLI:
make allThe names of the directories for the plugins, catalog cache, and local
plugin discovery (<XDG_DATA_HOME>/_tanzu-cli, $HOME/.cache/_tanzu,$HOME/.config/_tanzu-plugins)
are all directories prefixed with '_' for now, so as not to conflict with their nonprefixed counterparts.
This setup is temporary. We intend to unify the locations of various directories with those used by existing CLI installations once the new CLI releases can serve as drop-in replacements for the existing ones.
cmd/plugin/: code location for various plugins
Run the make build-all will build the CLI and any plugins in this directory
unlike make build which only builds the CLI
cmd/plugin/builder: code location for the builder plugin
Note on builder init:
The generated project's Makefile expects the TZBIN to be set to the name
of the CLI binary located in the user's path. Its default value is
currently set to 'tz'. This convention will allow the CLI under
development to coexist with the released tanzu CLI typically named 'tanzu'.
We should continue to adopt said convention until the CLI under
development is released as a backward-compatible replacement of the
existing CLI.
To run unit tests within the repository:
make testTo run e2e tests for the repository:
make e2e-cli-coreThe Tanzu CLI uses a system of plugins to provide functionality to interact with different Tanzu products. To install a plugin, the CLI uses an OCI discovery source, which contains the inventory of plugins. For the implementation details of the OCI discovery solution, please refer to the Centralized Discovery document.
Any changes aimed to remove functionality in the CLI (e.g. commands, command flags) have to follow the deprecation policy, For more details on the deprecation policy and process please refer to the Deprecation document.