Example Commands

Copy-paste CLI commands for common OpenClaw SimpleX tasks like generating invite links, approving contacts, listing paired users, and managing addresses.

Use this page as a command cookbook after the first setup is working. For the full first-run flow, start with Getting Started.

The long-running simplex-chat -p 5225 process should run in a separate terminal or as a host-managed service. See Runtime Setup for persistent startup.

Install and verify

Start the SimpleX WebSocket runtime:

simplex-chat -p 5225

Install plugin in OpenClaw:

openclaw plugins install @dangoldbj/openclaw-simplex

Enable plugin:

openclaw plugins enable openclaw-simplex

Trust plugin:

openclaw config set plugins.allow "$(
  (openclaw config get plugins.allow --json 2>/dev/null || echo '[]') \
  | jq -c '. + ["openclaw-simplex"] | unique'
)" --strict-json

Configure the WebSocket endpoint:

openclaw channels add --channel openclaw-simplex --url ws://127.0.0.1:5225

Verify that OpenClaw sees and trusts the plugin:

openclaw plugins list

openclaw plugins info openclaw-simplex

If you already completed the first setup flow, you can skip this section and jump straight to invite, pairing, or migration commands below.

Invite and address management

Create a one-time invite link and print a terminal QR code:

openclaw simplex invite create --qr

List current invite and address state:

openclaw simplex invite list

Show the current address link:

openclaw simplex address show --qr

Create or return the current address link:

openclaw simplex address create --qr

Revoke the current address link:

openclaw simplex address revoke

Pairing

List pending pairing requests:

openclaw pairing list

Approve a sender for this channel:

openclaw pairing approve openclaw-simplex <pairingCode>

Migration

Migrate older simplex installs to openclaw-simplex:

openclaw simplex migrate

Preview migration only:

openclaw simplex migrate --dry-run

SimpleX console commands

Run these inside the simplex-chat console if you want to manage links directly from the runtime:

Command	Meaning
/c	Create a one-time connect link.
/ad	Create or return the account address link.
/show_address	Show the current address link.
/delete_address	Revoke the current address link.

Gateway method names

For programmatic invite/address automation, the plugin exposes simplex.invite.create, simplex.invite.list, and simplex.invite.revoke. See Gateway Methods for request and response shapes.