`nupp.cli`

Command-line arguments, from raw tokens up to a whole application.

The usual way in is a record: the types decide the conversion, the doc comments become the help text.

local cli = require("nupp.cli")

@derive(cli.Arguments)
local record Options
    --- Print more detail.
    @cli(short = "v")
    verbose: boolean = false

    --- Output path.
    @cli(short = "o", value = "PATH")
    output: string?

    --- Input files.
    @cli(positional = "FILE")
    files: {string} = {}
end

const options, problem = Options.fromCLI(arg)

assert(options ~= nil, problem and problem.message)

@derive(cli.Command) goes further and adds metadata, help, and shell completion, with a parent naming its children in subcommands so the tree reads from the top down. Underneath both, optParser and getopt are the syntax-only foundation: a token stream with no types attached, for when the shape of the command line is not a record.

This module also holds the terminal side of a command-line program -- color modes, styles, and tables -- so what a command prints lines up with what it parsed.

See Command-line applications.

Module contents

Types

Type	Kind	Description
`Alignment`	type	How a cell sits in its column.
`Application`	record	A finite tree of derived command types.
`ApplicationOptions`	type	Runtime-only settings for a CLI application.
`ArgumentRecord`	interface	Marker implemented by a record deriving Arguments.
`Cell`	record	One cell.
`ColorMode`	type	How terminal styling is selected.
`Column`	record	One column.
`CommandType`	type	A record type deriving Command.
`Completer`	interface	A lazily invoked source of dynamic values for one CLI field.
`CompletionCandidate`	record	One shell-neutral completion candidate.
`CompletionRequest`	record	Context supplied to a dynamic field completion provider.
`DecodeError`	type
`Invocation`	record	A command type resolved and decoded without executing it.
`OptParser`	record	An incremental command-line option parser.
`OptParserConfig`	type	Syntax policy supplied to optParser.
`Pattern`	type	One whole-word option form, such as -O2.
`Runnable`	interface	The instance contract of a derived executable command.
`Style`	record	Generic terminal styles shared by CLI applications and their commands.
`SyntaxError`	record	A syntax failure found while consuming argv.
`TableOptions`	record	What to render.
`TokenKind`	type	The kind of one classified argv word.
`ValueArity`	type	How an option obtains a value.

Functions

Function	Kind	Description
`cliModule.annotatedCell`	function	A table cell carrying an aside, measured with the cell and painted apart from it.
`cliModule.application`	function	Builds an application from a command type and its subcommands tree.
`cliModule.Arguments`	comptime function	Derives typed argv decoding for a record.
`cliModule.cell`	function	A plain table cell.
`cliModule.colorEnabled`	function	Reports whether escapes should be written to one stream.
`cliModule.columns`	function	Reports how many columns one stream's terminal has, when it has one.
`cliModule.Command`	comptime function	Derives typed argv decoding and a self-describing executable command.
`cliModule.command`	function	Returns the descriptor generated for a command type.
`cliModule.decodeAs`	function	Decodes argv as a record deriving Arguments or Command.
`cliModule.isTerminal`	function	Reports whether one stream is connected to a terminal.
`cliModule.paintedCell`	function	A table cell that paints itself, whatever its column says.
`cliModule.schema`	function	Returns the CLI schema carried by a derived type.
`cliModule.setColorMode`	function	Sets the process-wide default color policy.
`cliModule.severity`	function	Selects the color associated with a diagnostic severity.
`cliModule.style`	function	Returns the generic styles selected for one stream.
`cliModule.table`	function	Renders aligned columns, painting each cell after it is padded.
`cliModule.withColorMode`	function	Runs a body under one color policy and restores the previous policy.
`cliModule.writeTable`	function	Renders aligned columns straight to a stream.

Types#

`Alignment`type#

type Alignment = "left" | "right"

How a cell sits in its column.

`Application`record#

record Application ...

A finite tree of derived command types.

Members

Name	Kind	Description
`root`	field
`commands`	field
`byParent`	field
`options`	field
`resolve`	method	Resolves and decodes argv, without writing output or invoking run.
`help`	method	Renders the application's top-level help.
`commandHelp`	method	Renders help for a command path, or returns nil when it is unknown.
`complete`	method	Produces shell-neutral candidates for one cursor position.
`completion`	method	Renders a Bash, Zsh, or Fish completion script from this schema.
`main`	method	Handles framework options, renders failures, and invokes a typed command.

`root`field#

root: Descriptor

@private

`commands`field#

commands: {Descriptor}

