Class default`Abstract`

Hierarchy

Command
- default

Constructors

constructor

new default(argv: string[], config: Config): default
Parameters
- argv: string[]
- config: Config
Returns default
Inherited from Command.constructor
- Defined in node_modules/.pnpm/@oclif+core@4.8.3/node_modules/@oclif/core/lib/command.d.ts:77

Properties

`Static`baseFlags

baseFlags: FlagInput<{}> = ...

`Static` `Optional`descriptionWithMarkdown

descriptionWithMarkdown?: string

Accessors

`Static`jsonOutputSchema

get jsonOutputSchema(): JsonOutputSchema<ZodTypeAny> | undefined
Returns JsonOutputSchema<ZodTypeAny> | undefined
- Defined in packages/cli-kit/src/public/node/base-command.ts:54

`Static`requiresSyncAnalytics

get requiresSyncAnalytics(): boolean
Returns boolean
- Defined in packages/cli-kit/src/public/node/base-command.ts:58

Methods

`Protected`_run

_run<T>(): Promise<T>
Type Parameters
- T
Returns Promise<T>
Overrides Command._run
- Defined in packages/cli-kit/src/public/node/base-command.ts:100

catch

catch(error: Error & { skipOclifErrorHandling: boolean }): Promise<void>
Parameters
- error: Error & { skipOclifErrorHandling: boolean }
Returns Promise<void>
Overrides Command.catch
- Defined in packages/cli-kit/src/public/node/base-command.ts:87

`Protected`environmentsFilename

environmentsFilename(): string | undefined
Returns string | undefined
- Defined in packages/cli-kit/src/public/node/base-command.ts:200

`Protected`exitWithTimestampWhenEnvVariablePresent

exitWithTimestampWhenEnvVariablePresent(): void
Returns void
- Defined in packages/cli-kit/src/public/node/base-command.ts:159

`Protected`failMissingNonTTYFlags

failMissingNonTTYFlags(flags: FlagOutput, requiredFlags: string[]): void
Parameters
- flags: FlagOutput
- requiredFlags: string[]
Returns void
- Defined in packages/cli-kit/src/public/node/base-command.ts:227

`Protected`init

init(): Promise<unknown>
Returns Promise<unknown>
Overrides Command.init
- Defined in packages/cli-kit/src/public/node/base-command.ts:104

`Protected`parse

parse<
    TFlags extends
        OutputFlags<any> & {
            "auth-alias"?: string;
            path?: string;
            verbose?: boolean;
        },
    TGlobalFlags extends OutputFlags<any>,
    TArgs extends OutputArgs<any>,
>(
    options?: Input<TFlags, TGlobalFlags, TArgs>,
    argv?: string[],
): Promise<ParserOutput<TFlags, TGlobalFlags, TArgs> & { argv: string[] }>
Type Parameters
- TFlags extends OutputFlags<any> & { "auth-alias"?: string; path?: string; verbose?: boolean }
- TGlobalFlags extends OutputFlags<any>
- TArgs extends OutputArgs<any>
Parameters
- Optionaloptions: Input<TFlags, TGlobalFlags, TArgs>
- Optionalargv: string[]
Returns Promise<ParserOutput<TFlags, TGlobalFlags, TArgs> & { argv: string[] }>
Overrides Command.parse
- Defined in packages/cli-kit/src/public/node/base-command.ts:170

`Protected`parseEnvironmentFlags

parseEnvironmentFlags<
    TFlags extends OutputFlags<any>,
    TGlobalFlags extends OutputFlags<any>,
    TArgs extends OutputArgs<any>,
>(
    environment: JsonMap,
    options: Input<TFlags, TGlobalFlags, TArgs>,
    explicitFlags: FlagOutput,
): Promise<OutputFlags<any>>
Type Parameters
- TFlags extends OutputFlags<any>
- TGlobalFlags extends OutputFlags<any>
- TArgs extends OutputArgs<any>
Parameters
- environment: JsonMap
- options: Input<TFlags, TGlobalFlags, TArgs>
- explicitFlags: FlagOutput
Returns Promise<OutputFlags<any>>
- Defined in packages/cli-kit/src/public/node/base-command.ts:205

`Protected`runWithParsedOutput

