{ "commands": { "init": { "aliases": [], "args": {}, "description": "Initialize Convos CLI configuration.\n\nSets up the Convos data directory structure and writes a default .env file.\nThe single XMTP inbox identity for this install is created lazily on first use\n(see 'convos identity create' to create it up-front).\n\nThis command creates:\n- The data directory (default: ~/.convos, override with --home or $CONVOS_HOME)\n- A .env file with default environment settings", "examples": [ { "command": "<%= config.bin %> <%= command.id %>", "description": "Initialize with default settings" }, { "command": "<%= config.bin %> <%= command.id %> --env production", "description": "Initialize with production environment" }, { "command": "<%= config.bin %> <%= command.id %> --force", "description": "Overwrite existing configuration" }, { "command": "<%= config.bin %> <%= command.id %> --home /tmp/agent1", "description": "Initialize with a custom data directory" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "stdout": { "description": "Output configuration to stdout instead of writing to file", "name": "stdout", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Path to write .env file", "name": "output", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "default": "dev", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "force": { "char": "f", "description": "Overwrite existing configuration", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "init", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "init.js" ] }, "reset": { "aliases": [], "args": {}, "description": "Reset Convos by deleting the install's identity and all data.\n\nPermanently removes the identity, wallet key, database encryption\nkey, and every XMTP database file under this CONVOS_HOME. The .env\nconfiguration file is preserved.\n\nThis is irreversible — all cryptographic keys will be destroyed and\nconversations become unreadable on this install.", "examples": [ { "command": "<%= config.bin %> <%= command.id %>", "description": "Reset with confirmation prompt" }, { "command": "<%= config.bin %> <%= command.id %> --force", "description": "Reset without confirmation" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Skip confirmation prompt", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "reset", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "reset.js" ] }, "schema": { "aliases": [], "args": { "command": { "description": "Command to describe (e.g. conversation:send-text or 'conversation send-text')", "name": "command", "required": false } }, "description": "Introspect CLI command schemas.\n\nOutputs machine-readable JSON describing commands, arguments, flags,\nand examples. Designed for AI agents to discover tool capabilities\nat runtime without pre-loaded documentation.\n\nWith no arguments, lists all commands with summaries.\nWith a command name, shows the full schema for that command.", "examples": [ { "command": "<%= config.bin %> <%= command.id %>", "description": "List all commands" }, { "command": "<%= config.bin %> <%= command.id %> conversation:send-text", "description": "Show schema for send-text" }, { "command": "<%= config.bin %> <%= command.id %> --topic conversation", "description": "List conversation commands" } ], "flags": { "topic": { "description": "Filter commands by topic", "name": "topic", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "schema", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": false, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "schema.js" ] }, "agent:serve": { "aliases": [], "args": { "id": { "description": "Existing conversation ID to attach to (omit to create new)", "name": "id", "required": false } }, "description": "Run an agent server for a conversation.\n\nStarts a long-running process bound to one conversation, combining\nmessage streaming, join-request processing, and stdin command handling\ninto a single session — ideal for AI agents and bots.\n\nUses this install's singleton identity (per ADR 011) for every\nconversation. To run multiple agents independently, point each at a\ndifferent CONVOS_HOME.\n\nIf no conversation ID is provided, creates a new conversation.\nDisplays the QR code invite on stderr so agents can share it.\n\nUses an ndjson (newline-delimited JSON) protocol:\n\nSTDIN commands (one JSON object per line):\n {\"type\":\"send\",\"text\":\"Hello\"} Send a text message\n {\"type\":\"send\",\"text\":\"Re\",\"replyTo\":\"\"} Reply to a message\n {\"type\":\"react\",\"messageId\":\"\",\"emoji\":\"👍\"} React to a message\n {\"type\":\"react\",\"messageId\":\"\",\"emoji\":\"👍\",\"action\":\"remove\"}\n {\"type\":\"attach\",\"file\":\"./photo.jpg\"} Send a file attachment\n {\"type\":\"attach\",\"file\":\"./img.jpg\",\"replyTo\":\"\"} Reply with attachment\n {\"type\":\"remote-attach\",\"url\":\"https://...\",\"contentDigest\":\"...\",\"secret\":\"...\",\"salt\":\"...\",\"nonce\":\"...\",\"contentLength\":123}\n {\"type\":\"rename\",\"name\":\"New Name\"} Rename the conversation\n {\"type\":\"update-profile\",\"name\":\"New Name\"} Update your profile name\n {\"type\":\"update-profile\",\"image\":\"https://...\"} Update your profile image\n {\"type\":\"update-profile\",\"name\":\"X\",\"image\":\"https://...\"} Update both\n {\"type\":\"update-profile\",\"metadata\":{\"credits\":75,\"verified\":true}} Update metadata\n {\"type\":\"lock\"} Lock (prevent new joins)\n {\"type\":\"unlock\"} Unlock (allow new joins)\n {\"type\":\"explode\"} Explode immediately\n {\"type\":\"explode\",\"scheduled\":\"2025-03-01T00:00:00Z\"} Schedule explosion\n {\"type\":\"stop\"} Graceful shutdown\n\nSTDOUT events (one JSON object per line):\n {\"event\":\"ready\",...} Session started, includes invite URL\n {\"event\":\"message\",...} New message received\n {\"event\":\"member_joined\",...} A member joined via invite\n {\"event\":\"sent\",...} Message sent confirmation\n {\"event\":\"heartbeat\",...} Periodic health check\n {\"event\":\"error\",...} Error occurred\n\nSTDERR: QR code, diagnostic logs (does not interfere with protocol)", "examples": [ { "command": "<%= config.bin %> <%= command.id %> --name \"My Bot\"", "description": "Create a new conversation and start serving" }, { "command": "<%= config.bin %> <%= command.id %> ", "description": "Attach to an existing conversation" }, { "command": "<%= config.bin %> <%= command.id %> --name \"Agent\" --profile-name \"Assistant\" --permissions admin-only", "description": "Create an admin-only conversation with a profile name" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "name": { "description": "Conversation name (when creating new)", "name": "name", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "description": { "description": "Conversation description (when creating new)", "name": "description", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "permissions": { "description": "Permission preset (when creating new)", "name": "permissions", "default": "all-members", "hasDynamicHelp": false, "multiple": false, "options": [ "all-members", "admin-only" ], "type": "option" }, "profile-name": { "description": "Profile display name to use in this conversation", "name": "profile-name", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "no-invite": { "description": "Skip generating an invite (attach mode only)", "name": "no-invite", "allowNo": false, "type": "boolean" }, "heartbeat": { "description": "Emit heartbeat events every N seconds (0 to disable)", "name": "heartbeat", "default": 0, "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "attestation": { "description": "Base64url-encoded Ed25519 attestation signature", "env": "CONVOS_ATTESTATION", "name": "attestation", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "attestation-ts": { "description": "ISO 8601 timestamp used in the attestation", "env": "CONVOS_ATTESTATION_TS", "name": "attestation-ts", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "attestation-kid": { "description": "Key ID for the attestation", "env": "CONVOS_ATTESTATION_KID", "name": "attestation-kid", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "attestation-private-key": { "description": "Path to an Ed25519 private key (PEM). When set with --attestation-kid, the CLI signs the attestation at startup against the resolved XMTP inbox id, so the same command works whether the inbox already exists locally or needs to be materialized first. Mutually exclusive with --attestation / --attestation-ts.", "env": "CONVOS_ATTESTATION_PRIVATE_KEY", "name": "attestation-private-key", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "agent:serve", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "MAX_RECENT_IDS": 1000, "isESM": true, "relativePath": [ "dist", "commands", "agent", "serve.js" ] }, "attestation:generate": { "aliases": [], "args": { "inbox-id": { "description": "The agent's XMTP inbox ID (hex string)", "name": "inbox-id", "required": true } }, "description": "Generate a test attestation for an agent inbox ID.\n\nCreates an Ed25519 key pair, signs an attestation for the given inbox ID,\nand outputs the attestation fields, the private key (for re-signing),\nand a JWKS containing the public key (for verification).\n\nThis is intended for local testing — in production, the backend signs\nattestations and hosts the JWKS endpoint.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "Generate an attestation for an inbox ID" }, { "command": "<%= config.bin %> <%= command.id %> --kid my-key-2026", "description": "Generate with a custom key ID" }, { "command": "<%= config.bin %> <%= command.id %> --json", "description": "Output as JSON for scripting" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "kid": { "description": "Key ID for the attestation", "name": "kid", "default": "convos-agents-test", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "private-key": { "description": "Ed25519 private key in PEM format (re-use an existing key instead of generating one)", "name": "private-key", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "timestamp": { "description": "ISO 8601 timestamp to use (default: now)", "name": "timestamp", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "issuer": { "description": "Issuer identifier for the JWKS key (default: convos)", "name": "issuer", "default": "convos", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "attestation:generate", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "attestation", "generate.js" ] }, "attestation:verify": { "aliases": [], "args": { "inbox-id": { "description": "The agent's XMTP inbox ID", "name": "inbox-id", "required": true } }, "description": "Verify an assistant attestation.\n\nChecks that the Ed25519 signature is valid for the given inbox ID,\ntimestamp, and key. Can verify against a JWKS URL, a local JWKS\nfile, or a raw public key.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> --attestation --attestation-ts --attestation-kid ", "description": "Verify against the default JWKS endpoint" }, { "command": "<%= config.bin %> <%= command.id %> --attestation --attestation-ts --public-key ", "description": "Verify against a raw public key" }, { "command": "<%= config.bin %> <%= command.id %> --attestation --attestation-ts --attestation-kid --jwks-url https://example.com/agents.json", "description": "Verify against a custom JWKS URL" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "attestation": { "description": "Base64url-encoded Ed25519 signature", "name": "attestation", "required": true, "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "attestation-ts": { "description": "ISO 8601 timestamp used in the attestation", "name": "attestation-ts", "required": true, "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "attestation-kid": { "description": "Key ID to look up in the JWKS", "name": "attestation-kid", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "public-key": { "description": "Base64url-encoded Ed25519 public key (skip JWKS lookup)", "name": "public-key", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "jwks-url": { "description": "URL to fetch JWKS from (default: derived from --env)", "name": "jwks-url", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "jwks-file": { "description": "Path to a local JWKS JSON file", "name": "jwks-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "max-age": { "description": "Maximum attestation age in seconds (default: 86400 = 24h)", "name": "max-age", "default": 86400, "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "attestation:verify", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "attestation", "verify.js" ] }, "conversation:add-members": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Add members to a conversation by inbox ID.\n\nLow-level member addition. In Convos, members typically join via\ninvite links instead. Requires super admin permissions.", "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:add-members", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": false, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "add-members.js" ] }, "conversation:consent-state": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Get the consent state of a conversation.", "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:consent-state", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "consent-state.js" ] }, "conversation:download-attachment": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true }, "message-id": { "description": "The message ID of the attachment", "name": "message-id", "required": true } }, "description": "Download an attachment from a message.\n\nDownloads an attachment message and saves it to disk. Handles both\ninline attachments and remote (encrypted) attachments transparently.\n\nFor inline attachments, the content is written directly to disk.\n\nFor remote attachments, the encrypted payload is fetched from the URL\nembedded in the message, decrypted using the keys in the message, and\nthe decrypted content is saved to disk.\n\nThe output filename is determined by (in order of priority):\n1. The --output flag (explicit path)\n2. The filename from the message metadata\n3. Auto-generated from message ID + MIME type extension\n\nUse --raw to save the encrypted payload without decrypting (remote\nattachments only).", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "Download attachment (auto-names from message metadata)" }, { "command": "<%= config.bin %> <%= command.id %> --output ./photo.jpg", "description": "Download to a specific path" }, { "command": "<%= config.bin %> <%= command.id %> --raw", "description": "Save the encrypted payload without decrypting (remote only)" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "output": { "char": "o", "description": "Output file path (default: auto-generated from metadata)", "name": "output", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "raw": { "description": "Save encrypted payload without decrypting (remote attachments only)", "name": "raw", "allowNo": false, "type": "boolean" }, "sync": { "description": "Sync conversation from network before downloading", "name": "sync", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:download-attachment", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "download-attachment.js" ] }, "conversation:download-profile-image": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true }, "inbox-id": { "description": "The member's inbox ID", "name": "inbox-id", "required": true } }, "description": "Download and decrypt a member's profile image.\n\nProfile images are encrypted end-to-end using the group's image encryption\nkey (stored in appData) plus a per-image salt and nonce (carried in each\nmember's ProfileUpdate). This command reads the member's resolved profile,\nfetches the encrypted blob, and writes the decrypted bytes to disk.\n\nRequires the group to have an imageEncryptionKey in appData and the member\nto have sent a ProfileUpdate containing an encryptedImage ref.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "Download to auto-generated filename in the current directory" }, { "command": "<%= config.bin %> <%= command.id %> --output ./alice.jpg", "description": "Download to a specific path" }, { "command": "<%= config.bin %> <%= command.id %> --sync --json", "description": "Sync first and output result as JSON" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "output": { "char": "o", "description": "Output file path (default: ./.bin)", "name": "output", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "sync": { "description": "Sync the conversation from network before reading", "name": "sync", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:download-profile-image", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "download-profile-image.js" ] }, "conversation:explode-status": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Show the explode status of a conversation.\n\nDumps the expiration timestamp from group metadata and the most recent\nExplodeSettings message (if any). Useful for verifying that a scheduled\nor immediate explode was recorded correctly, and for interop tests that\nneed to confirm what a peer observed.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "Show explode state (appData + most recent ExplodeSettings)" }, { "command": "<%= config.bin %> <%= command.id %> --sync --json", "description": "Sync from network first; machine-readable output" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "sync": { "description": "Sync the conversation from network before reading", "name": "sync", "allowNo": false, "type": "boolean" }, "limit": { "description": "Max messages to scan for ExplodeSettings (default 50)", "name": "limit", "default": 50, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:explode-status", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "explode-status.js" ] }, "conversation:explode": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Explode (permanently destroy) a conversation.\n\nSends an ExplodeSettings message to notify all members, updates the\ngroup metadata with the expiration timestamp, and removes every other\nmember from the MLS group (per ADR 011 / ADR 004 C9 amendment).\n\nReceiving clients drop the conversation locally on whichever arrives\nfirst: the ExplodeSettings message or the MLS remove commit.\n\nThe install's identity is NOT destroyed — one identity now covers\nevery conversation on this install.\n\nOnly the conversation creator (super admin) can explode.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> --force", "description": "Explode a conversation immediately" }, { "command": "<%= config.bin %> <%= command.id %> --scheduled \"2025-03-01T00:00:00Z\"", "description": "Schedule a conversation to explode at a specific time" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Skip confirmation prompt", "name": "force", "allowNo": false, "type": "boolean" }, "scheduled": { "description": "Schedule explosion for a future date (ISO8601). If omitted, explodes immediately.", "name": "scheduled", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:explode", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "explode.js" ] }, "conversation:info": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Get detailed information about a conversation.\n\nShows full details including members, permissions, metadata, and the\nidentity this install uses.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "Get conversation details" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:info", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "info.js" ] }, "conversation:invite": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Generate an invite link for a conversation.\n\nCreates a cryptographic invite slug that others can use to request\nto join this conversation (per ADR 001).\n\nThe invite contains:\n- An encrypted conversation ID (only the creator can decrypt)\n- The creator's inbox ID (for routing the join request DM)\n- An invite tag (for verification and revocation)\n- Optional metadata (name, description)\n- A secp256k1 ECDSA signature\n\nDisplays a QR code in the terminal that can be scanned by the\nConvos app. The QR code encodes the full invite URL.\n\nInvite URLs use the format:\n- Dev: dev.convos.org/v2?i=\n- Production: popup.convos.org/v2?i=", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "Generate an invite with QR code (default)" }, { "command": "<%= config.bin %> <%= command.id %> --no-qr", "description": "Generate an invite without QR code" }, { "command": "<%= config.bin %> <%= command.id %> --expires-in 3600", "description": "Generate an invite that expires in 1 hour" }, { "command": "<%= config.bin %> <%= command.id %> --single-use --json", "description": "Generate a single-use invite with JSON output" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "qr": { "description": "Display a QR code in the terminal", "name": "qr", "allowNo": true, "type": "boolean" }, "expires-in": { "description": "Invite expires in N seconds from now", "name": "expires-in", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "single-use": { "description": "Invite expires after first use", "name": "single-use", "allowNo": false, "type": "boolean" }, "include-metadata": { "description": "Include conversation name/description in invite", "name": "include-metadata", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:invite", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "invite.js" ] }, "conversation:last-read-times": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Show the last read times for each member of a conversation.\n\nQueries the XMTP SDK for the last read receipt timestamp per member.\nTimestamps are in nanoseconds since epoch. Members who have never\nsent a read receipt will not appear in the output.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "Show last read times" }, { "command": "<%= config.bin %> <%= command.id %> --json", "description": "Output as JSON for scripting" }, { "command": "<%= config.bin %> <%= command.id %> --sync", "description": "Sync from network before querying" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "sync": { "description": "Sync conversation from network before querying", "name": "sync", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:last-read-times", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "last-read-times.js" ] }, "conversation:lock": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Lock or unlock a conversation.\n\nLocking prevents new members from joining (per ADR 006) by:\n1. Rotating the invite tag (cryptographically invalidates all existing invites)\n2. Setting the XMTP addMember permission to 'deny'\n\nUnlocking restores the ability to add members. Previously shared\ninvites remain invalid — generate new ones after unlocking.\n\nOnly super admins can lock/unlock.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "Lock a conversation" }, { "command": "<%= config.bin %> <%= command.id %> --unlock", "description": "Unlock a conversation" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "unlock": { "description": "Unlock instead of locking", "name": "unlock", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Skip confirmation prompt", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:lock", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "lock.js" ] }, "conversation:members": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "List members of a conversation.\n\nShows all members with their inbox IDs, identifiers, and permission levels.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "List members" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:members", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "members.js" ] }, "conversation:messages": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "List messages in a conversation.\n\nSupports filtering, pagination, and sorting.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "List messages" }, { "command": "<%= config.bin %> <%= command.id %> --sync --limit 10", "description": "Sync and show last 10 messages" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "sync": { "description": "Sync from network before listing", "name": "sync", "allowNo": false, "type": "boolean" }, "limit": { "description": "Maximum number of messages", "name": "limit", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "direction": { "description": "Sort direction", "name": "direction", "default": "descending", "hasDynamicHelp": false, "multiple": false, "options": [ "ascending", "descending" ], "type": "option" }, "sent-before": { "description": "Only messages sent before this timestamp (nanoseconds)", "name": "sent-before", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "sent-after": { "description": "Only messages sent after this timestamp (nanoseconds)", "name": "sent-after", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "delivery-status": { "description": "Filter by delivery status", "name": "delivery-status", "hasDynamicHelp": false, "multiple": false, "options": [ "unpublished", "published", "failed" ], "type": "option" }, "kind": { "description": "Filter by message kind", "name": "kind", "hasDynamicHelp": false, "multiple": false, "options": [ "application", "membership-change" ], "type": "option" }, "content-type": { "description": "Filter by content type (repeatable)", "name": "content-type", "hasDynamicHelp": false, "multiple": true, "options": [ "actions", "attachment", "custom", "group-membership-change", "group-updated", "intent", "leave-request", "markdown", "multi-remote-attachment", "reaction", "read-receipt", "remote-attachment", "reply", "text", "transaction-reference", "wallet-send-calls" ], "type": "option" }, "exclude-content-type": { "description": "Exclude content type (repeatable)", "name": "exclude-content-type", "hasDynamicHelp": false, "multiple": true, "options": [ "actions", "attachment", "custom", "group-membership-change", "group-updated", "intent", "leave-request", "markdown", "multi-remote-attachment", "reaction", "read-receipt", "remote-attachment", "reply", "text", "transaction-reference", "wallet-send-calls" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:messages", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "messages.js" ] }, "conversation:permissions": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "View permissions for a conversation.", "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:permissions", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "permissions.js" ] }, "conversation:profiles": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "List member profiles in a conversation.\n\nShows display names and avatar URLs for all members who have set\na profile in this conversation. Profiles are resolved from\nProfileUpdate/ProfileSnapshot messages (primary) with appData as\nfallback for backward compatibility.\n\nMembers without a profile appear as anonymous with just their inbox ID.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "List all member profiles" }, { "command": "<%= config.bin %> <%= command.id %> --json", "description": "List profiles as JSON" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:profiles", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "profiles.js" ] }, "conversation:remove-members": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Remove members from a conversation. Requires super admin permissions.", "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:remove-members", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": false, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "remove-members.js" ] }, "conversation:send-attachment": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true }, "file": { "description": "Path to the file to send", "name": "file", "required": true } }, "description": "Send a file attachment to a conversation.\n\nReads a file from disk, encrypts it, uploads it via the configured\nupload provider, and sends it as a remote attachment message.\n\nTo configure an upload provider, add to your .env:\n\n CONVOS_API_KEY=\n\nOr explicitly:\n\n CONVOS_UPLOAD_PROVIDER=convos-api\n CONVOS_API_KEY=\n\nThe MIME type is auto-detected from the file extension, or can be\nspecified manually with --mime-type.\n\nUse --encrypt to only encrypt the file and output decryption keys\nwithout sending (for manual upload workflows).", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ./photo.jpg", "description": "Send a photo as a remote attachment" }, { "command": "<%= config.bin %> <%= command.id %> ./photo.jpg --encrypt", "description": "Encrypt and output decryption keys (for manual upload)" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "mime-type": { "description": "Override the auto-detected MIME type", "name": "mime-type", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "encrypt": { "description": "Encrypt the attachment and output decryption keys instead of sending. Upload the payload yourself, then use 'send-remote-attachment' to send.", "name": "encrypt", "allowNo": false, "type": "boolean" }, "encrypted-output": { "dependsOn": [ "encrypt" ], "description": "When using --encrypt, write encrypted payload to this path (default: .encrypted)", "name": "encrypted-output", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "upload-provider": { "description": "Upload provider for remote attachments", "name": "upload-provider", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "upload-provider-token": { "description": "Authentication token for the upload provider", "name": "upload-provider-token", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "upload-provider-gateway": { "description": "Custom gateway URL for the upload provider", "name": "upload-provider-gateway", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:send-attachment", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "send-attachment.js" ] }, "conversation:send-capability-request": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Send a CapabilityRequest to a conversation.\n\nAsks the user (via the device's picker / confirmation card) for a\nspecific capability on a subject — calendar reads, fitness writes,\ncontacts deletes, etc. The device replies asynchronously with a\nCapabilityRequestResult keyed on the same --request-id.\n\nSubject vs. kind: 'subject' is the user-facing capability dimension\nthat may resolve to a device or cloud provider. iOS device kinds\n`health` and `home_kit` correspond to subjects `fitness` and\n`home`; `motion` has no subject (device-only telemetry).", "examples": [ { "command": "<%= config.bin %> <%= command.id %> --subject calendar --capability read --rationale \"To summarize your week\"", "description": "Request calendar read access" }, { "command": "<%= config.bin %> <%= command.id %> --subject fitness --capability read --rationale \"To summarize training\" --preferred-providers composio.strava,composio.fitbit", "description": "Request fitness read with a federation hint (only fitness allows multi-provider reads)" }, { "command": "<%= config.bin %> <%= command.id %> --subject contacts --capability write_create --rationale \"To save the lead you mentioned\" --request-id req-42 --json", "description": "Pin a known requestId for correlating the eventual result" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "subject": { "description": "CapabilitySubject raw value (calendar, fitness, home, etc.)", "name": "subject", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "calendar", "contacts", "tasks", "mail", "photos", "fitness", "music", "location", "home", "screen_time" ], "type": "option" }, "capability": { "description": "ConnectionCapability raw value (read, write_create, write_update, write_delete)", "name": "capability", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "read", "write_create", "write_update", "write_delete" ], "type": "option" }, "rationale": { "description": "Free-form reason rendered verbatim on the picker card. Truncated at 500 chars on encode and decode.", "name": "rationale", "required": true, "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "request-id": { "description": "Caller-supplied correlation ID (default: random)", "name": "request-id", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "preferred-providers": { "description": "Comma-separated provider IDs the agent prefers the resolver default to (e.g. composio.strava,composio.fitbit). Truncated to 16 entries.", "name": "preferred-providers", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:send-capability-request", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "send-capability-request.js" ] }, "conversation:send-cloud-connection-grant-request": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Send a CloudConnectionGrantRequest to a conversation.\n\nPrompts the user (via a card on the receiving iOS device) to link a\ncloud provider (e.g. Strava, Google Calendar) over OAuth. The device\nperforms the OAuth flow itself; the resulting grant becomes visible\nthrough the next `profile.metadata` update under the unified\n`connections` key — there is no on-wire reply codec.\n\nThe codec is silent (`shouldPush=false`); it does not surface in the\nchat stream and emits as a `cloud_connection_grant_request` event on\n`agent serve` instead.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> --service strava --target-inbox-id --reason \"To summarize this week's training\"", "description": "Ask the user to link Strava" }, { "command": "<%= config.bin %> <%= command.id %> --service googlecalendar --target-inbox-id --reason \"To pull your calendar for scheduling\" --json", "description": "Ask the user to link Google Calendar" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "service": { "description": "Cloud service identifier — the Composio toolkit slug (e.g. \"strava\", \"googlecalendar\"). Used by iOS to render a service-specific link card. iOS, the CLI, the agent runtime, the backend, and Composio all use the same slug end-to-end.", "name": "service", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-inbox-id": { "description": "Inbox ID of the user expected to complete the OAuth flow.", "name": "target-inbox-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reason": { "description": "Free-form reason rendered verbatim on the link card. Truncated at 500 chars on encode and decode.", "name": "reason", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "requested-by-inbox-id": { "description": "Inbox ID requesting the grant. Defaults to the agent's own inbox ID.", "name": "requested-by-inbox-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:send-cloud-connection-grant-request", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "send-cloud-connection-grant-request.js" ] }, "conversation:send-invocation": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Send a ConvosConnections invocation to a conversation.\n\nConstructs a ConnectionInvocation envelope (convos.org/connection_invocation:1.0)\nand sends it to the conversation. The receiving device replies asynchronously\nwith a ConnectionInvocationResult keyed on the same --invocation-id.\n\nArguments are provided as a JSON object mapping parameter names to\nArgumentValue tagged objects ({type, value}). Each value is validated\nbefore sending — a malformed tag or value type fails fast rather than\nproducing a payload the device will reject.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> --kind calendar --action create_event \\\n --arguments '{\"title\":{\"type\":\"string\",\"value\":\"Team sync\"},\"isAllDay\":{\"type\":\"bool\",\"value\":false}}'", "description": "Send a calendar create_event invocation" }, { "command": "<%= config.bin %> <%= command.id %> --kind health --action log_water --arguments-file ./water.json", "description": "Read arguments JSON from a file" }, { "command": "<%= config.bin %> <%= command.id %> --kind contacts --action create_contact --invocation-id req-42 --arguments '{}' --json", "description": "Pin a known invocation-id for correlating the reply" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "kind": { "description": "ConnectionKind raw value (e.g. calendar, health, home_kit)", "name": "kind", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "health", "calendar", "contacts", "location", "photos", "music", "home_kit", "screen_time", "motion" ], "type": "option" }, "action": { "description": "Action name as defined by the iOS DataSink (e.g. create_event)", "name": "action", "required": true, "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "invocation-id": { "description": "Caller-supplied correlation ID (default: random)", "name": "invocation-id", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "arguments": { "description": "JSON object mapping arg names to ArgumentValue tagged objects (e.g. {\"title\":{\"type\":\"string\",\"value\":\"x\"}}). Use {} for an empty arg list.", "exclusive": [ "arguments-file" ], "name": "arguments", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "arguments-file": { "description": "Path to a JSON file containing the arguments object", "exclusive": [ "arguments" ], "name": "arguments-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "issued-at": { "description": "Issued-at timestamp (ISO 8601, default: now)", "name": "issued-at", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:send-invocation", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "send-invocation.js" ] }, "conversation:send-reaction": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true }, "message-id": { "description": "The message ID", "name": "message-id", "required": true }, "action": { "description": "add or remove", "name": "action", "options": [ "add", "remove" ], "required": true }, "emoji": { "description": "The reaction emoji", "name": "emoji", "required": true } }, "description": "Send a reaction to a message.", "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:send-reaction", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "send-reaction.js" ] }, "conversation:send-read-receipt": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Send a read receipt to a conversation.\n\nNotifies other members that you have read the latest messages.\nRead receipts are silent — they do not appear as messages in the\nconversation and do not trigger push notifications.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "Send a read receipt" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:send-read-receipt", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "send-read-receipt.js" ] }, "conversation:send-remote-attachment": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true }, "url": { "description": "URL where the encrypted file is hosted", "name": "url", "required": true } }, "description": "Send a remote attachment message to a conversation.\n\nSends a reference to an encrypted file that has been uploaded to a URL.\nThe recipient downloads and decrypts the file using the provided keys.\n\nUse 'conversation send-attachment --encrypt' to encrypt a file and get\nthe required keys, then upload the encrypted payload and use this\ncommand to send the message.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> https://example.com/file.enc --content-digest abc123 --secret --salt --nonce --content-length 12345", "description": "Send a remote attachment" }, { "command": "<%= config.bin %> <%= command.id %> https://example.com/photo.enc --content-digest abc123 --secret --salt --nonce --content-length 12345 --filename photo.jpg", "description": "Send with original filename" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "content-digest": { "description": "SHA-256 digest of the encrypted payload (hex)", "name": "content-digest", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "secret": { "description": "Decryption secret key (base64)", "name": "secret", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "salt": { "description": "Encryption salt (base64)", "name": "salt", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "nonce": { "description": "Encryption nonce (base64)", "name": "nonce", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "scheme": { "description": "URL scheme", "name": "scheme", "default": "https", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "content-length": { "description": "Size of the encrypted payload in bytes", "name": "content-length", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "filename": { "description": "Original filename", "name": "filename", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:send-remote-attachment", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "send-remote-attachment.js" ] }, "conversation:send-reply": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true }, "message-id": { "description": "The message ID to reply to", "name": "message-id", "required": true }, "text": { "description": "The reply text", "name": "text" } }, "description": "Send a reply to a message.\n\nBy default, sends a text reply. Use --file to reply with a file\nattachment instead. File replies are encrypted and uploaded via the\nconfigured upload provider, then sent as a remote attachment.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> \"Reply text\"", "description": "Reply with text" }, { "command": "<%= config.bin %> <%= command.id %> --file ./photo.jpg", "description": "Reply with a photo" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "file": { "char": "f", "description": "Path to a file to send as the reply (instead of text)", "name": "file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "mime-type": { "description": "Override the auto-detected MIME type (with --file)", "name": "mime-type", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "upload-provider": { "description": "Upload provider for remote attachments", "name": "upload-provider", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "upload-provider-token": { "description": "Authentication token for the upload provider", "name": "upload-provider-token", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "upload-provider-gateway": { "description": "Custom gateway URL for the upload provider", "name": "upload-provider-gateway", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:send-reply", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "send-reply.js" ] }, "conversation:send-text": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Send a text message to a conversation.\n\nThe text can be provided as a positional argument or via --text.\nUse --text to avoid shell quoting issues (e.g. smart quotes on macOS).", "examples": [ { "command": "<%= config.bin %> <%= command.id %> \"Hello!\"", "description": "Send a text message" }, { "command": "<%= config.bin %> <%= command.id %> --text \"Hello!\"", "description": "Send using --text flag (avoids shell quoting issues)" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "text": { "char": "t", "description": "The text message to send", "name": "text", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:send-text", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": false, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "send-text.js" ] }, "conversation:send-typing-indicator": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Send a typing indicator to a conversation.\n\nNotifies other members that you are currently typing (or stopped\ntyping). Typing indicators are silent — they do not appear as\nmessages in the conversation and do not trigger push notifications.\n\nThe iOS app auto-expires typing indicators after 15 seconds, so\nyou should send isTyping=true periodically while actively typing,\nand isTyping=false when done.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "Send a typing indicator (isTyping=true)" }, { "command": "<%= config.bin %> <%= command.id %> --stop", "description": "Send a stop-typing indicator (isTyping=false)" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "stop": { "description": "Send isTyping=false (stop typing) instead of isTyping=true", "name": "stop", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:send-typing-indicator", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "send-typing-indicator.js" ] }, "conversation:stream": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Stream messages in a conversation.\n\nListens for new messages in real-time. The stream continues until timeout,\ncount limit, or Ctrl+C.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "Stream messages indefinitely" }, { "command": "<%= config.bin %> <%= command.id %> --timeout 60", "description": "Stream for 60 seconds" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "timeout": { "description": "Stop streaming after N seconds", "name": "timeout", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "count": { "description": "Stop after receiving N messages", "name": "count", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:stream", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "stream.js" ] }, "conversation:sync": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Sync a specific conversation from the network.", "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:sync", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "sync.js" ] }, "conversation:update-consent": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true }, "state": { "description": "The new consent state", "name": "state", "options": [ "allowed", "denied", "unknown" ], "required": true } }, "description": "Update the consent state of a conversation.", "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:update-consent", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "update-consent.js" ] }, "conversation:update-description": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true }, "description": { "description": "The new description", "name": "description", "required": true } }, "description": "Update the description of a conversation.", "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:update-description", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "update-description.js" ] }, "conversation:update-name": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true }, "name": { "description": "The new name", "name": "name", "required": true } }, "description": "Update the name of a conversation. Visible to all members.", "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:update-name", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "update-name.js" ] }, "conversation:update-profile": { "aliases": [], "args": { "id": { "description": "The conversation ID", "name": "id", "required": true } }, "description": "Set your display name and avatar in a conversation.\n\nProfiles are per-conversation — you can be a different person in\neach conversation (ADR 005).\n\nUpdates are sent as ProfileUpdate messages to the group. Both iOS\nand CLI clients read profiles from these messages (with appData as\na legacy fallback). Profile messages are the primary source of truth.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> --name \"Alice\"", "description": "Set your display name" }, { "command": "<%= config.bin %> <%= command.id %> --name \"Alice\" --image \"https://example.com/avatar.jpg\"", "description": "Set display name and avatar" }, { "command": "<%= config.bin %> <%= command.id %> --name \"\" --image \"\"", "description": "Clear your profile (go anonymous)" }, { "command": "<%= config.bin %> <%= command.id %> --metadata credits=75 --metadata verified=true", "description": "Set custom metadata fields" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "name": { "description": "Display name (empty string to clear)", "name": "name", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "image": { "description": "Avatar image URL (empty string to clear)", "name": "image", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "metadata": { "description": "Set a metadata field (key=value). Value is auto-typed: \"true\"/\"false\" → bool, numeric → number, else string. Repeat for multiple fields.", "name": "metadata", "hasDynamicHelp": false, "helpValue": "", "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversation:update-profile", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversation", "update-profile.js" ] }, "conversations:create": { "aliases": [], "args": {}, "description": "Create a new Convos conversation.\n\nCreates an MLS group inside this install's singleton XMTP inbox\n(per ADR 011). The creator becomes super admin. Others join via\ninvite links.\n\nIf no identity exists yet, one is created automatically.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> --name \"Project Team\"", "description": "Create a named conversation" }, { "command": "<%= config.bin %> <%= command.id %> --name \"Team\" --description \"Team discussion\"", "description": "Create with metadata" }, { "command": "<%= config.bin %> <%= command.id %> --name \"Private\" --permissions admin-only --json", "description": "Create admin-only group with JSON output" }, { "command": "<%= config.bin %> <%= command.id %> --name \"Bot\" --attestation --attestation-ts --attestation-kid ", "description": "Create with pre-signed attestation metadata" }, { "command": "<%= config.bin %> <%= command.id %> --name \"Bot\" --metadata instanceId=abc123 --metadata version=2", "description": "Create with custom profile metadata" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "name": { "description": "Conversation name", "name": "name", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "description": { "description": "Conversation description", "name": "description", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "image-url": { "description": "Conversation image URL", "name": "image-url", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "permissions": { "description": "Permission preset", "name": "permissions", "default": "all-members", "hasDynamicHelp": false, "multiple": false, "options": [ "all-members", "admin-only" ], "type": "option" }, "profile-name": { "description": "Profile display name to use in this conversation", "name": "profile-name", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "profile-image": { "description": "Profile image URL to use in this conversation", "name": "profile-image", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "metadata": { "description": "Set a metadata field on the creator profile (key=value). Value is auto-typed: \"true\"/\"false\" → bool, numeric → number, else string. Repeat for multiple fields.", "name": "metadata", "hasDynamicHelp": false, "helpValue": "", "multiple": true, "type": "option" }, "attestation": { "description": "Base64url-encoded Ed25519 attestation signature", "env": "CONVOS_ATTESTATION", "name": "attestation", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "attestation-ts": { "description": "ISO 8601 timestamp used in the attestation", "env": "CONVOS_ATTESTATION_TS", "name": "attestation-ts", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "attestation-kid": { "description": "Key ID for the attestation", "env": "CONVOS_ATTESTATION_KID", "name": "attestation-kid", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversations:create", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversations", "create.js" ] }, "conversations:inspect-invite": { "aliases": [], "args": { "invite": { "description": "Invite slug or URL to inspect", "name": "invite", "required": true } }, "description": "Decode and inspect an invite slug or URL without joining.\n\nParses the invite, verifies its cryptographic signature, and displays\nall embedded metadata. Useful for debugging invite issues.\n\nDoes NOT create an identity, send a join request, or modify any state.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "Inspect a raw invite slug" }, { "command": "<%= config.bin %> <%= command.id %> \"https://dev.convos.org/v2?i=\"", "description": "Inspect a full invite URL" }, { "command": "<%= config.bin %> <%= command.id %> --json", "description": "Output as JSON for scripting" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversations:inspect-invite", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversations", "inspect-invite.js" ] }, "conversations:join": { "aliases": [], "args": { "invite": { "description": "Invite slug or URL", "name": "invite", "required": true } }, "description": "Join a conversation using an invite slug or URL.\n\nUses this install's singleton identity (per ADR 011) to send a join\nrequest to the creator.\n\nSteps:\n1. Parse and validate the invite (verify signature, check expiration)\n2. DM the creator's inbox with the invite slug + joiner profile\n3. Wait for the creator's client to process the request and add us\n4. Send a ProfileUpdate once joined\n\nThe creator's client (iOS app or another CLI instance running\n'convos conversations process-join-requests') must be online to\nprocess the join request.\n\nAccepts either a raw invite slug or a full URL containing the\nslug as query parameter 'i'.", "examples": [ { "command": "<%= config.bin %> <%= command.id %> ", "description": "Join using a raw invite slug" }, { "command": "<%= config.bin %> <%= command.id %> \"https://popup.convos.org/v2?i=\"", "description": "Join using a full invite URL" }, { "command": "<%= config.bin %> <%= command.id %> --no-wait", "description": "Send join request without waiting for acceptance" }, { "command": "<%= config.bin %> <%= command.id %> --timeout 120 --json", "description": "Wait up to 2 minutes for acceptance" }, { "command": "<%= config.bin %> <%= command.id %> --profile-name \"Bot\" --profile-image \"https://example.com/avatar.jpg\"", "description": "Join with a display name and avatar" }, { "command": "<%= config.bin %> <%= command.id %> --metadata role=assistant --metadata version=2", "description": "Join with custom metadata" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "no-wait": { "description": "Send the join request but don't wait for the creator to accept", "name": "no-wait", "allowNo": false, "type": "boolean" }, "timeout": { "description": "Seconds to wait for acceptance (default: 60)", "name": "timeout", "default": 60, "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "profile-name": { "description": "Profile display name to use in this conversation", "name": "profile-name", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "profile-image": { "description": "Profile image URL to use in this conversation", "name": "profile-image", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "metadata": { "description": "Set a metadata field on the join request and profile (key=value). Value is auto-typed: \"true\"/\"false\" → bool, numeric → number, else string. Repeat for multiple fields.", "name": "metadata", "hasDynamicHelp": false, "helpValue": "", "multiple": true, "type": "option" }, "attestation": { "description": "Base64url-encoded Ed25519 attestation signature", "env": "CONVOS_ATTESTATION", "name": "attestation", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "attestation-ts": { "description": "ISO 8601 timestamp used in the attestation", "env": "CONVOS_ATTESTATION_TS", "name": "attestation-ts", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "attestation-kid": { "description": "Key ID for the attestation", "env": "CONVOS_ATTESTATION_KID", "name": "attestation-kid", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "attestation-private-key": { "description": "Path to an Ed25519 private key (PEM). When set with --attestation-kid, the CLI signs the attestation against the resolved XMTP inbox id once the join is accepted. Mutually exclusive with --attestation / --attestation-ts.", "env": "CONVOS_ATTESTATION_PRIVATE_KEY", "name": "attestation-private-key", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversations:join", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversations", "join.js" ] }, "conversations:list": { "aliases": [], "args": {}, "description": "List all Convos conversations.\n\nLists every group this install's singleton XMTP inbox participates in\n(per ADR 011).\n\nInactive conversations (the install has been removed, or the group\nexploded from another client) are hidden by default. Pass --include-inactive\nto see them.\n\nUse --sync to fetch the latest state from the network first.", "examples": [ { "command": "<%= config.bin %> <%= command.id %>", "description": "List active groups" }, { "command": "<%= config.bin %> <%= command.id %> --sync", "description": "Sync from network then list" }, { "command": "<%= config.bin %> <%= command.id %> --include-inactive", "description": "Include conversations this install is no longer a member of" }, { "command": "<%= config.bin %> <%= command.id %> --json", "description": "Output as JSON" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "sync": { "description": "Sync from network before listing", "name": "sync", "allowNo": false, "type": "boolean" }, "include-dms": { "description": "Include DMs in the output (default: groups only)", "name": "include-dms", "allowNo": false, "type": "boolean" }, "include-inactive": { "description": "Include conversations where isActive=false (default: hide exploded / removed groups)", "name": "include-inactive", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversations:list", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversations", "list.js" ] }, "conversations:process-join-requests": { "aliases": [], "args": {}, "description": "Process pending join requests for this install's conversations.\n\nScans DMs addressed to this install's singleton inbox for signed\ninvite slugs. When a valid join request is found:\n\n1. Verify the invite signature\n2. Decrypt the conversation token to get the conversation ID\n3. Verify the creator inbox ID matches this install\n4. Add the requester to the conversation\n5. Send a ProfileSnapshot so the joiner has everyone's profile\n6. Block invalid/spam requests\n\nWithout --watch, processes all pending DMs and exits.\nWith --watch, streams DM messages in real-time (recommended for\nalways-on usage).", "examples": [ { "command": "<%= config.bin %> <%= command.id %>", "description": "Process all pending join requests" }, { "command": "<%= config.bin %> <%= command.id %> --watch", "description": "Continuously stream and process join requests" }, { "command": "<%= config.bin %> <%= command.id %> --conversation ", "description": "Process join requests for a specific conversation only" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "watch": { "description": "Stream DM messages in real-time and process join requests as they arrive", "name": "watch", "allowNo": false, "type": "boolean" }, "conversation": { "description": "Only process requests for this conversation ID", "name": "conversation", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversations:process-join-requests", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "MAX_PROCESSED_IDS": 1000, "isESM": true, "relativePath": [ "dist", "commands", "conversations", "process-join-requests.js" ] }, "conversations:sync": { "aliases": [], "args": {}, "description": "Sync all conversations from the network.\n\nFetches new messages and membership changes for every conversation\nin this install's singleton XMTP inbox (per ADR 011).", "examples": [ { "command": "<%= config.bin %> <%= command.id %>", "description": "Sync all conversations" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "conversations:sync", "pluginAlias": "@xmtp/convos-cli", "pluginName": "@xmtp/convos-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "helpValue": "", "env": "CONVOS_HOME", "input": [], "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "env": { "options": [ "local", "dev", "production" ], "description": "XMTP environment", "input": [], "multiple": false, "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "helpValue": "", "input": [], "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "default": false, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "commands", "conversations", "sync.js" ] }, "identity:create": { "aliases": [], "args": {}, "description": "Create the Convos identity for this install.\n\nGenerates a wallet key and database encryption key for the single\nXMTP inbox shared across all conversations on this install\n(per ADR 011: Single-Inbox Identity Model).\n\nErrors if an identity already exists. To run multiple independent\nagents on one machine, point each at its own CONVOS_HOME.", "examples": [ { "command": "<%= config.bin %> <%= command.id %>", "description": "Create the identity" }, { "command": "<%= config.bin %> <%= command.id %> --label \"My Bot\"", "description": "Create with a local label" }, { "command": "<%= config.bin %> <%= command.id %> --label \"Agent\" --profile-name \"Assistant\"", "description": "Create with label and default profile name" } ], "flags": { "home": { "description": "Path to Convos data directory (default: $CONVOS_HOME or ~/.convos)", "env": "CONVOS_HOME", "name": "home", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env-file": { "description": "Path to .env file", "name": "env-file", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "env": { "description": "XMTP environment", "name": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "local", "dev", "production" ], "type": "option" }, "gateway-host": { "description": "Custom gateway URL", "name": "gateway-host", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "json": { "description": "Format output as JSON", "name": "json", "allowNo": false, "type": "boolean" }, "fields": { "description": "Comma-separated list of fields to include in JSON output (supports nested paths with dot notation, e.g. id,content,contentType.typeId)", "name": "fields", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "verbose": { "description": "Show additional diagnostic information", "name": "verbose", "allowNo": false, "type": "boolean" }, "log-level": { "description": "Logging level", "name": "log-level", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "error", "warn", "info", "debug", "trace" ], "type": "option" }, "structured-logging": { "description": "Enable structured JSON logging", "name": "structured-logging", "allowNo": false, "type": "boolean" }, "app-version": { "description": "App version string", "name": "app-version", "hasDynamicHelp": false, "helpValue": "", "multiple": false, "type": "option" }, "label": { "description": "Local label for this identity (not shared)", "name": "label", "hasDynamicHelp": false, "helpValue": "