Interface PicoCLIOptions

All Superinterfaces:
BesuService
public interface PicoCLIOptions extends BesuService
A service that plugins can use to add CLI options and commands to the BesuCommand. The PicoCLI library annotations will be inspected and the object will be passed into a picocli.CommandLine.addMixin call.

This service will be available during the registration callbacks.

CLI arguments should conform to the CLI-STYLE-GUIDE.md conventions.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addPicoCLIOptions(String namespace, Object optionObject)
    During the registration callback plugins can register CLI options that should be added to Besu's CLI startup.

  • Method Details

    • addPicoCLIOptions

      void addPicoCLIOptions(String namespace, Object optionObject)
      During the registration callback plugins can register CLI options that should be added to Besu's CLI startup.
      Parameters:
      namespace - A namespace prefix. All registered options must start with this prefix
      optionObject - The instance of the object to be inspected. PicoCLI will reflect the fields of this object to extract the CLI options.