runWithParsedOutput<T>(flags: FlagOutput, execute: () => T): T
Type Parameters
- T
Parameters
- flags: FlagOutput
- execute: () => T
Returns T
- Defined in packages/cli-kit/src/public/node/base-command.ts:188

`Protected`showDeprecatedAutomationTokenVariableWarning

showDeprecatedAutomationTokenVariableWarning(): Promise<void>
Returns Promise<void>
- Defined in packages/cli-kit/src/public/node/base-command.ts:145

`Protected`showNpmFlagWarning

showNpmFlagWarning(): void
Returns void
- Defined in packages/cli-kit/src/public/node/base-command.ts:123

`Protected`validateNonTTYFlags

validateNonTTYFlags(flags: FlagOutput): void
Parameters
- flags: FlagOutput
Returns void
- Defined in packages/cli-kit/src/public/node/base-command.ts:223

`Static`analyticsNameOverride

analyticsNameOverride(): string | undefined
Returns string | undefined
- Defined in packages/cli-kit/src/public/node/base-command.ts:77

`Static`analyticsStopCommand

analyticsStopCommand(): string | undefined
Returns string | undefined
- Defined in packages/cli-kit/src/public/node/base-command.ts:81

`Static`descriptionForHelp

descriptionForHelp(): string | undefined
Returns string | undefined
- Defined in packages/cli-kit/src/public/node/base-command.ts:67

`Static`descriptionWithoutMarkdown

descriptionWithoutMarkdown(): string | undefined
Returns string | undefined

Deprecated
Use descriptionForHelp instead.
- Defined in packages/cli-kit/src/public/node/base-command.ts:73

`Static`nonTTYFlagRequirements

nonTTYFlagRequirements(_flags: FlagOutput): NonTTYFlagRequirement[]
Parameters
- _flags: FlagOutput
Returns NonTTYFlagRequirement[]
- Defined in packages/cli-kit/src/public/node/base-command.ts:62

Class defaultAbstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns default

Properties

StaticbaseFlags

Static OptionaldescriptionWithMarkdown

Accessors

StaticjsonOutputSchema

Returns JsonOutputSchema<ZodTypeAny> | undefined

StaticrequiresSyncAnalytics

Returns boolean

Methods

Protected_run

Type Parameters

Returns Promise<T>

catch

Parameters

Returns Promise<void>

ProtectedenvironmentsFilename

Returns string | undefined

ProtectedexitWithTimestampWhenEnvVariablePresent

Returns void

ProtectedfailMissingNonTTYFlags

Parameters

Returns void

Protectedinit

Returns Promise<unknown>

Protectedparse

Type Parameters

Parameters

Returns Promise<ParserOutput<TFlags, TGlobalFlags, TArgs> & { argv: string[] }>

ProtectedparseEnvironmentFlags

Type Parameters

Parameters

Returns Promise<OutputFlags<any>>

ProtectedrunWithParsedOutput

Type Parameters

Parameters

Returns T

ProtectedshowDeprecatedAutomationTokenVariableWarning

Returns Promise<void>

ProtectedshowNpmFlagWarning

Returns void

ProtectedvalidateNonTTYFlags

Parameters

Returns void

StaticanalyticsNameOverride

Returns string | undefined

StaticanalyticsStopCommand

Returns string | undefined

StaticdescriptionForHelp

Returns string | undefined

StaticdescriptionWithoutMarkdown

Returns string | undefined

Deprecated

StaticnonTTYFlagRequirements

Parameters

Returns NonTTYFlagRequirement[]

Settings

On This Page

Class default`Abstract`

`Static`baseFlags

`Static` `Optional`descriptionWithMarkdown

`Static`jsonOutputSchema

`Static`requiresSyncAnalytics

`Protected`_run

`Protected`environmentsFilename

`Protected`exitWithTimestampWhenEnvVariablePresent

`Protected`failMissingNonTTYFlags

`Protected`init

`Protected`parse

`Protected`parseEnvironmentFlags

`Protected`runWithParsedOutput

`Protected`showDeprecatedAutomationTokenVariableWarning

`Protected`showNpmFlagWarning

`Protected`validateNonTTYFlags

`Static`analyticsNameOverride

`Static`analyticsStopCommand

`Static`descriptionForHelp

`Static`descriptionWithoutMarkdown

`Static`nonTTYFlagRequirements