Class: Clerc<Commands, GlobalFlags>

Defined in: packages/core/src/cli.ts:48

Type Parameters

Type Parameter	Default type
Commands extends CommandsRecord	object
GlobalFlags extends ClercFlagsDefinition	object

Accessors

_commands

Get Signature

get _commands(): CommandsMap;

Defined in: packages/core/src/cli.ts:101

Returns

CommandsMap

---

_description

Get Signature

get _description(): string;

Defined in: packages/core/src/cli.ts:93

Returns

string

---

_globalFlags

Get Signature

get _globalFlags(): GlobalFlags;

Defined in: packages/core/src/cli.ts:105

Returns

GlobalFlags

---

_name

Get Signature

get _name(): string;

Defined in: packages/core/src/cli.ts:85

Returns

string

---

_scriptName

Get Signature

get _scriptName(): string;

Defined in: packages/core/src/cli.ts:89

Returns

string

---

_version

Get Signature

get _version(): string;

Defined in: packages/core/src/cli.ts:97

Returns

string

---

store

Get Signature

get store(): Partial<ContextStore>;

Defined in: packages/core/src/cli.ts:109

Returns

Partial<ContextStore>

Methods

command()

Call Signature

command(commands): this;

Defined in: packages/core/src/cli.ts:196

Parameters

Parameter	Type
commands	readonly CommandWithHandler<any, any, any>[]

Returns

this

Call Signature

command<Name, Parameters, Flags>(command): Clerc<Commands & Record<string, CommandWithHandler<Name, Parameters, Flags>>, GlobalFlags>;

Defined in: packages/core/src/cli.ts:197

Type Parameters

Type Parameter
Name extends string
Parameters extends readonly ParameterDefinitionValue[]
Flags extends ClercFlagsDefinition

Parameters

Parameter	Type
command	CommandWithHandler<Name, Parameters, Flags>

Returns

Clerc<Commands & Record<string, CommandWithHandler<Name, Parameters, Flags>>, GlobalFlags>

Call Signature

command<Name, Parameters, Flags>(name, options?): Clerc<Commands & Record<Name, Command<Name, Parameters, Flags>>, GlobalFlags>;

Defined in: packages/core/src/cli.ts:207

Type Parameters

Type Parameter
Name extends string
Parameters extends readonly ParameterDefinitionValue[]
Flags extends ClercFlagsDefinition

Parameters

Parameter	Type
name	Name extends keyof Commands ? ["COMMAND ALREADY EXISTS"] : Name
options?	CommandOptions<Parameters, Flags>

Returns

Clerc<Commands & Record<Name, Command<Name, Parameters, Flags>>, GlobalFlags>

Call Signature

command<Name, Parameters, Flags>(
   name,
   description,
options?): Clerc<Commands & Record<Name, Command<Name, Parameters, Flags>>, GlobalFlags>;

Defined in: packages/core/src/cli.ts:221

Type Parameters

Type Parameter
Name extends string
Parameters extends readonly ParameterDefinitionValue[]
Flags extends ClercFlagsDefinition

Parameters

Parameter	Type
name	Name extends keyof Commands ? ["COMMAND ALREADY EXISTS"] : Name
description	string
options?	CommandOptions<Parameters, Flags>

Returns

Clerc<Commands & Record<Name, Command<Name, Parameters, Flags>>, GlobalFlags>

---

description()

description(description): this;

Defined in: packages/core/src/cli.ts:129

Parameters

Parameter	Type
description	string

Returns

this

---

errorHandler()

errorHandler(handler): this;

Defined in: packages/core/src/cli.ts:147

Parameters

Parameter	Type
handler	ErrorHandler

Returns

this

---

globalFlag()

Call Signature

globalFlag<Name, Flag>(
   name,
   description,
options): Clerc<Commands, GlobalFlags & Record<Name, Flag>>;

Defined in: packages/core/src/cli.ts:276

Type Parameters

Type Parameter
Name extends string
Flag extends ClercFlagDefinitionValue

Parameters

Parameter	Type
name	Name
description	string
options	Flag

Returns

Clerc<Commands, GlobalFlags & Record<Name, Flag>>

Call Signature

globalFlag<Name, Flag>(name, options): Clerc<Commands, GlobalFlags & Record<Name, Flag>>;

Defined in: packages/core/src/cli.ts:281

Type Parameters

Type Parameter
Name extends string
Flag extends ClercFlagDefinitionValue

Parameters

Parameter	Type
name	Name
options	Flag

Returns

Clerc<Commands, GlobalFlags & Record<Name, Flag>>

---

interceptor()

interceptor(interceptor): this;

Defined in: packages/core/src/cli.ts:300

Parameters

Parameter	Type
interceptor	Interceptor<Command<string, readonly ParameterDefinitionValue[], ClercFlagsDefinition>, GlobalFlags>

Returns

this

---

name()

name(name): this;

Defined in: packages/core/src/cli.ts:117

Parameters

Parameter	Type
name	string

Returns

this

---

on()

on<Name>(name, handler): this;

Defined in: packages/core/src/cli.ts:306

Type Parameters

Type Parameter
Name extends string | number | symbol | string & Record<never, never>

Parameters

Parameter	Type
name	Name
handler	CommandHandler<Commands[Name], GlobalFlags>

Returns

this

---

parse()

parse<Run>(argvOrOptions): Run extends true ? Promise<void> : Clerc<Commands, GlobalFlags>;

Defined in: packages/core/src/cli.ts:410

Type Parameters

Type Parameter	Default type
Run extends boolean	true

Parameters

Parameter	Type	Default value
argvOrOptions	string[] | ParseOptions<Run>	platformArgv

Returns

Run extends true ? Promise<void> : Clerc<Commands, GlobalFlags>

---

run()

run(): Promise<void>;

Defined in: packages/core/src/cli.ts:340

Returns

Promise<void>

---

scriptName()

scriptName(scriptName): this;

Defined in: packages/core/src/cli.ts:123

Parameters

Parameter	Type
scriptName	string

Returns

this

---

use()

use(plugin): this;

Defined in: packages/core/src/cli.ts:141

Parameters

Parameter	Type
plugin	Plugin

Returns

this

---

version()

version(version): this;

Defined in: packages/core/src/cli.ts:135

Parameters

Parameter	Type
version	string

Returns

this

---

create()

static create(options?): Clerc;

Defined in: packages/core/src/cli.ts:113

Parameters

Parameter	Type
options?	CreateOptions

Returns

Clerc