alvis
bedb527145
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
74 lines
3.6 KiB
Markdown
74 lines
3.6 KiB
Markdown
---
|
|
summary: "CLI reference for `openclaw directory` (self, peers, groups)"
|
|
read_when:
|
|
- You want to look up contacts/groups/self ids for a channel
|
|
- You are developing a channel directory adapter
|
|
title: "Directory"
|
|
---
|
|
|
|
# `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
|
|
|
|
| Channel | Target id format |
|
|
| ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
| WhatsApp | `+15551234567` (DM), `1234567890-1234567890@g.us` (group), `120363123456789@newsletter` (Channel/Newsletter, outbound only) |
|
|
| Signal | Configured aliases resolve to E.164/UUID DM targets or `group:<id>` group targets |
|
|
| Telegram | `@username` or numeric chat id; groups use numeric ids |
|
|
| Slack | `user:U…` and `channel:C…` |
|
|
| Discord | `user:<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>
|
|
```
|
|
|
|
## Related
|
|
|
|
- [CLI reference](/cli)
|