Skip to main content

Install the CLI

npm install -g mosscrm
Verify the installation:
moss --version

Authenticate

Log in with your API key. You can create one from the Dashboard under Settings > API Keys.
moss auth login --key moss_k_your_api_key_here
Confirm you’re authenticated:
moss auth whoami

Create your first records

Add a contact

moss contact create \
  --name "Jane Smith" \
  --email "[email protected]" \
  --phone "+1-555-0100" \
  --title "CTO"

Add a deal

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

Schedule a follow-up

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

Check your pipeline

moss pipeline show

Use JSON output

Every command supports --json for structured output, perfect for scripting and AI agents:
moss contact list --json | jq '.data[].name'

Next steps