Interface: CliTool

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

Extends

• CliToolInfo.Disposable

Properties

displayName

displayName: string

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

Inherited from

CliToolInfo.displayName

---

extensionInfo

extensionInfo: object

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

id

id: string

label

label: string

Inherited from

CliToolInfo.extensionInfo

---

id

id: string

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

Inherited from

CliToolInfo.id

---

images

images: ProviderImages

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

Inherited from

CliToolInfo.images

---

markdownDescription

markdownDescription: string

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

Inherited from

CliToolInfo.markdownDescription

---

name

name: string

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

Inherited from

CliToolInfo.name

---

onDidUninstall

onDidUninstall: Event<void>

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

---

onDidUpdateVersion

onDidUpdateVersion: Event<string>

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

---

path?

optional path?: string

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

Inherited from

CliToolInfo.path

---

state

state: "registered"

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

---

version?

optional version?: string

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

Inherited from

CliToolInfo.version

Methods

dispose()

dispose(): void

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

Dispose this object.

Returns

void

Inherited from

Disposable.dispose

---

registerInstaller()

registerInstaller(installer): Disposable

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

Parameters

installer

CliToolInstaller

Returns

Disposable

---

registerUpdate()

registerUpdate(update): Disposable

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

Parameters

update

CliToolUpdate | CliToolSelectUpdate

Returns

Disposable

---

updateVersion()

updateVersion(version): void

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

Parameters

version

CliToolUpdateOptions

Returns

void