Registry / devops / openclaw-channel-dmwork

openclaw-channel-dmwork

library0.6.4jsnpmunverified

DMWork channel plugin for OpenClaw v0.6.4 (stable, weekly releases). This plugin connects OpenClaw bots to DMWork servers via DMWORK WebSocket for real-time messaging. It supports multi-account configuration, auto-reconnection, streaming responses, typing indicators, and group chat history. Ships TypeScript types. Requires Node.js >= 18 and OpenClaw >=2026.5.4. Key differentiators: seamless integration with OpenClaw's plugin system, one-command install via npx, CLI tools for health checks and configuration, and automatic WebSocket URL detection.

devops messaging

npm install openclaw-channel-dmwork

package ↗

INSTALL

IMPORT

SIG · OPENCLAW-CHANNEL-D

openclaw-channel-dmwork

devopsjavascriptv0.6.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import plugin from 'openclaw-channel-dmwork'

✗ const plugin = require('openclaw-channel-dmwork')

Package ships as ESM only (type: module). CommonJS require will error.

ChannelPlugin

✓ import { ChannelPlugin } from 'openclaw'

✗ import { ChannelPlugin } from 'openclaw-channel-dmwork'

ChannelPlugin is exported by OpenClaw, not this plugin.

✓ import plugin from 'openclaw-channel-dmwork'

✗ import { register } from 'openclaw-channel-dmwork'

Plugin object exported as default; register method is on that object.

Shows how to import and register the plugin with OpenClaw API, and manually start a bot account using environment variables.

import plugin from 'openclaw-channel-dmwork'; import { createAPI } from 'openclaw'; const api = createAPI(); plugin.register(api); api.runtime.log('Plugin registered'); // Example: start a bot account manually import { startBot } from 'openclaw-channel-dmwork'; await startBot({ botToken: process.env.DMWORK_BOT_TOKEN ?? '', apiUrl: process.env.DMWORK_API_URL ?? 'http://localhost:8090', });

Debug

Known issues

breakingv0.5.0 changed install command from npx openclaw-channel-dmwork install to npx -y openclaw-channel-dmwork install. The old command no longer works.

fix

Use npx -y openclaw-channel-dmwork install with --flags.

affects: <0.5.0

gotchaBot tokens must start with bf_ prefix. Tokens from other sources will be rejected silently.

fix

Ensure token obtained from BotFather in DMWork (send /newbot).

affects: >=0.0.1

deprecatedThe --interactive flag for install is deprecated. Install without arguments defaults to prompting, so --interactive is no longer needed.

fix

Simply run npx -y openclaw-channel-dmwork install without flags.

affects: >=0.4.0

gotchaConfiguration changes under channels.dmwork.accounts require gateway restart to take effect; hot-reload only works for top-level changes.

fix

Restart the OpenClaw gateway after modifying account configurations.

affects: >=0.1.0

breakingIn v0.3.0, the configuration format changed: apiUrl moved from channel-level to account-level. Old configs cause validation errors.

fix

Move apiUrl under each account object in channels.dmwork.accounts.

affects: <0.3.0

gotchaGroup chat history limit default is 20; setting it too high may cause performance issues on large groups.

fix

Set historyLimit to a reasonable value (e.g., 20).

affects: >=0.2.0

Errors

Common errors & fixes

Error: Cannot find module 'openclaw-channel-dmwork'

Package not installed or running in a non-ESM context.

fix

Ensure package is installed (npm i openclaw-channel-dmwork) and that your project uses ESM (type: module in package.json).

Error: Plugin register is not a function

Using named import { register } instead of default import.

fix

Use: import plugin from 'openclaw-channel-dmwork'; then plugin.register(api);

Error: Bot token must be a string starting with 'bf_'

Provided token from a source other than DMWork BotFather.

fix

Create a bot via /newbot in DMWork BotFather and use the token starting with 'bf_'.

Error: Configuration validation failed: 'apiUrl' is required

Missing apiUrl in account configuration after upgrade from v0.2.x.

fix

Add apiUrl under each account in channels.dmwork.accounts (e.g., "my_bot": {"botToken": "...", "apiUrl": "http://..."}).

Error: WebSocket connection failed (code 1006)

Invalid WebSocket URL or server unreachable.

fix

Check wsUrl or ensure DMWork server is running and accessible.

Upgrade

Version history

0.6.4latest on npm

Audit

Dependencies

openclawrequiredPeer dependency; provides the plugin API and runtime environment.

Agent activity

14 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

packageopenclaw-channel-dmwork ↗