inbox-zero-api
GitHub通过 CLI 操作 Inbox Zero API,用于查看规则、统计及自动化配置。适用于需通过 API 而非浏览器交互来管理收件箱状态和自动化的任务场景。
Trigger Scenarios
Install
npx skills add elie222/inbox-zero --skill inbox-zero-api -g -y
SKILL.md
Frontmatter
{
"name": "inbox-zero-api",
"homepage": "https:\/\/www.getinboxzero.com\/api-reference\/cli",
"metadata": {
"openclaw": {
"install": [
{
"id": "node",
"bins": [
"inbox-zero-api"
],
"kind": "node",
"label": "Install Inbox Zero API CLI (npm)",
"package": "@inbox-zero\/api"
}
],
"requires": {
"env": [
"INBOX_ZERO_API_KEY"
],
"bins": [
"inbox-zero-api"
]
},
"skillKey": "inboxZeroApi",
"primaryEnv": "INBOX_ZERO_API_KEY"
}
},
"description": "Use the Inbox Zero API CLI to inspect the live API schema, list and manage automation rules, and read inbox analytics through the public API. Use this when a task involves Inbox Zero rules, stats, or API-driven automation and can be solved through the CLI instead of browser interaction."
}
Inbox Zero API CLI
Use this skill when the task is to inspect or change Inbox Zero state through the public API.
Workflow
- Prefer
--jsonso the output is stable and machine-readable. - For authenticated commands (
rules,stats, etc.), keep credentials inINBOX_ZERO_API_KEYor OpenClaw skill config. Avoid passing API keys as CLI flags unless there is no alternative. - Before creating or replacing a rule body, fetch the live schema with
inbox-zero-api openapi --json(no API key required). - For create and update flows, write JSON into a workspace file or pipe it on stdin.
- Treat
rules updateas a full replacement. Read the current rule first if you only intend to change part of it.
Quick Start
inbox-zero-api rules list --json
inbox-zero-api stats by-period --period week --json
inbox-zero-api openapi --json
If the CLI is not installed yet, install it with the OpenClaw installer or run npm install -g @inbox-zero/api.
Cursor
Set INBOX_ZERO_API_KEY when using authenticated commands (rules, stats, etc.); openapi --json works without a key. Use shell profile, Cursor env, or a local env file—never commit keys. Install: npm install -g @inbox-zero/api or npx @inbox-zero/api.
OpenClaw Config
Set the API key in ~/.openclaw/openclaw.json under skills.entries.inboxZeroApi.apiKey, or export INBOX_ZERO_API_KEY in the host environment.
Use INBOX_ZERO_BASE_URL or inbox-zero-api config set base-url <url> only for self-hosted or nonstandard deployments.
Reference
For exact command patterns and a safe mutation flow, read references/cli-reference.md.
Version History
- 633a2ab Current 2026-08-20 17:15


