Package convex.cli

Class Main

java.lang.Object
convex.cli.ACommand
convex.cli.Main
All Implemented Interfaces:
Runnable
public class Main extends ACommand
Convex CLI implementation This is the main `convex` command and root for child commands.

  • Field Details

    • commandLine

      public picocli.CommandLine commandLine

  • Constructor Details

    • Main

      public Main()

  • Method Details

    • execute

      public void execute()
      Description copied from class: ACommand
      Execute this command. Subclasses should override this to provide specific command functionality
      Specified by:
      execute in class ACommand

    • main

      public static void main(String[] args)
      Java main(...) entry point when run as a Java application. Exits JVM process with specified exit code
      Parameters:
      args - Command line arguments

    • mainExecute

      public int mainExecute(String[] args)
      Command line execution entry point. Can be run from Java code without terminating the JVM.
      Parameters:
      args - Command line arguments
      Returns:
      Process result value

    • isParanoid

      public boolean isParanoid()
      Description copied from class: ACommand
      Checks if the CLI is in strict (paranoid) mode
      Overrides:
      isParanoid in class ACommand
      Returns:
      true iff in strict mode

    • isColoured

      public boolean isColoured()
      Description copied from class: ACommand
      Checks if the CLI should output ANSI colours
      Overrides:
      isColoured in class ACommand
      Returns:

    • commandLine

      public picocli.CommandLine commandLine()
      Overrides:
      commandLine in class ACommand

    • isInteractive

      public boolean isInteractive()
      Description copied from class: ACommand
      Checks if the CLI is in interactive mode (user input permitted)
      Overrides:
      isInteractive in class ACommand
      Returns:
      True if in interactive mode

    • verbose

      protected int verbose()
      Description copied from class: ACommand
      Gets the current verbosity level for the CLI
      Overrides:
      verbose in class ACommand
      Returns:

    • setOut

      public void setOut(String outFile)
      Sets output to the specified file.
      Parameters:
      outFile - String specifying file. `-` or `null` specifies STDOUT

    • cli

      public Main cli()
      Description copied from class: ACommand
      Gets the current CLI main command instance
      Specified by:
      cli in class ACommand
      Returns:
      CLI instance