@meterbox/cli

meterbox: command-line client for the Meterbox /v1 API. Commands are generated from your deployment's OpenAPI spec at startup, so every public /v1 endpoint shows up automatically and new endpoints need no CLI release. The spec handling and dispatch live in @meterbox/ops.

Install

npm install -g @meterbox/cli

Requires Node.js 18 or later.

Configure

export METERBOX_BASE_URL=https://meterbox.ai   # or your self-hosted Meterbox host
export METERBOX_API_KEY=mb_live_...            # Settings > API keys

API keys are scoped to one environment (sandbox or production), so the key picks the environment. METERBOX_ADMIN_KEY is still read if METERBOX_API_KEY isn't set.

Optional:

• METERBOX_OPERATOR_ID (or --operator-id): sent as X-Operator-Id and recorded on audit rows, so people sharing a key can be told apart.
• METERBOX_CLI_REDACT=true (or --redact / --no-redact): filter secrets and personal data out of responses before printing.

Use

meterbox --list                        # every operation
meterbox <operation> --help            # inputs for one op
meterbox get_v1_plans
meterbox post_v1_plans_by_id_publish pro
meterbox post_v1_customers_by_id_credits cus_42 --amount_usd 25 --reason apology
meterbox get_v1_audit --event plan.update --limit 20

Arg conventions

• Positional: path parameters in OpenAPI order. meterbox get_v1_plans_by_id pro.
• --<name> value: query parameters and individual body fields.
• --body '<json>' or --body @file.json: send an explicit request body as-is, overriding per-field flags.

JSON is printed to stdout. Failures include the server's error message and the response X-Trace-Id, so you can match them against server logs.