XMTP CLI
Use the xmtp command to test, debug, and interact with XMTP conversations, groups, and messages from the command line. This skill is the entry point; use the sub-skills below for specific CLI tasks.
When to apply
- Testing or debugging XMTP from the command line
- Sending messages or creating and managing groups
- Listing or finding conversations, members, and messages
- Syncing conversations and messages
- Managing group permissions
- Demonstrating content types (text, markdown, attachment, transaction, deeplink, miniapp)
Sub-skills
| Sub-skill |
Use when |
| setup |
Initialize CLI and configure env (init, env variables) |
| groups |
Create DM or group, update group metadata |
| send |
Send messages to address or group |
| list |
List conversations, members, messages; find by address or inbox |
| debug |
Get info, resolve address, inspect inbox |
| sync |
Sync conversations or sync all |
| permissions |
List/info group permissions, update permissions |
| content |
Demo text, markdown, attachment, transaction, deeplink, miniapp |
| debugging |
Enable CLI debug logging (XMTP_FORCE_DEBUG env) |
How to use
- Pick the sub-skill that matches the task (e.g. send message → send).
- Read that sub-skill’s
SKILL.md and its rules/ for step-by-step guidance.
Install
npm install -g @xmtp/cli
# or
pnpm add -g @xmtp/cli
# or
yarn global add @xmtp/cli
Run without install
npx @xmtp/cli <command> <arguments>
# or pnpx / yarn dlx
Help
xmtp --help
xmtp <command> --help
Full documentation: docs.xmtp.org
1---2name: xmtp-cli3description: Run and script the XMTP CLI for testing, debugging, and interacting with XMTP conversations, groups, and messages. Use when the user needs init, send, list, groups, debug, sync, permissions, or content commands from the CLI.4license: MIT5---6
7# XMTP CLI
8
9Use the `xmtp` command to test, debug, and interact with XMTP conversations, groups, and messages from the command line. This skill is the entry point; use the sub-skills below for specific CLI tasks.
10
11## When to apply
12
13- Testing or debugging XMTP from the command line
14- Sending messages or creating and managing groups
15- Listing or finding conversations, members, and messages
16- Syncing conversations and messages
17- Managing group permissions
18- Demonstrating content types (text, markdown, attachment, transaction, deeplink, miniapp)
19
20## Sub-skills
21
22| Sub-skill | Use when |
23|-----------|----------|
24| **setup** | Initialize CLI and configure env (init, env variables) |
25| **groups** | Create DM or group, update group metadata |
26| **send** | Send messages to address or group |
27| **list** | List conversations, members, messages; find by address or inbox |
28| **debug** | Get info, resolve address, inspect inbox |
29| **sync** | Sync conversations or sync all |
30| **permissions** | List/info group permissions, update permissions |
31| **content** | Demo text, markdown, attachment, transaction, deeplink, miniapp |
32| **debugging** | Enable CLI debug logging (XMTP_FORCE_DEBUG env) |
33
34## How to use
35
361. Pick the sub-skill that matches the task (e.g. send message → **send**).
372. Read that sub-skill’s `SKILL.md` and its `rules/` for step-by-step guidance.
38
39## Install
40
41```bash
42npm install -g @xmtp/cli
43# or
44pnpm add -g @xmtp/cli
45# or
46yarn global add @xmtp/cli
47```
48
49## Run without install
50
51```bash
52npx @xmtp/cli <command> <arguments>
53# or pnpx / yarn dlx
54```
55
56## Help
57
58```bash
59xmtp --help
60xmtp <command> --help
61```
62
63Full documentation: [docs.xmtp.org](https://docs.xmtp.org)
modbender