ringee CLI (ringee)

Operate Ringee from the terminal. The CLI is a thin front-end over @ringee-io/agent, which talks to the Ringee backend/MCP — the single source of truth.

Install

# Global binary
npm i -g ringee      # then: ringee --help

# Or run without installing
npx ringee --help

Runtime requires Node ≥ 20. The published binary is self-contained except for its npm dependencies (@modelcontextprotocol/sdk, zod, commander), which the installer pulls in automatically.

Use from an agent harness (Claude Code, OpenClaw, Hermes…)

Any agent that can run shell commands can drive Ringee through this CLI: install it (globally or via npx), export the connection env, and have the agent call ringee … --json so it can parse structured output.

npm i -g ringee
export RINGEE_MCP_URL="https://api.ringee.io/api/mcp/<userId>/sse"
ringee config check                       # confirm connectivity
ringee contacts search acme --json        # machine-readable for the agent

Sensitive/destructive actions still require explicit flags (--yes, --confirm-phone) — see Safety — so an autonomous agent cannot spend credits, mint magic links, or delete data without an intentional flag.

Configure

export RINGEE_MCP_URL="https://api.ringee.io/api/mcp/<userId>/sse"
# or:  RINGEE_BACKEND_URL + RINGEE_USER_ID [+ RINGEE_ORG_ID]

Get these from the dashboard (Settings → MCP / Integrations → GET /api/mcp/connection-info). Verify with ringee config check.

Run

In-repo (no build needed):

pnpm ringee contacts search acme          # root convenience script
pnpm --filter ringee dev -- config check

Built / global binary:

pnpm --filter ringee build        # bundles to dist/index.js
node apps/agent-cli/dist/index.js --help  # or `ringee` once linked on PATH

Commands

ringee contacts search <query>
ringee contacts get <contactId>
ringee contacts create --phone +E164 [--name ... --email ...]
ringee contacts update <contactId> [--email ...]
ringee contacts delete <contactId> --confirm-phone +E164 --yes   # destructive

ringee leads search [--title ... --country ... --industry ...]   # returns jobId
ringee leads reveal <jobId> <externalId> [--phone] --yes         # sensitive (credits)
ringee leads import <jobId> <externalId...>

ringee sessions create --contact <id> [--title ...] --yes        # sensitive (magic link)
ringee sessions get <callSessionId>
ringee sessions update <callSessionId> [--title ... --expires ...]
ringee sessions revoke <callSessionId> --yes                     # destructive

ringee calls list [--contact <id> --campaign <id|none> --outcome ... --from ... --to ...]
ringee outcomes log <callId> <outcome> [--note ...]
ringee callbacks list [--status scheduled|due|completed|missed|cancelled]
ringee callbacks create <contactId> <ISO-8601> [--note ...]
ringee meetings schedule <contactId> <ISO-8601> [--title ... --duration ...]

# Campaigns (organization workspaces; writes are org-admin only)
ringee campaigns list [--status active --search ...]
ringee campaigns get <campaignId>
ringee campaigns status <campaignId> <draft|active|paused|completed>
ringee campaigns leads <campaignId> [--status pending]
ringee campaigns add-lead <campaignId> --phone +E164 --name "Jane Doe" [--email ...]
ringee campaigns import-leads <campaignId> <leads.json>
ringee campaigns delete-lead <campaignId> <leadId> --yes          # destructive
ringee campaigns analytics <campaignId> [--from ... --to ... --hourly --no-agents]

# Analytics (the dashboard overview) and a single day
ringee analytics calls [--range 30d --campaign none --outcome sale --include kpis agents]
ringee analytics day <YYYY-MM-DD> [--offset -04:00 --campaign none]

# Do-not-call list
ringee dnc list [--search 415]
ringee dnc add +E164... [--reason "asked not to be called"]
ringee dnc remove +E164 --yes                                     # destructive

# AI pipeline analyses (org admins)
ringee pipelines list
ringee pipelines results <pipeline> [--campaign <id> | --org | --personal] [--status pending]

ringee config show | check
ringee tools | flow | prompt          # knowledge helpers (no connection)

Add --json to any command for raw machine-readable output.

--campaign none (on calls list, analytics calls, analytics day) isolates calls made outside any campaign — the manual dialer, extension, call sessions and SDK. Analytics rates are already percentages (0-100).

Safety

Sensitive and destructive actions require explicit flags so the CLI never spends credits, mints magic links, or deletes data by accident:

• leads reveal and sessions create/update need --yes.
• sessions revoke needs --yes.
• contacts delete needs both --confirm-phone <storedPhone> and --yes.
• campaigns delete-lead needs --yes (the lead's call attempts and campaign callbacks go with it; the contact and its call history survive).
• dnc remove needs --yes — it makes a suppressed number callable again.