> ## Documentation Index
> Fetch the complete documentation index at: https://openclaw-simplex.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Example Commands

> Copy-paste CLI commands for common OpenClaw SimpleX tasks like runtime diagnostics, one-time invites, SimpleX addresses, contact requests, group links, pairing approval, and migration.

Use this page as a command cookbook after the first setup is working. For the full first-run flow, start with [Getting Started](/guide/getting-started).

<Info>
  The long-running <code>simplex-chat -p 5225</code> process should run in a separate terminal or as a host-managed service. See [Runtime Setup](/guide/runtime-setup) for persistent startup.
</Info>

## Install and verify

Start the SimpleX WebSocket runtime:

```bash theme={null}
simplex-chat -p 5225
```

Install plugin in OpenClaw:

```bash theme={null}
openclaw plugins install @dangoldbj/openclaw-simplex
```

Enable plugin:

```bash theme={null}
openclaw plugins enable openclaw-simplex
```

Trust plugin:

```bash theme={null}
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:

```bash theme={null}
openclaw channels add --channel openclaw-simplex --url ws://127.0.0.1:5225
```

Verify that OpenClaw sees and trusts the plugin:

```bash theme={null}
openclaw plugins list
```

```bash theme={null}
openclaw plugins info openclaw-simplex
```

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

## Runtime diagnostics

Show the active SimpleX runtime state:

```bash theme={null}
openclaw simplex runtime status
```

List runtime users and show the active user:

```bash theme={null}
openclaw simplex runtime users
openclaw simplex runtime active-user
```

Run the higher-level diagnostic summary:

```bash theme={null}
openclaw simplex runtime doctor
```

Use a named account when the channel has multiple accounts:

```bash theme={null}
openclaw simplex runtime doctor --account-id support
```

## Runtime service

Install a user service for <code>simplex-chat</code>. The command prints the plan and asks before writing the service file:

```bash theme={null}
openclaw simplex runtime service install
```

Override auto-detection when needed:

```bash theme={null}
openclaw simplex runtime service install --provider systemd
openclaw simplex runtime service install --provider launchd
openclaw simplex runtime service install --provider sysvinit
```

## Invite and address management

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

```bash theme={null}
openclaw simplex invite create --qr
```

List current invite and address state:

```bash theme={null}
openclaw simplex invite list
```

Revoke the current address/invite link:

```bash theme={null}
openclaw simplex invite revoke
```

Show the current address link:

```bash theme={null}
openclaw simplex address show --qr
```

Create or return the current address link:

```bash theme={null}
openclaw simplex address create --qr
```

Revoke the current address link:

```bash theme={null}
openclaw simplex address revoke
```

## Contact requests

List pending SimpleX contact requests observed by the runtime:

```bash theme={null}
openclaw simplex requests list
```

Accept a pending request:

```bash theme={null}
openclaw simplex requests accept --contact-request-id <id>
```

Reject a pending request:

```bash theme={null}
openclaw simplex requests reject --contact-request-id <id>
```

With multiple accounts:

```bash theme={null}
openclaw simplex requests list --account-id support
```

## Verification

Show or check SimpleX contact verification metadata when supported by the runtime:

```bash theme={null}
openclaw simplex verification show --contact-id <id>
openclaw simplex verification check --contact-id <id> --code "<code>"
```

## Groups and group links

Create a SimpleX group:

```bash theme={null}
openclaw simplex groups create --display-name "OpenClaw Ops"
```

Create a group invite link and print a terminal QR code:

```bash theme={null}
openclaw simplex groups link create --group-id <id> --role member --qr
```

Show the current group invite link:

```bash theme={null}
openclaw simplex groups link list --group-id <id> --qr
```

Revoke the current group invite link:

```bash theme={null}
openclaw simplex groups link revoke --group-id <id>
```

Moderate a group member when supported by the runtime:

```bash theme={null}
openclaw simplex groups member block --group-id <id> --member-id <id>
openclaw simplex groups member delete-messages --group-id <id> --member-id <id>
```

## Files

Receive or cancel a SimpleX file transfer:

```bash theme={null}
openclaw simplex files receive --file-id <id>
openclaw simplex files cancel --file-id <id>
```

## Link onboarding

Preview what connecting to a SimpleX link would do:

```bash theme={null}
openclaw simplex connect plan --link "simplex:/contact#..."
```

Connect the active SimpleX user to a contact, address, or group link:

```bash theme={null}
openclaw simplex connect run --link "https://smp18.simplex.im/g#..."
```

## Pairing

List pending pairing requests:

```bash theme={null}
openclaw pairing list
```

Approve a sender for this channel:

```bash theme={null}
openclaw pairing approve openclaw-simplex <pairingCode>
```

## Migration

Migrate older <code>simplex</code> installs to <code>openclaw-simplex</code>:

```bash theme={null}
openclaw simplex migrate
```

Preview migration only:

```bash theme={null}
openclaw simplex migrate --dry-run
```

## SimpleX console commands

Run these inside the <code>simplex-chat</code> 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 automation, the plugin exposes gateway methods for one-time invite and SimpleX address management, runtime diagnostics, runtime users, verification, contact-request review, group-link lifecycle, moderation, file controls, and SimpleX link onboarding. See [Gateway Methods](/reference/gateway-methods) for request and response shapes.