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

Package-level declarations

Types

class CodyzeCli(val configFile: Path?) : CliktCommand

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

class CodyzeOptionGroup : OptionGroup

class ConfigFileParser : CliktCommand

A CliktCommand to parse the --config option.

class JsonValueSource(filePath: Path, root: JsonObject) : ValueSource

A ValueSource that uses Kotlin serialization to parse JSON config files as context to Clikt commands.

Every Backend must provide BackendCommand to be selectable in the CLI.

Each Executor must provide a ExecutorCommand to be selectable in the CLI.

List all available OutputBuilders. They convert the internally used SARIF format into the final output.

val plugins: List<Module>

List all available Plugins. They use external tools to extend the analysis.

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.

Entry point for Codyze.