T
ArgumentSingleValueType

The type of single Argument values which are supported.

T
ArgumentValues

A container object for populated argument values.

T
ArgumentValueType

The type of the value to be parsed as an argument can be: boolean, number or string or an array of these.

E
ArgumentValueTypeName

Enum of possible Argument value types.

v
ASCII_BANNER_GENERATOR_SERVICE_ID
No documentation available
I
AsciiBannerGeneratorService

Service allowing a text string to be rendered using an ASCII banner FIGlet font.

c
BaseCLI

Base implementation of a CLI.

I
CLI
No documentation available
I
CLIConfig

Interface specifying common configuration for a CLI application.

T
ColorScheme

Color scheme for syntax highlighting.

I
Command

Common interface for all command types.

I
ComplexOption

A container option argument for defining SubCommand nested argument hierarchies.

E
ComplexValueTypeName

Only possible value for ComplexOption.type.

c
DefaultAsciiBannerGeneratorService

Default implementation of AsciiBannerGeneratorService which has a font definition for the FIGlet "standard" font already registered.

c
DefaultPrettyPrinterService

Default implementation of PrettyPrinterService which provides by default the syntaxes built into prettier.

c
DefaultRuntimeCLI

Default Bun implementation of a CLI using process.stdout, process.stderr and process.argv.

c
DefaultSyntaxHighlighterService

Default implementation of SyntaxHighlighterService which has a syntax definition for JSON already registered.

I
GlobalCommand

Interface for a global command.

I
GlobalCommandArgument

Interface to be implemented by a single Argument defined by a GlobalCommand.

I
GlobalModifierCommand

Interface for a global modifier command.

I
GroupCommand

Interface for a group command.

E
Icon

Enum of message icons.

I
InvalidArgument

Details of an invalid parsed argument.

E
InvalidArgumentReason

Possible reasons for an invalid argument.

v
KEY_VALUE_SERVICE_ID
No documentation available
I
KeyValueService

Service providing keystore functionality for the CLI. The keystore data is scoped to the service or Command instances accessing this service via Context.getServiceById

f
launchMultiCommandCLI

Launch a DefaultRuntimeCLI with multiple specified Command instances.

f
launchSingleCommandCLI

Launch a DefaultRuntimeCLI with a single specified SubCommand instance.

E
Level

Enum of message importance level.

I
Option

Interface for SubCommand option arguments.

T
PopulatedArgumentSingleValueType

Populated single value type is very similar to ArgumentSingleValueType but allows for an illegal undefined value.

I
PopulatedArgumentValues

Populated values are very similar to ArgumentValues but allow for illegal undefined properties and array entries.

T
PopulatedArgumentValueType

Populated argument value types are very similar to ArgumentValueType but allow for illegal undefined values.

I
Positional

Interface for SubCommand positional arguments.

v
PRETTY_PRINTER_SERVICE_ID
No documentation available
I
PrettyPrinterService

Service providing syntax based pretty printing of text for the CLI using prettier.

v
PRINTER_SERVICE_ID
No documentation available
E
RunState
No documentation available
I
ServiceInfo

Information regarding a service instance provided by a ServiceProvider.

I
ServiceProvider

Interface allowing services to be provided to the CLI.

I
ServiceProviderRegistry

Interface used by a CLI to register ServiceProvider instances.

v
SHUTDOWN_SERVICE_ID
No documentation available
I
ShutdownService

Service allowing registration of callbacks for CLI shutdown.

I
SubCommandArgument

Interface to be implemented by all SubCommand arguments.

v
SYNTAX_HIGHLIGHTER_SERVICE_ID
No documentation available
I
SyntaxHighlighterService

Service providing syntax based color highlighting of text for the CLI using highlight.js.

I
UsageExample

A usage example for a SubCommand to be used in help output.