socialcrm

The SocialCRM CLI mirrors the full 21-tool SocialCRM API surface: monitor AI visibility, inspect alerts, run workflows, and connect AI coding tools to your brand intelligence MCP server.

Install

npx socialcrm

Or install globally:

npm install -g socialcrm

Quick Start

# 1. Save your API key (from Settings > API Keys in the dashboard)
socialcrm auth

# 2. Connect your AI editor (auto-detects Cursor / Claude Code)
socialcrm init

# 3. Verify connection
socialcrm status

# 4. Explore your brands and visibility
socialcrm brands list
socialcrm metrics "Ace Auto Repair"
socialcrm score "Ace Auto Repair"
socialcrm dashboard
socialcrm mentions "Ace Auto Repair" --platform chatgpt
socialcrm notifications --unread

Running socialcrm with no arguments shows an interactive menu.

Commands

Setup

socialcrm auth [api-key]        # Save API key (interactive if omitted)
socialcrm init                  # Auto-detect and configure editor
socialcrm init --cursor         # Configure Cursor only
socialcrm init --claude         # Configure Claude Code only
socialcrm init --gemini         # Configure Gemini CLI only
socialcrm init --all            # Configure all platforms
socialcrm status                # Check MCP server connection

Brands

socialcrm brands list                  # List all brand profiles
socialcrm brands get <id>              # Get brand details (name or UUID)
socialcrm brands competitors <id>      # List competitors

Visibility & Insights

socialcrm mentions <brandId> [-p platform] [-l limit]
socialcrm metrics <brandId>
socialcrm monitoring <brandId>
socialcrm trend <brandId> <metric> [-d days]
socialcrm score <brandId>                    # AI visibility score + factor breakdown
socialcrm dashboard                          # Company-wide overview
socialcrm simulations [-l limit]             # Recent AI simulation sessions
socialcrm rankings [-b brandId] [-p platform] [-l limit]
socialcrm notifications [-l limit] [-u]      # Recent alerts; -u = unread only

Repository

socialcrm repo list <brandId> [-c category] [-l limit]
socialcrm repo search <brandId> <query> [-l limit]

Workflows

socialcrm workflows list               # List available workflows + credit costs
socialcrm workflows run <id>           # Run workflow (polls until complete)
socialcrm workflows run <id> --no-wait # Start and exit immediately
socialcrm workflows run <id> --context "Focus on local SEO"
socialcrm workflows status <runId>     # Check run status
socialcrm workflows runs [-s status] [-w workflowId] [-l limit]
socialcrm workflows cancel <runId>

Agents

socialcrm agents summary <instanceId>  # Agent run statistics

Credits

socialcrm credits                      # Show credit balance

Global Flags

| Flag | Description | | ---------------- | ---------------------------------------- | | --json | Output raw JSON instead of formatted tables | | --api-url <url>| Override the API base URL | | --help | Show help for any command | | --version | Show CLI version |

Configuration

The CLI reads your API key from (in priority order):

1. SOCIALCRM_API_KEY environment variable
2. ~/.socialcrm/config.json (created by socialcrm auth)
3. Legacy ~/.socialcrmrc (auto-migrated on first use)

The server URL can be overridden with --api-url, SOCIALCRM_API_URL, or in the config file.

JSON Output

Every command supports --json for piping into jq or scripts:

socialcrm brands list --json | jq '.[].brandName'

BRAND_ID=$(socialcrm brands list --json | jq -r '.[0].id')
socialcrm metrics "$BRAND_ID" --json

Editor Configuration

socialcrm init writes the MCP server config for your editor:

| Platform | Config file | | ----------- | ------------------------ | | Cursor | .cursor/mcp.json | | Claude Code | .mcp.json | | Gemini CLI | gemini-extension.json |

Get an API Key

1. Log in at socialcrm.com
2. Go to Settings > API Keys
3. Click Create API Key
4. Run socialcrm auth <key>