Registry / ai-ml / openclaw-stepfun

openclaw-stepfun

library0.2.27jsnpmunverified

OpenClaw Stepfun is a WebSocket gateway channel plugin that integrates Stepfun Bot API into the OpenClaw platform, enabling real-time bidirectional communication with automatic reconnection and heartbeat keep-alive. The current stable version is 0.2.27, released under MIT license. It requires OpenClaw >= 2026.2.0 and Node.js >= 20.19.0. The plugin is designed for the OpenClaw ecosystem, providing a plugin-based architecture for extending gateway capabilities with Stepfun's service. Installation is primarily through the OpenClaw CLI, with an automated script available. Key differentiators include native integration with OpenClaw's plugin system and support for WebSocket-based real-time messaging.

ai-ml messaging

npm install openclaw-stepfun

package ↗

INSTALL

IMPORT

SIG · OPENCLAW-STEPFUN

openclaw-stepfun

ai-mljavascriptv0.2.27

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 export

✓ import openclawStepfun from 'openclaw-stepfun'

✗ const openclawStepfun = require('openclaw-stepfun')

Plugin is ESM-only; CommonJS require will fail.

PluginClass

✓ import { PluginClass } from 'openclaw-stepfun'

✗ import PluginClass from 'openclaw-stepfun'

Use named export for the class, not default.

ChannelInterface

✓ import type { ChannelInterface } from 'openclaw-stepfun'

✗ import { ChannelInterface } from 'openclaw-stepfun'

Type export only; not a runtime value.

Initializes OpenClaw client with Stepfun plugin using environment variables for credentials.

import { OpenClaw } from 'openclaw'; import { OpenClawStepfunPlugin } from 'openclaw-stepfun'; const appId = process.env.STEPFUN_APP_ID ?? ''; const appToken = process.env.STEPFUN_APP_TOKEN ?? ''; const client = new OpenClaw({ plugins: [ new OpenClawStepfunPlugin({ appId, appToken }) ] }); client.start(); console.log('OpenClaw Stepfun plugin initialized with appId:', appId);

Debug

Known issues

breakingOpenClaw Stepfun Plugin v0.2.x requires OpenClaw >= 2026.2.0. Using an older version will cause runtime errors.

fix

Update OpenClaw to 2026.2.0 or later.

affects: <0.2.0

breakingNode.js version must be >=20.19.0. Older versions are not supported and may cause unexpected crashes.

fix

Use Node.js 20.19.0 or newer.

affects: >=0.2.0

gotchaThe plugin uses ESM only. Attempting to use require() will throw a MODULE_NOT_FOUND error.

fix

Use import statements or set type: "module" in package.json.

affects: >=0.2.0

deprecatedThe 'appToken' configuration field is deprecated in favor of 'token'. Old field still works but will be removed in next major version.

fix

Replace 'appToken' with 'token' in the configuration object.

affects: >=0.2.25

gotchaPlugin requires OpenClaw to be running with WebSocket capability. If OpenClaw is not configured for WS, the plugin will fail silently.

fix

Ensure OpenClaw gateway has WebSocket transport enabled.

affects: >=0.2.0

deprecatedUsing 'curl' one-line install script without verifying checksum poses a security risk.

fix

Manually install via 'openclaw plugins install openclaw-stepfun' after verifying the package integrity.

affects: all

Errors

Common errors & fixes

Error: Cannot use 'require()' of ES Module

The package is ESM-only, but CommonJS require was used.

fix

Change to 'import openclawStepfun from 'openclaw-stepfun'' or set type: 'module' in package.json.

Error: Cannot find module 'openclaw-stepfun'

Package not installed or OpenClaw not properly initialized.

fix

Run 'npm install openclaw-stepfun' or install via OpenClaw CLI: 'openclaw plugins install openclaw-stepfun'.

TypeError: (intermediate value).start is not a function

OpenClaw client not created correctly, or plugin not passed to constructor.

fix

Ensure you instantiate OpenClaw with 'new OpenClaw({ plugins: [...] })' then call client.start().

Error: stepfun: auth failed: invalid app token

The appId or appToken provided is incorrect or revoked.

fix

Verify your Stepfun app credentials and update the configuration.

Error: WebSocket connection closed with code 1006

Network issue or Stepfun server unavailable, or heartbeat failure.

fix

Check network connectivity and ensure the Stepfun API endpoint is reachable. The plugin will auto-reconnect.

Upgrade

Version history

0.2.27latest on npm

Audit

Dependencies

openclawrequiredpeer dependency required for plugin runtime

Agent activity

16 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

packageopenclaw-stepfun ↗