Skip to main content

API Reference

The extension API reference is located here.

Based on your use cases, you can add these common capabilities to your extension:

  • Create a new CLI tool instance and register it with Podman Desktop, see the details here. You can add the createCliTool() function with relevant parameters in your src/extension.ts file.
    • Register the state of a CLI tool, see the resource.
  • Add operations related to a container engine, see the usage of the containerEngine API.
  • Add a new Kubernetes provider connection, use the KubernetesProviderConnection interface.
  • Enable navigation to a CLI tool page, use the function navigateToCliTools().
  • Enable navigation to a specific page in the UI, refer to the navigation APIs category.
  • Create and show a new webview panel in the UI, use the createWebviewPanel() function.
  • Add options for running a command, use the RunOptions interface.

You can also create your own custom extensions and add them to the catalog for others to use.