codyze-cli/de.fraunhofer.aisec.codyze.cli/CodyzeCli

CodyzeCli

class CodyzeCli(val configFile: Path?) : CliktCommand(source)

Main CliktCommand. Provides the common Codyze options. Each executor must provide a CliktCommand that is registered as a subcommand on CodyzeCli.

The configFile is actually parsed in the ConfigFileParser command and then passed to this class as an argument

Constructors

CodyzeCli

constructor(configFile: Path?)

Properties

allowMultipleSubcommands

open override val allowMultipleSubcommands: Boolean = true

autoCompleteEnvvar

open val autoCompleteEnvvar: String?

codyzeOptions

val codyzeOptions: CodyzeOptionGroup

commandName

val commandName: String

configFile

val configFile: Path?

currentContext

val currentContext: Context

helpTags

open val helpTags: Map<String, String>

hiddenFromHelp

open val hiddenFromHelp: Boolean

invokeWithoutSubcommand

open val invokeWithoutSubcommand: Boolean

messages

val messages: List<String>

printHelpOnEmptyArgs

open override val printHelpOnEmptyArgs: Boolean = true

treatUnknownOptionsAsArgs

open val treatUnknownOptionsAsArgs: Boolean

usedExecutors

val usedExecutors: MutableList<ExecutorCommand<*>>

Functions

aliases

open fun aliases(): Map<String, List<String>>

allHelpParams

open fun allHelpParams(): List<HelpFormatter.ParameterHelp>

commandHelp

open fun ~~commandHelp~~(context: Context): String

commandHelpEpilog

open fun ~~commandHelpEpilog~~(context: Context): String

configFileOption

fun CliktCommand.configFileOption(): OptionWithValues<Path, Path, Path>

The Clikt option for the config file. Defined as extension function because it is used in multiple CliktCommands.

configureContext

fun configureContext(block: Context.Builder.() -> Unit)

echo

fun echo()

fun echo(message: Any?, trailingNewline: Boolean, err: Boolean)

echoFormattedHelp

fun echoFormattedHelp(error: CliktError?)

getFormattedHelp

fun getFormattedHelp(error: CliktError?): String?

help

open override fun help(context: Context): String

helpEpilog

open fun helpEpilog(context: Context): String

issueMessage

fun issueMessage(message: String)

registerArgument

fun registerArgument(argument: Argument)

registeredArguments

fun registeredArguments(): List<Argument>

registeredOptions

fun registeredOptions(): List<Option>

registeredParameterGroups

fun registeredParameterGroups(): List<ParameterGroup>

registeredSubcommandNames

fun registeredSubcommandNames(): List<String>

registeredSubcommands

fun registeredSubcommands(): List<CoreCliktCommand>

registerOption

open override fun registerOption(option: GroupableOption)

fun registerOption(option: Option)

registerOptionGroup

fun registerOptionGroup(group: ParameterGroup)

resetContext

fun resetContext(parent: Context?): Context

run

open override fun run()

toString

open override fun toString(): String