Skip to main content

Interface: CliToolOptions

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


images

images: ProviderImages

Defined in

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


markdownDescription

markdownDescription: string

Defined in

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


name

name: string

Defined in

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


path

path: string

Defined in

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


version

version: string

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'.

Defined in

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