Skip to content
Skills Library
Sales & customer service · Tool integration

install-cli

/install-cli

Install and authenticate the Intercom CLI (`@intercom/cli`) — a command-line tool for managing Intercom workspaces, designed for both human operators and AI agents. Use when the user asks to "install the Intercom CLI", "set up the intercom command", "install @intercom/cli", or wants shell access to their Intercom workspace.

Licence
MIT
Last repository change
27.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
8
Deprecation

No signals detected. Repository changed on 27.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Install and authenticate the Intercom CLI (`@intercom/cli`) — a command-line tool for managing Intercom workspaces, designed for both human operators and AI agents. Use when the user asks to "install the Intercom CLI", "set up the intercom command", "install @intercom/cli", or wants shell access to their Intercom workspace.

Triggers from the description

install the Intercom CLIset up the intercom commandinstall @intercom/cli
Original author description

Install and authenticate the Intercom CLI (`@intercom/cli`) — a command-line tool for managing Intercom workspaces, designed for both human operators and AI agents. Use when the user asks to "install the Intercom CLI", "set up the intercom command", "install @intercom/cli", or wants shell access to their Intercom workspace.

How it works

  1. Prerequisites
  2. Step 1: Install Globally
  3. Step 2: Authenticate
  4. Step 3: Verify
  5. Step 4 (Optional): Shell Completions
  6. Quick Reference
  7. Agent / Pipe Mode
  8. Multi-Workspace
  9. Troubleshooting
Original SKILL.md headings · 183 lines, 966 words
SKILL.md preview
---
name: install-cli
license: MIT
description: >
  Install and authenticate the Intercom CLI (`@intercom/cli`) — a command-line
  tool for managing Intercom workspaces, designed for both human operators
  and AI agents. Use when the user asks to "install the Intercom CLI",
  "set up the intercom command", "install @intercom/cli", or wants
  shell access to their Intercom workspace.
disable-model-invocation: true
---

# Install Intercom CLI

