robin

Robin CLI

Scriptable access to the Robin platform. Built for humans and AI agents alike.

Setup

1. Install

Always install or upgrade to the latest version before starting any task:

npm install -g @robinai/cli@latest

2. Authenticate

robin auth status

If not authenticated:

# Interactive (prompts for API key and URL)
robin auth login

# Non-interactive (CI / scripted)
robin auth login --key robin_xxx --url https://api.robin.guide

API keys are generated at app.robin.guide → Settings → API Keys.

3. Set a default agent

# List available agents
robin agents list --json

# Set default — avoids passing --agent on every command
robin config set default-agent <agentId>

Once set, all commands use it automatically. Override per-command with --agent <id>.

---

Agent Output for Scripts and AI Agents

Pass --json to any command for clean, machine-readable output:

robin agents list --json
robin customers list --json | jq '.[].name'

---

Capabilities

Configure a Robin

Robin agents have two distinct instruction fields:

• userInstructions: What the Robin knows - facts, policies, product info, grounding knowledge
• goalInstructions: Who the Robin is - goals, tone, persona, behavioral directives

Update either field:

# Update knowledge base
robin agents update <agentId> \
  --user-instructions "Your full knowledge content here." \
  --commit-message "Updated knowledge base"

# Update goals / persona
robin agents update <agentId> \
  --goal-instructions "You are a friendly concierge for Feather Fest..." \
  --commit-message "Refined persona"

Read the current configuration first:

robin agents get <agentId> --json

Always include --commit-message — it's stored in the audit log.

Manage web crawler websites

# List current websites
robin websites list <agentId> --json

# Add a website
robin websites add <agentId> --url https://example.com \
  --description "Event FAQ page. Resource types: hours, parking, lineup"

# Remove a website
robin websites remove <agentId> <websiteId> --yes

# Enable or disable the web crawler
robin websites configure <agentId> --enabled true

A good website --description tells the Robin what the site is and what to use it for, followed by Resource types: listing the key content types.

Manage customers

# List customers
robin customers list --json

# Get a customer
robin customers get <customerId> --json

# Create a customer
robin customers create --name "Jane Smith" --phone "+15551234567"

# Update a customer
robin customers update <customerId> --name "Jane Smith"

# Bulk import from CSV
robin customers bulk-import --file customers.csv

Review and reply to conversations

# Get a thread
robin conversations get <threadId> --json

# Reply
robin conversations reply <threadId> --content "Here's what you need to know..."

# Pause AI for a thread (human takeover)
robin conversations pause <threadId>

# Resume AI
robin conversations resume <threadId>

To list all threads for an agent:

# Paginated — use nextCursor for subsequent pages
robin agents threads <agentId> --page-size 50 --json
robin agents threads <agentId> --page-size 50 --cursor <nextCursor> --json

Test an agent

Open an interactive chat session on the same channel the Robin web app uses:

robin chat
robin chat <agentId>

Controls: type + Enter to send, /reset to clear history, Esc or /quit to exit.

Manage announcements

# List announcements for a Robin
robin announcements list <agentId> --json

# Estimate a tagged announcement audience
robin announcements tag-counts <agentId> --tag-ids tag_1 tag_2 --json

# Create a scheduled announcement
robin announcements create <agentId> \
  --title "Doors Reminder" \
  --content "Doors open at 7pm tonight!" \
  --send-at "2025-06-01T19:00:00Z" \
  --tag-ids tag_1

# Schedule one message to one customer
robin announcements schedule-message <agentId> \
  --customer cust_123 \
  --content "Your appointment is tomorrow at 10am." \
  --send-at "2025-06-01T19:00:00Z"

Manage tags

robin tags list --json
robin tags create --name "VIP"
robin tags assign <tagId> --customer <customerId>
robin tags unassign <tagId> --customer <customerId>

Manage invitations

robin invitations list --json
robin invitations create --email [email protected]
robin invitations revoke <invitationId> --yes

---

Key rules

• Always use the CLI. Never call the Robin REST API directly. The CLI handles auth, pagination, error handling, and output formatting. Raw curl or direct HTTP calls are not acceptable substitutes.
• Always install or upgrade the CLI before starting any task: npm install -g @robinai/cli@latest
• Pass --json for any output you need to process or display programmatically.
• Always include --commit-message on agent update commands — it is stored in the audit log.
• Say "Robin", not "agent" — that is how owners refer to their AI.

---

Sub-skills

For more complex workflows, see:

• Build or configure a Robin from scratch: skills/robin-builder/SKILL.md
• Write, target, and schedule announcements: skills/robin-announcement-builder/SKILL.md
• Analyze conversations and produce a quality report: skills/robin-conversation-assessment/SKILL.md
• Manage contacts and tags, including bulk imports: skills/robin-contacts-management/SKILL.md

---

Reference

• Getting Started
• Full Command Reference — every flag and endpoint documented