@carnesen/cli

Index

Classes

Type aliases

Variables

Functions

Type aliases

TCliArgGroupArgs

TCliArgGroupArgs<TRequired>: TRequired extends true ? string[] : string[] | undefined

Defines the type of the args passed to an ICliArgGroup

Type parameters

TRequired: boolean

If true, the args parameter might be undefined

TCliDescription

TCliDescription: undefined | string | TCliDescriptionFunction

TCliDescriptionFunction

TCliDescriptionFunction: (input: ICliDescriptionFunctionInput) => string

Type declaration

- (input: ICliDescriptionFunctionInput): string
- Parameters
  - input: ICliDescriptionFunctionInput
  Returns string

TCliRoot

TCliRoot: ICliCommandGroup | ICliCommand<ICliArgGroup, any, ICliArgGroup>

The root of a command tree

Variables

Const CLI_COMMAND

CLI_COMMAND: "CLI_COMMAND" = "CLI_COMMAND"

"kind" of a ICliCommand

Const CLI_COMMAND_GROUP

CLI_COMMAND_GROUP: "CLI_COMMAND_GROUP" = "CLI_COMMAND_GROUP"

"kind" of an ICliCommandGroup

Const CLI_TERSE_ERROR

CLI_TERSE_ERROR: "CLI_TERSE_ERROR" = "CLI_TERSE_ERROR"

"code" of a CliTerseError

Const CLI_USAGE_ERROR

CLI_USAGE_ERROR: "CLI_USAGE_ERROR" = "CLI_USAGE_ERROR"

"code" of a CliUsageError

Functions

Cli

Cli(root: TCliRoot, options?: ICliOptions): ICli

- Defined in src/cli.ts:15
Options for Cli

Parameters
- root: TCliRoot
- Default value options: ICliOptions = {}
Returns ICli

CliAnsi

CliAnsi(enabled?: boolean): ICliAnsi

- Defined in src/cli-ansi.ts:56
A factory for ICliAnsis

Parameters
- Default value enabled: boolean = PROCESS.stdout.isTTY && PROCESS.stderr.isTTY
Returns ICliAnsi

CliCommand

CliCommand<TPositionalArgGroup, TNamedArgGroups, TDoubleDashArgGroup>(options: ICliCommandOptions<TPositionalArgGroup, TNamedArgGroups, TDoubleDashArgGroup>): ICliCommand<TPositionalArgGroup, TNamedArgGroups, TDoubleDashArgGroup>

- Defined in src/cli-command.ts:68
A factory for ICliCommands

Type parameters
- TPositionalArgGroup: ICliArgGroup
- TNamedArgGroups: {}
- TDoubleDashArgGroup: ICliArgGroup
Parameters
- options: ICliCommandOptions<TPositionalArgGroup, TNamedArgGroups, TDoubleDashArgGroup>
Returns ICliCommand<TPositionalArgGroup, TNamedArgGroups, TDoubleDashArgGroup>

CliCommandGroup

CliCommandGroup(options: ICliCommandGroupOptions): ICliCommandGroup

- Defined in src/cli-command-group.ts:40
A factory for ICliCommandGroups
example
```
const cloudCommandGroup = CliCommandGroup()
```
Parameters
- options: ICliCommandGroupOptions
Returns ICliCommandGroup

An ICliCommandGroup object

CliFlagArgGroup

CliFlagArgGroup(options?: ICliFlagArgGroupOptions): ICliArgGroup<boolean, false>

- Defined in src/arg-group-factories/cli-flag-arg-group.ts:27
A factory for boolean-valued ICliArgGroup's
example
```
$ cli           // named flag "foo" parses `false`
$ cli --foo     // named flag "foo" parses `true`
$ cli --foo bar // usage error
```
throws

CliUsageError
Parameters
- Default value options: ICliFlagArgGroupOptions = {}
Returns ICliArgGroup<boolean, false>

