Quickstart - MossDesk

Install the CLI

npm install -g @mossdesk/cli

pnpm add -g @mossdesk/cli

yarn global add @mossdesk/cli

Verify the installation:

moss --version

moss auth login --key moss_k_your_api_key_here

Confirm you’re authenticated:

moss auth whoami

moss contact create \
  --name "Jane Smith" \
  --email "jane@acme.com" \
  --phone "+1-555-0100" \
  --title "CTO"

moss deal create \
  --title "Acme Corp - Enterprise" \
  --value 25000 \
  --stage lead \
  --contact-id <contact-id>

moss followup create \
  --title "Send proposal to Jane" \
  --due-date 2026-02-15 \
  --contact-id <contact-id> \
  --priority high

moss pipeline show

Every command supports --json for structured output, perfect for scripting and AI agents:

moss contact list --json | jq '.data[].name'

Learn about workspaces, deal stages, and the MossDesk data model.

Full command reference with all flags and options.

Integrate MossDesk into your applications.

Set up MossDesk for autonomous CRM management.