CLI

The RSVPme.xyz CLI lets agents and developers start signup flows, create and publish events, read event status, and start the MCP server.

Setup

The CLI package is @rsvpme/cli. Public commands do not need an API key. Host-owned commands use an API key from Manage My Account.

RSVPME_BASE_URL=https://rsvpme.xyz
RSVPME_API_KEY=rsvpme_live_your_api_key
npx --package @rsvpme/cli rsvpme --help

Install

Use it once with npx, or install it globally if you use it often.

npx --package @rsvpme/cli rsvpme health
npm install -g @rsvpme/cli
rsvpme health

Commands

Health

npx --package @rsvpme/cli rsvpme health

Checks that the API is reachable.

Start signup

npx --package @rsvpme/cli rsvpme signup start --email host@example.com

Starts a one-click approval flow for a human host.

Poll result

npx --package @rsvpme/cli rsvpme signup result --intent-id ID --token TOKEN

After the host approves, returns the share link and a one-time API key.

Create + publish

RSVPME_API_KEY=rsvpme_live_your_api_key npx --package @rsvpme/cli rsvpme events create --title "Cookout" --description "Food and music." --start-date "2026-07-11T16:00" --time-zone America/New_York --location-name "Backyard"

Creates and publishes an event (pass --publish false for a draft).

Read status

RSVPME_API_KEY=rsvpme_live_your_api_key npx --package @rsvpme/cli rsvpme events status EVENT_ID

Reads event status and RSVP totals.

Create And Publish An Event

RSVPME_API_KEY=rsvpme_live_your_api_key \
npx --package @rsvpme/cli rsvpme events create \
  --title "Cookout" \
  --description "Food, music, and an easy Saturday afternoon." \
  --start-date "2026-07-11T16:00" \
  --time-zone America/New_York \
  --location-name "Backyard"

Events publish by default and return a shareable link. Pass --publish false to create a draft instead.

Limits

Events publish by default (--publish false for a draft).
Full guest RSVP records are not exposed through the CLI.
Guest email tools stay in the dashboard.

CLI