@inbox-zero/api

CLI tool for managing Inbox Zero through the external API.

This package is separate from @inbox-zero/cli, which is focused on self-hosting and deployment.

Installation

npx

Requires Node.js 18+.

npx @inbox-zero/api --help

Global install

npm install -g @inbox-zero/api

Quick Start

inbox-zero-api rules list
inbox-zero-api stats by-period --period week

Set INBOX_ZERO_API_KEY in your shell or secret manager before running commands. Avoid passing API keys as CLI arguments because they can leak into shell history and process listings.

Configuration

Configuration is loaded in this order:

1. Command flags
2. Environment variables
3. ~/.inbox-zero-api/config.json

Supported environment variables:

• INBOX_ZERO_API_KEY
• INBOX_ZERO_BASE_URL for self-hosted or custom API deployments

Commands

inbox-zero-api config

Manage local API CLI configuration.

inbox-zero-api config list
inbox-zero-api config get base-url

base-url is optional. It defaults to https://www.getinboxzero.com and only needs to be set for self-hosted or nonstandard deployments.

inbox-zero-api openapi

Fetch the live OpenAPI document from the configured Inbox Zero deployment.

inbox-zero-api openapi --json

inbox-zero-api rules

Manage automation rules for the inbox account scoped by the API key.

inbox-zero-api rules list
inbox-zero-api rules get rule_123
inbox-zero-api rules delete rule_123

Create or update rules with a JSON file or stdin:

inbox-zero-api rules create --file rule.json
cat rule.json | inbox-zero-api rules update rule_123 --file -

The request body must match the public API schema.

inbox-zero-api stats

Read analytics from the external API.

inbox-zero-api stats by-period --period month
inbox-zero-api stats response-time --email [email protected] --json

For bot workflows, prefer --json so the CLI returns structured output instead of a human-oriented summary.

License

See LICENSE in the repository root.