Argos/onl.ycode.argos

Package-level declarations

Types

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 = "|")

ArityListOptionBuilder

class ArityListOptionBuilder<T : Any> : PropertyDelegateProvider<Arguments, ReadOnlyProperty<Arguments, List<List<T>>?>>

Builder for arity-based list options that return nullable lists of lists.

ArityOptionBuilder

class ArityOptionBuilder<T> : PropertyDelegateProvider<Arguments, ReadOnlyProperty<Arguments, List<T>?>>

Builder for arity-based options that return nullable lists of values.

AritySetOptionBuilder

class AritySetOptionBuilder<T : Any> : PropertyDelegateProvider<Arguments, ReadOnlyProperty<Arguments, Set<List<T>>?>>

Builder for arity-based set options that return nullable sets of lists.

CollectionOptionBuilder

abstract class CollectionOptionBuilder<T : Any, C : Collection<T>> : PropertyDelegateProvider<Arguments, ReadOnlyProperty<Arguments, C>>

Abstract base class for collection option builders (List and Set).

Completions

object Completions

Utilities for generating shell completion scripts from Arguments definitions.

CountBuilder

class CountBuilder : PropertyDelegateProvider<Arguments, ReadOnlyProperty<Arguments, Int>>

Builder for creating command-line count options with various configurations and constraints.

DomainBuilder

class DomainBuilder : PropertyDelegateProvider<Arguments, ReadOnlyProperty<Arguments, Boolean>>

Builder for creating command-line domains (subcommands) with various configurations and constraints.

Help

object Help

Utilities for generating formatted help text and error messages.

NonNullableArityListOptionBuilder

class NonNullableArityListOptionBuilder<T : Any> : PropertyDelegateProvider<Arguments, ReadOnlyProperty<Arguments, List<List<T>>>>

Builder for arity-based list options that return non-nullable lists of lists.

NonNullableArityOptionBuilder

class NonNullableArityOptionBuilder<T> : PropertyDelegateProvider<Arguments, ReadOnlyProperty<Arguments, List<T>>>

Builder for arity-based options that return non-nullable lists of values.

NonNullableAritySetOptionBuilder

class NonNullableAritySetOptionBuilder<T : Any> : PropertyDelegateProvider<Arguments, ReadOnlyProperty<Arguments, Set<List<T>>>>

Builder for arity-based set options that return non-nullable sets of lists.

NonNullableOptionBuilder

class NonNullableOptionBuilder<T : Any>(val delegate: OptionBuilder<T?>) : PropertyDelegateProvider<Arguments, ReadOnlyProperty<Arguments, T>>

Builder for non-nullable command-line options. This type is returned by .default() and .required() to ensure type safety. It delegates most operations to the underlying OptionBuilder while ensuring type safety.

OptionBuilder

class OptionBuilder<T> : PropertyDelegateProvider<Arguments, ReadOnlyProperty<Arguments, T>>

Builder for creating command-line options with various configurations and constraints.

OptionListBuilder

class OptionListBuilder<T : Any> : CollectionOptionBuilder<T, List<T>>

Builder for creating command-line list options with various configurations and constraints.

OptionSetBuilder

class OptionSetBuilder<T : Any> : CollectionOptionBuilder<T, Set<T>>

Builder for creating command-line set options with various configurations and constraints.

OsBound

expect object OsBound

Platform abstraction layer providing OS-specific functionality.

actual object OsBound

ParseError

class ParseError(msg: String) : IllegalArgumentException

Exception thrown when argument parsing fails due to invalid input, missing required arguments, or constraint violations.

PasswordConfig

data class PasswordConfig(val prompt: String, val confirmPrompt: String, val requireConfirmation: Boolean, val mismatchPrompt: String, val maxRetries: Int)

Configuration for password options.

UninitializedPropertyException

class UninitializedPropertyException(propertyName: String) : Exception

Exception thrown when attempting to access an uninitialized property that was declared as non-nullable but no value was provided.

ValueSource

enum ValueSource : Enum<ValueSource>

Enum representing the source of a value for an Argos-managed property.

Functions

arity

fun <T : Any> OptionBuilder<T?>.arity(n: Int): ArityOptionBuilder<T>

Sets the arity (number of required values) for this option.

bool

fun OptionBuilder<String?>.bool(): OptionBuilder<Boolean?>

Converts string option to boolean option.

count