@private

`byParent`field#

byParent: {[any]: {[string]: Descriptor}}

@private

`options`field#

options: ApplicationOptions

@private

`resolve`method#

resolve: function resolve(self, argv: {string}): Invocation?, any?

Resolves and decodes argv, without writing output or invoking run.

Arguments

Name	Type	Description
`self`	`any`
`argv`	`{string}`

Returns

Type	Description
`Invocation?`
`any?`

`help`method#

help: function help(self): string

Renders the application's top-level help.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`string`

`commandHelp`method#

commandHelp: function commandHelp(self, path: {string}): string?

Renders help for a command path, or returns nil when it is unknown.

Arguments

Name	Type	Description
`self`	`any`
`path`	`{string}`

Returns

Type	Description
`string?`

`complete`method#

complete: function complete(self, request: any): {any}, string?

Produces shell-neutral candidates for one cursor position.

The second result is "files" or "dirs" when the slot is a path the shell should complete itself.

Arguments

Name	Type	Description
`self`	`any`
`request`	`any`

Returns

Type	Description
`{any}`
`string?`

`completion`method#

completion: function completion(self, shell: "bash" | "zsh" | "fish"): string

Renders a Bash, Zsh, or Fish completion script from this schema.

The script asks the program itself, through the hidden __complete command, so what it offers depends on where the cursor is: one command's options rather than every command's, and a value's choices rather than every word the grammar knows. A reply whose first line is :files or :dirs hands the word to the shell's own path completion.

Arguments

Name	Type	Description
`self`	`any`
`shell`	`"bash" \| "zsh" \| "fish"`

Returns

Type	Description
`string`

`main`method#

main: function main(self, argv: {string}): integer

Handles framework options, renders failures, and invokes a typed command.

Arguments

Name	Type	Description
`self`	`any`
`argv`	`{string}`

Returns

Type	Description
`integer`

`ApplicationOptions`type#

type ApplicationOptions = {
    name: string?,
    version: string?,
    stdout: LuaFile?,
    stderr: LuaFile?,
    cwd: string?,
    environment: {[string]: string}?,
    width: integer?,
    indent: string?,
    labelLimit: integer?
}

Runtime-only settings for a CLI application.

`ArgumentRecord`interface#

interface cliModule.ArgumentRecord

Marker implemented by a record deriving Arguments.

`Cell`record#

record Cell ...

One cell.

Members

Name	Kind	Description
`text`	field	What the cell says.
`paint`	field	Paints the text, overriding the column's painter for this cell alone.
`note`	field	An aside after the text, in its own color: a default a project moved off, a unit, a "(default)" beside the name it...
`notePaint`	field	Paints the note.

`text`field#

text: string

What the cell says.

`paint`field#

paint: (function(string): string)?

Paints the text, overriding the column's painter for this cell alone. How one row reports a level in its own severity color while its neighbors do not.

`note`field#

note: string?

An aside after the text, in its own color: a default a project moved off, a unit, a "(default)" beside the name it belongs to. Written separately because it is painted separately, and measured with the text rather than after it, so a column carrying one still lines up with the column beside it.

`notePaint`field#

notePaint: (function(string): string)?

Paints the note. Defaults to the style's faint, which is what an aside is.

`ColorMode`type#

type ColorMode = "auto" | "always" | "never"

How terminal styling is selected.

`Column`record#

record Column ...

One column.

Members

Name	Kind	Description
`heading`	field	What prints above it.
`align`	field	Which side the padding goes on.
`paint`	field	Paints every cell in this column that does not paint itself.
`minimumWidth`	field	A floor on the width, for a column whose contents are shorter than what they will be once a row appears that fills it.

`heading`field#

heading: string

What prints above it. An empty heading still reserves the column's width.

`align`field#

align: Alignment?

Which side the padding goes on. Numbers read as a column when they are right aligned and as noise when they are not.

`paint`field#

paint: (function(string): string)?

Paints every cell in this column that does not paint itself.

`minimumWidth`field#

minimumWidth: integer?

A floor on the width, for a column whose contents are shorter than what they will be once a row appears that fills it.

`CommandType`type#

type cliModule.CommandType = Type<cliModule.Runnable>

A record type deriving Command.

`Completer`interface#

interface cliModule.Completer ...

A lazily invoked source of dynamic values for one CLI field.

Members

Name	Kind	Description
`complete`	method

`complete`method#

complete: function(self, request: cliModule.CompletionRequest): {cliModule.CompletionCandidate}

Arguments

