Argos/onl.ycode.argos/Arguments

Arguments

abstract class Arguments(appName: String = "", appDescription: String? = null, unknownOptionsAsPositionals: Boolean = false, defaultLongPrefix: String = "--", clusterChar: Char? = '-', valueSeparators: Set<Char> = setOf('=', ':'), didYouMean: Boolean = true, didYouMeanMax: Int = 2, aggregateErrors: Boolean = true, maxAggregatedErrors: Int = 20, terminal: Terminal? = null, useANSITerminal: Boolean = true, argumentFilePrefix: Char? = '@', argumentSeparator: String = "|")(source)

Constructors

Link copied to clipboard
constructor(appName: String = "", appDescription: String? = null, unknownOptionsAsPositionals: Boolean = false, defaultLongPrefix: String = "--", clusterChar: Char? = '-', valueSeparators: Set<Char> = setOf('=', ':'), didYouMean: Boolean = true, didYouMeanMax: Int = 2, aggregateErrors: Boolean = true, maxAggregatedErrors: Int = 20, terminal: Terminal? = null, useANSITerminal: Boolean = true, argumentFilePrefix: Char? = '@', argumentSeparator: String = "|")

Functions

Link copied to clipboard
fun parseWithException(argv: Array<String>): Arguments

Parses command-line arguments and throws a ParseError if parsing fails. This method validates configuration, expands argument files, and performs complete argument parsing including constraint validation.

Link copied to clipboard
fun printUsage()

Prints the basic usage information for this command-line application. Shows usage line, options, and domains but not detailed constraint information.

Link copied to clipboard
fun printUsageExtended()

Prints extended usage information including constraint details. Shows usage line, options, domains, and detailed constraint information.

Link copied to clipboard
fun selectedDomain(): String?

Returns the currently selected domain/subcommand, or null if no domain is active. This reflects which subcommand was parsed from the command line.

Link copied to clipboard
fun terminal(): Terminal

Returns the terminal instance used for formatted output. This is either the user-provided terminal or auto-detected based on ANSI support.

Link copied to clipboard
fun <T> valueSourceOf(property: KProperty0<T>): ValueSource

Returns the value source for the specified property.