Skip to content

Reference

alter doctor

Diagnose the Alter wiring end to end — one self-check instead of five guesses.

alter doctor runs every wiring check end to end and reports each one as ok / warn / fail / skip with a concrete fix — authentication, the linked app, configured providers, active keys (including a wildcard-scope warning), OAuth grants, and managed secrets. All checks run (one broken link never hides the others); the command exits 1 only when a check fails. Warnings are informational — for example, zero OAuth providers is normal for an app that only uses managed secrets.

alter doctor [--app <app-id-or-name>] [--dir <path>] [--output json|jsonl|table]
FlagDefaultDescription
--app <app-id-or-name>resolved appApp to probe; falls back to ALTER_APP_ID or the linked workspace.
--dir <path>.Directory to resolve the linked workspace (.alter/config.yaml) from.
--output <format>tablejson, jsonl, or table. Because the summary is one object, jsonl falls back to pretty-printed JSON.

Every probe is read-only. When authentication fails, the authed checks report skip rather than crashing — fix the auth row first (alter auth login) and re-run. Typical use: run alter doctor before debugging any “my call doesn’t work” problem, and after finishing setup as a final wiring confirmation.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.