Environment variables & exit codes
The environment variables the CLI reads and the exit codes it returns.
Most of the time the CLI needs no environment configuration. These variables let you point it elsewhere or run it non-interactively, and the exit codes let you script around it.
Environment variables
- SYNCANIX_API_KEY — your secret API key for uploads (also read from ~/.syncanix/credentials).
- SYNCANIX_API_URL — override the Syncanix API origin (defaults to the production API).
- SYNCANIX_DASHBOARD_URL — override the dashboard URL used by syncanix login.
- ANTHROPIC_API_KEY and OPENAI_API_KEY — provider keys used during AI enrichment.
- ANTHROPIC_ZDR_ENABLED — must be true for managed enrichment to send anything.
- SYNCANIX_LOCALE (and LANG / LC_ALL) — set the output language when --locale is not passed.
- SYNCANIX_DEV_PORT, SYNCANIX_DEV_BACKEND, SYNCANIX_DEV_KEY, and related variables — defaults for syncanix dev.
Exit codes
- 0 — success.
- 1 — a user or input error (bad input, or missing configuration).
- 2 — a system error (a network, filesystem, or provider failure).
- 64 — a usage error (an unknown command or an invalid option).
Troubleshooting
If an upload is skipped, check that you have signed in or set SYNCANIX_API_KEY. If a framework is not detected, run syncanix doctor for a quick diagnosis. If managed enrichment refuses to run, confirm that zero-data-retention is enabled for your provider.