Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI flag to list available plugins #2086

Closed
camilamacedo86 opened this issue Mar 14, 2021 · 2 comments
Closed

CLI flag to list available plugins #2086

camilamacedo86 opened this issue Mar 14, 2021 · 2 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@camilamacedo86
Copy link
Member

camilamacedo86 commented Mar 14, 2021

Currently, the CLI does not provide an easy for we to check the available plugins. So, I was thinking that this need could be addressed by a list plugins flag;

kubebuilder plugins list 

ps.: after we address #1378 we might want to have other options as well such as to add or remove an external plugin.

@camilamacedo86 camilamacedo86 added the kind/feature Categorizes issue or PR as related to a new feature. label Mar 14, 2021
@Adirio
Copy link
Contributor

Adirio commented Mar 15, 2021

What about the output of kubebuilder --help?

@camilamacedo86
Copy link
Member Author

IHMO it sill not very clear for the end users. However, it is fine. I think we do not need to move forward with it before 2.0..

$ kubebuilder --help
CLI tool for building Kubernetes extensions and tools.

Usage:
  kubebuilder [flags]

Examples:
The first step is to initialize your project:
    kubebuilder init [--plugins=<PLUGIN KEYS> [--project-version=<PROJECT VERSION>]]

<PLUGIN KEYS> is a comma-separated list of plugin keys from the following table
and <PROJECT VERSION> a supported project version for these plugins.

                   Plugin keys | Supported project versions
-------------------------------+----------------------------
 declarative.kubebuilder.io/v1 |                       2, 3
          go.kubebuilder.io/v2 |                       2, 3
          go.kubebuilder.io/v3 |                          3

For more specific help for the init command of a certain plugins and project version
configuration please run:
    kubebuilder init --help --plugins=<PLUGIN KEYS> [--project-version=<PROJECT VERSION>]

Default plugin keys: "go.kubebuilder.io/v3"
Default project version: "3"

After the project has been initialized, run
    kubebuilder --help
to obtain further info about available commands.

Flags:
  -h, --help                     help for kubebuilder
      --plugins strings          plugin keys to be used for this subcommand execution
      --project-version string   project version (default "3")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

No branches or pull requests

2 participants