ContextQMD
Back to Openclaw

Directory

docs/cli/directory.md

2026.7.13.3 KB
Original Source

openclaw directory

Directory lookups for channels that support them: contacts/peers, groups, and "me" (self).

Results are meant to be pasted into other commands, especially openclaw message send --target ....

Common flags

  • --channel <name>: channel id/alias (required when multiple channels are configured; auto-selected when only one is configured)
  • --account <id>: account id (default: channel default)
  • --json: output JSON

Default (non-JSON) output is id (and sometimes name) separated by a tab.

Notes

  • For many channels, results are config-backed (allowlists / configured groups) rather than a live provider directory.
  • An already-installed channel plugin can lack directory support. In that case the command reports the unsupported operation; it does not try to reinstall or upgrade the plugin to add support.

Using results with message send

bash
openclaw directory peers list --channel slack --query "U0"
openclaw message send --channel slack --target user:U012ABCDEF --message "hello"

ID formats by channel

ChannelTarget id format
WhatsApp+15551234567 (DM), [email protected] (group), 120363123456789@newsletter (Channel/Newsletter, outbound only)
SignalConfigured aliases resolve to E.164/UUID DM targets or group:<id> group targets
Telegram@username or numeric chat id; groups use numeric ids
Slackuser:U… and channel:C…
Discorduser:<id> and channel:<id>
Matrix (plugin)user:@user:server, room:!roomId:server, or #alias:server
Microsoft Teams (plugin)user:<id> and conversation:<id>
Zalo (plugin)User id (Bot API)
Zalo Personal / zalouser (plugin)Thread id (DM/group), from zca (me, friend list, group list)

Self ("me")

bash
openclaw directory self --channel zalouser

Peers (contacts/users)

bash
openclaw directory peers list --channel zalouser
openclaw directory peers list --channel zalouser --query "name"
openclaw directory peers list --channel zalouser --limit 50

Groups

bash
openclaw directory groups list --channel zalouser
openclaw directory groups list --channel zalouser --query "work"
openclaw directory groups members --channel zalouser --group-id <id>