Name	Type	Description
`?`	`self`
`request`	`cliModule.CompletionRequest`

Returns

Type	Description
`{cliModule.CompletionCandidate}`

`CompletionCandidate`record#

record cliModule.CompletionCandidate ...

One shell-neutral completion candidate.

Members

Name	Kind	Description
`value`	field
`description`	field
`kind`	field

`value`field#

value: string

`description`field#

description: string?

`kind`field#

kind: "value" | "file" | "directory"?

`CompletionRequest`record#

record cliModule.CompletionRequest ...

Context supplied to a dynamic field completion provider.

Members

Name	Kind	Description
`prefix`	field
`argv`	field
`wordIndex`	field
`commandPath`	field
`field`	field
`cwd`	field
`environment`	field

`prefix`field#

prefix: string

`argv`field#

argv: {string}

`wordIndex`field#

wordIndex: integer

`commandPath`field#

commandPath: {string}

`field`field#

field: string

`cwd`field#

cwd: string

`environment`field#

environment: {[string]: string}

`DecodeError`type#

type DecodeError = {
    @readonly kind: string,
    @readonly message: string,
    @readonly index: integer?,
    @readonly raw: string?,
    @readonly option: string?,
    @readonly field: string?,
    @readonly destination: string?
}

`Invocation`record#

record Invocation ...

A command type resolved and decoded without executing it.

Members

Name	Kind	Description
`commandType`	field
`options`	field
`argv`	field
`commandPath`	field

`commandType`field#

commandType: any

`options`field#

options: any

`argv`field#

argv: {string}

`commandPath`field#

commandPath: {string}

`OptParser`record#

record OptParser ...

An incremental command-line option parser.

Members

Name	Kind	Description
`argv`	field
`config`	field
`nextIndex`	field
`literal`	field
`currentKind`	field
`currentKey`	field
`currentValue`	field
`currentRaw`	field
`currentIndex`	field
`currentAttached`	field
`currentPattern`	field
`next`	method	Advances to the next token and returns its kind, or a syntax error.
`kind`	method	Returns the current token kind.
`key`	method	Returns the current option's normalized key.
`value`	method	Returns the current option's value, when it has one.
`raw`	method	Returns the original argv word for the current token.
`index`	method	Returns the one-based argv index of the current token.
`attached`	method	Reports whether the current option carried an attached value.
`pattern`	method	Reports whether the current option matched a configured whole-word form.
`remaining`	method	Returns the unclassified suffix in its original order.
`original`	method	Returns the original argv table.

`argv`field#

argv: {string}

@private

`config`field#

config: OptParserConfig

@private

`nextIndex`field#

nextIndex: integer

@private

`literal`field#

literal: boolean

@private

`currentKind`field#

currentKind: TokenKind?

@private

`currentKey`field#

currentKey: string?

@private

`currentValue`field#

currentValue: string?

@private

`currentRaw`field#

currentRaw: string?

@private

`currentIndex`field#

currentIndex: integer

@private

`currentAttached`field#

currentAttached: boolean

@private

`currentPattern`field#

currentPattern: boolean

@private

`next`method#

next: function next(self): TokenKind?, SyntaxError?

Advances to the next token and returns its kind, or a syntax error.

Token data remains on this parser until the next call to next.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`TokenKind?`
`SyntaxError?`

`kind`method#

kind: function kind(self): TokenKind

Returns the current token kind.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`TokenKind`

Raises

Type	Condition
`string`	when the parser has no current token

`key`method#

key: function key(self): string

Returns the current option's normalized key.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`string`

Raises

Type	Condition
`string`	when the parser has no current token or it is not an option

`value`method#

value: function value(self): string?

Returns the current option's value, when it has one.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`string?`

Raises

Type	Condition
`string`	when the parser has no current token or it is not an option

`raw`method#

raw: function raw(self): string

Returns the original argv word for the current token.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`string`

Raises

Type	Condition
`string`	when the parser has no current token

`index`method#

index: function index(self): integer

Returns the one-based argv index of the current token.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`integer`

Raises

Type	Condition
`string`	when the parser has no current token

`attached`method#

attached: function attached(self): boolean

Reports whether the current option carried an attached value.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`boolean`

Raises

Type	Condition
`string`	when the parser has no current token or it is not an option

`pattern`method#

pattern: function pattern(self): boolean

Reports whether the current option matched a configured whole-word form.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`boolean`

Raises

Type	Condition
`string`	when the parser has no current token or it is not an option

`remaining`method#

