unplugin-devpilot

Installation

npm i -D unplugin-devpilot

// vite.config.ts
import Devpilot from 'unplugin-devpilot/vite';

export default defineConfig({
  plugins: [Devpilot()],
});

The WebSocket proxy is automatically configured for both HTTP and HTTPS development servers.

// webpack.config.js
import Devpilot from 'unplugin-devpilot/webpack';

export default {
  /* ... */
  plugins: [Devpilot()],
};

The WebSocket proxy is automatically configured in webpack-dev-server.

// rspack.config.js
import Devpilot from 'unplugin-devpilot/rspack';

export default {
  /* ... */
  plugins: [Devpilot()],
};

The WebSocket proxy is automatically configured in rspack-dev-server.

// farm.config.ts
import Devpilot, { getProxyConfig } from 'unplugin-devpilot/farm';

// Note: wsPort is the WebSocket server port (obtained from console output)
export default defineConfig({
  plugins: [Devpilot()],
  server: {
    proxy: getProxyConfig(60427),
  },
});

Farm requires manual proxy configuration. The getProxyConfig(wsPort) helper generates the correct proxy settings. The actual wsPort will be logged to the console when the dev server starts.

Client Import

Add this import to your project entry point to enable the devpilot client:

// main.ts or main.js (entry point)
import 'virtual:devpilot-client';

This import activates the WebSocket connection to the development server and initializes all registered plugins on the client side.

Configuration

You can customize the plugin behavior by passing options:

// vite.config.ts
import Devpilot from 'unplugin-devpilot/vite';

export default defineConfig({
  plugins: [
    Devpilot({
      mcpPort: 3101, // Optional: Specify MCP server port (defaults to 3101)
      plugins: [], // Optional: Array of DevpilotPlugin instances
      skillPaths: ['./.github/skills/devpilot', './.cursor/skills/devpilot'], // Optional: Array of paths to core skill files
    }),
  ],
});

Port Allocation

• WebSocket: Port is automatically allocated internally. The WebSocket connection is proxied through the dev server (via /__devpilot_ws), so it works seamlessly with both HTTP and HTTPS.
• MCP: Defaults to port 3101. If occupied, specify a different port or free up the occupied port.

HTTPS Support

The plugin automatically works with HTTPS development servers (e.g., using unplugin-https-reverse-proxy or Vite's built-in HTTPS). The WebSocket connection is proxied through the dev server using the same protocol:

• HTTP pages: Connects via ws:// (WebSocket)
• HTTPS pages: Connects via wss:// (Secure WebSocket)

No additional configuration is required for HTTPS support.

License

MIT License © 2025-PRESENT Huali