Skip to main content
This skill teaches your coding agent how to drive the entire Inkbox API from a shell using the @inkbox/cli tool. Once installed, the agent knows which commands exist, which flags they take, which require a vault key, and which are high-risk and need user confirmation before running. View the source →

What your agent learns

Directional policies and notices

CLI 0.7.14 or later adds slack contact-rule, slack contacts-import, and identity update --slack-filter-mode with --slack-inbound-filter-mode / --slack-outbound-filter-mode. Rule writes, defaults and import require an organization admin key. Follow import cursors; import never grants messaging or Companion access. See Slack contact rules. CLI 0.7.3 or later adds:
  • --direction inbound|outbound|both on mail, phone, and iMessage rule create/update/list/list-all commands, including deprecated mailbox/number commands. Create omission means both; update omission preserves coverage. Inbound/outbound list filters include both rules. A2A’s existing exact filters and defaults are unchanged.
  • --apply-to inbound|outbound with --action on rule updates. It changes one covered side atomically and cannot be combined with --direction.
  • --mail-inbound-filter-mode, --mail-outbound-filter-mode, --phone-inbound-filter-mode, and --phone-outbound-filter-mode on identity update. Each accepts whitelist or blacklist. Do not mix shared and directional mode flags for the same channel.
  • inboundContactable and outboundContactable in contact-access JSON files. Legacy contactable writes still set both sides; reads mean can send.
Rule saves can consolidate coverage and preserve an existing ID. See mail rules and contact access for result shapes and errors.

Install

bash
Install the CLI itself:
bash

Prerequisites

  • Node.js ≥ 22
  • An Inkbox API key from the Console, exported as INKBOX_API_KEY or passed via --api-key
  • INKBOX_VAULT_KEY set only when you need vault decrypt or secret-creation flows

Message request retries

Send commands handle bounded request retries automatically. For a repeated command, use the original --idempotency-key and unchanged input. send-lookup recovers a message ID without sending. Read that message for delivery status. See retry behavior.