🚨 Active Supply Chain Attack:node-ipc Package Compromised.Learn More →
Socket
Book a DemoSign in
Socket
Book a DemoSign in

@kyoji2/intercom-cli

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@kyoji2/intercom-cli

AI-native CLI for Intercom - manage customer conversations, contacts, messages, and support

latest
Source
npmnpm
Version
0.1.6
Version published
Maintainers
1
Created
Source

Intercom CLI

AI-native CLI for Intercom - manage customer conversations, contacts, messages, and support.

Installation

From npm (recommended)

bun install -g @kyoji2/intercom-cli

From source

git clone https://github.com/kyoji2/intercom-cli.git
cd intercom-cli
bun install
bun link

Verify installation

intercom --version

Prerequisites

  • Bun runtime (v1.0 or later) - Install Bun
  • Intercom account with API access token

Getting an Access Token

  • Log in to your Intercom workspace
  • Navigate to Settings → Developers → Developer Hub
  • Create a new app or select an existing one
  • Go to Configure → Authentication
  • Copy your Access Token

Quick Start

# Authentication
intercom login [token]           # Login with your access token
intercom whoami                  # Show current admin and workspace
intercom logout                  # Remove credentials

# Get context about the account
intercom context                 # Admin info and workspace details
intercom schema                  # Show API schemas (for AI context)

# Manage contacts
intercom contact list            # List contacts
intercom contact search --email "user@example.com"
intercom contact create --email "new@example.com" --name "John Doe"
intercom contact get <id>
intercom contact update <id> --name "New Name"
intercom contact delete <id>

# Manage conversations
intercom conversation list
intercom conversation search --state open
intercom conversation get <id>
intercom conversation reply <id> --admin <admin-id> --body "Internal triage note" --type note
intercom conversation close <id> --admin <admin-id>

# Manage companies
intercom company create --company-id "acme" --name "Acme Corp"
intercom company list
intercom company get <id>

# Manage tags
intercom tag list
intercom tag create "VIP Customer"

# Help center articles
intercom article list
intercom article search "getting started"
intercom article get <id>

# Track events
intercom event track --name "purchase" --user-id "user123"

# Manage tickets
intercom ticket create --type-id 1234 --contact-id abc123 --title "Issue"
intercom ticket search --state open
intercom ticket get <id>
intercom ticket reply <id> --admin <admin-id> --body "We're on it!" --type comment
intercom ticket reply <id> --admin <admin-id> --body "Internal note" --json '{"message_type":"note"}'
intercom ticket close <id> --admin <admin-id>

# List ticket types
intercom ticket-type list

Commands

Authentication

CommandDescription
intercom login [token]Save access token (prompts if not provided)
intercom logoutRemove stored credentials
intercom whoamiShow current admin and workspace info
intercom contextShow account context (admins, workspace)
intercom schemaOutput API schemas for AI context

Contacts

CommandDescription
intercom contact createCreate a new contact
intercom contact get <id>Get contact details
intercom contact update <id>Update a contact
intercom contact delete <id>Delete a contact
intercom contact searchSearch contacts
intercom contact listList contacts
intercom contact note <id> <body>Add note to contact
intercom contact notes <id>List contact notes
intercom contact tag <id> <tag-id>Tag a contact
intercom contact untag <id> <tag-id>Remove tag from contact
intercom contact attach-company <id> <company-id>Attach contact to company

Conversations

CommandDescription
intercom conversation listList conversations
intercom conversation get <id>Get conversation details
intercom conversation searchSearch conversations
intercom conversation reply <id>Reply to conversation
intercom conversation assign <id>Assign conversation
intercom conversation close <id>Close conversation
intercom conversation open <id>Reopen conversation
intercom conversation snooze <id>Snooze conversation
intercom conversation convert <id>Convert conversation to ticket

intercom conversation reply supports --type <comment|note> and --json <json>.
Message type precedence: --type > --json.message_type > comment.

Companies

CommandDescription
intercom company createCreate a company
intercom company get <id>Get company details
intercom company listList companies
intercom company update <id>Update a company

Tags

CommandDescription
intercom tag listList all tags
intercom tag create <name>Create a tag
intercom tag get <id>Get tag details
intercom tag delete <id>Delete a tag

Articles

CommandDescription
intercom article listList articles
intercom article get <id>Get article details
intercom article search <query>Search articles
intercom article createCreate an article
intercom article update <id>Update an article
intercom article delete <id>Delete an article

Admins

CommandDescription
intercom admin listList all admins
intercom admin get <id>Get admin details

Events

CommandDescription
intercom event trackTrack a custom event
intercom event listList events for a user

Tickets

CommandDescription
intercom ticket createCreate a new ticket
intercom ticket get <id>Get ticket details
intercom ticket update <id>Update a ticket
intercom ticket delete <id>Delete a ticket
intercom ticket searchSearch tickets
intercom ticket reply <id>Reply to a ticket
intercom ticket close <id>Close a ticket
intercom ticket assign <id>Assign ticket to admin/team

intercom ticket reply supports --type <comment|note> and --json <json>.
Message type precedence: --type > --json.message_type > comment.

Ticket Types

CommandDescription
intercom ticket-type listList all ticket types
intercom ticket-type get <id>Get ticket type details

Global Options

All commands support:

--dry-run              # Log actions without making API calls
-f, --format <format>  # Output format: toon (default) or json
--config-dir <path>    # Config directory (default: ~/.config/intercom-cli)
-v, --version          # Show version
-h, --help             # Show help

Output Formats

TOON (Default)

Token-optimized format designed for AI agents:

field_name: value
another_field: value

JSON

Standard JSON output with --format json:

{
  "field_name": "value"
}

Environment Variables

VariableDescription
INTERCOM_ACCESS_TOKENAccess token (takes priority over config file)

Configuration

Credentials are stored in ~/.config/intercom-cli/config.json

Development

# Run in development mode
bun run dev

# Run tests
bun test

# Lint code
bun run lint

# Format code
bun run format

# Type check
bun run typecheck

# Build
bun run build

License

MIT

Keywords

intercom
customer-support
conversations
contacts
cli
ai-native

FAQs

Package last updated on 06 Mar 2026

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Popular node-ipc npm Package Infected with Credential Stealer

Security News

/

Research

Popular node-ipc npm Package Infected with Credential Stealer

Socket detected malicious node-ipc versions with obfuscated stealer/backdoor behavior in a developing npm supply chain attack.

By Socket Research Team  -  May 14, 2026