Interface: CliToolOptions

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

Options to create new CliTool instance and register it in podman desktop

Properties

displayName

displayName: string

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

---

images

images: ProviderImages

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

---

installationSource?

optional installationSource: CliToolInstallationSource

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

How the cli tool has been installed

• external: it has been installed by the user externally from podman desktop. Its update process is disable.
• extension: it has been installed by podman desktop extension. It can be updated

---

markdownDescription

markdownDescription: string

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

---

name

name: string

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

---

path?

optional path: string

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

---

version?

optional version: string

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

Within your extension, it is reccommended to implement your own functionality to check the current version number of the CLI tool. For example, parsing the information from the CLI tool's --version flag. Passing in path will also help to show where the CLI tool is expected to be installed. This is usually the ~/.local/share/containers/podman-desktop/extensions-storage directory. Note: The expected value should not include 'v'. Note: If the version and path are not defined (= the tool is not installed), the install logic should be implemented