Skip to content

Local testing ​

Run your plugin during development without packaging or publishing.

Steps ​

  1. Start the Dot X application (this launches the plugin server on port 3001)

  2. From your plugin directory, run the plugin:

    Node:

    bash
    npm run build
    npm start

    Deno:

    bash
    deno task start
  3. The plugin connects, registers, and calls onLoad(). Watch for logs in:

    • The Dot X application UI
    • plugin.log inside your plugin folder
    • Your terminal output

Hot reload ​

Deno: Pass --watch to restart on file changes:

bash
deno run --allow-all --watch main.ts

Node: Re-run npm run build && npm start after each change, or use a watcher.

Custom port ​

If you changed the plugin server port, set the environment variable before starting:

bash
DOTX_PLUGIN_PORT=3002 npm start

Tips ​

  • Keep onUnload() idempotent so rapid restarts don't leave stale state
  • Use this.config to persist settings between restarts
  • The SDK automatically retries failed connections — you don't need to restart if the app isn't ready yet
  • If connection hangs, verify the app is running and check firewall rules for localhost