CliJsonArgGroup

CliJsonArgGroup(options?: ICliJsonArgGroupOptions): ICliArgGroup<any>

- Defined in src/arg-group-factories/cli-json-arg-group.ts:34
A factory for ICliArgGroups that JSON.parse
example
Suppose our CLI's positionalArgGroup is a CliJsonArgGroup. Here's how that behaves:
```
$ cli '{"foo":true}' // named value "json" receives object `{ foo: true }`
$ cli                // usage error
$ cli '""' '""'      // usage error
$ cli foo            // error parsing JSON
```
throws

CliUsageError
Parameters
- Default value options: ICliJsonArgGroupOptions = {}
Returns ICliArgGroup<any>

CliNumberArgGroup

CliNumberArgGroup(options: ICliNumberArgGroupOptions & { required: true }): ICliArgGroup<number, true>
CliNumberArgGroup(options?: ICliNumberArgGroupOptions): ICliArgGroup<number | undefined, boolean>

- Defined in src/arg-group-factories/cli-number-arg-group.ts:21
A factory for number-valued required ICliArgGroups

Parameters
- options: ICliNumberArgGroupOptions & { required: true }
Returns ICliArgGroup<number, true>
- Defined in src/arg-group-factories/cli-number-arg-group.ts:26
A factory for number | undefined-valued optional ICliArgGroups

Parameters
- Optional options: ICliNumberArgGroupOptions
Returns ICliArgGroup<number | undefined, boolean>

CliNumberArrayArgGroup

CliNumberArrayArgGroup(options: ICliNumberArrayArgGroupOptions & { required: true }): ICliArgGroup<number[], true>
CliNumberArrayArgGroup(options?: ICliNumberArrayArgGroupOptions): ICliArgGroup<number[] | undefined, boolean>

- Defined in src/arg-group-factories/cli-number-array-arg-group.ts:21
A factory for required number[]-valued ICliArgGroups

Parameters
- options: ICliNumberArrayArgGroupOptions & { required: true }
Returns ICliArgGroup<number[], true>
- Defined in src/arg-group-factories/cli-number-array-arg-group.ts:26
A factory for optional number[] | undefined-valued ICliArgGroups

Parameters
- Optional options: ICliNumberArrayArgGroupOptions
Returns ICliArgGroup<number[] | undefined, boolean>

CliStringArgGroup

CliStringArgGroup(options: ICliStringArgGroupOptions & { required: true }): ICliArgGroup<string, true>
CliStringArgGroup(options?: ICliStringArgGroupOptions): ICliArgGroup<string | undefined, false>

- Defined in src/arg-group-factories/cli-string-arg-group.ts:20
A factory for required string-valued ICliArgGroups

Parameters
- options: ICliStringArgGroupOptions & { required: true }
Returns ICliArgGroup<string, true>
- Defined in src/arg-group-factories/cli-string-arg-group.ts:25
A factory for optional string | undefined-valued ICliArgGroups

Parameters
- Optional options: ICliStringArgGroupOptions
Returns ICliArgGroup<string | undefined, false>

CliStringArrayArgGroup

CliStringArrayArgGroup(options: ICliStringArrayArgGroupOptions & { required: true }): ICliArgGroup<string[], true>
CliStringArrayArgGroup(options?: ICliStringArrayArgGroupOptions): ICliArgGroup<string[] | undefined, boolean>

- Defined in src/arg-group-factories/cli-string-array-arg-group.ts:20
A factory for required string[]-valued ICliArgGroups

Parameters
- options: ICliStringArrayArgGroupOptions & { required: true }
Returns ICliArgGroup<string[], true>
- Defined in src/arg-group-factories/cli-string-array-arg-group.ts:25
A factory for optional string[] | undefined-valued ICliArgGroups

Parameters
- Optional options: ICliStringArrayArgGroupOptions
Returns ICliArgGroup<string[] | undefined, boolean>

