vmware-tanzu / tanzu-cli

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
Apache License 2.0
33 stars 21 forks source link

Hide the init command #773

Closed marckhouzam closed 3 months ago

marckhouzam commented 3 months ago

What this PR does / why we need it

There was a time when the tanzu init command did a fair bit, but it is a no-op now and kept around for backward compatibility. There is however, no need to keep it visible, as it also leads to some confusion with other commands like "tanzu app init".

This commit hides the command.

We don't deprecate it because it may become useful again in the future.

Which issue(s) this PR fixes

Fixes # N/A

Describe testing done for PR

# notice there is no `init` command shown in the `system` group
$ tz
The Tanzu CLI

Usage:
  tanzu [command]

Available command groups:

  Admin
    builder                 Build Tanzu components
[...]
  System
    completion              Output shell completion code
    config                  Configuration for the CLI
    context                 Configure and manage contexts for the Tanzu CLI
    login                   Login to Tanzu Application Platform
    plugin                  Manage CLI plugins
    version                 Version information
  Target
    kubernetes              Commands that interact with a Kubernetes endpoint
    operations              Commands that support Kubernetes operations for Tanzu Application Platform

Flags:
  -h, --help   help for tanzu

Use "tanzu [command] --help" for more information about a command.

# Shell completion no longer suggests `init`
$ tz ini<TAB>

# The init command is still available to avoid breaking scripts
$ tz init
[ok] successfully initialized CLI

$ tz init -h
Initialize the CLI

Usage:
  tanzu init [flags]

Flags:
  -h, --help   help for init

Release note

Hide the `tanzu init` command which is no longer performing any actual initialization.

Additional information

Special notes for your reviewer