Skip to main content

Interface: CliToolOptions

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

Properties

displayName

displayName: string

Source

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


images

images: ProviderImages

Source

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


markdownDescription

markdownDescription: string

Source

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


name

name: string

Source

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


path

path: string

Source

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


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

Source

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