Skip to main content

Interface: CliTool

Extends

Properties

displayName

displayName: string

Inherited from

CliToolInfo.displayName

Defined in

packages/extension-api/src/extension-api.d.ts:4631


extensionInfo

extensionInfo: object

id

id: string

label

label: string

Inherited from

CliToolInfo.extensionInfo

Defined in

packages/extension-api/src/extension-api.d.ts:4635


id

id: string

Inherited from

CliToolInfo.id

Defined in

packages/extension-api/src/extension-api.d.ts:4629


images

images: ProviderImages

Inherited from

CliToolInfo.images

Defined in

packages/extension-api/src/extension-api.d.ts:4633


markdownDescription

markdownDescription: string

Inherited from

CliToolInfo.markdownDescription

Defined in

packages/extension-api/src/extension-api.d.ts:4632


name

name: string

Inherited from

CliToolInfo.name

Defined in

packages/extension-api/src/extension-api.d.ts:4630


onDidUninstall

onDidUninstall: Event<void>

Defined in

packages/extension-api/src/extension-api.d.ts:4619


onDidUpdateVersion

onDidUpdateVersion: Event<string>

Defined in

packages/extension-api/src/extension-api.d.ts:4617


state

state: "registered"

Defined in

packages/extension-api/src/extension-api.d.ts:4615


version?

optional version: string

Inherited from

CliToolInfo.version

Defined in

packages/extension-api/src/extension-api.d.ts:4634

Methods

dispose()

dispose(): void

Dispose this object.

Returns

void

Inherited from

Disposable.dispose

Defined in

packages/extension-api/src/extension-api.d.ts:103


registerInstaller()

registerInstaller(installer): Disposable

Parameters

installer: CliToolInstaller

Returns

Disposable

Defined in

packages/extension-api/src/extension-api.d.ts:4625


registerUpdate()

registerUpdate(update): Disposable

Parameters

update: CliToolUpdate | CliToolSelectUpdate

Returns

Disposable

Defined in

packages/extension-api/src/extension-api.d.ts:4622


updateVersion()

updateVersion(version): void

Parameters

version: CliToolUpdateOptions

Returns

void

Defined in

packages/extension-api/src/extension-api.d.ts:4616