Registry / messaging / openclaw-channel-octo

openclaw-channel-octo

library1.0.0jsnpmunverified

Octo channel plugin for OpenClaw enabling real-time communication via WuKongIM WebSocket protocol. Current version 1.0.0, stable with no known breaking changes. It acts as a transport layer for OpenClaw, allowing developers to integrate instant messaging features into their applications. Key differentiators: leverages WuKongIM's scalable WebSocket infrastructure, supports TypeScript types, and follows OpenClaw's plugin architecture. Release cadence is initial stable release.

messaging

npm install openclaw-channel-octo

package ↗

INSTALL

IMPORT

SIG · OPENCLAW-CHANNEL-O

openclaw-channel-octo

messagingjavascriptv1.0.0

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.

OctoChannel

✓ import { OctoChannel } from 'openclaw-channel-octo'

✗ const OctoChannel = require('openclaw-channel-octo').OctoChannel

ESM-only module; CommonJS require will not work. TypeScript types are bundled.

default export (channel factory)

✓ import createOctoChannel from 'openclaw-channel-octo'

✗ const createOctoChannel = require('openclaw-channel-octo')

Default export is a factory function to create a channel instance. ESM only.

ChannelConfig

✓ import type { ChannelConfig } from 'openclaw-channel-octo'

✗ import { ChannelConfig } from 'openclaw-channel-octo'

ChannelConfig is a TypeScript type only; use type import to avoid runtime bundling issues.

Shows how to create an Octo channel, connect using OpenClaw, and listen for messages via WuKongIM WebSocket.

import createOctoChannel from 'openclaw-channel-octo'; import { Claw } from 'openclaw'; const channel = createOctoChannel({ url: process.env.WUKONGIM_URL ?? 'wss://example.com/ws', appKey: process.env.WUKONGIM_APP_KEY ?? '', appSecret: process.env.WUKONGIM_APP_SECRET ?? '' }); const claw = new Claw({ channel }); await claw.connect(); // Now you can use claw to send/receive messages claw.on('message', (msg) => { console.log('Received:', msg); });

Debug

Known issues

gotchaThe default export createOctoChannel is a factory function, not the channel instance. You must call it with config.

fix

Use createOctoChannel(config) to get the channel object.

affects: all

breakingThis package is ESM-only. Attempting to require() will throw an error.

fix

Use import syntax. If using CommonJS, consider dynamic import() or switch to ESM.

affects: >=1.0.0

gotchaThe peer dependency openclaw must be at least version 2026.4.15. Using an older version may cause runtime errors.

fix

Ensure openclaw version meets >=2026.4.15.

affects: all

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module not supported

Attempting to use CommonJS require() on an ESM-only package.

fix

Use import statement or switch to ESM in your project.

TypeError: createOctoChannel is not a function

Using the wrong import (e.g., named import when default import expected).

fix

Import default: import createOctoChannel from 'openclaw-channel-octo'

Error: Cannot find module 'openclaw'

Peer dependency openclaw is not installed.

fix

Install openclaw: npm install openclaw@>=2026.4.15

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

openclawrequiredPeer dependency required for plugin integration, version >=2026.4.15

Agent activity

32 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

packageopenclaw-channel-octo ↗