remaining: function remaining(self): {string}

Returns the unclassified suffix in its original order.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`{string}`

`original`method#

original: function original(self): {string}

Returns the original argv table.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`{string}`

`OptParserConfig`type#

type OptParserConfig = {
    --- Value arity by normalized option name, without leading hyphens.
    arity: {[string]: ValueArity}?,

    --- Whole-word forms tried before ordinary short-option classification.
    patterns: {Pattern}?,

    --- Once the first argument is seen, expose every later word as an argument.
    stopAtFirstArgument: boolean?,

    --- Whether `--` itself is returned before its following arguments.
    exposeTerminator: boolean?
}

Syntax policy supplied to optParser.

`Pattern`type#

type Pattern = {
    --- Lua pattern matched against the complete argv word.
    pattern: string,

    --- The normalized key exposed by the token.
    key: string
}

One whole-word option form, such as -O2.

`Runnable`interface#

interface cliModule.Runnable ...

The instance contract of a derived executable command.

Members

Name	Kind	Description
`run`	method

`run`method#

run: function(self): integer

Arguments

Name	Type	Description
`?`	`self`

Returns

Type	Description
`integer`

`Style`record#

record Style ...

Generic terminal styles shared by CLI applications and their commands.

Members

Name	Kind	Description
`strong`	method
`faint`	method
`heading`	method	A column heading, a section title: text that names what is beneath it rather than saying anything itself.
`red`	method
`yellow`	method
`green`	method
`cyan`	method
`blue`	method
`path`	method
`gutter`	method
`severity`	field

`strong`method#

strong: function(string): string

Arguments

Name	Type	Description
`?`	`string`

Returns

Type	Description
`string`

`faint`method#

faint: function(string): string

Arguments

Name	Type	Description
`?`	`string`

Returns

Type	Description
`string`

`heading`method#

heading: function(string): string

A column heading, a section title: text that names what is beneath it rather than saying anything itself. Named as a role rather than as a colour so the one decision lives here instead of at every table that prints one.

Arguments

Name	Type	Description
`?`	`string`

Returns

Type	Description
`string`

`red`method#

red: function(string): string

Arguments

Name	Type	Description
`?`	`string`

Returns

Type	Description
`string`

`yellow`method#

yellow: function(string): string

Arguments

Name	Type	Description
`?`	`string`

Returns

Type	Description
`string`

`green`method#

green: function(string): string

Arguments

Name	Type	Description
`?`	`string`

Returns

Type	Description
`string`

`cyan`method#

cyan: function(string): string

Arguments

Name	Type	Description
`?`	`string`

Returns

Type	Description
`string`

`blue`method#

blue: function(string): string

Arguments

Name	Type	Description
`?`	`string`

Returns

Type	Description
`string`

`path`method#

path: function(string): string

Arguments

Name	Type	Description
`?`	`string`

Returns

Type	Description
`string`

`gutter`method#

gutter: function(string): string

Arguments

Name	Type	Description
`?`	`string`

Returns

Type	Description
`string`

`severity`field#

severity: {[string]: function(string): string}

`SyntaxError`record#

record SyntaxError ...

A syntax failure found while consuming argv.

Members

Name	Kind	Description
`kind`	field
`index`	field
`raw`	field
`key`	field
`message`	field

`kind`field#

kind: "missingValue" | "needsAttachedValue"

`index`field#

index: integer

`raw`field#

raw: string

`key`field#

key: string

`message`field#

message: string

`TableOptions`record#

record TableOptions ...

What to render.

Members

Name	Kind	Description
`columns`	field
`rows`	field	Rows, each as many cells as there are columns.
`style`	field	Where the heading color and any cell colors come from.
`headingPaint`	field	Paints the heading row.
`gap`	field	Printed between columns.
`indent`	field	Printed before every line, heading included.
`showHeading`	field	Whether to print the heading row at all.
`width`	field	Columns available on screen.

`columns`field#

columns: {Column}

`rows`field#

rows: {{Cell}}

Rows, each as many cells as there are columns. A short row is padded with blanks rather than refused, so a caller may leave a trailing cell out.

`style`field#

style: Style?

Where the heading color and any cell colors come from. Supply the style selected for the stream being written to; omit it and nothing is painted.

`headingPaint`field#

headingPaint: (function(string): string)?

Paints the heading row. Defaults to the style's heading role.

`gap`field#

gap: string?

Printed between columns. Two spaces unless a caller says otherwise.

`indent`field#

indent: string?

Printed before every line, heading included.

