Class Nuru

Index

Constructors

Properties

name version accent commands nuru_version _args

Methods

_add_cmd register_commands log _format_inline _error _substr _find_cmd _resolve_cmd_name handle

Constructors

constructor

new Nuru(opts?: Partial<NuruOptions>): Nuru
Parameters
- opts: Partial<NuruOptions> = {}
Returns Nuru
- Defined in index.ts:31

Properties

name

name: string

version

version: string

accent

accent: ChalkInstance

An instance of Chalk that uses the accent color

commands

commands: Command<Nuru>[]

The registered commands

nuru_version

nuru_version: string = version

The version of Nuru

`Protected`_args

_args: Result<Spec>

Methods

`Protected`_add_cmd

_add_cmd(cmd: Command<Nuru>): void
Parameters
- cmd: Command<Nuru>
Returns void
- Defined in index.ts:61

register_commands

register_commands(cmds: Command<Nuru> | Command<Nuru>[]): this
Register command(s)
Parameters
- cmds: Command<Nuru> | Command<Nuru>[]
Returns this
- Defined in index.ts:67

log

log(text: string, showTitle?: boolean, title?: boolean): Promise<void>
Log a message
Parameters
- text: string
- showTitle: boolean = false
- title: boolean = false
Returns Promise<void>
- Defined in index.ts:74

`Protected`_format_inline

_format_inline(str: string): string
Parameters
- str: string
Returns string
- Defined in index.ts:81

`Protected`_error

_error(_text: string | Error): void
Parameters
- _text: string | Error
Returns void
- Defined in index.ts:83

`Protected`_substr

_substr(str: string, start: string, end: string): string
Parameters
- str: string
- start: string
- end: string
Returns string
- Defined in index.ts:92

`Protected`_find_cmd

_find_cmd(name: string): undefined | Command<Nuru>
Parameters
- name: string
Returns undefined | Command<Nuru>
- Defined in index.ts:95

`Protected`_resolve_cmd_name

_resolve_cmd_name(): undefined | string
Returns undefined | string
- Defined in index.ts:97

handle

handle(): Promise<void>
Run the CLI

Returns Promise<void>
- Defined in index.ts:104