CliStringChoiceArgGroup

CliStringChoiceArgGroup<TChoices>(options: ICliStringChoiceArgGroupOptions<TChoices> & { required: true }): ICliArgGroup<TChoices[number], true>
CliStringChoiceArgGroup<TChoices>(options: ICliStringChoiceArgGroupOptions<TChoices>): ICliArgGroup<TChoices[number] | undefined, false>

- Defined in src/arg-group-factories/cli-string-choice-arg-group.ts:41
A factory for ICliArgGroups whose value is one of the choices provided

Type parameters
- TChoices: CliStringChoices
  
  Type of the provided choices.
Parameters
- options: ICliStringChoiceArgGroupOptions<TChoices> & { required: true }
Returns ICliArgGroup<TChoices[number], true>
- Defined in src/arg-group-factories/cli-string-choice-arg-group.ts:46
Type parameters
- TChoices: CliStringChoices
Parameters
- options: ICliStringChoiceArgGroupOptions<TChoices>
Returns ICliArgGroup<TChoices[number] | undefined, false>

Const CliWordMark

CliWordMark(__namedParameters: { ansi: ICliAnsi }): string

- Defined in src/cli-word-mark.ts:3
Parameters
- __namedParameters: { ansi: ICliAnsi }
  - ansi: ICliAnsi
Returns string

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

TCliArgGroupArgs

Type parameters

TRequired: boolean

TCliDescription

TCliDescriptionFunction

Type declaration

Parameters

input: ICliDescriptionFunctionInput

Returns string

TCliRoot

Variables

Const CLI_COMMAND

Const CLI_COMMAND_GROUP

Const CLI_TERSE_ERROR

Const CLI_USAGE_ERROR

Functions

Cli

Parameters

root: TCliRoot

Default value options: ICliOptions = {}

Returns ICli

CliAnsi

Parameters

Default value enabled: boolean = PROCESS.stdout.isTTY && PROCESS.stderr.isTTY

Returns ICliAnsi

CliCommand

Type parameters

TPositionalArgGroup: ICliArgGroup

TNamedArgGroups: {}

TDoubleDashArgGroup: ICliArgGroup

Parameters

options: ICliCommandOptions<TPositionalArgGroup, TNamedArgGroups, TDoubleDashArgGroup>

Returns ICliCommand<TPositionalArgGroup, TNamedArgGroups, TDoubleDashArgGroup>

CliCommandGroup

Parameters

options: ICliCommandGroupOptions

Returns ICliCommandGroup

CliFlagArgGroup

Parameters

Default value options: ICliFlagArgGroupOptions = {}

Returns ICliArgGroup<boolean, false>

CliJsonArgGroup

Parameters

Default value options: ICliJsonArgGroupOptions = {}

Returns ICliArgGroup<any>

CliNumberArgGroup

Parameters

options: ICliNumberArgGroupOptions & { required: true }

Returns ICliArgGroup<number, true>

Parameters

Optional options: ICliNumberArgGroupOptions

Returns ICliArgGroup<number | undefined, boolean>

CliNumberArrayArgGroup

Parameters

options: ICliNumberArrayArgGroupOptions & { required: true }

Returns ICliArgGroup<number[], true>

Parameters

Optional options: ICliNumberArrayArgGroupOptions

Returns ICliArgGroup<number[] | undefined, boolean>

CliStringArgGroup

Parameters

options: ICliStringArgGroupOptions & { required: true }

Returns ICliArgGroup<string, true>

Parameters

Optional options: ICliStringArgGroupOptions

Returns ICliArgGroup<string | undefined, false>

CliStringArrayArgGroup

Parameters

options: ICliStringArrayArgGroupOptions & { required: true }

Returns ICliArgGroup<string[], true>

Parameters

Optional options: ICliStringArrayArgGroupOptions

Returns ICliArgGroup<string[] | undefined, boolean>