`showHeading`field#

showHeading: boolean?

Whether to print the heading row at all.

`width`field#

width: integer?

Columns available on screen. The last column is cut to fit rather than left to wrap. Nil cuts nothing, which is what a pipe wants.

`TokenKind`type#

type TokenKind = "shortOption" | "longOption" | "argument" | "terminator"

The kind of one classified argv word.

`ValueArity`type#

type ValueArity = "none" | "required" | "optionalAttached" | "attachedOnly"

How an option obtains a value.

Functions#

`cliModule.annotatedCell`function#

function cliModule.annotatedCell(value: string, note: string, paint: (function(string): string)?): cliModule.Cell

A table cell carrying an aside, measured with the cell and painted apart from it.

Arguments

Name	Type	Description
`value`	`string`
`note`	`string`
`paint`	`(function(string): string)?`

Returns

Type	Description
`cliModule.Cell`

`cliModule.application`function#

function cliModule.application<T is cliModule.Runnable>(rootType: Type<T>, options: cliModule.ApplicationOptions?): cliModule.Application

Builds an application from a command type and its subcommands tree.

Type parameters

Name	Description
`T`

Arguments

Name	Type	Description
`rootType`	`Type<T>`
`options`	`cliModule.ApplicationOptions?`

Returns

Type	Description
`cliModule.Application`

`cliModule.Arguments`comptime function#

@comptime function cliModule.Arguments(info: nupp.derive.Info): nupp.derive.Result<cliModule.ArgumentRecord>

@comptime

Derives typed argv decoding for a record.

Arguments

Name	Type	Description
`info`	`nupp.derive.Info`

Returns

Type	Description
`nupp.derive.Result<cliModule.ArgumentRecord>`

`cliModule.cell`function#

function cliModule.cell(value: string): cliModule.Cell

A plain table cell.

Arguments

Name	Type	Description
`value`	`string`

Returns

Type	Description
`cliModule.Cell`

`cliModule.colorEnabled`function#

function cliModule.colorEnabled(stream: LuaFile): boolean

Reports whether escapes should be written to one stream.

Arguments

Name	Type	Description
`stream`	`LuaFile`

Returns

Type	Description
`boolean`

`cliModule.columns`function#

function cliModule.columns(stream: LuaFile): integer?

Reports how many columns one stream's terminal has, when it has one.

Arguments

Name	Type	Description
`stream`	`LuaFile`

Returns

Type	Description
`integer?`

`cliModule.Command`comptime function#

@comptime function cliModule.Command(info: nupp.derive.Info): nupp.derive.Result<cliModule.Runnable>

@comptime

Derives typed argv decoding and a self-describing executable command.

Arguments

Name	Type	Description
`info`	`nupp.derive.Info`

Returns

Type	Description
`nupp.derive.Result<cliModule.Runnable>`

`cliModule.command`function#

function cliModule.command<T is table>(subject: Type<T>): table?, string?

Returns the descriptor generated for a command type.

Type parameters

Name	Description
`T`

Arguments

Name	Type	Description
`subject`	`Type<T>`

Returns

Type	Description
`table?`
`string?`

`cliModule.decodeAs`function#

function cliModule.decodeAs<T is table>(subject: Type<T>, argv: {string}): T?, cliModule.DecodeError?

Decodes argv as a record deriving Arguments or Command.

Type parameters

Name	Description
`T`

Arguments

Name	Type	Description
`subject`	`Type<T>`
`argv`	`{string}`

Returns

Type	Description
`T?`
`cliModule.DecodeError?`

`cliModule.isTerminal`function#

function cliModule.isTerminal(stream: LuaFile): boolean

Reports whether one stream is connected to a terminal.

Arguments

Name	Type	Description
`stream`	`LuaFile`

Returns

Type	Description
`boolean`

`cliModule.paintedCell`function#

function cliModule.paintedCell(value: string, paint: function(string): string): cliModule.Cell

A table cell that paints itself, whatever its column says.

Arguments

Name	Type	Description
`value`	`string`
`paint`	`function(string): string`

Returns

Type	Description
`cliModule.Cell`

`cliModule.schema`function#

function cliModule.schema<T is table>(subject: Type<T>): table?

Returns the CLI schema carried by a derived type.

Type parameters

Name	Description
`T`

Arguments

Name	Type	Description
`subject`	`Type<T>`

Returns

Type	Description
`table?`

`cliModule.setColorMode`function#

function cliModule.setColorMode(wanted: cliModule.ColorMode): nil

