Class CCli

A @carnesen/cli command-line interface (CLI)

Hierarchy

CCli

Index

Constructors

constructor

Properties

Methods

Constructors

Protected constructor

new CCli(root: CCliRoot, options: CCliOptions): CCli

- Defined in src/c-cli.ts:51
Parameters
- root: CCliRoot
- options: CCliOptions
Returns CCli

Properties

Private color

color: { blue: any; bold: any; green: any; red: any } = this.options.color ?? cCliColorFactory(this.options.ansi)

Type declaration

blue: function
- blue(text: string): string
- - Defined in src/c-cli-color.ts:4
  Color the text blue
  
  Parameters
  - text: string
  Returns string
bold: function
- bold(text: string): string
- - Defined in src/c-cli-color.ts:7
  Color the text bold
  
  Parameters
  - text: string
  Returns string
green: function
- green(text: string): string
- - Defined in src/c-cli-color.ts:10
  Color the text red
  
  Parameters
  - text: string
  Returns string
red: function
- red(text: string): string
- - Defined in src/c-cli-color.ts:13
  Color the text red
  
  Parameters
  - text: string
  Returns string

Private logger

logger: CCliLogger = this.options.logger ?? CCliConsoleLogger.create()

Private options

options: CCliOptions

Private root

Methods

api

api(args: string[]): Promise<any>

- Defined in src/c-cli.ts:66
Programmatic interface for the CLI. Mostly used for unit testing

Parameters
- args: string[]
  
  Command-line argument strings
Returns Promise<any>

A promise resolving to the command action's return value

Private done

done(code?: undefined | number): void

- Defined in src/c-cli.ts:210
Parameters
- Optional code: undefined | number
Returns void

Private handleException

handleException(exception: any): void

- Defined in src/c-cli.ts:214
Parameters
- exception: any
Returns void

run

run(args?: string[]): Promise<number>

- Defined in src/c-cli.ts:157
Run the command-line interface, console.log the result, and process.exit

Parameters
- Optional args: string[]
  
  Command-line arguments to be parsed and passed into the command action. Defaults to process.argv.slice(2) in Node.js.
Returns Promise<number>

A promise resolving to the command's exit code

runLine

runLine(line?: string): Promise<number>

- Defined in src/c-cli.ts:192
Split a command line into args and call this Cli's run method

This method is used to implement the pseudo-shell on the @carnesen/cli website and will form the basis of a future REPL feature

Parameters
- Default value line: string = ""
  
  A command line
Returns Promise<number>

A promise resolving to the command's exit code

Static create

create(root: CCliRoot, options?: CCliOptions): CCli

- Defined in src/c-cli.ts:265
Factory for CClis

Parameters
- root: CCliRoot
  
  The "root" of this CLI's command tree. See also CCliCommandGroup.
- Default value options: CCliOptions = {}
  
  Advanced options for configuring the CLI
Returns CCli

Generated using TypeDoc and MonoLisa