DevDock Logo DevDock

Plugin API Reference

Extend DevDock with custom plugins written in TypeScript.

DevDock offers a powerful IPC-based plugin system that allows you to add custom panels, interact with the local filesystem, or hook into the native Docker and Process Manager engines.

Getting Started

To create a new plugin, run the following command in your terminal:

npx create-devdock-plugin my-plugin

Core API Endpoints

devdock.docker.listContainers()

Returns a promise resolving to an array of all active and inactive Docker containers on the local machine.

devdock.process.kill(pid)

Forcefully terminates a running process by its Process ID (PID). Requires administrative privileges on some systems.

devdock.ui.registerSidebarPanel(config)

Registers a new tab in the DevDock left sidebar. You must pass a configuration object containing the icon, title, and React component to render.

Coming Soon

The full API documentation portal is currently under construction for the v1.2.0 release. Check back later for complete type definitions and examples.