Install the [`@intercom/cli`](https://www.npmjs.com/package/@intercom/cli) package globally and authenticate it against the user's workspace. The CLI complements this plugin: the plugin is for in-conversation MCP usage, while the CLI is for shell access, scripting, and workspace provisioning.

## Prerequisites

Before installing, verify the user has:

1. **Node.js >= 20.6.0** — Run `node --version` to check. If missing or older, direct them to install via [nodejs.org](https://nodejs.org) or their version manager (nvm, fnm, volta).
2. **npm** — Comes bundled with Node.

If `node --version` returns < 20.6.0, stop and ask the user to upgrade before proceeding. The CLI will not run on older versions.

## Step 1: Install Globally

```bash
npm install -g @intercom/cli
```

Verify the install:

```bash
intercom --version
```

If the user gets a permission error (`EACCES`) on macOS or Linux, they likely have a system Node install. Recommend either:
- Switching to a user-managed Node via nvm/fnm/volta (preferred), or
- Configuring an [npm prefix](https://docs.npmjs.com/cli/v10/configuring-npm/folders#prefix-configuration) under their home directory.

Do **not** suggest `sudo npm install -g` — installing global packages as root is a known footgun and will cause permissions issues on later updates.

## Step 2: Authenticate

There are two paths. Ask the user which applies.

### Path A: Existing Workspace (most common)

The user has an Intercom workspace and needs to connect the CLI to it.

1. Direct them to the [Developer Hub](https://app.intercom.com/a/apps/_/developer-hub).
2. Click **New app** (or select an existing app).
3. Under **Authentication**, copy the **Access Token**.
4. Authenticate one of two ways:

**Option 1 — Persistent (recommended for interactive use):**

```bash
intercom auth login --token "<paste-token-here>"
```

This stores the token in the OS keyring (Keychain on macOS, Secret Service on Linux, Credential Manager on Windows) so future commands don't need the env var.

**Option 2 — Environment variable (recommended for CI / scripting):**

```bash
export INTERCOM_TOKEN="<paste-token-here>"
```

Add this to `~/.zshrc`, `~/.bashrc`, or the equivalent so it persists across shells. For CI, set it as a secret in the pipeline config.

The env var takes precedence over the keyring-stored credential when both are present.

### Path B: New Workspace (provisioning)

The user wants to create a brand-new Intercom workspace from scratch — no token needed.

```bash
intercom setup --company-name "Acme"
```

This command provisions a workspace, signs the user in, and stores the resulting credentials. The CLI will prompt for an email, password, and verification code during the flow.

If the user has additional setup needs (importing articles, enabling Fin, etc.), point them at:

```bash
intercom setup --help
```

## Step 3: Verify

Run:

```bash
intercom me
```

Expected output: the admin's name, email, and the active workspace ID. If this fails:

| Error | Likely Cause | Fix |
|-------|--------------|-----|
| `Not authenticated` | No token in keyring or env | Re-run Step 2 |
| `401 Unauthorized` | Token revoked or wrong workspace | Generate a new token in the Developer Hub |
| `command not found: intercom` | Global install path not on `$PATH` | Run `npm config get prefix`, ensure `<prefix>/bin` is on `$PATH` |

## Step 4 (Optional): Shell Completions

Recommend this only if the user uses `intercom` interactively in their shell.

```bash
# zsh — append to ~/.zshrc
intercom completion zsh >> ~/.zshrc

# bash — append to ~/.bashrc
intercom completion bash >> ~/.bashrc

# fish
intercom completion fish > ~/.config/fish/completions/intercom.fish
```

Restart the shell or `source` the rc file for completions to take effect.

## Quick Reference

After install, the user can run any of these. Don't dump this whole list at them — surface relevant commands based on their goal.

| Command | Purpose |
|---------|---------|
| `intercom me` | Show current admin + workspace |
| `intercom api <endpoint>` | Raw API access (like `gh api`) |
| `intercom articles list\|get\|search` | Help center articles |
| `intercom contacts list\|get\|search` | Contacts |
| `intercom conversations list\|get\|search` | Conversations |
| `intercom fin manifest\|enable\|download` | Fin AI Agent |
| `intercom messenger get\|update\|snippet` | Messenger config |
| `intercom config list` | Show CLI config |

Full reference: [`@intercom/cli` README](https://github.com/intercom/cli#readme).

## Agent / Pipe Mode

The CLI auto-detects when stdout is piped and switches to compact NDJSON (one JSON object per line). This makes it ergonomic for scripts and AI agents:

```bash
# Auto NDJSON when piped
intercom articles list | jq '.title'

# Force JSON
intercom articles list --json

# Inline jq filter
intercom articles list --jq '.data[].title'
```

If the user is using the CLI from a Claude Code agent or other automation, prefer `--json` or `--jq` over parsing human-formatted output.

## Multi-Workspace

If the user manages multiple workspaces:

```bash
intercom auth list                  # show stored credentials
intercom auth switch <workspace>    # change default
intercom me --workspace <id>        # one-off override
```

Each workspace's credential is stored separately in the keyring.

## Troubleshooting

### `npm install -g` Hangs or Fails on Corporate Network
The user's npm registry may be proxied. Check `npm config get registry` — if it points at an internal mirror, that mirror may not have `@intercom/cli` published. Set the registry explicitly for this install:

```bash
npm install -g @intercom/cli --registry=https://registry.npmjs.org
```

### `intercom` Command Found But Crashes Immediately
Usually a Node version mismatch. Run `node --version` and confirm it's >= 20.6.0. If using nvm, ensure the active version (`nvm current`) is the one the global install used.

### Token Stored But Commands Still Fail With 401
The `INTERCOM_TOKEN` env var overrides the keyring. Run `unset INTERCOM_TOKEN` and try again — a stale env var may be shadowing a fresh keyring credential.

### Wrong Region (EU / Australia)
The CLI defaults to the US API. If the workspace is hosted in EU or Australia:

```bash
export INTERCOM_API_BASE_URL="https://api.eu.intercom.io"      # EU
export INTERCOM_API_BASE_URL="https://api.au.intercom.io"      # Australia
```

Set this in the shell rc file alongside the token.

Versions

The database has no other skills named install-cli.

Database snapshot: 13.11.2026 · package version 361f49f6f863 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100intercom-install-auth
    Install and configure Intercom API authentication with access tokens or OAuth. Use when setting up a new Intercom integration, configuring API credentials, or initializing the intercom-client SDK in your project. Trigger with phrases like "install intercom", "setup intercom",…
  • 100intercom-ci-integration
    Configure CI/CD pipelines for Intercom integrations with GitHub Actions. Use when setting up automated testing, configuring CI with Intercom secrets, or integrating Intercom API tests into your build process. Trigger with phrases like "intercom CI", "intercom GitHub Actions",…
  • 90intercom-analysis
    Analyze Intercom conversations to identify support patterns, investigate customer issues, and look up contacts and companies. Use when the user asks to "analyze conversations", "find support patterns", "search Intercom", "look up a customer", "investigate a customer issue",…
  • 100intercom
    Intercom via Apideck's Proxy API + managed Vault auth — Apideck handles auth and proxies HTTP calls to Intercom's native API. Use when the user wants to call Intercom (no unified API resource mapping). Routes through Apideck with serviceId "intercom".
  • 90migrate-from-intercom
    Migrates projects from Intercom to Gleap. Detects Intercom SDK integration (JavaScript, iOS, Android, React Native, Flutter), removes it, installs the Gleap SDK, and replaces all Intercom API calls with Gleap equivalents. Also covers server-side REST API migration. Use when…
  • 100install-messenger
    Install the Intercom Messenger on a website or web application with secure JWT-based identity verification. Generates backend and frontend code for React, Next.js, Vue.js, Angular, Ember, and plain JavaScript. Supports Node.js, Python (Flask/Django), PHP, and Ruby backends. Use…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.