fun OptionBuilder<Boolean?>.count(): CountBuilder

Converts boolean option to count collector.

default

fun <T : Any> OptionBuilder<T?>.default(value: T): NonNullableOptionBuilder<T>

Sets a default value for nullable option, making it non-nullable.

double

fun NonNullableOptionBuilder<String>.double(): NonNullableOptionBuilder<Double>

Converts non-nullable string option to non-nullable double option.

fun OptionBuilder<String?>.double(): OptionBuilder<Double?>

Converts string option to double option.

eager

fun OptionBuilder<Boolean?>.eager(): OptionBuilder<Boolean?>

Makes boolean option eager (evaluated immediately, causing early exit).

enum

inline fun <E : Enum<E>> NonNullableOptionBuilder<String>.enum(aliases: Map<String, E> = emptyMap(), ignoreCase: Boolean = true): NonNullableOptionBuilder<E>

Converts non-nullable string option to non-nullable enum option.

inline fun <E : Enum<E>> OptionBuilder<String?>.enum(aliases: Map<String, E> = emptyMap(), ignoreCase: Boolean = true): OptionBuilder<E?>

Converts string option to enum option.

float

fun NonNullableOptionBuilder<String>.float(): NonNullableOptionBuilder<Float>

Converts non-nullable string option to non-nullable float option.

fun OptionBuilder<String?>.float(): OptionBuilder<Float?>

Converts string option to float option.

int

fun NonNullableOptionBuilder<String>.int(): NonNullableOptionBuilder<Int>

Converts non-nullable string option to non-nullable integer option.

fun OptionBuilder<String?>.int(): OptionBuilder<Int?>

Converts string option to integer option.

list

fun <T : Any> OptionBuilder<T?>.list(): OptionListBuilder<T>

Converts option to list collector.

long

fun NonNullableOptionBuilder<String>.long(): NonNullableOptionBuilder<Long>

Converts non-nullable string option to non-nullable long option.

fun OptionBuilder<String?>.long(): OptionBuilder<Long?>

Converts string option to long option.

negatable

fun NonNullableOptionBuilder<Boolean>.negatable(prefix: String? = null): NonNullableOptionBuilder<Boolean>

Makes a non-nullable boolean option negatable with custom prefix.

fun OptionBuilder<Boolean?>.negatable(prefix: String? = null): OptionBuilder<Boolean?>

Makes this nullable boolean option negatable with a custom prefix. Creates an automatic negation option (e.g., --disable-colors for --colors with prefix "disable-").

@JvmName(name = "negatableNonNull")

fun OptionBuilder<Boolean>.negatable(prefix: String? = null): OptionBuilder<Boolean>

Makes this non-nullable boolean option negatable with a custom prefix. Creates an automatic negation option (e.g., --disable-colors for --colors with prefix "disable-").

oneOf

fun NonNullableOptionBuilder<String>.oneOf(vararg allowed: String, ignoreCase: Boolean = true): NonNullableOptionBuilder<String>

Restricts non-nullable string option to one of the specified allowed values.

fun OptionBuilder<String?>.oneOf(vararg allowed: String, ignoreCase: Boolean = true): OptionBuilder<String?>

Restricts string option to one of the specified allowed values.

parse

fun <T : Arguments> T.parse(args: Array<String>, onSuccess: (T) -> Unit = {}, onError: (ParseError, T) -> Unit = { _, t -> Help.printError(t) }): T?

Extension function for parsing arguments with error handling.

password

fun OptionBuilder<String?>.password(prompt: String = "Password: ", confirmPrompt: String = "Confirm password: ", requireConfirmation: Boolean = false, mismatchPrompt: String = "Passwords do not match. Please try again.", maxRetries: Int = 3): OptionBuilder<CharArray?>

Converts string option to password option with prompting capabilities.

required

fun <T> OptionBuilder<T>.required(): OptionBuilder<T>

Marks this option as required.

@JvmName(name = "requiredGeneric")

fun <T : Any> OptionBuilder<T?>.required(): NonNullableOptionBuilder<T>

Marks this nullable option as required, converting it to a non-nullable type.

requiresValue

fun <T> OptionBuilder<T>.requiresValue(requires: Boolean): OptionBuilder<T>

Controls whether this option requires a value.

set

fun <T : Any> OptionBuilder<T?>.set(): OptionSetBuilder<T>

Converts option to set collector.