@zairos/connect-cli

Interactive CLI to call any Zairos Connect API endpoint.

Install

npm install -g @zairos/connect-cli

Then run:

zairos

(Or without installing: npx @zairos/connect-cli.) jq must be on your PATH for pretty output, and your IP must be whitelisted.

First run

If no stored credentials are found, zairos walks you through setup:

1. It asks for the path to your credentials JSON file. Paths with spaces are fine — quoted, or with the spaces backslash-escaped (as drag-and-drop into the terminal produces), and a leading ~ is expanded.
2. It tests the connection against GET /v1/credentials.
3. On success it saves the bundle to ~/.zairos/credentials.json (owner-only, chmod 600) for future runs.

The bundle is the file the Zairos admin console issues when you "Issue credentials".

Usage

You get a searchable endpoint menu. Pick one, answer any path/query prompts (POST bodies open in $EDITOR as JSON), and the response is rendered through jq. The tool loops back to the menu; Ctrl-C exits.

• limit/offset default to 25/0 — press Enter to accept.
• For equals-money endpoints, credentialId is picked from your stored credentials (auto-selected when you only have one).

Credentials resolution

In order of precedence:

1. --credentials <path> flag (used as-is, not persisted)
2. ZAIROS_CREDENTIALS env var
3. ~/.zairos/credentials.json (the stored bundle)
4. First-run onboarding (saves to #3)

A ~ in a path is expanded.

API docs credentials

The endpoint menu is built from the live OpenAPI document, which (since Zairos Connect v1.3.0) sits behind a shared HTTP Basic credential. The CLI defaults to the shared docs creds, so no setup is needed in the common case. For hardened environments, override them:

• ZAIROS_DOCS_USER (default zairos-docs)
• ZAIROS_DOCS_PASSWORD (default zairos-docs-2026)

These only gate the spec fetch — the actual API calls use your mTLS credentials.

Develop

npm install
npm start            # node cli.js
npm test             # node --test