xmtp-cli

Automate XMTP messaging workflows from the command line.

302|87|Updated Jan 5, 2022
One-click install
npx skills add https://github.com/xmtp/xmtp-js --skill xmtp-cli
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: xmtp-cli
Source: https://github.com/xmtp/xmtp-js/tree/main/packages/xmtp-cli/skills/xmtp-cli
Command: npx skills add https://github.com/xmtp/xmtp-js --skill xmtp-cli

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Streamlines XMTP messaging tasks by providing a unified CLI to send encrypted messages, manage DMs and group conversations, and configure identities and consent across wallets.

Core Features & Use Cases

  • Sending and receiving encrypted messages: Command-line operations to exchange secure XMTP messages.
  • DMs and group conversations management: Create, list, and manage direct message chats and group chats.
  • Identity and consent management: Handle wallet-based identities and user consent preferences for spam control across devices.
  • Use Case: Devs can automate messaging workflows, test conversations, and manage user consent in CI/CD pipelines using the xmtp-cli.

Quick Start

Use the XMTP CLI to initialize keys with xmtp init and then begin messaging with commands like xmtp conversations create-dm and xmtp conversation send-text.

Frequently Asked Questions about xmtp-cli

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I send encrypted XMTP messages from the command line?

You can send encrypted XMTP messages from the command line by initializing keys with xmtp init and using commands like xmtp conversations create-dm and xmtp conversation send-text to exchange secure messages.

Can I manage direct messages and group conversations using an XMTP CLI?

Yes, you can manage direct messages and group conversations using the XMTP CLI to create, list, and manage DM chats and group chats directly from the command line.

Do I need wallet keys to use a command-line tool for XMTP messaging?

Yes, you need wallet and encryption keys to use the XMTP CLI, specifically requiring the XMTP_WALLET_KEY and XMTP_DB_ENCRYPTION_KEY environment variables for identity handling and secure messaging.

How do I handle user consent and spam control across multiple wallets in XMTP?

You handle user consent and spam control across multiple wallets in XMTP by using the CLI to configure wallet-based identities and manage user consent preferences across devices.

Can I automate XMTP messaging workflows in a CI/CD pipeline?

Yes, you can automate XMTP messaging workflows in a CI/CD pipeline by using the CLI to test conversations, send messages, and manage consent with support for environment configuration and JSON outputs.

What output formats are supported when running XMTP commands in the terminal?

The XMTP CLI supports JSON and verbose outputs, allowing you to format command-line responses for automated processing or detailed terminal inspection.