Skip to main content

Interface: CliTool

Defined in: packages/extension-api/src/extension-api.d.ts:4638

Extends

Properties

displayName

displayName: string

Defined in: packages/extension-api/src/extension-api.d.ts:4655

Inherited from

CliToolInfo.displayName


extensionInfo

extensionInfo: object

Defined in: packages/extension-api/src/extension-api.d.ts:4659

id

id: string

label

label: string

Inherited from

CliToolInfo.extensionInfo


id

id: string

Defined in: packages/extension-api/src/extension-api.d.ts:4653

Inherited from

CliToolInfo.id


images

images: ProviderImages

Defined in: packages/extension-api/src/extension-api.d.ts:4657

Inherited from

CliToolInfo.images


markdownDescription

markdownDescription: string

Defined in: packages/extension-api/src/extension-api.d.ts:4656

Inherited from

CliToolInfo.markdownDescription


name

name: string

Defined in: packages/extension-api/src/extension-api.d.ts:4654

Inherited from

CliToolInfo.name


onDidUninstall

onDidUninstall: Event<void>

Defined in: packages/extension-api/src/extension-api.d.ts:4643


onDidUpdateVersion

onDidUpdateVersion: Event<string>

Defined in: packages/extension-api/src/extension-api.d.ts:4641


state

state: "registered"

Defined in: packages/extension-api/src/extension-api.d.ts:4639


version?

optional version: string

Defined in: packages/extension-api/src/extension-api.d.ts:4658

Inherited from

CliToolInfo.version

Methods

dispose()

dispose(): void

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

Dispose this object.

Returns

void

Inherited from

Disposable.dispose


registerInstaller()

registerInstaller(installer): Disposable

Defined in: packages/extension-api/src/extension-api.d.ts:4649

Parameters

installer

CliToolInstaller

Returns

Disposable


registerUpdate()

registerUpdate(update): Disposable

Defined in: packages/extension-api/src/extension-api.d.ts:4646

Parameters

update

CliToolUpdate | CliToolSelectUpdate

Returns

Disposable


updateVersion()

updateVersion(version): void

Defined in: packages/extension-api/src/extension-api.d.ts:4640

Parameters

version

CliToolUpdateOptions

Returns

void