Sets the process-wide default color policy.

Arguments

Name	Type	Description
`wanted`	`cliModule.ColorMode`

Returns

Type	Description
`nil`

`cliModule.severity`function#

function cliModule.severity(styles: cliModule.Style, name: string?): function(string): string

Selects the color associated with a diagnostic severity.

Arguments

Name	Type	Description
`styles`	`cliModule.Style`
`name`	`string?`

Returns

Type	Description
`function(string): string`

`cliModule.style`function#

function cliModule.style(stream: LuaFile): cliModule.Style

Returns the generic styles selected for one stream.

Arguments

Name	Type	Description
`stream`	`LuaFile`

Returns

Type	Description
`cliModule.Style`

`cliModule.table`function#

function cliModule.table(options: cliModule.TableOptions): string

Renders aligned columns, painting each cell after it is padded.

Arguments

Name	Type	Description
`options`	`cliModule.TableOptions`

Returns

Type	Description
`string`

`cliModule.withColorMode`function#

function cliModule.withColorMode(wanted: cliModule.ColorMode, body: function(): nil): nil

Runs a body under one color policy and restores the previous policy.

Arguments

Name	Type	Description
`wanted`	`cliModule.ColorMode`
`body`	`function(): nil`

Returns

Type	Description
`nil`

`cliModule.writeTable`function#

function cliModule.writeTable(stream: LuaFile, options: cliModule.TableOptions): nil

Renders aligned columns straight to a stream.

Arguments

Name	Type	Description
`stream`	`LuaFile`
`options`	`cliModule.TableOptions`

Returns

Type	Description
`nil`

nupp.cli

Module contents

Types

Functions

Types#

Alignmenttype#

Applicationrecord#

Members

rootfield#

commandsfield#

byParentfield#

optionsfield#

resolvemethod#

Arguments

Returns

helpmethod#

Arguments

Returns

commandHelpmethod#

Arguments

Returns

completemethod#

Arguments

Returns

completionmethod#

Arguments

Returns

mainmethod#

Arguments

Returns

ApplicationOptionstype#

ArgumentRecordinterface#

Cellrecord#

Members

textfield#

paintfield#

notefield#

notePaintfield#

ColorModetype#

Columnrecord#

Members

headingfield#

alignfield#

paintfield#

minimumWidthfield#

CommandTypetype#

Completerinterface#

Members

completemethod#

Arguments

Returns

CompletionCandidaterecord#

Members

valuefield#

descriptionfield#

kindfield#

CompletionRequestrecord#

Members

prefixfield#

argvfield#

wordIndexfield#

commandPathfield#

fieldfield#

cwdfield#

environmentfield#

DecodeErrortype#

Invocationrecord#

Members

commandTypefield#

optionsfield#

argvfield#

commandPathfield#

OptParserrecord#

Members

argvfield#

configfield#

nextIndexfield#

literalfield#

currentKindfield#

currentKeyfield#

`nupp.cli`

`Alignment`type#

`Application`record#

`root`field#

`commands`field#

`byParent`field#

`options`field#

`resolve`method#

`help`method#

`commandHelp`method#

`complete`method#

`completion`method#

`main`method#

`ApplicationOptions`type#

`ArgumentRecord`interface#

`Cell`record#

`text`field#

`paint`field#

`note`field#

`notePaint`field#

`ColorMode`type#

`Column`record#

`heading`field#

`align`field#

`paint`field#

`minimumWidth`field#

`CommandType`type#

`Completer`interface#

`complete`method#

`CompletionCandidate`record#

`value`field#

`description`field#

`kind`field#

`CompletionRequest`record#

`prefix`field#

`argv`field#

`wordIndex`field#

`commandPath`field#

`field`field#

`cwd`field#

`environment`field#

`DecodeError`type#

`Invocation`record#

`commandType`field#

`options`field#

`argv`field#

`commandPath`field#

`OptParser`record#

`argv`field#

`config`field#

`nextIndex`field#

`literal`field#

`currentKind`field#

`currentKey`field#

`currentValue`field#

`currentRaw`field#

`currentIndex`field#

`currentAttached`field#

`currentPattern`field#

`next`method#

`kind`method#

`key`method#

`value`method#

`raw`method#

`index`method#

`attached`method#

`pattern`method#

`remaining`method#

`original`method#

`OptParserConfig`type#

`Pattern`type#

`Runnable`interface#

`run`method#

`Style`record#

`strong`method#

`faint`method#

`heading`method#

`red`method#

`yellow`method#

`green`method#