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:4316
images
images:
ProviderImages
Defined in
packages/extension-api/src/extension-api.d.ts:4318
installationSource?
optionalinstallationSource:CliToolInstallationSource
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
Defined in
packages/extension-api/src/extension-api.d.ts:4336
markdownDescription
markdownDescription:
string
Defined in
packages/extension-api/src/extension-api.d.ts:4317
name
name:
string
Defined in
packages/extension-api/src/extension-api.d.ts:4315
path?
optionalpath:string
Defined in
packages/extension-api/src/extension-api.d.ts:4329
version?
optionalversion: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'.
Note: If the version and path are not defined (= the tool is not installed), the install logic should be implemented