From c7330eb7168c5269f71dfb4d9d9cd6faa3fa7f64 Mon Sep 17 00:00:00 2001 From: Gustavo Madeira Santana Date: Sun, 29 Mar 2026 01:47:25 -0400 Subject: [PATCH] Docs: audit Matrix CLI and setup docs --- docs/cli/channels.md | 2 +- docs/cli/message.md | 24 +++++++++++++----------- docs/reference/wizard.md | 2 +- docs/start/wizard-cli-reference.md | 2 +- 4 files changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/cli/channels.md b/docs/cli/channels.md index cf8b2367a7f..07d19fbaa37 100644 --- a/docs/cli/channels.md +++ b/docs/cli/channels.md @@ -1,7 +1,7 @@ --- summary: "CLI reference for `openclaw channels` (accounts, status, login/logout, logs)" read_when: - - You want to add/remove channel accounts (WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost (plugin)/Signal/iMessage) + - You want to add/remove channel accounts (WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost (plugin)/Signal/iMessage/Matrix) - You want to check channel status or tail channel logs title: "channels" --- diff --git a/docs/cli/message.md b/docs/cli/message.md index 784fa654dba..2b6abc28a69 100644 --- a/docs/cli/message.md +++ b/docs/cli/message.md @@ -9,7 +9,7 @@ title: "message" # `openclaw message` Single outbound command for sending messages and channel actions -(Discord/Google Chat/Slack/Mattermost (plugin)/Telegram/WhatsApp/Signal/iMessage/Microsoft Teams). +(Discord/Google Chat/iMessage/Matrix/Mattermost (plugin)/Microsoft Teams/Signal/Slack/Telegram/WhatsApp). ## Usage @@ -21,7 +21,7 @@ Channel selection: - `--channel` required if more than one channel is configured. - If exactly one channel is configured, it becomes the default. -- Values: `whatsapp|telegram|discord|googlechat|slack|mattermost|signal|imessage|msteams` (Mattermost requires plugin) +- Values: `discord|googlechat|imessage|matrix|mattermost|msteams|signal|slack|telegram|whatsapp` (Mattermost requires plugin) Target formats (`--target`): @@ -33,6 +33,7 @@ Target formats (`--target`): - Mattermost (plugin): `channel:`, `user:`, or `@username` (bare ids are treated as channels) - Signal: `+E.164`, `group:`, `signal:+E.164`, `signal:group:`, or `username:`/`u:` - iMessage: handle, `chat_id:`, `chat_guid:`, or `chat_identifier:` +- Matrix: `@user:server`, `!room:server`, or `#alias:server` - Microsoft Teams: conversation id (`19:...@thread.tacv2`) or `conversation:` or `user:` Name lookup: @@ -65,7 +66,7 @@ Name lookup: ### Core - `send` - - Channels: WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost (plugin)/Signal/iMessage/Microsoft Teams + - Channels: WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost (plugin)/Signal/iMessage/Matrix/Microsoft Teams - Required: `--target`, plus `--message` or `--media` - Optional: `--media`, `--reply-to`, `--thread-id`, `--gif-playback` - Telegram only: `--buttons` (requires `channels.telegram.capabilities.inlineButtons` to allow it) @@ -82,7 +83,7 @@ Name lookup: - Telegram only: `--poll-duration-seconds` (5-600), `--silent`, `--poll-anonymous` / `--poll-public`, `--thread-id` - `react` - - Channels: Discord/Google Chat/Slack/Telegram/WhatsApp/Signal + - Channels: Discord/Google Chat/Slack/Telegram/WhatsApp/Signal/Matrix - Required: `--message-id`, `--target` - Optional: `--emoji`, `--remove`, `--participant`, `--from-me`, `--target-author`, `--target-author-uuid` - Note: `--remove` requires `--emoji` (omit `--emoji` to clear own reactions where supported; see /tools/reactions) @@ -90,35 +91,36 @@ Name lookup: - Signal group reactions: `--target-author` or `--target-author-uuid` required - `reactions` - - Channels: Discord/Google Chat/Slack + - Channels: Discord/Google Chat/Slack/Matrix - Required: `--message-id`, `--target` - Optional: `--limit` - `read` - - Channels: Discord/Slack + - Channels: Discord/Slack/Matrix - Required: `--target` - Optional: `--limit`, `--before`, `--after` - Discord only: `--around` - `edit` - - Channels: Discord/Slack + - Channels: Discord/Slack/Matrix - Required: `--message-id`, `--message`, `--target` - `delete` - - Channels: Discord/Slack/Telegram + - Channels: Discord/Slack/Telegram/Matrix - Required: `--message-id`, `--target` - `pin` / `unpin` - - Channels: Discord/Slack + - Channels: Discord/Slack/Matrix - Required: `--message-id`, `--target` - `pins` (list) - - Channels: Discord/Slack + - Channels: Discord/Slack/Matrix - Required: `--target` - `permissions` - - Channels: Discord + - Channels: Discord/Matrix - Required: `--target` + - Matrix only: available when Matrix encryption is enabled and verification actions are allowed - `search` - Channels: Discord diff --git a/docs/reference/wizard.md b/docs/reference/wizard.md index 039d3df811e..12a746471df 100644 --- a/docs/reference/wizard.md +++ b/docs/reference/wizard.md @@ -209,7 +209,7 @@ Typical fields in `~/.openclaw/openclaw.json`: - `tools.profile` (local onboarding defaults to `"coding"` when unset; existing explicit values are preserved) - `gateway.*` (mode, bind, auth, tailscale) - `session.dmScope` (behavior details: [CLI Setup Reference](/start/wizard-cli-reference#outputs-and-internals)) -- `channels.telegram.botToken`, `channels.discord.token`, `channels.signal.*`, `channels.imessage.*` +- `channels.telegram.botToken`, `channels.discord.token`, `channels.matrix.*`, `channels.signal.*`, `channels.imessage.*` - Channel allowlists (Slack/Discord/Matrix/Microsoft Teams) when you opt in during the prompts (names resolve to IDs when possible). - `skills.install.nodeManager` - `wizard.lastRunAt` diff --git a/docs/start/wizard-cli-reference.md b/docs/start/wizard-cli-reference.md index 73418425c71..3caf3b221f2 100644 --- a/docs/start/wizard-cli-reference.md +++ b/docs/start/wizard-cli-reference.md @@ -258,7 +258,7 @@ Typical fields in `~/.openclaw/openclaw.json`: - `tools.profile` (local onboarding defaults to `"coding"` when unset; existing explicit values are preserved) - `gateway.*` (mode, bind, auth, tailscale) - `session.dmScope` (local onboarding defaults this to `per-channel-peer` when unset; existing explicit values are preserved) -- `channels.telegram.botToken`, `channels.discord.token`, `channels.signal.*`, `channels.imessage.*` +- `channels.telegram.botToken`, `channels.discord.token`, `channels.matrix.*`, `channels.signal.*`, `channels.imessage.*` - Channel allowlists (Slack, Discord, Matrix, Microsoft Teams) when you opt in during prompts (names resolve to IDs when possible) - `skills.install.nodeManager` - `wizard.lastRunAt`