Interface: CliTool

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

Extends

• CliToolInfo.Disposable

Properties

displayName

displayName: string

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

Inherited from

CliToolInfo.displayName

---

extensionInfo

extensionInfo: object

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

id

id: string

label

label: string

Inherited from

CliToolInfo.extensionInfo

---

id

id: string

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

Inherited from

CliToolInfo.id

---

images

images: ProviderImages

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

Inherited from

CliToolInfo.images

---

markdownDescription

markdownDescription: string

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

Inherited from

CliToolInfo.markdownDescription

---

name

name: string

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

Inherited from

CliToolInfo.name

---

onDidUninstall

onDidUninstall: Event<void>

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

---

onDidUpdateVersion

onDidUpdateVersion: Event<string>

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

---

path?

optional path: string

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

Inherited from

CliToolInfo.path

---

state

state: "registered"

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

---

version?

optional version: string

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

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:4773

Parameters

installer

CliToolInstaller

Returns

Disposable

---

registerUpdate()

registerUpdate(update): Disposable

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

Parameters

update

CliToolUpdate | CliToolSelectUpdate

Returns

Disposable

---

updateVersion()

updateVersion(version): void

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

Parameters

version

CliToolUpdateOptions

Returns

void