clikt/com.github.ajalt.clikt.parsers/CommandLineParser

CommandLineParser

Methods for parsing command lines and running commands manually.

Functions

fun finalizeCommand(invocation: CommandInvocation<*>)

Finalize a command invocation, converting and setting the values for all options and other parameters. This function does not finalizeEagerOptions or run the command.

finalizeEagerOptions

fun finalizeEagerOptions(invocation: CommandInvocation<*>)

Finalize eager options for a command invocation, running them if they were invoked.

main

inline fun <T : BaseCliktCommand<T>> main(command: T, parseAndRun: T.() -> Unit)

Call parseAndRun on the given command. If an error is thrown, exit the process with the error's status code.

mainReturningValue

inline fun <T : BaseCliktCommand<T>, R> mainReturningValue(command: T, parseAndRun: T.() -> R): R

Call parseAndRun on the given command. If an error is thrown, exit the process with the error's status code.

parse

fun <T : BaseCliktCommand<T>> parse(command: T, argv: List<String>): CommandLineParseResult<T>

Parse a command line and return the result.

parseAndRun

inline fun <T : BaseCliktCommand<T>> parseAndRun(command: T, argv: List<String>, runCommand: (T) -> Unit): CommandLineParseResult<T>

A shortcut for calling run(parse(command, argv).invocation, runCommand)

run

inline fun <T : BaseCliktCommand<T>> run(rootInvocation: CommandInvocation<T>, runCommand: (T) -> Unit)

Finalize and run all invoked commands.

tokenize

fun tokenize(commandLine: String, filename: String = "", localization: Localization = defaultLocalization): List<String>

Split a command line into a list of argv tokens.