SimetrikDocs
ReferenceOnboarding & devx

doctor

Diagnose the simetrik install, config, auth, network, and shell.

Runs a battery of local diagnostics over your simetrik install, configuration, authentication, network reachability, and shell, then prints a per-check report. Reach for it first whenever the CLI "isn't working" — a stale token, an unreachable BFF, a missing config file, or shell completion that never got wired up all surface here as a single named check instead of a cryptic failure deep in another command.

Pass --fix to apply the safe auto-fix any failing check advertises, --check <name> to run just one check by name, and --post-install to run only the subset relevant right after a fresh install (it skips auth, config, updates, and completion). Use --json for a machine-readable report when scripting or feeding an agent. The dedicated --install-completion [shell] path is a shortcut that installs tab completion and exits; if you omit the shell it is detected from $SHELL, and an unsupported or undetectable shell exits 2.

For just printing a completion script to stdout (rather than installing it), use simetrik completion instead.

See also: completion, version, update. Requires CLI access to the workspace for the auth and config checks. See permissions.

Flags

  • --json — Emit machine-readable JSON.
  • --fix — Apply safe auto-fixes for any check that reports one.
  • --post-install — Run only checks relevant after a fresh install (skip auth, config, updates, completion).
  • --check <name> — Run a single check by name.
  • --install-completion [shell] — Install shell completion (bash | zsh | fish | pwsh).

Examples

simetrik doctor
simetrik doctor --json
simetrik doctor --fix
simetrik doctor --post-install
simetrik doctor --check auth
simetrik doctor --install-completion zsh

Exit codes

CodeMeaning
0All checks passed (or every reported issue was a warning)
1One or more checks reported an error
2Usage error — unsupported shell passed to --install-completion, or shell could not be detected

On this page