Use the Mavo CLI

Read and change your family's plan from a terminal with one generated command for every public Mavo API operation.

The official @mavolife/cli package brings the Mavo API to your terminal. It uses the same operation list as the TypeScript SDK, so calendar, collections, people, notifications, webhooks, and every other public action have their own command.

Install

The CLI requires Node.js 20 or newer:

npm install --global @mavolife/cli

Set your family

Create an API key in Settings → Developer, then copy the family slug from the same page. Set both once in your shell:

export MAVO_API_KEY="your-api-key"
export MAVO_FAMILY_SLUG="your-family"

Now commands automatically use that family:

mavo list-calendar-events --from 2026-07-14
mavo list-collection-entries --collection-key groceries --status active --limit 20

Send changes

Commands that create or update something take a JSON body:

mavo create-collection-entry \
  --collection-key groceries \
  --body '{"title":"Dish soap"}'

For a larger body, put the JSON in a file and prefix its path with @:

mavo create-collection --body @collection.json

Successful responses are printed as formatted JSON, so you can read them directly or pipe them into another command. API and usage errors go to standard error and return a nonzero exit code.

See what's available

Run mavo --help to list every command. Run a command with --help to see its path, query, and body options:

mavo list-collection-entries --help

Use --api-key, --family-slug, or --base-url to override the matching environment variable for one command. MAVO_BASE_URL changes the default API origin when you intentionally need another Mavo deployment.

Keep exploring